diff --git a/docs/data/contributors.json b/docs/data/contributors.json index bb7930ba2..6f5a9f844 100644 --- a/docs/data/contributors.json +++ b/docs/data/contributors.json @@ -1 +1 @@ -{"openapi-typescript":[{"username":"drwpow","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4?s=400","name":"Drew Powers","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1713898064578},{"username":"psmyrdek","avatar":"https://avatars.githubusercontent.com/u/6187417?v=4?s=400","name":"Przemek Smyrdek","links":[{"icon":"github","link":"https://github.com/psmyrdek"}],"lastFetch":1713898064799},{"username":"enmand","avatar":"https://avatars.githubusercontent.com/u/432487?v=4?s=400","name":"Dan Enman","links":[{"icon":"github","link":"https://github.com/enmand"}],"lastFetch":1713898065020},{"username":"atlefren","avatar":"https://avatars.githubusercontent.com/u/1829927?v=4?s=400","name":"Atle Frenvik Sveen","links":[{"icon":"github","link":"https://github.com/atlefren"}],"lastFetch":1713898065248},{"username":"tpdewolf","avatar":"https://avatars.githubusercontent.com/u/4455209?v=4?s=400","name":"Tim de Wolf","links":[{"icon":"github","link":"https://github.com/tpdewolf"}],"lastFetch":1713898065450},{"username":"tombarton","avatar":"https://avatars.githubusercontent.com/u/6222711?v=4?s=400","name":"Tom Barton","links":[{"icon":"github","link":"https://github.com/tombarton"}],"lastFetch":1713898065683},{"username":"svnv","avatar":"https://avatars.githubusercontent.com/u/1080888?v=4?s=400","name":"Sven Nicolai Viig","links":[{"icon":"github","link":"https://github.com/svnv"}],"lastFetch":1713898065999},{"username":"sorin-davidoi","avatar":"https://avatars.githubusercontent.com/u/2109702?v=4?s=400","name":"Sorin Davidoi","links":[{"icon":"github","link":"https://github.com/sorin-davidoi"}],"lastFetch":1713898066383},{"username":"scvnathan","avatar":"https://avatars.githubusercontent.com/u/73474?v=4?s=400","name":"Nathan Schneirov","links":[{"icon":"github","link":"https://github.com/scvnathan"}],"lastFetch":1713898066561},{"username":"lbenie","avatar":"https://avatars.githubusercontent.com/u/7316046?v=4?s=400","name":"Lucien Bénié","links":[{"icon":"github","link":"https://github.com/lbenie"}],"lastFetch":1713898066856},{"username":"bokub","avatar":"https://avatars.githubusercontent.com/u/17952318?v=4?s=400","name":"Boris K","links":[{"icon":"github","link":"https://github.com/bokub"}],"lastFetch":1713898067071},{"username":"antonk52","avatar":"https://avatars.githubusercontent.com/u/5817809?v=4?s=400","name":"Anton Kastritskii","links":[{"icon":"github","link":"https://github.com/antonk52"}],"lastFetch":1713898067344},{"username":"tshelburne","avatar":"https://avatars.githubusercontent.com/u/1202267?v=4?s=400","name":"Tim Shelburne","links":[{"icon":"github","link":"https://github.com/tshelburne"}],"lastFetch":1713898067562},{"username":"mmiszy","avatar":"https://avatars.githubusercontent.com/u/1338731?v=4?s=400","name":"Michał Miszczyszyn","links":[{"icon":"github","link":"https://github.com/mmiszy"}],"lastFetch":1713898067800},{"username":"skh-","avatar":"https://avatars.githubusercontent.com/u/1292598?v=4?s=400","name":"Sam K Hall","links":[{"icon":"github","link":"https://github.com/skh-"}],"lastFetch":1713898125055},{"username":"BlooJeans","avatar":"https://avatars.githubusercontent.com/u/1751182?v=4?s=400","name":"Matt Jeanes","links":[{"icon":"github","link":"https://github.com/BlooJeans"}],"lastFetch":1713898125316},{"username":"selbekk","avatar":"https://avatars.githubusercontent.com/u/1307267?v=4?s=400","name":"Kristofer Giltvedt Selbekk","links":[{"icon":"github","link":"https://github.com/selbekk"}],"lastFetch":1713898125666},{"username":"Mause","avatar":"https://avatars.githubusercontent.com/u/1405026?v=4?s=400","name":"Elliana May","links":[{"icon":"github","link":"https://github.com/Mause"}],"lastFetch":1713898125942},{"username":"henhal","avatar":"https://avatars.githubusercontent.com/u/9608258?v=4?s=400","name":"Henrik Hall","links":[{"icon":"github","link":"https://github.com/henhal"}],"lastFetch":1713898126193},{"username":"gr2m","avatar":"https://avatars.githubusercontent.com/u/39992?v=4?s=400","name":"Gregor Martynus","links":[{"icon":"github","link":"https://github.com/gr2m"}],"lastFetch":1713898126755},{"username":"samdbmg","avatar":"https://avatars.githubusercontent.com/u/408983?v=4?s=400","name":"Sam Mesterton-Gibbons","links":[{"icon":"github","link":"https://github.com/samdbmg"}],"lastFetch":1713898126983},{"username":"rendall","avatar":"https://avatars.githubusercontent.com/u/293263?v=4?s=400","name":"Rendall","links":[{"icon":"github","link":"https://github.com/rendall"}],"lastFetch":1713898127205},{"username":"robertmassaioli","avatar":"https://avatars.githubusercontent.com/u/149178?v=4?s=400","name":"Robert Massaioli","links":[{"icon":"github","link":"https://github.com/robertmassaioli"}],"lastFetch":1713898127451},{"username":"jankuca","avatar":"https://avatars.githubusercontent.com/u/367262?v=4?s=400","name":"Jan Kuča","links":[{"icon":"github","link":"https://github.com/jankuca"}],"lastFetch":1713898127686},{"username":"th-m","avatar":"https://avatars.githubusercontent.com/u/13792029?v=4?s=400","name":"Thomas Valadez","links":[{"icon":"github","link":"https://github.com/th-m"}],"lastFetch":1713898128087},{"username":"asithade","avatar":"https://avatars.githubusercontent.com/u/3814354?v=4?s=400","name":"Asitha de Silva","links":[{"icon":"github","link":"https://github.com/asithade"}],"lastFetch":1713898128263},{"username":"MikeYermolayev","avatar":"https://avatars.githubusercontent.com/u/8783498?v=4?s=400","name":"Misha","links":[{"icon":"github","link":"https://github.com/MikeYermolayev"}],"lastFetch":1707884474830},{"username":"radist2s","avatar":"https://avatars.githubusercontent.com/u/725645?v=4?s=400","name":"Alex Batalov","links":[{"icon":"github","link":"https://github.com/radist2s"}],"lastFetch":1713898128716},{"username":"FedeBev","avatar":"https://avatars.githubusercontent.com/u/22151395?v=4?s=400","name":"Federico Bevione","links":[{"icon":"github","link":"https://github.com/FedeBev"}],"lastFetch":1713898128966},{"username":"yamacent","avatar":"https://avatars.githubusercontent.com/u/8544439?v=4?s=400","name":"Daisuke Yamamoto","links":[{"icon":"github","link":"https://github.com/yamacent"}],"lastFetch":1713898129249},{"username":"dnalborczyk","avatar":"https://avatars.githubusercontent.com/u/2903325?v=4?s=400","name":"dnalborczyk","links":[{"icon":"github","link":"https://github.com/dnalborczyk"}],"lastFetch":1713898129465},{"username":"FabioWanner","avatar":"https://avatars.githubusercontent.com/u/46821078?v=4?s=400","name":"FabioWanner","links":[{"icon":"github","link":"https://github.com/FabioWanner"}],"lastFetch":1713898129651},{"username":"ashsmith","avatar":"https://avatars.githubusercontent.com/u/1086841?v=4?s=400","name":"Ash Smith","links":[{"icon":"github","link":"https://github.com/ashsmith"}],"lastFetch":1713898129978},{"username":"mehalter","avatar":"https://avatars.githubusercontent.com/u/1591837?v=4?s=400","name":"Micah Halter","links":[{"icon":"github","link":"https://github.com/mehalter"}],"lastFetch":1713898130232},{"username":"Chrg1001","avatar":"https://avatars.githubusercontent.com/u/40189653?v=4?s=400","name":"chrg1001","links":[{"icon":"github","link":"https://github.com/Chrg1001"}],"lastFetch":1713898130524},{"username":"sharmarajdaksh","avatar":"https://avatars.githubusercontent.com/u/33689528?v=4?s=400","name":"Dakshraj Sharma","links":[{"icon":"github","link":"https://github.com/sharmarajdaksh"}],"lastFetch":1713898130769},{"username":"shuluster","avatar":"https://avatars.githubusercontent.com/u/1707910?v=4?s=400","name":"Shaosu Liu","links":[{"icon":"github","link":"https://github.com/shuluster"}],"lastFetch":1713898131039},{"username":"FDiskas","avatar":"https://avatars.githubusercontent.com/u/468006?v=4?s=400","name":"Vytenis","links":[{"icon":"github","link":"https://github.com/FDiskas"}],"lastFetch":1713898131355},{"username":"ericzorn93","avatar":"https://avatars.githubusercontent.com/u/22532542?v=4?s=400","name":"Eric Zorn","links":[{"icon":"github","link":"https://github.com/ericzorn93"}],"lastFetch":1713898131736},{"username":"mbelsky","avatar":"https://avatars.githubusercontent.com/u/3923527?v=4?s=400","name":"Max Belsky","links":[{"icon":"github","link":"https://github.com/mbelsky"}],"lastFetch":1713898131979},{"username":"Peteck","avatar":"https://avatars.githubusercontent.com/u/129566390?v=4?s=400","name":"Peteck","links":[{"icon":"github","link":"https://github.com/Peteck"}],"lastFetch":1709656979935},{"username":"rustyconover","avatar":"https://avatars.githubusercontent.com/u/731941?v=4?s=400","name":"Rusty Conover","links":[{"icon":"github","link":"https://github.com/rustyconover"}],"lastFetch":1713898271041},{"username":"bunkscene","avatar":"https://avatars.githubusercontent.com/u/2693678?v=4?s=400","name":"Dave Carlson","links":[{"icon":"github","link":"https://github.com/bunkscene"}],"lastFetch":1713898271231},{"username":"ottomated","avatar":"https://avatars.githubusercontent.com/u/31470743?v=4?s=400","name":"ottomated","links":[{"icon":"github","link":"https://github.com/ottomated"}],"lastFetch":1713898271654},{"username":"sadfsdfdsa","avatar":"https://avatars.githubusercontent.com/u/28733669?v=4?s=400","name":"Artem Shuvaev","links":[{"icon":"github","link":"https://github.com/sadfsdfdsa"}],"lastFetch":1713898271921},{"username":"ajaishankar","avatar":"https://avatars.githubusercontent.com/u/328008?v=4?s=400","name":"ajaishankar","links":[{"icon":"github","link":"https://github.com/ajaishankar"}],"lastFetch":1713898272133},{"username":"dominikdosoudil","avatar":"https://avatars.githubusercontent.com/u/15929942?v=4?s=400","name":"Dominik Dosoudil","links":[{"icon":"github","link":"https://github.com/dominikdosoudil"}],"lastFetch":1713898272378},{"username":"kgtkr","avatar":"https://avatars.githubusercontent.com/u/17868838?v=4?s=400","name":"kgtkr","links":[{"icon":"github","link":"https://github.com/kgtkr"}],"lastFetch":1713898272614},{"username":"berzi","avatar":"https://avatars.githubusercontent.com/u/32619123?v=4?s=400","name":"berzi","links":[{"icon":"github","link":"https://github.com/berzi"}],"lastFetch":1713898272860},{"username":"PhilipTrauner","avatar":"https://avatars.githubusercontent.com/u/9287847?v=4?s=400","name":"Philip Trauner","links":[{"icon":"github","link":"https://github.com/PhilipTrauner"}],"lastFetch":1713898273111},{"username":"Powell-v2","avatar":"https://avatars.githubusercontent.com/u/25308326?v=4?s=400","name":"Pavel Yermolin","links":[{"icon":"github","link":"https://github.com/Powell-v2"}],"lastFetch":1713898273358},{"username":"duncanbeevers","avatar":"https://avatars.githubusercontent.com/u/7367?v=4?s=400","name":"Duncan Beevers","links":[{"icon":"github","link":"https://github.com/duncanbeevers"}],"lastFetch":1713898273587},{"username":"tkukushkin","avatar":"https://avatars.githubusercontent.com/u/1482516?v=4?s=400","name":"Timofei Kukushkin","links":[{"icon":"github","link":"https://github.com/tkukushkin"}],"lastFetch":1713898273910},{"username":"Semigradsky","avatar":"https://avatars.githubusercontent.com/u/1198848?v=4?s=400","name":"Dmitry Semigradsky","links":[{"icon":"github","link":"https://github.com/Semigradsky"}],"lastFetch":1713898274144},{"username":"MrLeebo","avatar":"https://avatars.githubusercontent.com/u/2754163?v=4?s=400","name":"Jeremy Liberman","links":[{"icon":"github","link":"https://github.com/MrLeebo"}],"lastFetch":1713898274377},{"username":"axelhzf","avatar":"https://avatars.githubusercontent.com/u/175627?v=4?s=400","name":"Axel Hernández Ferrera","links":[{"icon":"github","link":"https://github.com/axelhzf"}],"lastFetch":1713898274571},{"username":"imagoiq","avatar":"https://avatars.githubusercontent.com/u/12294151?v=4?s=400","name":"Loïc Fürhoff","links":[{"icon":"github","link":"https://github.com/imagoiq"}],"lastFetch":1713898274807},{"username":"BTMPL","avatar":"https://avatars.githubusercontent.com/u/247153?v=4?s=400","name":"Bartosz Szczeciński","links":[{"icon":"github","link":"https://github.com/BTMPL"}],"lastFetch":1713898274986},{"username":"HiiiiD","avatar":"https://avatars.githubusercontent.com/u/61231210?v=4?s=400","name":"Marco Salomone","links":[{"icon":"github","link":"https://github.com/HiiiiD"}],"lastFetch":1713898275231},{"username":"yacinehmito","avatar":"https://avatars.githubusercontent.com/u/6893840?v=4?s=400","name":"Yacine Hmito","links":[{"icon":"github","link":"https://github.com/yacinehmito"}],"lastFetch":1713898275465},{"username":"sajadtorkamani","avatar":"https://avatars.githubusercontent.com/u/9380313?v=4?s=400","name":"Sajad Torkamani","links":[{"icon":"github","link":"https://github.com/sajadtorkamani"}],"lastFetch":1713898275639},{"username":"mvdbeek","avatar":"https://avatars.githubusercontent.com/u/6804901?v=4?s=400","name":"Marius van den Beek","links":[{"icon":"github","link":"https://github.com/mvdbeek"}],"lastFetch":1713898275881},{"username":"sgrimm","avatar":"https://avatars.githubusercontent.com/u/1248649?v=4?s=400","name":"Steven Grimm","links":[{"icon":"github","link":"https://github.com/sgrimm"}],"lastFetch":1713898276056},{"username":"Swiftwork","avatar":"https://avatars.githubusercontent.com/u/455178?v=4?s=400","name":"Erik Hughes","links":[{"icon":"github","link":"https://github.com/Swiftwork"}],"lastFetch":1713898276465},{"username":"mtth","avatar":"https://avatars.githubusercontent.com/u/1216372?v=4?s=400","name":"Matthieu Monsch","links":[{"icon":"github","link":"https://github.com/mtth"}],"lastFetch":1713898276691},{"username":"mitchell-merry","avatar":"https://avatars.githubusercontent.com/u/8567231?v=4?s=400","name":"Mitchell Merry","links":[{"icon":"github","link":"https://github.com/mitchell-merry"}],"lastFetch":1713898276910},{"username":"qnp","avatar":"https://avatars.githubusercontent.com/u/6012554?v=4?s=400","name":"François Risoud","links":[{"icon":"github","link":"https://github.com/qnp"}],"lastFetch":1713898277107},{"username":"shoffmeister","avatar":"https://avatars.githubusercontent.com/u/3868036?v=4?s=400","name":"shoffmeister","links":[{"icon":"github","link":"https://github.com/shoffmeister"}],"lastFetch":1713898277322},{"username":"liangskyli","avatar":"https://avatars.githubusercontent.com/u/31531283?v=4?s=400","name":"liangsky","links":[{"icon":"github","link":"https://github.com/liangskyli"}],"lastFetch":1713898277526},{"username":"happycollision","avatar":"https://avatars.githubusercontent.com/u/3663628?v=4?s=400","name":"Don Denton","links":[{"icon":"github","link":"https://github.com/happycollision"}],"lastFetch":1713898314128},{"username":"ysmood","avatar":"https://avatars.githubusercontent.com/u/1415488?v=4?s=400","name":"Yad Smood","links":[{"icon":"github","link":"https://github.com/ysmood"}],"lastFetch":1713898314356},{"username":"barakalon","avatar":"https://avatars.githubusercontent.com/u/12398927?v=4?s=400","name":"barak","links":[{"icon":"github","link":"https://github.com/barakalon"}],"lastFetch":1713898314561},{"username":"horaklukas","avatar":"https://avatars.githubusercontent.com/u/996088?v=4?s=400","name":"Lukáš Horák","links":[{"icon":"github","link":"https://github.com/horaklukas"}],"lastFetch":1713898314763},{"username":"pvanagtmaal","avatar":"https://avatars.githubusercontent.com/u/5946464?v=4?s=400","name":"pvanagtmaal","links":[{"icon":"github","link":"https://github.com/pvanagtmaal"}],"lastFetch":1713898314958},{"username":"toomuchdesign","avatar":"https://avatars.githubusercontent.com/u/4573549?v=4?s=400","name":"Andrea Carraro","links":[{"icon":"github","link":"https://github.com/toomuchdesign"}],"lastFetch":1713898315186},{"username":"psychedelicious","avatar":"https://avatars.githubusercontent.com/u/4822129?v=4?s=400","name":"psychedelicious","links":[{"icon":"github","link":"https://github.com/psychedelicious"}],"lastFetch":1713898315388},{"username":"tkrotoff","avatar":"https://avatars.githubusercontent.com/u/643434?v=4?s=400","name":"Tanguy Krotoff","links":[{"icon":"github","link":"https://github.com/tkrotoff"}],"lastFetch":1713898315629},{"username":"pimveldhuisen","avatar":"https://avatars.githubusercontent.com/u/3043834?v=4?s=400","name":"Pim Veldhuisen","links":[{"icon":"github","link":"https://github.com/pimveldhuisen"}],"lastFetch":1713898315892},{"username":"asvishnyakov","avatar":"https://avatars.githubusercontent.com/u/6369252?v=4?s=400","name":"Aleksandr Vishniakov","links":[{"icon":"github","link":"https://github.com/asvishnyakov"}],"lastFetch":1713898316091},{"username":"SchabaJo","avatar":"https://avatars.githubusercontent.com/u/138689813?v=4?s=400","name":"SchabaJo","links":[{"icon":"github","link":"https://github.com/SchabaJo"}],"lastFetch":1713898316291},{"username":"AhsanFazal","avatar":"https://avatars.githubusercontent.com/u/7458046?v=4?s=400","name":"Ahsan Fazal","links":[{"icon":"github","link":"https://github.com/AhsanFazal"}],"lastFetch":1713898316558},{"username":"ElForastero","avatar":"https://avatars.githubusercontent.com/u/5102818?v=4?s=400","name":"Eugene Dzhumak","links":[{"icon":"github","link":"https://github.com/ElForastero"}],"lastFetch":1713898316781},{"username":"msgadi","avatar":"https://avatars.githubusercontent.com/u/9037086?v=4?s=400","name":"Mohammed Gadi","links":[{"icon":"github","link":"https://github.com/msgadi"}],"lastFetch":1713898317221},{"username":"muttonchop","avatar":"https://avatars.githubusercontent.com/u/1037657?v=4?s=400","name":"Adam K","links":[{"icon":"github","link":"https://github.com/muttonchop"}],"lastFetch":1713898317424},{"username":"christoph-fricke","avatar":"https://avatars.githubusercontent.com/u/23103835?v=4?s=400","name":"Christoph Fricke","links":[{"icon":"github","link":"https://github.com/christoph-fricke"}],"lastFetch":1713898317673},{"username":"JorrinKievit","avatar":"https://avatars.githubusercontent.com/u/43169049?v=4?s=400","name":"Jorrin","links":[{"icon":"github","link":"https://github.com/JorrinKievit"}],"lastFetch":1713898317923},{"username":"WickyNilliams","avatar":"https://avatars.githubusercontent.com/u/1091390?v=4?s=400","name":"Nick Williams","links":[{"icon":"github","link":"https://github.com/WickyNilliams"}],"lastFetch":1713898318132},{"username":"hrsh7th","avatar":"https://avatars.githubusercontent.com/u/629908?v=4?s=400","name":"hrsh7th","links":[{"icon":"github","link":"https://github.com/hrsh7th"}],"lastFetch":1713898318377},{"username":"davidleger95","avatar":"https://avatars.githubusercontent.com/u/10498708?v=4?s=400","name":"David Leger","links":[{"icon":"github","link":"https://github.com/davidleger95"}],"lastFetch":1713898318588},{"username":"misha-erm","avatar":"https://avatars.githubusercontent.com/u/8783498?v=4?s=400","name":"Misha","links":[{"icon":"github","link":"https://github.com/misha-erm"}],"lastFetch":1713898128506},{"username":"phk422","avatar":"https://avatars.githubusercontent.com/u/59734322?v=4?s=400","name":"Hongkun Peng","links":[{"icon":"github","link":"https://github.com/phk422"}],"lastFetch":1713898318850},{"username":"mzronek","avatar":"https://avatars.githubusercontent.com/u/3847700?v=4?s=400","name":"Matthias Zronek","links":[{"icon":"github","link":"https://github.com/mzronek"}],"lastFetch":1713898319036},{"username":"techbech","avatar":"https://avatars.githubusercontent.com/u/1520592?v=4?s=400","name":"Peter Bech","links":[{"icon":"github","link":"https://github.com/techbech"}],"lastFetch":1713898270816},{"username":"raurfang","avatar":"https://avatars.githubusercontent.com/u/867241?v=4?s=400","name":"Łukasz Wiśniewski","links":[{"icon":"github","link":"https://github.com/raurfang"}],"lastFetch":1713899800845},{"username":"JeanRemiDelteil","avatar":"https://avatars.githubusercontent.com/u/9743907?v=4?s=400","name":"Jean-Rémi Delteil","links":[{"icon":"github","link":"https://github.com/JeanRemiDelteil"}],"lastFetch":1713899801050},{"username":"TzviPM","avatar":"https://avatars.githubusercontent.com/u/1950680?v=4?s=400","name":"Tzvi Melamed","links":[{"icon":"github","link":"https://github.com/TzviPM"}],"lastFetch":1713899801290},{"username":"LucaSchwan","avatar":"https://avatars.githubusercontent.com/u/25820532?v=4?s=400","name":"ehrenschwan","links":[{"icon":"github","link":"https://github.com/LucaSchwan"}],"lastFetch":1713908825592}],"openapi-fetch":[{"username":"drwpow","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4?s=400","name":"Drew Powers","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1713898064568},{"username":"fergusean","avatar":"https://avatars.githubusercontent.com/u/1029297?v=4?s=400","name":"fergusean","links":[{"icon":"github","link":"https://github.com/fergusean"}],"lastFetch":1713898064757},{"username":"shinzui","avatar":"https://avatars.githubusercontent.com/u/519?v=4?s=400","name":"Nadeem Bitar","links":[{"icon":"github","link":"https://github.com/shinzui"}],"lastFetch":1713898064941},{"username":"ezpuzz","avatar":"https://avatars.githubusercontent.com/u/672182?v=4?s=400","name":"Emory Petermann","links":[{"icon":"github","link":"https://github.com/ezpuzz"}],"lastFetch":1713898065168},{"username":"KotoriK","avatar":"https://avatars.githubusercontent.com/u/52659125?v=4?s=400","name":"KotoriK","links":[{"icon":"github","link":"https://github.com/KotoriK"}],"lastFetch":1713898065420},{"username":"fletchertyler914","avatar":"https://avatars.githubusercontent.com/u/3344498?v=4?s=400","name":"Tyler Fletcher","links":[{"icon":"github","link":"https://github.com/fletchertyler914"}],"lastFetch":1713898065675},{"username":"nholik","avatar":"https://avatars.githubusercontent.com/u/2022214?v=4?s=400","name":"Nicklos Holik","links":[{"icon":"github","link":"https://github.com/nholik"}],"lastFetch":1713898065875},{"username":"roj1512","avatar":"https://avatars.githubusercontent.com/u/49933115?v=4?s=400","name":"Roj","links":[{"icon":"github","link":"https://github.com/roj1512"}],"lastFetch":1713898066093},{"username":"nickcaballero","avatar":"https://avatars.githubusercontent.com/u/355976?v=4?s=400","name":"Nick Caballero","links":[{"icon":"github","link":"https://github.com/nickcaballero"}],"lastFetch":1713898066322},{"username":"hd-o","avatar":"https://avatars.githubusercontent.com/u/58871222?v=4?s=400","name":"Hadrian de Oliveira","links":[{"icon":"github","link":"https://github.com/hd-o"}],"lastFetch":1713898066499},{"username":"kecrily","avatar":"https://avatars.githubusercontent.com/u/45708948?v=4?s=400","name":"Percy Ma","links":[{"icon":"github","link":"https://github.com/kecrily"}],"lastFetch":1713898066750},{"username":"psychedelicious","avatar":"https://avatars.githubusercontent.com/u/4822129?v=4?s=400","name":"psychedelicious","links":[{"icon":"github","link":"https://github.com/psychedelicious"}],"lastFetch":1713898066945},{"username":"muttonchop","avatar":"https://avatars.githubusercontent.com/u/1037657?v=4?s=400","name":"Adam K","links":[{"icon":"github","link":"https://github.com/muttonchop"}],"lastFetch":1713898067161},{"username":"marcomuser","avatar":"https://avatars.githubusercontent.com/u/64737396?v=4?s=400","name":"Marco Muser","links":[{"icon":"github","link":"https://github.com/marcomuser"}],"lastFetch":1713898067341},{"username":"HugeLetters","avatar":"https://avatars.githubusercontent.com/u/119697239?v=4?s=400","name":"Evgenii Perminov","links":[{"icon":"github","link":"https://github.com/HugeLetters"}],"lastFetch":1713898067620},{"username":"Fumaz","avatar":"https://avatars.githubusercontent.com/u/45318608?v=4?s=400","name":"alex","links":[{"icon":"github","link":"https://github.com/Fumaz"}],"lastFetch":1713898067875},{"username":"darwish","avatar":"https://avatars.githubusercontent.com/u/292570?v=4?s=400","name":"Mike Darwish","links":[{"icon":"github","link":"https://github.com/darwish"}],"lastFetch":1713898125202},{"username":"kaechele","avatar":"https://avatars.githubusercontent.com/u/454490?v=4?s=400","name":"Felix Kaechele","links":[{"icon":"github","link":"https://github.com/kaechele"}],"lastFetch":1713898125420},{"username":"phk422","avatar":"https://avatars.githubusercontent.com/u/59734322?v=4?s=400","name":"Hongkun Peng","links":[{"icon":"github","link":"https://github.com/phk422"}],"lastFetch":1713898125732},{"username":"mikestopcontinues","avatar":"https://avatars.githubusercontent.com/u/150434?v=4?s=400","name":"Mike Stop Continues","links":[{"icon":"github","link":"https://github.com/mikestopcontinues"}],"lastFetch":1713899800954},{"username":"JE-Lee","avatar":"https://avatars.githubusercontent.com/u/19794813?v=4?s=400","name":"maurice","links":[{"icon":"github","link":"https://github.com/JE-Lee"}],"lastFetch":1713899801217},{"username":"vipentti","avatar":"https://avatars.githubusercontent.com/u/4726680?v=4?s=400","name":"Ville Penttinen","links":[{"icon":"github","link":"https://github.com/vipentti"}],"lastFetch":1713899801412},{"username":"armandabric","avatar":"https://avatars.githubusercontent.com/u/95120?v=4?s=400","name":"Armand Abric","links":[{"icon":"github","link":"https://github.com/armandabric"}],"lastFetch":1713899801647},{"username":"illright","avatar":"https://avatars.githubusercontent.com/u/15035286?v=4?s=400","name":"Lev Chelyadinov","links":[{"icon":"github","link":"https://github.com/illright"}],"lastFetch":1713899801946}]} \ No newline at end of file +{"openapi-typescript":[{"username":"drwpow","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4?s=400","name":"Drew Powers","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1714340667219},{"username":"psmyrdek","avatar":"https://avatars.githubusercontent.com/u/6187417?v=4?s=400","name":"Przemek Smyrdek","links":[{"icon":"github","link":"https://github.com/psmyrdek"}],"lastFetch":1714340667291},{"username":"enmand","avatar":"https://avatars.githubusercontent.com/u/432487?v=4?s=400","name":"Dan Enman","links":[{"icon":"github","link":"https://github.com/enmand"}],"lastFetch":1714340667357},{"username":"atlefren","avatar":"https://avatars.githubusercontent.com/u/1829927?v=4?s=400","name":"Atle Frenvik Sveen","links":[{"icon":"github","link":"https://github.com/atlefren"}],"lastFetch":1714340667421},{"username":"tpdewolf","avatar":"https://avatars.githubusercontent.com/u/4455209?v=4?s=400","name":"Tim de Wolf","links":[{"icon":"github","link":"https://github.com/tpdewolf"}],"lastFetch":1714340667483},{"username":"tombarton","avatar":"https://avatars.githubusercontent.com/u/6222711?v=4?s=400","name":"Tom Barton","links":[{"icon":"github","link":"https://github.com/tombarton"}],"lastFetch":1714340667546},{"username":"svnv","avatar":"https://avatars.githubusercontent.com/u/1080888?v=4?s=400","name":"Sven Nicolai Viig","links":[{"icon":"github","link":"https://github.com/svnv"}],"lastFetch":1714340667613},{"username":"sorin-davidoi","avatar":"https://avatars.githubusercontent.com/u/2109702?v=4?s=400","name":"Sorin Davidoi","links":[{"icon":"github","link":"https://github.com/sorin-davidoi"}],"lastFetch":1714340667675},{"username":"scvnathan","avatar":"https://avatars.githubusercontent.com/u/73474?v=4?s=400","name":"Nathan Schneirov","links":[{"icon":"github","link":"https://github.com/scvnathan"}],"lastFetch":1714340667740},{"username":"lbenie","avatar":"https://avatars.githubusercontent.com/u/7316046?v=4?s=400","name":"Lucien Bénié","links":[{"icon":"github","link":"https://github.com/lbenie"}],"lastFetch":1714340667811},{"username":"bokub","avatar":"https://avatars.githubusercontent.com/u/17952318?v=4?s=400","name":"Boris K","links":[{"icon":"github","link":"https://github.com/bokub"}],"lastFetch":1714340667878},{"username":"antonk52","avatar":"https://avatars.githubusercontent.com/u/5817809?v=4?s=400","name":"Anton Kastritskii","links":[{"icon":"github","link":"https://github.com/antonk52"}],"lastFetch":1714340667943},{"username":"tshelburne","avatar":"https://avatars.githubusercontent.com/u/1202267?v=4?s=400","name":"Tim Shelburne","links":[{"icon":"github","link":"https://github.com/tshelburne"}],"lastFetch":1714340668010},{"username":"mmiszy","avatar":"https://avatars.githubusercontent.com/u/1338731?v=4?s=400","name":"Michał Miszczyszyn","links":[{"icon":"github","link":"https://github.com/mmiszy"}],"lastFetch":1714340668075},{"username":"skh-","avatar":"https://avatars.githubusercontent.com/u/1292598?v=4?s=400","name":"Sam K Hall","links":[{"icon":"github","link":"https://github.com/skh-"}],"lastFetch":1714340668140},{"username":"BlooJeans","avatar":"https://avatars.githubusercontent.com/u/1751182?v=4?s=400","name":"Matt Jeanes","links":[{"icon":"github","link":"https://github.com/BlooJeans"}],"lastFetch":1714340709072},{"username":"selbekk","avatar":"https://avatars.githubusercontent.com/u/1307267?v=4?s=400","name":"Kristofer Giltvedt Selbekk","links":[{"icon":"github","link":"https://github.com/selbekk"}],"lastFetch":1714340709328},{"username":"Mause","avatar":"https://avatars.githubusercontent.com/u/1405026?v=4?s=400","name":"Elliana May","links":[{"icon":"github","link":"https://github.com/Mause"}],"lastFetch":1714340709654},{"username":"henhal","avatar":"https://avatars.githubusercontent.com/u/9608258?v=4?s=400","name":"Henrik Hall","links":[{"icon":"github","link":"https://github.com/henhal"}],"lastFetch":1714340709892},{"username":"gr2m","avatar":"https://avatars.githubusercontent.com/u/39992?v=4?s=400","name":"Gregor Martynus","links":[{"icon":"github","link":"https://github.com/gr2m"}],"lastFetch":1714340710186},{"username":"samdbmg","avatar":"https://avatars.githubusercontent.com/u/408983?v=4?s=400","name":"Sam Mesterton-Gibbons","links":[{"icon":"github","link":"https://github.com/samdbmg"}],"lastFetch":1714340710394},{"username":"rendall","avatar":"https://avatars.githubusercontent.com/u/293263?v=4?s=400","name":"Rendall","links":[{"icon":"github","link":"https://github.com/rendall"}],"lastFetch":1714340710632},{"username":"robertmassaioli","avatar":"https://avatars.githubusercontent.com/u/149178?v=4?s=400","name":"Robert Massaioli","links":[{"icon":"github","link":"https://github.com/robertmassaioli"}],"lastFetch":1714340710844},{"username":"jankuca","avatar":"https://avatars.githubusercontent.com/u/367262?v=4?s=400","name":"Jan Kuča","links":[{"icon":"github","link":"https://github.com/jankuca"}],"lastFetch":1714340711057},{"username":"th-m","avatar":"https://avatars.githubusercontent.com/u/13792029?v=4?s=400","name":"Thomas Valadez","links":[{"icon":"github","link":"https://github.com/th-m"}],"lastFetch":1714340711333},{"username":"asithade","avatar":"https://avatars.githubusercontent.com/u/3814354?v=4?s=400","name":"Asitha de Silva","links":[{"icon":"github","link":"https://github.com/asithade"}],"lastFetch":1714340711552},{"username":"MikeYermolayev","avatar":"https://avatars.githubusercontent.com/u/8783498?v=4?s=400","name":"Misha","links":[{"icon":"github","link":"https://github.com/MikeYermolayev"}],"lastFetch":1707884474830},{"username":"radist2s","avatar":"https://avatars.githubusercontent.com/u/725645?v=4?s=400","name":"Alex Batalov","links":[{"icon":"github","link":"https://github.com/radist2s"}],"lastFetch":1714340711943},{"username":"FedeBev","avatar":"https://avatars.githubusercontent.com/u/22151395?v=4?s=400","name":"Federico Bevione","links":[{"icon":"github","link":"https://github.com/FedeBev"}],"lastFetch":1714340712155},{"username":"yamacent","avatar":"https://avatars.githubusercontent.com/u/8544439?v=4?s=400","name":"Daisuke Yamamoto","links":[{"icon":"github","link":"https://github.com/yamacent"}],"lastFetch":1714340712374},{"username":"dnalborczyk","avatar":"https://avatars.githubusercontent.com/u/2903325?v=4?s=400","name":"dnalborczyk","links":[{"icon":"github","link":"https://github.com/dnalborczyk"}],"lastFetch":1714340712614},{"username":"FabioWanner","avatar":"https://avatars.githubusercontent.com/u/46821078?v=4?s=400","name":"FabioWanner","links":[{"icon":"github","link":"https://github.com/FabioWanner"}],"lastFetch":1714340712837},{"username":"ashsmith","avatar":"https://avatars.githubusercontent.com/u/1086841?v=4?s=400","name":"Ash Smith","links":[{"icon":"github","link":"https://github.com/ashsmith"}],"lastFetch":1714340713091},{"username":"mehalter","avatar":"https://avatars.githubusercontent.com/u/1591837?v=4?s=400","name":"Micah Halter","links":[{"icon":"github","link":"https://github.com/mehalter"}],"lastFetch":1714340713353},{"username":"Chrg1001","avatar":"https://avatars.githubusercontent.com/u/40189653?v=4?s=400","name":"chrg1001","links":[{"icon":"github","link":"https://github.com/Chrg1001"}],"lastFetch":1714340756373},{"username":"sharmarajdaksh","avatar":"https://avatars.githubusercontent.com/u/33689528?v=4?s=400","name":"Dakshraj Sharma","links":[{"icon":"github","link":"https://github.com/sharmarajdaksh"}],"lastFetch":1714340756593},{"username":"shuluster","avatar":"https://avatars.githubusercontent.com/u/1707910?v=4?s=400","name":"Shaosu Liu","links":[{"icon":"github","link":"https://github.com/shuluster"}],"lastFetch":1714340756766},{"username":"FDiskas","avatar":"https://avatars.githubusercontent.com/u/468006?v=4?s=400","name":"Vytenis","links":[{"icon":"github","link":"https://github.com/FDiskas"}],"lastFetch":1714340757041},{"username":"ericzorn93","avatar":"https://avatars.githubusercontent.com/u/22532542?v=4?s=400","name":"Eric Zorn","links":[{"icon":"github","link":"https://github.com/ericzorn93"}],"lastFetch":1714340757301},{"username":"mbelsky","avatar":"https://avatars.githubusercontent.com/u/3923527?v=4?s=400","name":"Max Belsky","links":[{"icon":"github","link":"https://github.com/mbelsky"}],"lastFetch":1714340757534},{"username":"Peteck","avatar":"https://avatars.githubusercontent.com/u/129566390?v=4?s=400","name":"Peteck","links":[{"icon":"github","link":"https://github.com/Peteck"}],"lastFetch":1709656979935},{"username":"rustyconover","avatar":"https://avatars.githubusercontent.com/u/731941?v=4?s=400","name":"Rusty Conover","links":[{"icon":"github","link":"https://github.com/rustyconover"}],"lastFetch":1714340757972},{"username":"bunkscene","avatar":"https://avatars.githubusercontent.com/u/2693678?v=4?s=400","name":"Dave Carlson","links":[{"icon":"github","link":"https://github.com/bunkscene"}],"lastFetch":1714340758166},{"username":"ottomated","avatar":"https://avatars.githubusercontent.com/u/31470743?v=4?s=400","name":"ottomated","links":[{"icon":"github","link":"https://github.com/ottomated"}],"lastFetch":1714340758393},{"username":"sadfsdfdsa","avatar":"https://avatars.githubusercontent.com/u/28733669?v=4?s=400","name":"Artem Shuvaev","links":[{"icon":"github","link":"https://github.com/sadfsdfdsa"}],"lastFetch":1714340758712},{"username":"ajaishankar","avatar":"https://avatars.githubusercontent.com/u/328008?v=4?s=400","name":"ajaishankar","links":[{"icon":"github","link":"https://github.com/ajaishankar"}],"lastFetch":1714340758937},{"username":"dominikdosoudil","avatar":"https://avatars.githubusercontent.com/u/15929942?v=4?s=400","name":"Dominik Dosoudil","links":[{"icon":"github","link":"https://github.com/dominikdosoudil"}],"lastFetch":1714340759193},{"username":"kgtkr","avatar":"https://avatars.githubusercontent.com/u/17868838?v=4?s=400","name":"kgtkr","links":[{"icon":"github","link":"https://github.com/kgtkr"}],"lastFetch":1714340759480},{"username":"berzi","avatar":"https://avatars.githubusercontent.com/u/32619123?v=4?s=400","name":"berzi","links":[{"icon":"github","link":"https://github.com/berzi"}],"lastFetch":1714340759690},{"username":"PhilipTrauner","avatar":"https://avatars.githubusercontent.com/u/9287847?v=4?s=400","name":"Philip Trauner","links":[{"icon":"github","link":"https://github.com/PhilipTrauner"}],"lastFetch":1714340760041},{"username":"Powell-v2","avatar":"https://avatars.githubusercontent.com/u/25308326?v=4?s=400","name":"Pavel Yermolin","links":[{"icon":"github","link":"https://github.com/Powell-v2"}],"lastFetch":1714340760261},{"username":"duncanbeevers","avatar":"https://avatars.githubusercontent.com/u/7367?v=4?s=400","name":"Duncan Beevers","links":[{"icon":"github","link":"https://github.com/duncanbeevers"}],"lastFetch":1714340760535},{"username":"tkukushkin","avatar":"https://avatars.githubusercontent.com/u/1482516?v=4?s=400","name":"Timofei Kukushkin","links":[{"icon":"github","link":"https://github.com/tkukushkin"}],"lastFetch":1714340760783},{"username":"Semigradsky","avatar":"https://avatars.githubusercontent.com/u/1198848?v=4?s=400","name":"Dmitry Semigradsky","links":[{"icon":"github","link":"https://github.com/Semigradsky"}],"lastFetch":1714340761031},{"username":"MrLeebo","avatar":"https://avatars.githubusercontent.com/u/2754163?v=4?s=400","name":"Jeremy Liberman","links":[{"icon":"github","link":"https://github.com/MrLeebo"}],"lastFetch":1714340761373},{"username":"axelhzf","avatar":"https://avatars.githubusercontent.com/u/175627?v=4?s=400","name":"Axel Hernández Ferrera","links":[{"icon":"github","link":"https://github.com/axelhzf"}],"lastFetch":1714340761609},{"username":"imagoiq","avatar":"https://avatars.githubusercontent.com/u/12294151?v=4?s=400","name":"Loïc Fürhoff","links":[{"icon":"github","link":"https://github.com/imagoiq"}],"lastFetch":1714340761849},{"username":"BTMPL","avatar":"https://avatars.githubusercontent.com/u/247153?v=4?s=400","name":"Bartosz Szczeciński","links":[{"icon":"github","link":"https://github.com/BTMPL"}],"lastFetch":1714340762052},{"username":"HiiiiD","avatar":"https://avatars.githubusercontent.com/u/61231210?v=4?s=400","name":"Marco Salomone","links":[{"icon":"github","link":"https://github.com/HiiiiD"}],"lastFetch":1714340762236},{"username":"yacinehmito","avatar":"https://avatars.githubusercontent.com/u/6893840?v=4?s=400","name":"Yacine Hmito","links":[{"icon":"github","link":"https://github.com/yacinehmito"}],"lastFetch":1714340762454},{"username":"sajadtorkamani","avatar":"https://avatars.githubusercontent.com/u/9380313?v=4?s=400","name":"Sajad Torkamani","links":[{"icon":"github","link":"https://github.com/sajadtorkamani"}],"lastFetch":1714340762702},{"username":"mvdbeek","avatar":"https://avatars.githubusercontent.com/u/6804901?v=4?s=400","name":"Marius van den Beek","links":[{"icon":"github","link":"https://github.com/mvdbeek"}],"lastFetch":1714340762900},{"username":"sgrimm","avatar":"https://avatars.githubusercontent.com/u/1248649?v=4?s=400","name":"Steven Grimm","links":[{"icon":"github","link":"https://github.com/sgrimm"}],"lastFetch":1714340763058},{"username":"Swiftwork","avatar":"https://avatars.githubusercontent.com/u/455178?v=4?s=400","name":"Erik Hughes","links":[{"icon":"github","link":"https://github.com/Swiftwork"}],"lastFetch":1714340830170},{"username":"mtth","avatar":"https://avatars.githubusercontent.com/u/1216372?v=4?s=400","name":"Matthieu Monsch","links":[{"icon":"github","link":"https://github.com/mtth"}],"lastFetch":1714340831380},{"username":"mitchell-merry","avatar":"https://avatars.githubusercontent.com/u/8567231?v=4?s=400","name":"Mitchell Merry","links":[{"icon":"github","link":"https://github.com/mitchell-merry"}],"lastFetch":1714340832847},{"username":"qnp","avatar":"https://avatars.githubusercontent.com/u/6012554?v=4?s=400","name":"François Risoud","links":[{"icon":"github","link":"https://github.com/qnp"}],"lastFetch":1714340834049},{"username":"shoffmeister","avatar":"https://avatars.githubusercontent.com/u/3868036?v=4?s=400","name":"shoffmeister","links":[{"icon":"github","link":"https://github.com/shoffmeister"}],"lastFetch":1714340835258},{"username":"liangskyli","avatar":"https://avatars.githubusercontent.com/u/31531283?v=4?s=400","name":"liangsky","links":[{"icon":"github","link":"https://github.com/liangskyli"}],"lastFetch":1714340836485},{"username":"happycollision","avatar":"https://avatars.githubusercontent.com/u/3663628?v=4?s=400","name":"Don Denton","links":[{"icon":"github","link":"https://github.com/happycollision"}],"lastFetch":1714340837678},{"username":"ysmood","avatar":"https://avatars.githubusercontent.com/u/1415488?v=4?s=400","name":"Yad Smood","links":[{"icon":"github","link":"https://github.com/ysmood"}],"lastFetch":1714340838993},{"username":"barakalon","avatar":"https://avatars.githubusercontent.com/u/12398927?v=4?s=400","name":"barak","links":[{"icon":"github","link":"https://github.com/barakalon"}],"lastFetch":1714340840202},{"username":"horaklukas","avatar":"https://avatars.githubusercontent.com/u/996088?v=4?s=400","name":"Lukáš Horák","links":[{"icon":"github","link":"https://github.com/horaklukas"}],"lastFetch":1714340841401},{"username":"pvanagtmaal","avatar":"https://avatars.githubusercontent.com/u/5946464?v=4?s=400","name":"pvanagtmaal","links":[{"icon":"github","link":"https://github.com/pvanagtmaal"}],"lastFetch":1714340842652},{"username":"toomuchdesign","avatar":"https://avatars.githubusercontent.com/u/4573549?v=4?s=400","name":"Andrea Carraro","links":[{"icon":"github","link":"https://github.com/toomuchdesign"}],"lastFetch":1714340843894},{"username":"psychedelicious","avatar":"https://avatars.githubusercontent.com/u/4822129?v=4?s=400","name":"psychedelicious","links":[{"icon":"github","link":"https://github.com/psychedelicious"}],"lastFetch":1714340845078},{"username":"tkrotoff","avatar":"https://avatars.githubusercontent.com/u/643434?v=4?s=400","name":"Tanguy Krotoff","links":[{"icon":"github","link":"https://github.com/tkrotoff"}],"lastFetch":1714340846296},{"username":"pimveldhuisen","avatar":"https://avatars.githubusercontent.com/u/3043834?v=4?s=400","name":"Pim Veldhuisen","links":[{"icon":"github","link":"https://github.com/pimveldhuisen"}],"lastFetch":1714340847529},{"username":"asvishnyakov","avatar":"https://avatars.githubusercontent.com/u/6369252?v=4?s=400","name":"Aleksandr Vishniakov","links":[{"icon":"github","link":"https://github.com/asvishnyakov"}],"lastFetch":1714340848760},{"username":"SchabaJo","avatar":"https://avatars.githubusercontent.com/u/138689813?v=4?s=400","name":"SchabaJo","links":[{"icon":"github","link":"https://github.com/SchabaJo"}],"lastFetch":1714340849972},{"username":"AhsanFazal","avatar":"https://avatars.githubusercontent.com/u/7458046?v=4?s=400","name":"Ahsan Fazal","links":[{"icon":"github","link":"https://github.com/AhsanFazal"}],"lastFetch":1714340851380},{"username":"ElForastero","avatar":"https://avatars.githubusercontent.com/u/5102818?v=4?s=400","name":"Eugene Dzhumak","links":[{"icon":"github","link":"https://github.com/ElForastero"}],"lastFetch":1714340852617},{"username":"msgadi","avatar":"https://avatars.githubusercontent.com/u/9037086?v=4?s=400","name":"Mohammed Gadi","links":[{"icon":"github","link":"https://github.com/msgadi"}],"lastFetch":1714340853939},{"username":"muttonchop","avatar":"https://avatars.githubusercontent.com/u/1037657?v=4?s=400","name":"Adam K","links":[{"icon":"github","link":"https://github.com/muttonchop"}],"lastFetch":1714340855146},{"username":"christoph-fricke","avatar":"https://avatars.githubusercontent.com/u/23103835?v=4?s=400","name":"Christoph Fricke","links":[{"icon":"github","link":"https://github.com/christoph-fricke"}],"lastFetch":1714340856499},{"username":"JorrinKievit","avatar":"https://avatars.githubusercontent.com/u/43169049?v=4?s=400","name":"Jorrin","links":[{"icon":"github","link":"https://github.com/JorrinKievit"}],"lastFetch":1714340857711},{"username":"WickyNilliams","avatar":"https://avatars.githubusercontent.com/u/1091390?v=4?s=400","name":"Nick Williams","links":[{"icon":"github","link":"https://github.com/WickyNilliams"}],"lastFetch":1714340858933},{"username":"hrsh7th","avatar":"https://avatars.githubusercontent.com/u/629908?v=4?s=400","name":"hrsh7th","links":[{"icon":"github","link":"https://github.com/hrsh7th"}],"lastFetch":1714340860206},{"username":"davidleger95","avatar":"https://avatars.githubusercontent.com/u/10498708?v=4?s=400","name":"David Leger","links":[{"icon":"github","link":"https://github.com/davidleger95"}],"lastFetch":1714340861433},{"username":"misha-erm","avatar":"https://avatars.githubusercontent.com/u/8783498?v=4?s=400","name":"Misha","links":[{"icon":"github","link":"https://github.com/misha-erm"}],"lastFetch":1714340711778},{"username":"phk422","avatar":"https://avatars.githubusercontent.com/u/59734322?v=4?s=400","name":"Hongkun Peng","links":[{"icon":"github","link":"https://github.com/phk422"}],"lastFetch":1714340862684},{"username":"mzronek","avatar":"https://avatars.githubusercontent.com/u/3847700?v=4?s=400","name":"Matthias Zronek","links":[{"icon":"github","link":"https://github.com/mzronek"}],"lastFetch":1714340863937},{"username":"techbech","avatar":"https://avatars.githubusercontent.com/u/1520592?v=4?s=400","name":"Peter Bech","links":[{"icon":"github","link":"https://github.com/techbech"}],"lastFetch":1714340757744},{"username":"raurfang","avatar":"https://avatars.githubusercontent.com/u/867241?v=4?s=400","name":"Łukasz Wiśniewski","links":[{"icon":"github","link":"https://github.com/raurfang"}],"lastFetch":1714340865134},{"username":"JeanRemiDelteil","avatar":"https://avatars.githubusercontent.com/u/9743907?v=4?s=400","name":"Jean-Rémi Delteil","links":[{"icon":"github","link":"https://github.com/JeanRemiDelteil"}],"lastFetch":1714340866535},{"username":"TzviPM","avatar":"https://avatars.githubusercontent.com/u/1950680?v=4?s=400","name":"Tzvi Melamed","links":[{"icon":"github","link":"https://github.com/TzviPM"}],"lastFetch":1714340867743},{"username":"LucaSchwan","avatar":"https://avatars.githubusercontent.com/u/25820532?v=4?s=400","name":"ehrenschwan","links":[{"icon":"github","link":"https://github.com/LucaSchwan"}],"lastFetch":1714340869092}],"openapi-fetch":[{"username":"drwpow","avatar":"https://avatars.githubusercontent.com/u/1369770?v=4?s=400","name":"Drew Powers","links":[{"icon":"github","link":"https://github.com/drwpow"}],"lastFetch":1714340667247},{"username":"fergusean","avatar":"https://avatars.githubusercontent.com/u/1029297?v=4?s=400","name":"fergusean","links":[{"icon":"github","link":"https://github.com/fergusean"}],"lastFetch":1714340667316},{"username":"shinzui","avatar":"https://avatars.githubusercontent.com/u/519?v=4?s=400","name":"Nadeem Bitar","links":[{"icon":"github","link":"https://github.com/shinzui"}],"lastFetch":1714340667384},{"username":"ezpuzz","avatar":"https://avatars.githubusercontent.com/u/672182?v=4?s=400","name":"Emory Petermann","links":[{"icon":"github","link":"https://github.com/ezpuzz"}],"lastFetch":1714340667456},{"username":"KotoriK","avatar":"https://avatars.githubusercontent.com/u/52659125?v=4?s=400","name":"KotoriK","links":[{"icon":"github","link":"https://github.com/KotoriK"}],"lastFetch":1714340667528},{"username":"fletchertyler914","avatar":"https://avatars.githubusercontent.com/u/3344498?v=4?s=400","name":"Tyler Fletcher","links":[{"icon":"github","link":"https://github.com/fletchertyler914"}],"lastFetch":1714340667597},{"username":"nholik","avatar":"https://avatars.githubusercontent.com/u/2022214?v=4?s=400","name":"Nicklos Holik","links":[{"icon":"github","link":"https://github.com/nholik"}],"lastFetch":1714340667666},{"username":"roj1512","avatar":"https://avatars.githubusercontent.com/u/49933115?v=4?s=400","name":"Roj","links":[{"icon":"github","link":"https://github.com/roj1512"}],"lastFetch":1714340667743},{"username":"nickcaballero","avatar":"https://avatars.githubusercontent.com/u/355976?v=4?s=400","name":"Nick Caballero","links":[{"icon":"github","link":"https://github.com/nickcaballero"}],"lastFetch":1714340667816},{"username":"hd-o","avatar":"https://avatars.githubusercontent.com/u/58871222?v=4?s=400","name":"Hadrian de Oliveira","links":[{"icon":"github","link":"https://github.com/hd-o"}],"lastFetch":1714340667885},{"username":"kecrily","avatar":"https://avatars.githubusercontent.com/u/45708948?v=4?s=400","name":"Percy Ma","links":[{"icon":"github","link":"https://github.com/kecrily"}],"lastFetch":1714340667955},{"username":"psychedelicious","avatar":"https://avatars.githubusercontent.com/u/4822129?v=4?s=400","name":"psychedelicious","links":[{"icon":"github","link":"https://github.com/psychedelicious"}],"lastFetch":1714340668024},{"username":"muttonchop","avatar":"https://avatars.githubusercontent.com/u/1037657?v=4?s=400","name":"Adam K","links":[{"icon":"github","link":"https://github.com/muttonchop"}],"lastFetch":1714340668093},{"username":"marcomuser","avatar":"https://avatars.githubusercontent.com/u/64737396?v=4?s=400","name":"Marco Muser","links":[{"icon":"github","link":"https://github.com/marcomuser"}],"lastFetch":1714340668162},{"username":"HugeLetters","avatar":"https://avatars.githubusercontent.com/u/119697239?v=4?s=400","name":"Evgenii Perminov","links":[{"icon":"github","link":"https://github.com/HugeLetters"}],"lastFetch":1714340709188},{"username":"Fumaz","avatar":"https://avatars.githubusercontent.com/u/45318608?v=4?s=400","name":"alex","links":[{"icon":"github","link":"https://github.com/Fumaz"}],"lastFetch":1714340709412},{"username":"darwish","avatar":"https://avatars.githubusercontent.com/u/292570?v=4?s=400","name":"Mike Darwish","links":[{"icon":"github","link":"https://github.com/darwish"}],"lastFetch":1714340709624},{"username":"kaechele","avatar":"https://avatars.githubusercontent.com/u/454490?v=4?s=400","name":"Felix Kaechele","links":[{"icon":"github","link":"https://github.com/kaechele"}],"lastFetch":1714340709821},{"username":"phk422","avatar":"https://avatars.githubusercontent.com/u/59734322?v=4?s=400","name":"Hongkun Peng","links":[{"icon":"github","link":"https://github.com/phk422"}],"lastFetch":1714340710106},{"username":"mikestopcontinues","avatar":"https://avatars.githubusercontent.com/u/150434?v=4?s=400","name":"Mike Stop Continues","links":[{"icon":"github","link":"https://github.com/mikestopcontinues"}],"lastFetch":1714340710383},{"username":"JE-Lee","avatar":"https://avatars.githubusercontent.com/u/19794813?v=4?s=400","name":"maurice","links":[{"icon":"github","link":"https://github.com/JE-Lee"}],"lastFetch":1714340710635},{"username":"vipentti","avatar":"https://avatars.githubusercontent.com/u/4726680?v=4?s=400","name":"Ville Penttinen","links":[{"icon":"github","link":"https://github.com/vipentti"}],"lastFetch":1714340710855},{"username":"armandabric","avatar":"https://avatars.githubusercontent.com/u/95120?v=4?s=400","name":"Armand Abric","links":[{"icon":"github","link":"https://github.com/armandabric"}],"lastFetch":1714340711064},{"username":"illright","avatar":"https://avatars.githubusercontent.com/u/15035286?v=4?s=400","name":"Lev Chelyadinov","links":[{"icon":"github","link":"https://github.com/illright"}],"lastFetch":1714340711360}]} \ No newline at end of file diff --git a/docs/package.json b/docs/package.json index a2ab1f26b..a935c456f 100644 --- a/docs/package.json +++ b/docs/package.json @@ -10,6 +10,6 @@ "update-contributors": "node scripts/update-contributors.js" }, "devDependencies": { - "vitepress": "1.1.3" + "vitepress": "1.1.4" } } diff --git a/docs/scripts/update-contributors.js b/docs/scripts/update-contributors.js index 40a16dce2..c0ecea40f 100644 --- a/docs/scripts/update-contributors.js +++ b/docs/scripts/update-contributors.js @@ -202,6 +202,7 @@ async function main() { upsert(contributors[repo], userData); console.log(`Updated old contributor data for ${username}`); // biome-disable-line no-console fs.writeFileSync(new URL("../data/contributors.json", import.meta.url), JSON.stringify(contributors)); // update file while fetching (sync happens safely in between fetches) + await new Promise((resolve) => setTimeout(resolve, 500)); // sleep to prevent 429 } catch (err) { throw new Error(err); } diff --git a/packages/openapi-fetch/examples/nextjs/package.json b/packages/openapi-fetch/examples/nextjs/package.json index 1ce9134fb..8564a0e2a 100644 --- a/packages/openapi-fetch/examples/nextjs/package.json +++ b/packages/openapi-fetch/examples/nextjs/package.json @@ -6,15 +6,15 @@ "dev": "next dev" }, "dependencies": { - "next": "14.2.2", + "next": "14.2.3", "openapi-fetch": "workspace:^", - "react": "18.2.0", - "react-dom": "18.2.0" + "react": "18.3.1", + "react-dom": "18.3.1" }, "devDependencies": { "@types/node": "20.12.7", - "@types/react": "18.2.79", - "@types/react-dom": "18.2.25", + "@types/react": "18.3.1", + "@types/react-dom": "18.3.0", "openapi-typescript": "workspace:^", "typescript": "5.4.5" } diff --git a/packages/openapi-fetch/examples/nextjs/tsconfig.json b/packages/openapi-fetch/examples/nextjs/tsconfig.json index 6de0acb7e..d6b46aba5 100644 --- a/packages/openapi-fetch/examples/nextjs/tsconfig.json +++ b/packages/openapi-fetch/examples/nextjs/tsconfig.json @@ -8,8 +8,8 @@ "isolatedModules": true, "jsx": "preserve", "lib": ["dom", "dom.iterable", "esnext"], - "module": "esnext", - "moduleResolution": "bundler", + "module": "ESNext", + "moduleResolution": "Bundler", "noEmit": true, "paths": { "@/*": ["./*"] diff --git a/packages/openapi-fetch/examples/react-query/package.json b/packages/openapi-fetch/examples/react-query/package.json index 1cad97a7c..49d826517 100644 --- a/packages/openapi-fetch/examples/react-query/package.json +++ b/packages/openapi-fetch/examples/react-query/package.json @@ -9,12 +9,12 @@ "@tanstack/react-query": "^5.32.0", "openapi-fetch": "workspace:^", "openapi-typescript": "workspace:^", - "react": "^18.2.0", - "react-dom": "^18.2.0" + "react": "^18.3.1", + "react-dom": "^18.3.1" }, "devDependencies": { - "@types/react": "18.2.79", - "@types/react-dom": "18.2.25", + "@types/react": "18.3.1", + "@types/react-dom": "18.3.0", "@vitejs/plugin-react-swc": "^3.6.0", "typescript": "^5.4.5", "vite": "^5.2.10" diff --git a/packages/openapi-fetch/examples/react-query/src/index.tsx b/packages/openapi-fetch/examples/react-query/src/index.tsx index 1e5b76813..dada0e825 100644 --- a/packages/openapi-fetch/examples/react-query/src/index.tsx +++ b/packages/openapi-fetch/examples/react-query/src/index.tsx @@ -20,10 +20,7 @@ function Fact() { {JSON.stringify(fact.data, undefined, 2)} )} - @@ -39,7 +36,7 @@ function App() { refetchOnWindowFocus: false, // don’t refetch on window focus }, }, - }), + }) ); return ( @@ -48,6 +45,8 @@ function App() { ); } -const domNode = document.getElementById("app")!; -const root = createRoot(domNode); -root.render(); +const domNode = document.getElementById("app"); +if (domNode) { + const root = createRoot(domNode); + root.render(); +} diff --git a/packages/openapi-fetch/examples/sveltekit/package.json b/packages/openapi-fetch/examples/sveltekit/package.json index ff28004b7..7369b5da2 100644 --- a/packages/openapi-fetch/examples/sveltekit/package.json +++ b/packages/openapi-fetch/examples/sveltekit/package.json @@ -8,15 +8,15 @@ "check:watch": "svelte-kit sync && svelte-check --tsconfig ./tsconfig.json --watch" }, "dependencies": { - "openapi-fetch": "workspace:^", - "openapi-typescript": "workspace:^" + "openapi-fetch": "workspace:^" }, "devDependencies": { "@sveltejs/adapter-auto": "^3.2.0", "@sveltejs/kit": "^2.5.7", "@sveltejs/vite-plugin-svelte": "^3.1.0", + "openapi-typescript": "workspace:^", "svelte": "^4.2.15", - "svelte-check": "^3.6.9", + "svelte-check": "^3.7.0", "tslib": "^2.6.2", "typescript": "^5.4.5", "vite": "^5.2.10" diff --git a/packages/openapi-fetch/tsconfig.build.json b/packages/openapi-fetch/tsconfig.build.json deleted file mode 100644 index 332d31dcc..000000000 --- a/packages/openapi-fetch/tsconfig.build.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "extends": "./tsconfig.json", - "compilerOptions": { - "module": "ES2022", - "moduleResolution": "Node" - }, - "exclude": ["./**/*.test.*"] -} diff --git a/packages/openapi-typescript/examples/digital-ocean-api.ts b/packages/openapi-typescript/examples/digital-ocean-api.ts index 667967907..856fffeea 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api.ts +++ b/packages/openapi-typescript/examples/digital-ocean-api.ts @@ -982,8 +982,11 @@ export interface paths { /** * List All Database Clusters * @description To list all of the database clusters available on your account, send a GET request to `/v2/databases`. To limit the results to database clusters with a specific tag, include the `tag_name` query parameter set to the name of the tag. For example, `/v2/databases?tag_name=$TAG_NAME`. + * * The result will be a JSON object with a `databases` key. This will be set to an array of database objects, each of which will contain the standard database attributes. - * The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster: + * + * The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster. For multi-node clusters, the `standby_connection` and `standby_private_connection` objects will contain the information needed to connect to the cluster's standby node(s). + * * The embedded `maintenance_window` object will contain information about any scheduled maintenance for the database cluster. */ get: operations["databases_list_clusters"]; @@ -992,7 +995,9 @@ export interface paths { * Create a New Database Cluster * @description To create a database cluster, send a POST request to `/v2/databases`. * The response will be a JSON object with a key called `database`. The value of this will be an object that contains the standard attributes associated with a database cluster. The initial value of the database cluster's `status` attribute will be `creating`. When the cluster is ready to receive traffic, this will transition to `online`. - * The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster. + * + * The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster. For multi-node clusters, the `standby_connection` and `standby_private_connection` objects will contain the information needed to connect to the cluster's standby node(s). + * * DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST request to `/v2/databases`. In addition to the standard database cluster attributes, the JSON body must include a key named `backup_restore` with the name of the original database cluster and the timestamp of the backup to be restored. Creating a database from a backup is the same as forking a database in the control panel. * Note: Backups are not supported for Redis clusters. */ @@ -1013,8 +1018,11 @@ export interface paths { /** * Retrieve an Existing Database Cluster * @description To show information about an existing database cluster, send a GET request to `/v2/databases/$DATABASE_ID`. + * * The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes. - * The embedded connection and private_connection objects will contain the information needed to access the database cluster. + * + * The embedded `connection` and `private_connection` objects will contain the information needed to access the database cluster. For multi-node clusters, the `standby_connection` and `standby_private_connection` objects contain the information needed to connect to the cluster's standby node(s). + * * The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster. */ get: operations["databases_get_cluster"]; @@ -1283,6 +1291,30 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/databases/{database_cluster_uuid}/events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List all Events Logs + * @description To list all of the cluster events, send a GET request to + * `/v2/databases/$DATABASE_ID/events`. + * + * The result will be a JSON object with a `events` key. + * + */ + get: operations["databases_list_events_logs"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/databases/{database_cluster_uuid}/replicas/{replica_name}": { parameters: { query?: never; @@ -1410,7 +1442,20 @@ export interface paths { * */ get: operations["databases_get_user"]; - put?: never; + /** + * Update a Database User + * @description To update an existing database user, send a PUT request to `/v2/databases/$DATABASE_ID/users/$USERNAME` + * with the desired settings. + * + * **Note**: only `settings` can be updated via this type of request. If you wish to change the name of a user, + * you must recreate a new user. + * + * The response will be a JSON object with a key called `user`. The value of this will be an + * object that contains the name of the update database user, along with the `settings` object that + * has been updated. + * + */ + put: operations["databases_update_user"]; post?: never; /** * Remove a Database User @@ -1748,6 +1793,30 @@ export interface paths { patch?: never; trace?: never; }; + "/v2/databases/metrics/credentials": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Retrieve Database Clusters' Metrics Endpoint Credentials + * @description To show the credentials for all database clusters' metrics endpoints, send a GET request to `/v2/databases/metrics/credentials`. The result will be a JSON object with a `credentials` key. + */ + get: operations["databases_get_cluster_metrics_credentials"]; + /** + * Update Database Clusters' Metrics Endpoint Credentials + * @description To update the credentials for all database clusters' metrics endpoints, send a PUT request to `/v2/databases/metrics/credentials`. A successful request will receive a 204 No Content status code with no body in response. + */ + put: operations["databases_update_cluster_metrics_credentials"]; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v2/domains": { parameters: { query?: never; @@ -2078,7 +2147,7 @@ export interface paths { * | `rebuild` | Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. | * | `rename` | Renames a Droplet. | * | `change_kernel` | Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. | - * | `enable_ipv6` | Enables IPv6 for a Droplet. | + * | `enable_ipv6` | Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, [additional OS-level configuration](https://docs.digitalocean.com/products/networking/ipv6/how-to/enable/#on-existing-droplets) is required. | * | `snapshot` | Takes a snapshot of a Droplet. | * */ @@ -3628,6 +3697,7 @@ export interface paths { /** * Get Droplet Bandwidth Metrics * @description To retrieve bandwidth metrics for a given Droplet, send a GET request to `/v2/monitoring/metrics/droplet/bandwidth`. Use the `interface` query parameter to specify if the results should be for the `private` or `public` interface. Use the `direction` query parameter to specify if the results should be for `inbound` or `outbound` traffic. + * The metrics in the response body are in megabits per second (Mbps). */ get: operations["monitoring_get_dropletBandwidthMetrics"]; put?: never; @@ -4858,7 +4928,7 @@ export interface paths { }; /** * Retrieve an Existing Volume Snapshot - * @description To retrieve the details of a snapshot that has been created from a volume, send a GET request to `/v2/volumes/snapshots/$SNAPSHOT_ID`. + * @description To retrieve the details of a snapshot that has been created from a volume, send a GET request to `/v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID`. * * */ @@ -4868,7 +4938,7 @@ export interface paths { /** * Delete a Volume Snapshot * @description To delete a volume snapshot, send a DELETE request to - * `/v2/snapshots/$SNAPSHOT_ID`. + * `/v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID`. * * A status of 204 will be given. This indicates that the request was processed * successfully, but that no response body is needed. @@ -5772,10 +5842,18 @@ export interface components { /** * @description - DOCKER_HUB: The DockerHub container registry type. * - DOCR: The DigitalOcean container registry type. + * - GHCR: The Github container registry type. * @example DOCR * @enum {string} */ - registry_type?: "DOCKER_HUB" | "DOCR"; + registry_type?: "DOCKER_HUB" | "DOCR" | "GHCR"; + /** + * @description The credentials to be able to pull the image. The value will be encrypted on first submission. On following submissions, the encrypted value should be used. + * - "$username:$access_token" for registries of type `DOCKER_HUB`. + * - "$username:$access_token" for registries of type `GHCR`. + * @example my-dockerhub-username:dckr_pat_the_access_token + */ + registry_credentials?: string; /** * @description The repository name. * @example origin/master @@ -5908,7 +5986,7 @@ export interface components { app_component_instance_base: { /** * Format: int64 - * @description The amount of instances that this component should be scaled to. Default: 1 + * @description The amount of instances that this component should be scaled to. Default: 1. Must not be set if autoscaling is used. * @default 1 * @example 2 */ @@ -5920,6 +5998,34 @@ export interface components { * @enum {string} */ instance_size_slug: "basic-xxs" | "basic-xs" | "basic-s" | "basic-m" | "professional-xs" | "professional-s" | "professional-m" | "professional-1l" | "professional-l" | "professional-xl"; + /** @description Configuration for automatically scaling this component based on metrics. */ + autoscaling?: { + /** + * Format: uint32 + * @description The minimum amount of instances for this component. Must be less than max_instance_count. + * @example 2 + */ + min_instance_count?: number; + /** + * Format: uint32 + * @description The maximum amount of instances for this component. Must be more than min_instance_count. + * @example 3 + */ + max_instance_count?: number; + /** @description The metrics that the component is scaled on. */ + metrics?: { + /** @description Settings for scaling the component based on CPU utilization. */ + cpu?: { + /** + * Format: uint32 + * @description The average target CPU utilization for the component. + * @default 80 + * @example 75 + */ + percent: number; + }; + }; + }; }; apps_string_match: { /** @@ -6666,6 +6772,7 @@ export interface components { slug?: string; /** * The slug of the corresponding downgradable instance size on the lower tier + * @deprecated * @example basic */ tier_downgrade_to?: string; @@ -6676,6 +6783,7 @@ export interface components { tier_slug?: string; /** * The slug of the corresponding upgradable instance size on the higher tier + * @deprecated * @example basic */ tier_upgrade_to?: string; @@ -6742,6 +6850,7 @@ export interface components { app_cost?: number; /** * Format: int32 + * @deprecated * @description The monthly cost of the proposed app in USD using the previous pricing plan tier. For example, if you propose an app that uses the Professional tier, the `app_tier_downgrade_cost` field displays the monthly cost of the app if it were to use the Basic tier. If the proposed app already uses the lest expensive tier, the field is empty. * @example 17 */ @@ -7279,6 +7388,11 @@ export interface components { * @example fdabb512-6faf-443c-ba2e-665452332a9e */ invoice_uuid?: string; + /** + * @description ID of the invoice. Listed on the face of the invoice PDF as the "Invoice number". + * @example 123456789 + */ + invoice_id?: string; /** * @description Total amount of the invoice, in USD. This will reflect month-to-date usage in the invoice preview. * @example 23.45 @@ -7457,6 +7571,11 @@ export interface components { * @example 22737513-0ea7-4206-8ceb-98a575af7681 */ invoice_uuid?: string; + /** + * @description ID of the invoice + * @example 123456789 + */ + invoice_id?: string; /** * @description Billing period of usage for which the invoice is issued, in `YYYY-MM` format. * @example 2020-01 @@ -7550,6 +7669,7 @@ export interface components { pg?: components["schemas"]["database_region_options"] & components["schemas"]["database_version_options"] & components["schemas"]["database_layout_options"]; mysql?: components["schemas"]["database_region_options"] & components["schemas"]["database_version_options"] & components["schemas"]["database_layout_options"]; redis?: components["schemas"]["database_region_options"] & components["schemas"]["database_version_options"] & components["schemas"]["database_layout_options"]; + opensearch?: components["schemas"]["database_region_options"] & components["schemas"]["database_version_options"] & components["schemas"]["database_layout_options"]; }; version_availability?: { kafka?: components["schemas"]["database_version_availabilities"]; @@ -7557,8 +7677,41 @@ export interface components { mysql?: components["schemas"]["database_version_availabilities"]; redis?: components["schemas"]["database_version_availabilities"]; mongodb?: components["schemas"]["database_version_availabilities"]; + opensearch?: components["schemas"]["database_version_availabilities"]; }; }; + opensearch_connection: { + /** + * @description This is provided as a convenience and should be able to be constructed by the other attributes. + * @example opensearch://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require + */ + readonly uri?: string; + /** + * @description The FQDN pointing to the opensearch cluster's current primary node. + * @example backend-do-user-19081923-0.db.ondigitalocean.com + */ + readonly host?: string; + /** + * @description The port on which the opensearch dashboard is listening. + * @example 25060 + */ + readonly port?: number; + /** + * @description The default user for the opensearch dashboard. + * @example doadmin + */ + readonly user?: string; + /** + * @description The randomly generated password for the default user. + * @example wv78n3zpz42xezdk + */ + readonly password?: string; + /** + * @description A boolean value indicating if the connection should be made over SSL. + * @example true + */ + readonly ssl?: boolean; + }; database_connection: { /** * @description A connection string in the format accepted by the `psql` command. This is provided as a convenience and should be able to be constructed by the other attributes. @@ -7610,10 +7763,17 @@ export interface components { auth_plugin: "mysql_native_password" | "caching_sha2_password"; }; user_settings: { + /** + * @description For Postgres clusters, set to `true` for a user with replication rights. + * This option is not currently supported for other database engines. + * + * @example true + */ + pg_allow_replication?: boolean; /** @description ACLs (Access Control Lists) specifying permissions on topics within a Kafka cluster. */ acl?: { /** - * @description An identifier for the ACL. + * @description An identifier for the ACL. Will be computed after the ACL is created/updated. * @example aaa */ id?: string; @@ -7772,6 +7932,18 @@ export interface components { */ readonly created_at?: string; }; + database_service_endpoint: { + /** + * @description A FQDN pointing to the database cluster's node(s). + * @example backend-do-user-19081923-0.db.ondigitalocean.com + */ + readonly host?: string; + /** + * @description The port on which a service is listening. + * @example 9273 + */ + readonly port?: number; + }; database_cluster: { /** * Format: uuid @@ -7785,11 +7957,11 @@ export interface components { */ name: string; /** - * @description A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, and "kafka" for Kafka. + * @description A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, "kafka" for Kafka and "opensearch" for Opensearch. * @example mysql * @enum {string} */ - engine: "pg" | "mysql" | "redis" | "mongodb" | "kafka"; + engine: "pg" | "mysql" | "redis" | "mongodb" | "kafka" | "opensearch"; /** * @description A string representing the version of the database engine in use for the cluster. * @example 8 @@ -7846,8 +8018,12 @@ export interface components { * ] */ readonly db_names?: string[] | null; + /** @description The connection details for OpenSearch dashboard. */ + ui_connection?: components["schemas"]["opensearch_connection"] & unknown; connection?: components["schemas"]["database_connection"] & unknown; private_connection?: components["schemas"]["database_connection"] & unknown; + standby_connection?: components["schemas"]["database_connection"] & unknown; + standby_private_connection?: components["schemas"]["database_connection"] & unknown; readonly users?: components["schemas"]["database_user"][] | null; maintenance_window?: components["schemas"]["database_maintenance_window"] & unknown; /** @@ -7872,6 +8048,8 @@ export interface components { * @example 61440 */ storage_size_mib?: number; + /** @description Public hostname and port of the cluster's metrics endpoint(s). Includes one record for the cluster's primary node and a second entry for the cluster's standby node(s). */ + readonly metrics_endpoints?: components["schemas"]["database_service_endpoint"][]; }; database_backup: { /** @@ -8473,8 +8651,241 @@ export interface components { */ redis_acl_channels_default?: "allchannels" | "resetchannels"; }; + mongo: { + /** + * @description Specifies the default consistency behavior of reads from the database. Data that is returned from the query with may or may not have been acknowledged by all nodes in the replicaset depending on this value. Learn more [here](https://www.mongodb.com/docs/manual/reference/read-concern/). + * @default local + * @example local + * @enum {string} + */ + default_read_concern: "local" | "available" | "majority"; + /** + * @description Describes the level of acknowledgment requested from MongoDB for write operations clusters. This field can set to either `majority` or a number `0...n` which will describe the number of nodes that must acknowledge the write operation before it is fully accepted. Setting to `0` will request no acknowledgement of the write operation. Learn more [here](https://www.mongodb.com/docs/manual/reference/write-concern/). + * @default majority + * @example majority + */ + default_write_concern: string; + /** + * @description Specifies the lifetime of multi-document transactions. Transactions that exceed this limit are considered expired and will be aborted by a periodic cleanup process. The cleanup process runs every `transactionLifetimeLimitSeconds/2 seconds` or at least once every 60 seconds. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more [here](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds). + * @default 60 + * @example 100 + */ + transaction_lifetime_limit_seconds: number; + /** + * @description Operations that run for longer than this threshold are considered slow which are then recorded to the diagnostic logs. Higher log levels (verbosity) will record all operations regardless of this threshold on the primary node. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more [here](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-operationProfiling.slowOpThresholdMs). + * @default 100 + * @example 200 + */ + slow_op_threshold_ms: number; + /** + * @description The log message verbosity level. The verbosity level determines the amount of Informational and Debug messages MongoDB outputs. 0 includes informational messages while 1...5 increases the level to include debug messages. *Changing this parameter will lead to a restart of the MongoDB service.* Learn more [here](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-systemLog.verbosity). + * @default 0 + * @example 3 + */ + verbosity: number; + }; + kafka: { + /** + * @description Specify the final compression type for a given topic. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent to no compression; and 'producer' which means retain the original compression codec set by the producer. + * @example gzip + * @enum {string} + */ + compression_type?: "gzip" | "snappy" | "lz4" | "zstd" | "uncompressed" | "producer"; + /** + * @description The amount of time, in milliseconds, the group coordinator will wait for more consumers to join a new group before performing the first rebalance. A longer delay means potentially fewer rebalances, but increases the time until processing begins. The default value for this is 3 seconds. During development and testing it might be desirable to set this to 0 in order to not delay test execution time. + * @example 3000 + */ + group_initial_rebalance_delay_ms?: number; + /** + * @description The minimum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. + * @example 6000 + */ + group_min_session_timeout_ms?: number; + /** + * @description The maximum allowed session timeout for registered consumers. Longer timeouts give consumers more time to process messages in between heartbeats at the cost of a longer time to detect failures. + * @example 1800000 + */ + group_max_session_timeout_ms?: number; + /** + * @description Idle connections timeout: the server socket processor threads close the connections that idle for longer than this. + * @example 540000 + */ + connections_max_idle_ms?: number; + /** + * @description The maximum number of incremental fetch sessions that the broker will maintain. + * @example 1000 + */ + max_incremental_fetch_session_cache_slots?: number; + /** + * @description The maximum size of message that the server can receive. + * @example 1048588 + */ + message_max_bytes?: number; + /** + * @description Log retention window in minutes for offsets topic + * @example 10080 + */ + offsets_retention_minutes?: number; + /** + * @description How long are delete records retained? + * @example 86400000 + */ + log_cleaner_delete_retention_ms?: number; + /** + * @description Controls log compactor frequency. Larger value means more frequent compactions but also more space wasted for logs. Consider setting log_cleaner_max_compaction_lag_ms to enforce compactions sooner, instead of setting a very high value for this option. + * @example 0.5 + */ + log_cleaner_min_cleanable_ratio?: number; + /** + * @description The maximum amount of time message will remain uncompacted. Only applicable for logs that are being compacted + * @example 60000 + */ + log_cleaner_max_compaction_lag_ms?: number; + /** + * @description The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. + * @example 100000 + */ + log_cleaner_min_compaction_lag_ms?: number; + /** + * @description The default cleanup policy for segments beyond the retention window + * @example delete + * @enum {string} + */ + log_cleanup_policy?: "delete" | "compact" | "compact,delete"; + /** + * @description The number of messages accumulated on a log partition before messages are flushed to disk + * @example 9223372036854776000 + */ + log_flush_interval_messages?: number; + /** + * @description The maximum time in ms that a message in any topic is kept in memory before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms is used + * @example 1000000 + */ + log_flush_interval_ms?: number; + /** + * @description The interval with which Kafka adds an entry to the offset index + * @example 4096 + */ + log_index_interval_bytes?: number; + /** + * @description The maximum size in bytes of the offset index + * @example 10485760 + */ + log_index_size_max_bytes?: number; + /** + * @description This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. + * @example true + */ + log_message_downconversion_enable?: boolean; + /** + * @description Define whether the timestamp in the message is message create time or log append time. + * @example CreateTime + * @enum {string} + */ + log_message_timestamp_type?: "CreateTime" | "LogAppendTime"; + /** + * @description The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message + * @example 1000000 + */ + log_message_timestamp_difference_max_ms?: number; + /** + * @description Controls whether to preallocate a file when creating a new segment + * @example false + */ + log_preallocate?: boolean; + /** + * @description The maximum size of the log before deleting messages + * @example 1000000 + */ + log_retention_bytes?: number; + /** + * @description The number of hours to keep a log file before deleting it + * @example 1000000 + */ + log_retention_hours?: number; + /** + * @description The number of milliseconds to keep a log file before deleting it (in milliseconds), If not set, the value in log.retention.minutes is used. If set to -1, no time limit is applied. + * @example 100000000 + */ + log_retention_ms?: number; + /** + * @description The maximum jitter to subtract from logRollTimeMillis (in milliseconds). If not set, the value in log.roll.jitter.hours is used + * @example 10000000 + */ + log_roll_jitter_ms?: number; + /** + * @description The maximum time before a new log segment is rolled out (in milliseconds). + * @example 1000000 + */ + log_roll_ms?: number; + /** + * @description The maximum size of a single log file + * @example 100000000 + */ + log_segment_bytes?: number; + /** + * @description The amount of time to wait before deleting a file from the filesystem + * @example 60000 + */ + log_segment_delete_delay_ms?: number; + /** + * @description Enable auto creation of topics + * @example true + */ + auto_create_topics_enable?: boolean; + /** + * @description When a producer sets acks to 'all' (or '-1'), min_insync_replicas specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. + * @example 1 + */ + min_insync_replicas?: number; + /** + * @description Number of partitions for autocreated topics + * @example 10 + */ + num_partitions?: number; + /** + * @description Replication factor for autocreated topics + * @example 2 + */ + default_replication_factor?: number; + /** + * @description The number of bytes of messages to attempt to fetch for each partition (defaults to 1048576). This is not an absolute maximum, if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. + * @example 2097152 + */ + replica_fetch_max_bytes?: number; + /** + * @description Maximum bytes expected for the entire fetch response (defaults to 10485760). Records are fetched in batches, and if the first record batch in the first non-empty partition of the fetch is larger than this value, the record batch will still be returned to ensure that progress can be made. As such, this is not an absolute maximum. + * @example 20971520 + */ + replica_fetch_response_max_bytes?: number; + /** + * @description The maximum number of connections allowed from each ip address (defaults to 2147483647). + * @example 512 + */ + max_connections_per_ip?: number; + /** + * @description The purge interval (in number of requests) of the producer request purgatory (defaults to 1000). + * @example 100 + */ + producer_purgatory_purge_interval_requests?: number; + /** + * @description The maximum number of bytes in a socket request (defaults to 104857600). + * @example 20971520 + */ + socket_request_max_bytes?: number; + /** + * @description The transaction topic segment bytes should be kept relatively small in order to facilitate faster log compaction and cache loads (defaults to 104857600 (100 mebibytes)). + * @example 104857600 + */ + transaction_state_log_segment_bytes?: number; + /** + * @description The interval at which to remove transactions that have expired due to transactional.id.expiration.ms passing (defaults to 3600000 (1 hour)). + * @example 3600000 + */ + transaction_remove_expired_transaction_cleanup_interval_ms?: number; + }; database_config: { - config?: components["schemas"]["mysql"] | components["schemas"]["postgres"] | components["schemas"]["redis"]; + config?: components["schemas"]["mysql"] | components["schemas"]["postgres"] | components["schemas"]["redis"] | components["schemas"]["mongo"] | components["schemas"]["kafka"]; }; ca: { /** @@ -8629,6 +9040,29 @@ export interface components { */ storage_size_mib?: number; }; + events_logs: { + /** + * @description ID of the particular event. + * @example pe8u2huh + */ + id?: string; + /** + * @description The name of cluster. + * @example sample_cluster + */ + cluster_name?: string; + /** + * @description Type of the event. + * @example cluster_create + * @enum {string} + */ + event_type?: "cluster_maintenance_perform" | "cluster_master_promotion" | "cluster_create" | "cluster_update" | "cluster_delete" | "cluster_poweron" | "cluster_poweroff"; + /** + * @description The time of the generation of a event. + * @example 2020-10-29T15:57:38Z + */ + create_time?: string; + }; database: { /** * @description The name of the database. @@ -8665,6 +9099,8 @@ export interface components { user?: string; connection?: components["schemas"]["database_connection"] & unknown; private_connection?: components["schemas"]["database_connection"] & unknown; + standby_connection?: components["schemas"]["database_connection"] & unknown; + standby_private_connection?: components["schemas"]["database_connection"] & unknown; }; connection_pools: { /** @description An array of connection pool objects. */ @@ -8936,6 +9372,21 @@ export interface components { partition_count?: number; config?: components["schemas"]["kafka_topic_config"]; }; + databases_basic_auth_credentials: { + /** + * @description basic authentication username for metrics HTTP endpoint + * @example username + */ + basic_auth_username?: string; + /** + * @description basic authentication password for metrics HTTP endpoint + * @example password + */ + basic_auth_password?: string; + }; + database_metrics_credentials: { + credentials?: components["schemas"]["databases_basic_auth_credentials"]; + }; domain: { /** * @description The name of the domain itself. This should follow the standard domain format of domain.TLD. For instance, `example.com` is a valid domain name. @@ -12815,6 +13266,20 @@ export interface components { }; }; }; + /** @description A JSON object with a key of `events`. */ + events_logs: { + 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": { + events?: components["schemas"]["events_logs"][]; + }; + }; + }; /** @description A JSON object with a key of `users`. */ users: { headers: { @@ -12951,6 +13416,20 @@ export interface components { }; }; }; + /** @description A JSON object with a key of `credentials`. */ + database_metrics_auth: { + 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": { + credentials?: components["schemas"]["database_metrics_credentials"]; + }; + }; + }; /** @description The response will be a JSON object with a key called `domains`. The value of this will be an array of Domain objects, each of which contain the standard domain attributes. */ all_domains_response: { headers: { @@ -14422,6 +14901,18 @@ export interface components { }; }; }; + /** @description Bad Request */ + not_a_snapshot: { + 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 To list all of your tags, you can send a `GET` request to `/v2/tags`. */ tags_all: { headers: { @@ -14746,9 +15237,10 @@ export interface components { * - BUILD: Build-time logs * - DEPLOY: Deploy-time logs * - RUN: Live run-time logs + * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime * @example BUILD */ - log_type: "UNSPECIFIED" | "BUILD" | "DEPLOY" | "RUN"; + log_type: "UNSPECIFIED" | "BUILD" | "DEPLOY" | "RUN" | "RUN_RESTARTED"; /** * @description An optional time duration to wait if the underlying component instance is not immediately available. Default: `3m`. * @example 3m @@ -14779,6 +15271,11 @@ export interface components { * @example 19f06b6a-3ace-4315-b086-499a0e521b76 */ cdn_endpoint_id: string; + /** + * @description Name of expected certificate + * @example certificate-name + */ + certificate_name: string; /** * @description A unique identifier for a certificate. * @example 4de7ac8b-495b-4884-9a69-1050c6793cd6 @@ -14975,12 +15472,12 @@ export interface components { */ network_direction: "inbound" | "outbound"; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ metric_timestamp_start: string; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ metric_timestamp_end: string; @@ -15074,6 +15571,11 @@ export interface components { * @example nyc3 */ region: components["schemas"]["region_slug"]; + /** + * @description The unique identifier for the snapshot. + * @example fbe805e8-866b-11e6-96bf-000f53315a41 + */ + volume_snapshot_id: string; /** * @description The ID of the block storage volume. * @example 7724db7c-e098-11e5-b522-000f53304e51 @@ -15548,6 +16050,7 @@ export interface operations { * - BUILD: Build-time logs * - DEPLOY: Deploy-time logs * - RUN: Live run-time logs + * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime * @example BUILD */ type: components["parameters"]["log_type"]; @@ -15712,6 +16215,7 @@ export interface operations { * - BUILD: Build-time logs * - DEPLOY: Deploy-time logs * - RUN: Live run-time logs + * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime * @example BUILD */ type: components["parameters"]["log_type"]; @@ -15764,6 +16268,7 @@ export interface operations { * - BUILD: Build-time logs * - DEPLOY: Deploy-time logs * - RUN: Live run-time logs + * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime * @example BUILD */ type: components["parameters"]["log_type"]; @@ -15811,6 +16316,7 @@ export interface operations { * - BUILD: Build-time logs * - DEPLOY: Deploy-time logs * - RUN: Live run-time logs + * - RUN_RESTARTED: Logs of crashed/restarted instances during runtime * @example BUILD */ type: components["parameters"]["log_type"]; @@ -16352,6 +16858,11 @@ export interface operations { * @example 1 */ page?: components["parameters"]["page"]; + /** + * @description Name of expected certificate + * @example certificate-name + */ + name?: components["parameters"]["certificate_name"]; }; header?: never; path?: never; @@ -17112,6 +17623,29 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; + databases_list_events_logs: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["events_logs"]; + 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"]; + }; + }; databases_get_replica: { parameters: { query?: never; @@ -17282,6 +17816,40 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; + databases_update_user: { + parameters: { + query?: never; + header?: never; + path: { + /** + * @description A unique identifier for a database cluster. + * @example 9cc10173-e9ea-4176-9dbc-a4cee4c4ff30 + */ + database_cluster_uuid: components["parameters"]["database_cluster_uuid"]; + /** + * @description The name of the database user. + * @example app-01 + */ + username: components["parameters"]["username"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + settings: components["schemas"]["user_settings"]; + }; + }; + }; + responses: { + 201: components["responses"]["user"]; + 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"]; + }; + }; databases_delete_user: { parameters: { query?: never; @@ -17902,6 +18470,49 @@ export interface operations { default: components["responses"]["unexpected_error"]; }; }; + databases_get_cluster_metrics_credentials: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: never; + responses: { + 200: components["responses"]["database_metrics_auth"]; + 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"]; + }; + }; + databases_update_cluster_metrics_credentials: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + /** @example { + * "credentials": { + * "basic_auth_username": "new_username", + * "basic_auth_password": "new_password" + * } + * } */ + "application/json": components["schemas"]["database_metrics_credentials"]; + }; + }; + responses: { + 204: components["responses"]["no_content"]; + 401: components["responses"]["unauthorized"]; + 429: components["responses"]["too_many_requests"]; + 500: components["responses"]["server_error"]; + default: components["responses"]["unexpected_error"]; + }; + }; domains_list: { parameters: { query?: { @@ -20949,12 +21560,12 @@ export interface operations { */ direction: components["parameters"]["network_direction"]; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ end: components["parameters"]["metric_timestamp_end"]; @@ -20981,12 +21592,12 @@ export interface operations { */ host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ end: components["parameters"]["metric_timestamp_end"]; @@ -21013,12 +21624,12 @@ export interface operations { */ host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ end: components["parameters"]["metric_timestamp_end"]; @@ -21045,12 +21656,12 @@ export interface operations { */ host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ end: components["parameters"]["metric_timestamp_end"]; @@ -21077,12 +21688,12 @@ export interface operations { */ host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ end: components["parameters"]["metric_timestamp_end"]; @@ -21109,12 +21720,12 @@ export interface operations { */ host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ end: components["parameters"]["metric_timestamp_end"]; @@ -21141,12 +21752,12 @@ export interface operations { */ host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ end: components["parameters"]["metric_timestamp_end"]; @@ -21173,12 +21784,12 @@ export interface operations { */ host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ end: components["parameters"]["metric_timestamp_end"]; @@ -21205,12 +21816,12 @@ export interface operations { */ host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ end: components["parameters"]["metric_timestamp_end"]; @@ -21237,12 +21848,12 @@ export interface operations { */ host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ end: components["parameters"]["metric_timestamp_end"]; @@ -21269,12 +21880,12 @@ export interface operations { */ host_id: components["parameters"]["parameters_droplet_id"]; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ end: components["parameters"]["metric_timestamp_end"]; @@ -21306,12 +21917,12 @@ export interface operations { */ app_component?: components["parameters"]["app_component"]; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ end: components["parameters"]["metric_timestamp_end"]; @@ -21343,12 +21954,12 @@ export interface operations { */ app_component?: components["parameters"]["app_component"]; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ end: components["parameters"]["metric_timestamp_end"]; @@ -21380,12 +21991,12 @@ export interface operations { */ app_component?: components["parameters"]["app_component"]; /** - * @description Timestamp to start metric window. + * @description UNIX timestamp to start metric window. * @example 1620683817 */ start: components["parameters"]["metric_timestamp_start"]; /** - * @description Timestamp to end metric window. + * @description UNIX timestamp to end metric window. * @example 1620705417 */ end: components["parameters"]["metric_timestamp_end"]; @@ -22498,6 +23109,7 @@ export interface operations { requestBody?: never; responses: { 200: components["responses"]["snapshots_existing"]; + 400: components["responses"]["not_a_snapshot"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22521,6 +23133,7 @@ export interface operations { requestBody?: never; responses: { 204: components["responses"]["no_content"]; + 400: components["responses"]["not_a_snapshot"]; 401: components["responses"]["unauthorized"]; 404: components["responses"]["not_found"]; 429: components["responses"]["too_many_requests"]; @@ -22801,10 +23414,10 @@ export interface operations { header?: never; path: { /** - * @description Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot. - * @example 6372321 + * @description The unique identifier for the snapshot. + * @example fbe805e8-866b-11e6-96bf-000f53315a41 */ - snapshot_id: components["parameters"]["snapshot_id"]; + snapshot_id: components["parameters"]["volume_snapshot_id"]; }; cookie?: never; }; @@ -22824,10 +23437,10 @@ export interface operations { header?: never; path: { /** - * @description Either the ID of an existing snapshot. This will be an integer for a Droplet snapshot or a string for a volume snapshot. - * @example 6372321 + * @description The unique identifier for the snapshot. + * @example fbe805e8-866b-11e6-96bf-000f53315a41 */ - snapshot_id: components["parameters"]["snapshot_id"]; + snapshot_id: components["parameters"]["volume_snapshot_id"]; }; cookie?: never; }; 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 43556bebe..089ba19af 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 @@ -159,50 +159,8 @@ tags: which is used in some of the following requests. Each slug denotes the node's identifier, CPU count, and amount of RAM, in that order. - For **Basic nodes**, reference the following table for its slug: - - Slug | CPU | RAM - -------------------|---------|--------- - db-s-1vcpu-1gb | 1 vCPU | 1 GB - db-s-1vcpu-2gb | 1 vCPU | 2 GB - db-s-2vcpu-4gb | 2 vCPU | 4 GB - db-s-4vcpu-8gb | 4 vCPU | 8 GB - db-s-6vcpu-16gb | 6 vCPU | 16 GB - db-s-8vcpu-32gb | 8 vCPU | 32 GB - db-s-16vcpu-64gb | 16 vCPU | 64 GB - - For **General Purpose nodes**, reference the following table for its slug: - - Slug | CPU | RAM - -------------------|---------|--------- - gd-2vcpu-8gb | 2 vCPU | 8 GB - gd-4vcpu-16gb | 4 vCPU | 16 GB - gd-8vcpu-32gb | 8 vCPU | 32 GB - gd-16vcpu-64gb | 16 vCPU | 64 GB - gd-32vcpu-128gb | 32 vCPU | 128 GB - gd-40vcpu-160gb | 40 vCPU | 160 GB - - For **Storage-Optimized nodes**, reference the following table for its slug: - - Slug | CPU | RAM - -------------------|---------|--------- - so1_5-2vcpu-16gb | 2 vCPU | 16 GB - so1_5-4vcpu-32gb | 4 vCPU | 32 GB - so1_5-8vcpu-64gb | 8 vCPU | 64 GB - so1_5-16vcpu-128gb | 16 vCPU | 128 GB - so1_5-24vcpu-192gb | 24 vCPU | 192 GB - so1_5-32vcpu-256gb | 32 vCPU | 256 GB - - For **Memory-Optimized nodes**, reference the following table for its slug: - - Slug | CPU | RAM - -------------------|---------|--------- - m-2vcpu-16gb | 2 vCPU | 16 GB - m-4vcpu-32gb | 4 vCPU | 32 GB - m-8vcpu-64gb | 8 vCPU | 64 GB - m-16vcpu-128gb | 16 vCPU | 128 GB - m-24vcpu-192gb | 24 vCPU | 192 GB - m-32vcpu-256gb | 32 vCPU | 256 GB + For a list of currently available database slugs and options, use the `/v2/databases/options` endpoint or use the + `doctl databases options` [command](https://docs.digitalocean.com/reference/doctl/reference/databases/options). - name: Domain Records description: |- @@ -793,6 +751,10 @@ paths: $ref: 'resources/databases/databases_list_replicas.yml' post: $ref: 'resources/databases/databases_create_replica.yml' + + /v2/databases/{database_cluster_uuid}/events: + get: + $ref: 'resources/databases/databases_events_logs.yml' /v2/databases/{database_cluster_uuid}/replicas/{replica_name}: get: @@ -815,6 +777,8 @@ paths: $ref: 'resources/databases/databases_get_user.yml' delete: $ref: 'resources/databases/databases_delete_user.yml' + put: + $ref: 'resources/databases/databases_update_user.yml' /v2/databases/{database_cluster_uuid}/users/{username}/reset_auth: post: @@ -876,6 +840,12 @@ paths: delete: $ref: 'resources/databases/databases_delete_kafka_topic.yml' + /v2/databases/metrics/credentials: + get: + $ref: 'resources/databases/databases_get_cluster_metrics_credentials.yml' + put: + $ref: 'resources/databases/databases_update_cluster_metrics_credentials.yml' + /v2/domains: get: $ref: 'resources/domains/domains_list.yml' @@ -1577,8 +1547,9 @@ components: authenticate. The DigitalOcean API handles this through OAuth, an open standard for - authorization. OAuth allows you to delegate access to your account in full - or in read-only mode. + authorization. OAuth allows you to delegate access to your account. + Scopes can be used to grant full access, read-only access, or access to + a specific set of endpoints. You can generate an OAuth token by visiting the [Apps & API](https://cloud.digitalocean.com/account/api/tokens) section of the DigitalOcean control panel for your account. @@ -1597,6 +1568,31 @@ components: - `doo_v1_` for tokens generated by applications using [the OAuth flow](https://docs.digitalocean.com/reference/api/oauth-api/) - `dor_v1_` for OAuth refresh tokens + ### Scopes + + Scopes act like permissions assigned to an API token. These permissions + determine what actions the token can perform. You can create API + tokens that grant read-only access, full access, or limited access to + specific endpoints by using custom scopes. + + Generally, scopes are designed to match HTTP verbs and common CRUD + operations (Create, Read, Update, Delete). + + | HTTP Verb | CRUD Operation | Scope | + |---|---|---| + | GET | Read | `:read` | + | POST | Create | `:create` | + | PUT/PATCH | Update | `:update` | + | DELETE | Delete | `:delete` | + + For example, creating a new Droplet by making a `POST` request to the + `/v2/droplets` endpoint requires the `droplet:create` scope while + listing Droplets by making a `GET` request to the `/v2/droplets` + endpoint requires the `droplet:read` scope. + + Each endpoint below specifies which scope is required to access it when + using custom scopes. + ### How to Authenticate with OAuth In order to make an authenticated request, include a bearer-type diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_install_kubernetes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_install_kubernetes.yml index 51180956b..2ae54f7d6 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_install_kubernetes.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_install_kubernetes.yml @@ -40,4 +40,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - '1click:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_list.yml index fe0be07b6..56c2319ef 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_list.yml @@ -38,5 +38,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - '1click:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/account/account_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/account/account_get.yml index e8f9ac38b..f60af09bf 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/account/account_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/account/account_get.yml @@ -30,5 +30,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'account:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_get.yml index 295adc49a..f0555a6c5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_get.yml @@ -37,5 +37,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'actions:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_list.yml index 72f434655..305b33661 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/actions/actions_list.yml @@ -37,5 +37,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'actions:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_assign_alertDestinations.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_assign_alertDestinations.yml index 930b3062b..7ef1965ac 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_assign_alertDestinations.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_assign_alertDestinations.yml @@ -45,4 +45,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'app:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_cancel_deployment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_cancel_deployment.yml index f9f2ed7fa..8974455ef 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_cancel_deployment.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_cancel_deployment.yml @@ -36,4 +36,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'app:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_commit_rollback.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_commit_rollback.yml index 34f398750..19d332036 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_commit_rollback.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_commit_rollback.yml @@ -36,4 +36,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' \ No newline at end of file + - 'app:update' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create.yml index 8c14b82e8..3710e803f 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create.yml @@ -58,4 +58,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'app:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_deployment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_deployment.yml index 58482fb14..2532d595b 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_deployment.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_deployment.yml @@ -43,4 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'app:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_rollback.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_rollback.yml index 0c3a4492f..331e582f3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_rollback.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_rollback.yml @@ -49,4 +49,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'app:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_delete.yml index 9cc3f7e0c..c20e6bca5 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_delete.yml @@ -37,4 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'app:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get.yml index d351c4018..9774612a4 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get.yml @@ -39,5 +39,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_deployment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_deployment.yml index b7c5fdce5..793a50d7c 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_deployment.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_deployment.yml @@ -36,5 +36,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_instanceSize.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_instanceSize.yml index d209791f5..0d05e74ef 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_instanceSize.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_instanceSize.yml @@ -36,5 +36,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs.yml index b36827f40..eef0bdf92 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs.yml @@ -42,5 +42,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment.yml index 22310ac03..1852cd51c 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment.yml @@ -44,5 +44,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment_aggregate.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment_aggregate.yml index 940593cb3..655c006f3 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment_aggregate.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_active_deployment_aggregate.yml @@ -43,5 +43,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_aggregate.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_aggregate.yml index 941bd4f9d..cc4a3b0b8 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_aggregate.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_logs_aggregate.yml @@ -42,5 +42,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_metrics_bandwidth_usage.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_metrics_bandwidth_usage.yml index 9a968f487..6823b20eb 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_metrics_bandwidth_usage.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_metrics_bandwidth_usage.yml @@ -42,4 +42,4 @@ x-codeSamples: security: - bearer_auth: - - read + - app:read diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_tier.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_tier.yml index 1ccb9cf8d..bc681224d 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_tier.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_tier.yml @@ -35,5 +35,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list.yml index e5f54b2ba..56d4bfd9d 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list.yml @@ -35,5 +35,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_alerts.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_alerts.yml index bb5f962c2..f7d444126 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_alerts.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_alerts.yml @@ -37,5 +37,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_deployments.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_deployments.yml index 132c30b1f..4549855d4 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_deployments.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_deployments.yml @@ -37,5 +37,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_instanceSizes.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_instanceSizes.yml index cae0b3a1b..b7b188f70 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_instanceSizes.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_instanceSizes.yml @@ -29,5 +29,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_metrics_bandwidth_usage.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_metrics_bandwidth_usage.yml index 9ca738082..df23cff44 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_metrics_bandwidth_usage.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_metrics_bandwidth_usage.yml @@ -44,4 +44,4 @@ x-codeSamples: security: - bearer_auth: - - read + - app:read diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_regions.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_regions.yml index a735b5cf3..22a356a0e 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_regions.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_regions.yml @@ -29,5 +29,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_tiers.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_tiers.yml index 09a560be0..d52113699 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_tiers.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_list_tiers.yml @@ -29,5 +29,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'app:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_revert_rollback.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_revert_rollback.yml index 20b900e22..a865fd59f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_revert_rollback.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_revert_rollback.yml @@ -37,4 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'app:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_update.yml index e75dc7cad..0ee56fc3b 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_update.yml @@ -43,4 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'app:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_appSpec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_appSpec.yml index 139a178b7..b66c54608 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_appSpec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_appSpec.yml @@ -53,5 +53,5 @@ responses: security: - bearer_auth: - - 'read' + - 'app:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_rollback.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_rollback.yml index 25e9c03f5..9de830816 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_rollback.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_validate_rollback.yml @@ -46,4 +46,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' \ No newline at end of file + - 'app:update' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_instance_base.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_instance_base.yml index ee07369c0..6779982bf 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_instance_base.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_instance_base.yml @@ -5,7 +5,7 @@ properties: type: integer format: int64 minimum: 1 - description: 'The amount of instances that this component should be scaled to. Default: 1' + description: 'The amount of instances that this component should be scaled to. Default: 1. Must not be set if autoscaling is used.' default: 1 example: 2 @@ -25,3 +25,36 @@ properties: - professional-xl default: basic-xxs example: basic-xxs + + autoscaling: + description: Configuration for automatically scaling this component based on metrics. + type: object + properties: + min_instance_count: + description: The minimum amount of instances for this component. Must be less than max_instance_count. + type: integer + format: uint32 + minimum: 1 + example: 2 + max_instance_count: + description: The maximum amount of instances for this component. Must be more than min_instance_count. + type: integer + format: uint32 + minimum: 1 + example: 3 + metrics: + description: The metrics that the component is scaled on. + type: object + properties: + cpu: + description: Settings for scaling the component based on CPU utilization. + type: object + properties: + percent: + description: The average target CPU utilization for the component. + type: integer + format: uint32 + minimum: 1 + maximum: 100 + default: 80 + example: 75 diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_propose_response.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_propose_response.yml index 11ec59a0a..c4ab49f67 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_propose_response.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_propose_response.yml @@ -44,3 +44,4 @@ properties: monthly cost of the app if it were to use the Basic tier. If the proposed app already uses the lest expensive tier, the field is empty. example: 17 + deprecated: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_image_source_spec.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_image_source_spec.yml index 453c658b7..0ac3dcc9f 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_image_source_spec.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_image_source_spec.yml @@ -10,10 +10,20 @@ properties: enum: - DOCKER_HUB - DOCR + - GHCR description: |2- - DOCKER_HUB: The DockerHub container registry type. - DOCR: The DigitalOcean container registry type. + - GHCR: The Github container registry type. example: DOCR + + registry_credentials: + type: string + description: |2- + The credentials to be able to pull the image. The value will be encrypted on first submission. On following submissions, the encrypted value should be used. + - "$username:$access_token" for registries of type `DOCKER_HUB`. + - "$username:$access_token" for registries of type `GHCR`. + example: my-dockerhub-username:dckr_pat_the_access_token repository: type: string diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_instance_size.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_instance_size.yml index d5aa7a0ea..e52e05942 100755 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_instance_size.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/apps_instance_size.yml @@ -23,6 +23,7 @@ properties: title: The slug of the corresponding downgradable instance size on the lower tier type: string example: basic + deprecated: true tier_slug: title: The slug of the tier to which this instance size belongs type: string @@ -31,6 +32,7 @@ properties: title: The slug of the corresponding upgradable instance size on the higher tier type: string example: basic + deprecated: true usd_per_month: title: The cost of this instance size in USD per month type: string diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/parameters.yml index cffc6f880..9697ded87 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/parameters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/apps/parameters.yml @@ -98,6 +98,7 @@ log_type: - BUILD: Build-time logs - DEPLOY: Deploy-time logs - RUN: Live run-time logs + - RUN_RESTARTED: Logs of crashed/restarted instances during runtime in: query name: type required: true @@ -108,6 +109,7 @@ log_type: - BUILD - DEPLOY - RUN + - RUN_RESTARTED type: string example: BUILD diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/balance_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/balance_get.yml index bfed76525..a4dc71b6e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/balance_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/balance_get.yml @@ -34,5 +34,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'billing:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/billingHistory_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/billingHistory_list.yml index 1ca5f946f..a60eca6f0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/billingHistory_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/billingHistory_list.yml @@ -34,5 +34,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'billing:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_byUUID.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_byUUID.yml index 6a41a86c2..354165834 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_byUUID.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_byUUID.yml @@ -37,5 +37,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'billing:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_csvByUUID.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_csvByUUID.yml index 2208eed78..d789bad31 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_csvByUUID.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_csvByUUID.yml @@ -37,5 +37,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'billing:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_pdfByUUID.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_pdfByUUID.yml index 026bf8cf0..69e5c3631 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_pdfByUUID.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_pdfByUUID.yml @@ -37,5 +37,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'billing:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_summaryByUUID.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_summaryByUUID.yml index 2e5af5fa4..a90ae4409 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_summaryByUUID.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_get_summaryByUUID.yml @@ -38,5 +38,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'billing:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_list.yml index 97fb597d3..dd626e772 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/invoices_list.yml @@ -35,5 +35,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'billing:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_preview.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_preview.yml index 3444a2eb9..ca08b5818 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_preview.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_preview.yml @@ -8,6 +8,11 @@ properties: description: >- The UUID of the invoice. The canonical reference for the invoice. example: fdabb512-6faf-443c-ba2e-665452332a9e + invoice_id: + type: string + description: >- + ID of the invoice. Listed on the face of the invoice PDF as the "Invoice number". + example: "123456789" amount: type: string description: >- diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_summary.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_summary.yml index d60b00768..93ec7ab9f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_summary.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/models/invoice_summary.yml @@ -6,6 +6,11 @@ properties: description: UUID of the invoice example: 22737513-0ea7-4206-8ceb-98a575af7681 + invoice_id: + type: string + description: ID of the invoice + example: '123456789' + billing_period: type: string description: >- diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoice_summary.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoice_summary.yml index 1c075398c..7843cd759 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoice_summary.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoice_summary.yml @@ -16,6 +16,7 @@ content: $ref: '../models/invoice_summary.yml' example: invoice_uuid: 22737513-0ea7-4206-8ceb-98a575af7681 + invoice_id: '123456789' billing_period: 2020-01 amount: '27.13' user_name: Sammy Shark diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoices.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoices.yml index 3ffcdc801..d4f142a89 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoices.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/billing/responses/invoices.yml @@ -34,13 +34,16 @@ content: example: invoices: - invoice_uuid: 22737513-0ea7-4206-8ceb-98a575af7681 + invoice_id: '12345678' amount: '12.34' invoice_period: 2019-12 - invoice_uuid: fdabb512-6faf-443c-ba2e-665452332a9e + invoice_id: '23456789' amount: '23.45' invoice_period: 2019-11 invoice_preview: invoice_uuid: 1afe95e6-0958-4eb0-8d9a-9c5060d3ef03 + invoice_id: '34567890' amount: '34.56' invoice_period: 2020-02 updated_at: '2020-02-23T06:31:50Z' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_create_endpoint.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_create_endpoint.yml index 7ef3abbb5..39367c575 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_create_endpoint.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_create_endpoint.yml @@ -59,4 +59,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'cdn:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_delete_endpoint.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_delete_endpoint.yml index 64f0e3c6c..dc8006fa4 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_delete_endpoint.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_delete_endpoint.yml @@ -42,4 +42,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'cdn:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_get_endpoint.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_get_endpoint.yml index a4cfc90a1..9a14842b7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_get_endpoint.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_get_endpoint.yml @@ -39,5 +39,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'cdn:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_list_endpoints.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_list_endpoints.yml index e80112637..896fd69cc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_list_endpoints.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_list_endpoints.yml @@ -37,5 +37,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'cdn:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_purge_cache.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_purge_cache.yml index 2561aeed5..058322535 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_purge_cache.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_purge_cache.yml @@ -52,4 +52,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'cdn:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_update_endpoint.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_update_endpoint.yml index b27aedc69..65752fa5a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_update_endpoint.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/cdn/cdn_update_endpoint.yml @@ -48,4 +48,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'cdn:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_create.yml index 3cd9bef4f..fd5bf952d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_create.yml @@ -50,4 +50,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'certificate:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_delete.yml index b755cc3dd..d51c982c3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_delete.yml @@ -39,4 +39,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'certificate:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_get.yml index 85c99f5de..94c98ef7a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_get.yml @@ -39,5 +39,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'cdn:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_list.yml index 0b7aced28..5ca386d4c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/certificates_list.yml @@ -9,6 +9,7 @@ description: >- parameters: - $ref: '../../shared/parameters.yml#/per_page' - $ref: '../../shared/parameters.yml#/page' + - $ref: "parameters.yml#/certificate_name" tags: - Certificates @@ -37,5 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'cdn:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/parameters.yml index df1d84899..cd79d82a5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/parameters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/certificates/parameters.yml @@ -7,4 +7,14 @@ certificate_id: type: string format: uuid minimum: 1 - example: 4de7ac8b-495b-4884-9a69-1050c6793cd6 \ No newline at end of file + example: 4de7ac8b-495b-4884-9a69-1050c6793cd6 + +certificate_name: + name: name + in: query + description: Name of expected certificate + required: false + schema: + type: string + default: "" + example: "certificate-name" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add.yml index ce3f73fa2..6dff7e48d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add.yml @@ -52,4 +52,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_connectionPool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_connectionPool.yml index 263e7b8bd..c2500da3a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_connectionPool.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_connectionPool.yml @@ -59,4 +59,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_user.yml index 792daf61d..6c73a9c4b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_user.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_add_user.yml @@ -38,7 +38,8 @@ requestBody: example: true description: | For MongoDB clusters, set to `true` to create a read-only user. - This option is not currently supported for other database engines. + This option is not currently supported for other database engines. + examples: Add New User: value: @@ -54,6 +55,12 @@ requestBody: value: name: my-readonly readonly: true + + Add New User for Postgres with replication rights: + value: + name: app-02 + settings: + pg_allow_replication: true Add New User with Kafka ACLs: value: @@ -93,4 +100,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml index f065dc011..11868c762 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_cluster.yml @@ -11,8 +11,12 @@ description: >- `creating`. When the cluster is ready to receive traffic, this will transition to `online`. + The embedded `connection` and `private_connection` objects will contain the - information needed to access the database cluster. + information needed to access the database cluster. For multi-node clusters, the + `standby_connection` and `standby_private_connection` objects will contain the information + needed to connect to the cluster's standby node(s). + DigitalOcean managed PostgreSQL and MySQL database clusters take automated daily backups. To create a new database cluster based on a backup of an existing cluster, send a POST @@ -109,4 +113,4 @@ x-codeSamples: security: - bearer_auth: - - "write" + - "database:create" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_topic.yml index ae0333bb5..0dfd7d632 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_topic.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_kafka_topic.yml @@ -55,4 +55,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_replica.yml index b1c9cf465..5a71d1872 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_replica.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_create_replica.yml @@ -66,4 +66,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete.yml index 81c248b76..adb2bf8a5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete.yml @@ -44,4 +44,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_connectionPool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_connectionPool.yml index ac6cb1ff0..5fc2ccc31 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_connectionPool.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_connectionPool.yml @@ -41,4 +41,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_topic.yml index eb597fde9..53dd22672 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_topic.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_kafka_topic.yml @@ -41,5 +41,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' - + - 'database:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_onlineMigration.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_onlineMigration.yml index f1d5581a8..6d474bc80 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_onlineMigration.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_onlineMigration.yml @@ -38,4 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_user.yml index c13a01daf..432c6d38f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_user.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_delete_user.yml @@ -44,4 +44,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_cluster.yml index e1ef8b007..0c44efbda 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_cluster.yml @@ -41,4 +41,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_replica.yml index e9c7d3a22..105ae1152 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_replica.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_destroy_replica.yml @@ -46,4 +46,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_events_logs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_events_logs.yml new file mode 100644 index 000000000..4ff4161d7 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_events_logs.yml @@ -0,0 +1,42 @@ +operationId: databases_list_events_logs + +summary: List all Events Logs + +description: | + To list all of the cluster events, send a GET request to + `/v2/databases/$DATABASE_ID/events`. + + The result will be a JSON object with a `events` key. + +tags: + - Databases + +parameters: + - $ref: "parameters.yml#/database_cluster_uuid" + +responses: + "200": + $ref: "responses/events_logs.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/databases_list_events.yml" + - $ref: "examples/go/databases_list_events.yml" + +security: + - bearer_auth: + - "database:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get.yml index 83b39861f..92e5f2d8b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get.yml @@ -44,5 +44,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_ca.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_ca.yml index 10f47d434..b6bc401fe 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_ca.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_ca.yml @@ -41,5 +41,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_cluster.yml index 8d816e096..a2920d19c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_cluster.yml @@ -6,11 +6,16 @@ description: >- To show information about an existing database cluster, send a GET request to `/v2/databases/$DATABASE_ID`. + The response will be a JSON object with a database key. This will be set to an object containing the standard database cluster attributes. - The embedded connection and private_connection objects will contain the information - needed to access the database cluster. + + The embedded `connection` and `private_connection` objects will contain the + information needed to access the database cluster. For multi-node clusters, the + `standby_connection` and `standby_private_connection` objects contain the information + needed to connect to the cluster's standby node(s). + The embedded maintenance_window object will contain information about any scheduled maintenance for the database cluster. @@ -47,5 +52,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_cluster_metrics_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_cluster_metrics_credentials.yml new file mode 100644 index 000000000..6e281f43c --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_cluster_metrics_credentials.yml @@ -0,0 +1,38 @@ +operationId: databases_get_cluster_metrics_credentials + +summary: Retrieve Database Clusters' Metrics Endpoint Credentials + +description: >- + To show the credentials for all database clusters' metrics endpoints, send a GET request to + `/v2/databases/metrics/credentials`. The result will be a JSON object with a `credentials` key. + +tags: + - Databases + +responses: + '200': + $ref: 'responses/database_metrics_auth.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/databases_get_cluster_metrics_credentials.yml' + - $ref: 'examples/go/databases_get_cluster_metrics_credentials.yml' + +security: + - bearer_auth: + - 'database:update' + diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_config.yml index 439bfc8f9..b2d5d2faf 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_config.yml @@ -38,5 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_connectionPool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_connectionPool.yml index 083be2b0e..ecf54d41f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_connectionPool.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_connectionPool.yml @@ -42,5 +42,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_evictionPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_evictionPolicy.yml index 2cc3c9d4f..b4cb5bcdc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_evictionPolicy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_evictionPolicy.yml @@ -41,4 +41,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_topic.yml index 3ce862088..85565e194 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_topic.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_kafka_topic.yml @@ -40,5 +40,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_migrationStatus.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_migrationStatus.yml index 95d70d99b..38f9f4f75 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_migrationStatus.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_migrationStatus.yml @@ -37,5 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_replica.yml index f58f5adff..daf063597 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_replica.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_replica.yml @@ -46,5 +46,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_sql_mode.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_sql_mode.yml index b7f42c8cd..1534c8d7b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_sql_mode.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_sql_mode.yml @@ -41,5 +41,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_user.yml index 94e20e2ca..126562fe6 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_user.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_get_user.yml @@ -49,5 +49,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list.yml index d1e08f463..0b79b2981 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list.yml @@ -43,5 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_backups.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_backups.yml index 84f919695..b01fff1dc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_backups.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_backups.yml @@ -44,5 +44,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_clusters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_clusters.yml index 7e3ad4fc3..63c3e6562 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_clusters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_clusters.yml @@ -7,11 +7,15 @@ description: >- `/v2/databases`. To limit the results to database clusters with a specific tag, include the `tag_name` query parameter set to the name of the tag. For example, `/v2/databases?tag_name=$TAG_NAME`. + The result will be a JSON object with a `databases` key. This will be set to an array of database objects, each of which will contain the standard database attributes. + The embedded `connection` and `private_connection` objects will contain the information needed to access the - database cluster: + database cluster. For multi-node clusters, the `standby_connection` and `standby_private_connection` objects + will contain the information needed to connect to the cluster's standby node(s). + The embedded `maintenance_window` object will contain information about any scheduled maintenance for the database cluster. @@ -48,5 +52,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_connectionPools.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_connectionPools.yml index 14b30021d..329b3a1a3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_connectionPools.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_connectionPools.yml @@ -41,5 +41,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_firewall_rules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_firewall_rules.yml index e6e2da22b..b892c9664 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_firewall_rules.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_firewall_rules.yml @@ -41,5 +41,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_topics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_topics.yml index 3bdb19f39..37e84f5d0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_topics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_kafka_topics.yml @@ -39,5 +39,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_options.yml index c4a89bb87..7be7fa908 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_options.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_options.yml @@ -37,5 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_replicas.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_replicas.yml index 05ce8dcab..236d48b11 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_replicas.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_replicas.yml @@ -46,5 +46,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_users.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_users.yml index 1c52c364d..256caef8d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_users.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_list_users.yml @@ -45,5 +45,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_patch_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_patch_config.yml index 212de2857..429747acc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_patch_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_patch_config.yml @@ -47,4 +47,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_promote_replica.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_promote_replica.yml index 34df5a28f..c961e3610 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_promote_replica.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_promote_replica.yml @@ -46,4 +46,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_reset_auth.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_reset_auth.yml index 137bd6bcd..f1261887b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_reset_auth.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_reset_auth.yml @@ -59,4 +59,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_clusterSize.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_clusterSize.yml index 03adabd5b..20a5d343a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_clusterSize.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_clusterSize.yml @@ -57,4 +57,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_cluster_metrics_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_cluster_metrics_credentials.yml new file mode 100644 index 000000000..45c9e2339 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_cluster_metrics_credentials.yml @@ -0,0 +1,46 @@ +operationId: databases_update_cluster_metrics_credentials + +summary: Update Database Clusters' Metrics Endpoint Credentials + +description: >- + To update the credentials for all database clusters' metrics endpoints, send a PUT request to + `/v2/databases/metrics/credentials`. A successful request will receive a 204 No Content status code + with no body in response. + +tags: + - Databases + +requestBody: + content: + application/json: + schema: + allOf: + - $ref: 'models/database_metrics_credentials.yml' + example: + credentials: + basic_auth_username: "new_username" + basic_auth_password: "new_password" + +responses: + '204': + $ref: '../../shared/responses/no_content.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/databases_update_cluster_metrics_credentials.yml' + - $ref: 'examples/go/databases_update_cluster_metrics_credentials.yml' + +security: + - bearer_auth: + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_connectionPool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_connectionPool.yml index d40ba7f2d..f4f65f86e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_connectionPool.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_connectionPool.yml @@ -51,5 +51,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_evictionPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_evictionPolicy.yml index 1b494a197..e6e8f92b1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_evictionPolicy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_evictionPolicy.yml @@ -53,4 +53,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_firewall_rules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_firewall_rules.yml index f9c03af22..5661f2f6a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_firewall_rules.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_firewall_rules.yml @@ -71,4 +71,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_topic.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_topic.yml index b68f9b468..8d301053b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_topic.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_kafka_topic.yml @@ -53,5 +53,5 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_maintenanceWindow.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_maintenanceWindow.yml index 4728576fc..80587c784 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_maintenanceWindow.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_maintenanceWindow.yml @@ -52,4 +52,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_onlineMigration.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_onlineMigration.yml index 0951c3e45..31c699597 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_onlineMigration.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_onlineMigration.yml @@ -58,4 +58,4 @@ x-codeSamples: security: - bearer_auth: - - "write" + - "database:update" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_region.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_region.yml index d14715ae4..8edce356d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_region.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_region.yml @@ -62,4 +62,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_sql_mode.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_sql_mode.yml index 53071dfcd..2003d0894 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_sql_mode.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_sql_mode.yml @@ -52,4 +52,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_user.yml new file mode 100644 index 000000000..821805489 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_update_user.yml @@ -0,0 +1,75 @@ +operationId: databases_update_user + +summary: Update a Database User + +description: | + To update an existing database user, send a PUT request to `/v2/databases/$DATABASE_ID/users/$USERNAME` + with the desired settings. + + **Note**: only `settings` can be updated via this type of request. If you wish to change the name of a user, + you must recreate a new user. + + The response will be a JSON object with a key called `user`. The value of this will be an + object that contains the name of the update database user, along with the `settings` object that + has been updated. + +tags: + - Databases + +parameters: + - $ref: 'parameters.yml#/database_cluster_uuid' + - $ref: 'parameters.yml#/username' + +requestBody: + required: true + content: + application/json: + schema: + allOf: + - type: object + properties: + settings: + $ref: './models/user_settings.yml' + required: + - settings + examples: + Update User Kafka ACLs: + value: + settings: + acl: + - id: acl128aaaa99239 + permission: produceconsume + topic: customer-events + - id: acl293098flskdf + permission: produce + topic: customer-events.* + - id: acl128ajei20123 + permission: consume + topic: customer-events + +responses: + '201': + $ref: 'responses/user.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/databases_update_user.yml' + - $ref: 'examples/go/databases_update_user.yml' + +security: + - bearer_auth: + - 'database:update' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_upgrade_major_version.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_upgrade_major_version.yml index 921d10301..2413b8ae1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_upgrade_major_version.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/databases_upgrade_major_version.yml @@ -50,4 +50,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'database:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_get_cluster_metrics_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_get_cluster_metrics_credentials.yml new file mode 100644 index 000000000..fb4f6f375 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_get_cluster_metrics_credentials.yml @@ -0,0 +1,6 @@ +lang: cURL +source: |- + curl -X GET \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + "https://api.digitalocean.com/v2/databases/metrics/credentials" + \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_list_events.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_list_events.yml new file mode 100644 index 000000000..c42ad2a1e --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_list_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/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/events" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_cluster_metrics_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_cluster_metrics_credentials.yml new file mode 100644 index 000000000..be29c0623 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_cluster_metrics_credentials.yml @@ -0,0 +1,8 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"credentials": {"basic_auth_username": "new_username", "basic_auth_password": "new_password"}}'\ + "https://api.digitalocean.com/v2/databases/metrics/credentials" + \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_user.yml new file mode 100644 index 000000000..6f3247e04 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/curl/databases_update_user.yml @@ -0,0 +1,7 @@ +lang: cURL +source: |- + curl -X PUT \ + -H "Content-Type: application/json" \ + -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \ + -d '{"settings": {"acl": [{"topic": "events", "permission": "produce"}]}}' \ + "https://api.digitalocean.com/v2/databases/9cc10173-e9ea-4176-9dbc-a4cee4c4ff30/users" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_get_cluster_metrics_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_get_cluster_metrics_credentials.yml new file mode 100644 index 000000000..c9dab0468 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_get_cluster_metrics_credentials.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() + + creds, _, _ := client.Databases.GetMetricsCredentials(ctx) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_list_events.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_list_events.yml new file mode 100644 index 000000000..de3036523 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_list_events.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() + + replicas, _, err := client.Databases.ListProjectEvents(ctx, "9cc10173-e9ea-4176-9dbc-a4cee4c4ff30", nil) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_cluster_metrics_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_cluster_metrics_credentials.yml new file mode 100644 index 000000000..ba5595690 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_cluster_metrics_credentials.yml @@ -0,0 +1,22 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + + _, _ = client.Databases.UpdateMetricsCredentials(ctx, &godo.DatabaseUpdateMetricsCredentialsRequest{ + Credentials: &godo.DatabaseMetricsCredentials{ + BasicAuthUsername: "a_new_username", + BasicAuthPassword: "a_new_password", + }, + }) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_user.yml new file mode 100644 index 000000000..670df07cb --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/examples/go/databases_update_user.yml @@ -0,0 +1,33 @@ +lang: Go +source: |- + import ( + "context" + "os" + + "github.com/digitalocean/godo" + ) + + func main() { + token := os.Getenv("DIGITALOCEAN_TOKEN") + + client := godo.NewFromToken(token) + ctx := context.TODO() + userName := "test-user" + + updateUserRequest := &godo.DatabaseUpdateUserRequest{ + Settings: { + ACL: [ + { + Permssion: "consume", + Topic: "events", + } + { + Permission: "produce", + Topic: "metrics", + } + ] + } + } + + user, _, err := client.Databases.UpdateUser(ctx, "88055188-9e54-4f21-ab11-8a918ed79ee2", userName, updateUserRequest) + } diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/connection_pool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/connection_pool.yml index 8b0db3afc..afc8c1b91 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/connection_pool.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/connection_pool.yml @@ -42,6 +42,14 @@ properties: allOf: - $ref: './database_connection.yml' - readOnly: true + standby_connection: + allOf: + - $ref: './database_connection.yml' + - readOnly: true + standby_private_connection: + allOf: + - $ref: './database_connection.yml' + - readOnly: true required: - name - mode diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml index 59e564b37..e0085dc5f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_cluster.yml @@ -20,10 +20,11 @@ properties: - redis - mongodb - kafka + - opensearch description: >- A slug representing the database engine used for the cluster. The possible values are: "pg" for PostgreSQL, "mysql" for MySQL, "redis" for Redis, "mongodb" for MongoDB, - and "kafka" for Kafka. + "kafka" for Kafka and "opensearch" for Opensearch. version: type: string example: '8' @@ -92,6 +93,12 @@ properties: description: >- An array of strings containing the names of databases created in the database cluster. + ui_connection: + allOf: + - $ref: './opensearch_connection.yml' + - readOnly: true + description: >- + The connection details for OpenSearch dashboard. connection: allOf: - $ref: './database_connection.yml' @@ -100,6 +107,14 @@ properties: allOf: - $ref: './database_connection.yml' - readOnly: true + standby_connection: + allOf: + - $ref: './database_connection.yml' + - readOnly: true + standby_private_connection: + allOf: + - $ref: './database_connection.yml' + - readOnly: true users: type: array nullable: true @@ -139,6 +154,15 @@ properties: description: >- Additional storage added to the cluster, in MiB. If null, no additional storage is added to the cluster, beyond what is provided as a base amount from the 'size' and any previously added additional storage. + metrics_endpoints: + type: array + items: + $ref: './database_service_endpoint.yml' + description: >- + Public hostname and port of the cluster's metrics endpoint(s). Includes one record for the cluster's primary node and + a second entry for the cluster's standby node(s). + readOnly: true + required: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml index 23564797b..61282ddbf 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_config.yml @@ -6,3 +6,5 @@ properties: - $ref: './mysql.yml' - $ref: './postgres.yml' - $ref: './redis.yml' + - $ref: './mongo.yml' + - $ref: './kafka.yml' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_metrics_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_metrics_credentials.yml new file mode 100644 index 000000000..973806675 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_metrics_credentials.yml @@ -0,0 +1,5 @@ +type: object + +properties: + credentials: + $ref: "./databases_basic_auth_credentials.yml" \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_service_endpoint.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_service_endpoint.yml new file mode 100644 index 000000000..86002a7e8 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/database_service_endpoint.yml @@ -0,0 +1,13 @@ +type: object + +properties: + host: + type: string + description: A FQDN pointing to the database cluster's node(s). + example: backend-do-user-19081923-0.db.ondigitalocean.com + readOnly: true + port: + type: integer + description: The port on which a service is listening. + example: 9273 + readOnly: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/databases_basic_auth_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/databases_basic_auth_credentials.yml new file mode 100644 index 000000000..13cc3d444 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/databases_basic_auth_credentials.yml @@ -0,0 +1,11 @@ +type: object + +properties: + basic_auth_username: + type: string + example: username + description: basic authentication username for metrics HTTP endpoint + basic_auth_password: + type: string + example: password + description: basic authentication password for metrics HTTP endpoint diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/events_logs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/events_logs.yml new file mode 100644 index 000000000..a0b57c1b6 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/events_logs.yml @@ -0,0 +1,27 @@ +type: object + +properties: + id: + type: string + description: ID of the particular event. + example: 'pe8u2huh' + cluster_name: + type: string + description: The name of cluster. + example: 'sample_cluster' + event_type: + type: string + enum: + - cluster_maintenance_perform + - cluster_master_promotion + - cluster_create + - cluster_update + - cluster_delete + - cluster_poweron + - cluster_poweroff + description: Type of the event. + example: 'cluster_create' + create_time: + type: string + description: The time of the generation of a event. + example: '2020-10-29T15:57:38Z' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka.yml new file mode 100644 index 000000000..a9e9b959f --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/kafka.yml @@ -0,0 +1,328 @@ +type: object + +properties: + compression_type: + description: >- + Specify the final compression type for a given topic. This + configuration accepts the standard compression codecs ('gzip', 'snappy', + 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent + to no compression; and 'producer' which means retain the original + compression codec set by the producer. + type: string + enum: + - gzip + - snappy + - lz4 + - zstd + - uncompressed + - producer + example: gzip + group_initial_rebalance_delay_ms: + description: >- + The amount of time, in milliseconds, the group coordinator + will wait for more consumers to join a new group before performing + the first rebalance. A longer delay means potentially fewer rebalances, + but increases the time until processing begins. The default value + for this is 3 seconds. During development and testing it might be + desirable to set this to 0 in order to not delay test execution time. + type: integer + example: 3000 + minimum: 0 + maximum: 300000 + group_min_session_timeout_ms: + description: >- + The minimum allowed session timeout for registered consumers. + Longer timeouts give consumers more time to process messages in between + heartbeats at the cost of a longer time to detect failures. + type: integer + example: 6000 + minimum: 0 + maximum: 60000 + group_max_session_timeout_ms: + description: >- + The maximum allowed session timeout for registered consumers. + Longer timeouts give consumers more time to process messages in between + heartbeats at the cost of a longer time to detect failures. + type: integer + example: 1800000 + minimum: 0 + maximum: 1800000 + connections_max_idle_ms: + description: >- + Idle connections timeout: the server socket processor + threads close the connections that idle for longer than this. + type: integer + minimum: 1000 + example: 540000 + maximum: 3600000 + max_incremental_fetch_session_cache_slots: + description: >- + The maximum number of incremental fetch sessions that the + broker will maintain. + type: integer + example: 1000 + minimum: 1000 + maximum: 10000 + message_max_bytes: + description: >- + The maximum size of message that the server can receive. + type: integer + example: 1048588 + minimum: 0 + maximum: 100001200 + offsets_retention_minutes: + description: >- + Log retention window in minutes for offsets topic + type: integer + example: 10080 + minimum: 1 + maximum: 2147483647 + log_cleaner_delete_retention_ms: + description: >- + How long are delete records retained? + type: integer + minimum: 0 + maximum: 315569260000 + example: 86400000 + log_cleaner_min_cleanable_ratio: + description: >- + Controls log compactor frequency. Larger value means more + frequent compactions but also more space wasted for logs. Consider + setting log_cleaner_max_compaction_lag_ms to enforce compactions sooner, + instead of setting a very high value for this option. + type: number + minimum: 0.2 + maximum: 0.9 + example: 0.5 + log_cleaner_max_compaction_lag_ms: + description: >- + The maximum amount of time message will remain uncompacted. + Only applicable for logs that are being compacted + type: integer + minimum: 30000 + maximum: 9223372036854776000 + example: 60000 + log_cleaner_min_compaction_lag_ms: + description: >- + The minimum time a message will remain uncompacted in the + log. Only applicable for logs that are being compacted. + type: integer + minimum: 0 + maximum: 9223372036854776000 + example: 100000 + log_cleanup_policy: + description: >- + The default cleanup policy for segments beyond the retention + window + type: string + enum: + - delete + - compact + - compact,delete + example: delete + log_flush_interval_messages: + description: >- + The number of messages accumulated on a log partition before + messages are flushed to disk + type: integer + minimum: 1 + maximum: 9223372036854776000 + example: 9223372036854776000 + log_flush_interval_ms: + description: >- + The maximum time in ms that a message in any topic is kept + in memory before flushed to disk. If not set, the value in log.flush.scheduler.interval.ms + is used + type: integer + minimum: 0 + maximum: 9223372036854776000 + example: 1000000 + log_index_interval_bytes: + description: >- + The interval with which Kafka adds an entry to the offset + index + type: integer + minimum: 0 + maximum: 104857600 + example: 4096 + log_index_size_max_bytes: + description: >- + The maximum size in bytes of the offset index + type: integer + minimum: 1048576 + maximum: 104857600 + example: 10485760 + log_message_downconversion_enable: + description: >- + This configuration controls whether down-conversion of + message formats is enabled to satisfy consume requests. + type: boolean + example: true + log_message_timestamp_type: + description: >- + Define whether the timestamp in the message is message + create time or log append time. + type: string + enum: + - CreateTime + - LogAppendTime + example: CreateTime + log_message_timestamp_difference_max_ms: + description: >- + The maximum difference allowed between the timestamp when + a broker receives a message and the timestamp specified in the message + type: integer + minimum: 0 + maximum: 9223372036854776000 + example: 1000000 + log_preallocate: + description: >- + Controls whether to preallocate a file when creating a new segment + type: boolean + example: false + log_retention_bytes: + description: >- + The maximum size of the log before deleting messages + type: integer + minimum: -1 + maximum: 9223372036854776000 + example: 1000000 + log_retention_hours: + description: >- + The number of hours to keep a log file before deleting it + type: integer + minimum: -1 + maximum: 2147483647 + example: 1000000 + log_retention_ms: + description: >- + The number of milliseconds to keep a log file before deleting + it (in milliseconds), If not set, the value in log.retention.minutes + is used. If set to -1, no time limit is applied. + type: integer + minimum: -1 + maximum: 9223372036854776000 + example: 100000000 + log_roll_jitter_ms: + description: >- + The maximum jitter to subtract from logRollTimeMillis (in + milliseconds). If not set, the value in log.roll.jitter.hours is used + type: integer + minimum: 0 + maximum: 9223372036854776000 + example: 10000000 + log_roll_ms: + description: >- + The maximum time before a new log segment is rolled out + (in milliseconds). + type: integer + minimum: 1 + maximum: 9223372036854776000 + example: 1000000 + log_segment_bytes: + description: >- + The maximum size of a single log file + type: integer + minimum: 10485760 + maximum: 1073741824 + example: 100000000 + log_segment_delete_delay_ms: + description: >- + The amount of time to wait before deleting a file from + the filesystem + type: integer + minimum: 0 + maximum: 3600000 + example: 60000 + auto_create_topics_enable: + description: >- + Enable auto creation of topics + type: boolean + example: true + min_insync_replicas: + description: >- + When a producer sets acks to 'all' (or '-1'), min_insync_replicas + specifies the minimum number of replicas that must acknowledge a write + for the write to be considered successful. + type: integer + minimum: 1 + maximum: 7 + example: 1 + num_partitions: + description: >- + Number of partitions for autocreated topics + type: integer + minimum: 1 + maximum: 1000 + example: 10 + default_replication_factor: + description: >- + Replication factor for autocreated topics + type: integer + minimum: 1 + maximum: 10 + example: 2 + replica_fetch_max_bytes: + description: >- + The number of bytes of messages to attempt to fetch for + each partition (defaults to 1048576). This is not an absolute maximum, + if the first record batch in the first non-empty partition of the + fetch is larger than this value, the record batch will still be returned + to ensure that progress can be made. + type: integer + minimum: 1048576 + maximum: 104857600 + example: 2097152 + replica_fetch_response_max_bytes: + description: >- + Maximum bytes expected for the entire fetch response (defaults + to 10485760). Records are fetched in batches, and if the first record + batch in the first non-empty partition of the fetch is larger than + this value, the record batch will still be returned to ensure that + progress can be made. As such, this is not an absolute maximum. + type: integer + minimum: 10485760 + maximum: 1048576000 + example: 20971520 + max_connections_per_ip: + description: >- + The maximum number of connections allowed from each ip + address (defaults to 2147483647). + type: integer + minimum: 256 + maximum: 2147483647 + example: 512 + producer_purgatory_purge_interval_requests: + description: >- + The purge interval (in number of requests) of the producer + request purgatory (defaults to 1000). + type: integer + minimum: 10 + maximum: 10000 + example: 100 + socket_request_max_bytes: + description: >- + The maximum number of bytes in a socket request (defaults + to 104857600). + type: integer + minimum: 10485760 + maximum: 209715200 + example: 20971520 + transaction_state_log_segment_bytes: + description: >- + The transaction topic segment bytes should be kept relatively + small in order to facilitate faster log compaction and cache loads + (defaults to 104857600 (100 mebibytes)). + type: integer + minimum: 1048576 + maximum: 2147483647 + example: 104857600 + transaction_remove_expired_transaction_cleanup_interval_ms: + description: >- + The interval at which to remove transactions that have + expired due to transactional.id.expiration.ms passing (defaults to + 3600000 (1 hour)). + type: integer + minimum: 600000 + maximum: 3600000 + example: 3600000 \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/mongo.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/mongo.yml new file mode 100644 index 000000000..a6ca81d9d --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/mongo.yml @@ -0,0 +1,52 @@ +type: object + +properties: + default_read_concern: + description: >- + Specifies the default consistency behavior of reads from the database. Data that is returned from the query with may + or may not have been acknowledged by all nodes in the replicaset depending on this value. + Learn more [here](https://www.mongodb.com/docs/manual/reference/read-concern/). + type: string + enum: [local, available, majority] + default: local + example: local + default_write_concern: + description: >- + Describes the level of acknowledgment requested from MongoDB for write operations clusters. This field can set to either `majority` + or a number `0...n` which will describe the number of nodes that must acknowledge the write operation before it is fully accepted. + Setting to `0` will request no acknowledgement of the write operation. + Learn more [here](https://www.mongodb.com/docs/manual/reference/write-concern/). + type: string + default: majority + example: majority + transaction_lifetime_limit_seconds: + description: >- + Specifies the lifetime of multi-document transactions. Transactions that exceed this limit are considered expired and will be + aborted by a periodic cleanup process. The cleanup process runs every `transactionLifetimeLimitSeconds/2 seconds` or at least + once every 60 seconds. *Changing this parameter will lead to a restart of the MongoDB service.* + Learn more [here](https://www.mongodb.com/docs/manual/reference/parameters/#mongodb-parameter-param.transactionLifetimeLimitSeconds). + type: integer + minimum: 1 + default: 60 + example: 100 + slow_op_threshold_ms: + description: >- + Operations that run for longer than this threshold are considered slow which are then recorded to the diagnostic logs. + Higher log levels (verbosity) will record all operations regardless of this threshold on the primary node. + *Changing this parameter will lead to a restart of the MongoDB service.* + Learn more [here](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-operationProfiling.slowOpThresholdMs). + type: integer + minimum: 0 + default: 100 + example: 200 + verbosity: + description: >- + The log message verbosity level. The verbosity level determines the amount of Informational and Debug messages MongoDB outputs. + 0 includes informational messages while 1...5 increases the level to include debug messages. + *Changing this parameter will lead to a restart of the MongoDB service.* + Learn more [here](https://www.mongodb.com/docs/manual/reference/configuration-options/#mongodb-setting-systemLog.verbosity). + type: integer + minimum: 0 + maximum: 5 + default: 0 + example: 3 \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_connection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_connection.yml new file mode 100644 index 000000000..1f495b803 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/opensearch_connection.yml @@ -0,0 +1,34 @@ +type: object + +properties: + uri: + type: string + description: >- + This is provided as a convenience and should be able to be constructed by the other attributes. + example: opensearch://doadmin:wv78n3zpz42xezdk@backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require + readOnly: true + host: + type: string + description: The FQDN pointing to the opensearch cluster's current primary node. + example: backend-do-user-19081923-0.db.ondigitalocean.com + readOnly: true + port: + type: integer + description: The port on which the opensearch dashboard is listening. + example: 25060 + readOnly: true + user: + type: string + description: The default user for the opensearch dashboard. + example: doadmin + readOnly: true + password: + type: string + description: The randomly generated password for the default user. + example: wv78n3zpz42xezdk + readOnly: true + ssl: + type: boolean + description: A boolean value indicating if the connection should be made over SSL. + example: true + readOnly: true diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/options.yml index 32f54b19c..b9b4cef3c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/options.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/options.yml @@ -6,39 +6,46 @@ properties: properties: kafka: allOf: - - $ref: './database_region_options.yml' - - $ref: './database_version_options.yml' - - $ref: './database_layout_options.yml' + - $ref: "./database_region_options.yml" + - $ref: "./database_version_options.yml" + - $ref: "./database_layout_options.yml" mongodb: allOf: - - $ref: './database_region_options.yml' - - $ref: './database_version_options.yml' - - $ref: './database_layout_options.yml' + - $ref: "./database_region_options.yml" + - $ref: "./database_version_options.yml" + - $ref: "./database_layout_options.yml" pg: allOf: - - $ref: './database_region_options.yml' - - $ref: './database_version_options.yml' - - $ref: './database_layout_options.yml' + - $ref: "./database_region_options.yml" + - $ref: "./database_version_options.yml" + - $ref: "./database_layout_options.yml" mysql: allOf: - - $ref: './database_region_options.yml' - - $ref: './database_version_options.yml' - - $ref: './database_layout_options.yml' + - $ref: "./database_region_options.yml" + - $ref: "./database_version_options.yml" + - $ref: "./database_layout_options.yml" redis: allOf: - - $ref: './database_region_options.yml' - - $ref: './database_version_options.yml' - - $ref: './database_layout_options.yml' + - $ref: "./database_region_options.yml" + - $ref: "./database_version_options.yml" + - $ref: "./database_layout_options.yml" + opensearch: + allOf: + - $ref: "./database_region_options.yml" + - $ref: "./database_version_options.yml" + - $ref: "./database_layout_options.yml" version_availability: type: object properties: kafka: - $ref: './database_version_availabilities.yml' + $ref: "./database_version_availabilities.yml" pg: - $ref: './database_version_availabilities.yml' + $ref: "./database_version_availabilities.yml" mysql: - $ref: './database_version_availabilities.yml' + $ref: "./database_version_availabilities.yml" redis: - $ref: './database_version_availabilities.yml' + $ref: "./database_version_availabilities.yml" mongodb: - $ref: './database_version_availabilities.yml' \ No newline at end of file + $ref: "./database_version_availabilities.yml" + opensearch: + $ref: "./database_version_availabilities.yml" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml index 8a111fce7..6b8e33004 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/models/user_settings.yml @@ -1,6 +1,12 @@ type: object properties: + pg_allow_replication: + type: boolean + example: true + description: | + For Postgres clusters, set to `true` for a user with replication rights. + This option is not currently supported for other database engines. acl: type: array items: @@ -8,7 +14,7 @@ properties: properties: id: type: string - description: An identifier for the ACL. + description: An identifier for the ACL. Will be computed after the ACL is created/updated. example: "aaa" topic: type: string diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_cluster.yml index cb1f33ec6..9cfb9918c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_cluster.yml @@ -40,6 +40,22 @@ content: user: doadmin password: wv78n3zpz42xezdk ssl: true + standby_connection: + uri: postgres://doadmin:wv78n3zpz42xezdk@replica-backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require + database: '' + host: replica-backend-do-user-19081923-0.db.ondigitalocean.com + port: 25060 + user: doadmin + password: wv78n3zpz42xezdk + ssl: true + standby_private_connection: + uri: postgres://doadmin:wv78n3zpz42xezdk@private-replica-backend-do-user-19081923-0.db.ondigitalocean.com:25060/defaultdb?sslmode=require + database: '' + host: private-replica-backend-do-user-19081923-0.db.ondigitalocean.com + port: 25060 + user: doadmin + password: wv78n3zpz42xezdk + ssl: true users: - name: doadmin role: primary diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_metrics_auth.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_metrics_auth.yml new file mode 100644 index 000000000..6be4a1271 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/database_metrics_auth.yml @@ -0,0 +1,20 @@ +description: A JSON object with a key of `credentials`. + +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: + credentials: + $ref: '../models/database_metrics_credentials.yml' + example: + credentials: + basic_auth_username: username + basic_auth_password: password diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/events_logs.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/events_logs.yml new file mode 100644 index 000000000..e147a5c57 --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/events_logs.yml @@ -0,0 +1,29 @@ +description: A JSON object with a key of `events`. + +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: + events: + type: array + items: + $ref: '../models/events_logs.yml' + + example: + events: + - id: 'pe8u2huh' + cluster_name: 'customer-events' + event_type: 'cluster_create' + create_time: '2020-10-29T15:57:38Z' + - id: 'pe8ufefuh' + cluster_name: 'customer-events' + event_type: 'cluster_update' + create_time: '2023-10-30T15:57:38Z' \ No newline at end of file diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml index 723c31808..1aa36f3ac 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/options.yml @@ -365,6 +365,45 @@ content: - m-16vcpu-128gb - m-24vcpu-192gb - m-32vcpu-256gb + opensearch: + regions: + - ams3 + - blr1 + - fra1 + - lon1 + - nyc1 + - nyc3 + - sfo2 + - sfo3 + - sgp1 + - syd1 + - tor1 + versions: + - '1' + - '2' + layouts: + - num_nodes: 1 + sizes: + - db-s-2vcpu-4gb + - db-s-4vcpu-8gb + - num_nodes: 3 + sizes: + - db-s-2vcpu-4gb + - db-s-4vcpu-8gb + - m3-2vcpu-16gb + - m3-4vcpu-32gb + - num_nodes: 6 + sizes: + - m3-2vcpu-16gb + - m3-4vcpu-32gb + - num_nodes: 9 + sizes: + - m3-2vcpu-16gb + - m3-4vcpu-32gb + - num_nodes: 15 + sizes: + - m3-2vcpu-16gb + - m3-4vcpu-32gb version_availability: kafka: - end_of_life: '2024-05-13T00:00:00Z' @@ -387,6 +426,13 @@ content: - end_of_life: null end_of_availability: null version: '8' + opensearch: + - end_of_life: null + end_of_availability: null + version: '1' + - end_of_life: null + end_of_availability: null + version: '2' pg: - end_of_life: '2024-11-14T00:00:00Z' end_of_availability: '2024-05-14T00:00:00Z' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/user.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/user.yml index 08c3c38b5..8cb1b07cb 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/user.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/databases/responses/user.yml @@ -33,6 +33,15 @@ content: password: wv78n3zpz42xezdk mysql_settings: auth_plugin: mysql_native_password + + New User for Postgres with replication rights: + value: + user: + name: app-02 + role: normal + password: wv78n3zpz42xezdk + settings: + pg_allow_replication: true Kafka User: value: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create.yml index d8c16681e..342bd3be9 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create.yml @@ -43,4 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'domain:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create_record.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create_record.yml index ab7a45c22..c5a7c5aee 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create_record.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_create_record.yml @@ -83,4 +83,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'domain:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete.yml index 2b0de7360..827518f1e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete.yml @@ -38,4 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'domain:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete_record.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete_record.yml index 1a323f5c0..e350131dc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete_record.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_delete_record.yml @@ -43,4 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'domain:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get.yml index 23c0994ef..8a373ec9f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get.yml @@ -39,5 +39,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'domain:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get_record.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get_record.yml index 138ed5243..704e18d80 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get_record.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_get_record.yml @@ -39,5 +39,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'domain:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list.yml index fb2eaf7ca..43d46e02a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list.yml @@ -37,5 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'domain:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list_records.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list_records.yml index d127c742d..e83a8b2ff 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list_records.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_list_records.yml @@ -51,5 +51,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'domain:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_patch_record.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_patch_record.yml index 59f131810..c39821aba 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_patch_record.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_patch_record.yml @@ -52,4 +52,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'domain:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_update_record.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_update_record.yml index 35725b92f..935812642 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_update_record.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/domains/domains_update_record.yml @@ -54,4 +54,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'domain:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_get.yml index 24da1f457..9005767b7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_get.yml @@ -43,5 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_list.yml index d905a7405..6e71fb6ab 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_list.yml @@ -45,5 +45,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml index 061cc3a1d..1f085ebcc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post.yml @@ -22,7 +22,7 @@ description: | | `rebuild` | Rebuilds a Droplet from a new base image. Set the `image` attribute to an image ID or slug. | | `rename` | Renames a Droplet. | | `change_kernel` | Changes a Droplet's kernel. Only applies to Droplets with externally managed kernels. All Droplets created after March 2017 use internal kernels by default. | - | `enable_ipv6` | Enables IPv6 for a Droplet. | + | `enable_ipv6` | Enables IPv6 for a Droplet. Once enabled for a Droplet, IPv6 can not be disabled. When enabling IPv6 on an existing Droplet, [additional OS-level configuration](https://docs.digitalocean.com/products/networking/ipv6/how-to/enable/#on-existing-droplets) is required. | | `snapshot` | Takes a snapshot of a Droplet. | tags: @@ -94,4 +94,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'droplet:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post_byTag.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post_byTag.yml index fb9c9b40e..49194314c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post_byTag.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/dropletActions_post_byTag.yml @@ -72,4 +72,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'droplet:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_create.yml index 00693cddb..a8b4aa046 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_create.yml @@ -70,4 +70,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'droplet:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy.yml index 7b5fbbfd3..f0057dc92 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy.yml @@ -41,4 +41,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'droplet:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_byTag.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_byTag.yml index 684eb78b2..791e7121e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_byTag.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_byTag.yml @@ -43,4 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'droplet:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_retryWithAssociatedResources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_retryWithAssociatedResources.yml index 57e31fa86..9d2bb2ab2 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_retryWithAssociatedResources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_retryWithAssociatedResources.yml @@ -46,4 +46,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'droplet:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml index 848d3732b..d7dd2d335 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesDangerous.yml @@ -46,4 +46,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'droplet:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml index e8b31fa78..c5c73319a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_destroy_withAssociatedResourcesSelective.yml @@ -52,4 +52,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'droplet:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get.yml index 17bbfd01c..eecb814ed 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get.yml @@ -39,5 +39,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml index 9fda4a29d..72b7fdde0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_get_destroyAssociatedResourcesStatus.yml @@ -38,5 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list.yml index f6d075e8e..5d37ed30c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list.yml @@ -49,5 +49,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_associatedResources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_associatedResources.yml index 5294b4373..8419a1cce 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_associatedResources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_associatedResources.yml @@ -42,5 +42,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backups.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backups.yml index ab2379253..536adb04d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backups.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_backups.yml @@ -45,5 +45,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_firewalls.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_firewalls.yml index c3177b43b..c8d363aff 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_firewalls.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_firewalls.yml @@ -39,5 +39,4 @@ responses: security: - bearer_auth: - - 'read' - + - 'firewall:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_kernels.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_kernels.yml index 61ca30d52..5612acfb5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_kernels.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_kernels.yml @@ -45,5 +45,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighbors.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighbors.yml index 144ce9b8f..873e9da57 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighbors.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighbors.yml @@ -43,5 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighborsIds.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighborsIds.yml index 70209670e..77a198a2c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighborsIds.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_neighborsIds.yml @@ -40,5 +40,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_snapshots.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_snapshots.yml index 7cd128692..73e0d9d0c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_snapshots.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/droplets_list_snapshots.yml @@ -45,5 +45,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'droplet:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_multi_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_multi_create.yml index c2e8df4bf..dadb0c835 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_multi_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_multi_create.yml @@ -7,6 +7,8 @@ allOf: type: array items: type: string + maxLength: 255 + pattern: ^[a-zA-Z0-9]?[a-z0-9A-Z.\-]*[a-z0-9A-Z]$ example: - sub-01.example.com - sub-02.example.com diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_single_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_single_create.yml index e2ebd8d42..1fa5b56a1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_single_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/droplets/models/droplet_single_create.yml @@ -5,6 +5,8 @@ allOf: properties: name: type: string + maxLength: 255 + pattern: ^[a-zA-Z0-9]?[a-z0-9A-Z.\-]*[a-z0-9A-Z]$ example: example.com description: The human-readable string you wish to use when displaying the Droplet name. The name, if set to a domain name managed in the diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_rules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_rules.yml index 7a3cba5e9..11de54796 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_rules.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_add_rules.yml @@ -76,4 +76,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'firewall:create' 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 d4eceeeda..712535d2c 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 @@ -66,4 +66,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'firewall:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_assign_droplets.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_assign_droplets.yml index 6a41c0703..14f80c1fe 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_assign_droplets.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_assign_droplets.yml @@ -69,4 +69,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'firewall:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_create.yml index 0b5c4d548..e2f38f943 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_create.yml @@ -77,4 +77,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'firewall:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete.yml index 72248b471..a52f0b2de 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete.yml @@ -42,4 +42,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'firewall:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_droplets.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_droplets.yml index 30d854d38..5b8110532 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_droplets.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_droplets.yml @@ -69,4 +69,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'firewall:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_rules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_rules.yml index 95b485e9f..fd56b2a39 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_rules.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_delete_rules.yml @@ -76,4 +76,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'firewall:delete' 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 6d1b37c4a..4282d92f7 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 @@ -66,4 +66,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'firewall:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_get.yml index c3aea7ef8..2b80b1908 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_get.yml @@ -39,5 +39,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'firewall:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_list.yml index 6c89ad437..2832290b1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_list.yml @@ -37,5 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'firewall:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_update.yml index 300dc25cc..b870374be 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/firewalls/firewalls_update.yml @@ -87,4 +87,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'firewall:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_get.yml index 416ff667d..70e0a9db1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_get.yml @@ -38,5 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'firewall:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_list.yml index 501f835ae..a3ef73cb3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_list.yml @@ -37,5 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'firewall:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_post.yml index e3a6f0364..829a591b8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_post.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPsAction_post.yml @@ -61,4 +61,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'reserved_ip:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_create.yml index 0fb83dd3f..e4ad6626f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_create.yml @@ -49,4 +49,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'reserved_ip:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_delete.yml index 4d739ef17..34db51088 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_delete.yml @@ -41,4 +41,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'reserved_ip:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_get.yml index 1659f2cac..4a724e78a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_get.yml @@ -37,5 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'firewall:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_list.yml index 124a36b04..109148593 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/floating_ips/floatingIPs_list.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'firewall:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_namespace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_namespace.yml index c9e3be35e..70539e262 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_namespace.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_namespace.yml @@ -44,4 +44,5 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'function:create' + - 'function:admin' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_trigger.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_trigger.yml index f53b1bc1e..e7c39b632 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_trigger.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_create_trigger.yml @@ -49,4 +49,5 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'function:create' + - 'function:admin' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_namespace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_namespace.yml index 09b37a2b3..dd978920f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_namespace.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_namespace.yml @@ -42,4 +42,5 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'function:delete' + - 'function:admin' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_trigger.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_trigger.yml index fd52fa0b1..18b99b043 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_trigger.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_delete_trigger.yml @@ -41,4 +41,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'function:delete' + - 'function:admin' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_namespace.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_namespace.yml index 480d89a8a..823ee73c5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_namespace.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_namespace.yml @@ -40,4 +40,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'function:admin' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_trigger.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_trigger.yml index b06555217..f8d957eeb 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_trigger.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_get_trigger.yml @@ -38,4 +38,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'function:read' + - 'function:admin' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_namespaces.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_namespaces.yml index 5266a0c00..768564658 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_namespaces.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_namespaces.yml @@ -31,4 +31,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'function:read' + - 'function:admin' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_triggers.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_triggers.yml index 55f1ea1d0..b32e00f71 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_triggers.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_list_triggers.yml @@ -37,4 +37,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'function:read' + - 'function:admin' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_update_trigger.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_update_trigger.yml index 6a6f2b88a..4eec732af 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_update_trigger.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/functions/functions_update_trigger.yml @@ -47,4 +47,5 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'function:update' + - 'function:admin' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_get.yml index f0dee7f21..e1e3b9b43 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_get.yml @@ -40,5 +40,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'image:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_list.yml index b6ebe4fb2..eb72a3629 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_list.yml @@ -38,5 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'image:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_post.yml index 246782864..aa2f29241 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_post.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/imageActions_post.yml @@ -63,4 +63,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'image:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_create_custom.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_create_custom.yml index 6a09216ce..8edb6ba61 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_create_custom.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_create_custom.yml @@ -43,4 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'image:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_delete.yml index fe9d8ca2d..506992e44 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_delete.yml @@ -38,4 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'image:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_get.yml index 7b14138f0..08b1e0e61 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_get.yml @@ -59,5 +59,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'image:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_list.yml index ccc7930d1..7e4c0b157 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_list.yml @@ -62,5 +62,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'image:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_update.yml index e38b8d705..e5c020d55 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/images/images_update.yml @@ -48,4 +48,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'image:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_nodePool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_nodePool.yml index 28da92d22..4096c37a2 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_nodePool.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_nodePool.yml @@ -58,4 +58,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'kubernetes:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registry.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registry.yml index 9c204d65d..67ac1e15e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registry.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_add_registry.yml @@ -37,4 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'kubernetes:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_create_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_create_cluster.yml index 1943c7879..f5bc62c11 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_create_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_create_cluster.yml @@ -54,4 +54,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'kubernetes:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_cluster.yml index 8ca28acdf..a1cf035fb 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_cluster.yml @@ -42,4 +42,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'kubernetes:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_node.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_node.yml index b4073d953..b6cd32b72 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_node.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_node.yml @@ -50,4 +50,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'kubernetes:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_nodePool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_nodePool.yml index 7c69a55d0..70c323fc6 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_nodePool.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_delete_nodePool.yml @@ -43,4 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'kubernetes:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesDangerous.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesDangerous.yml index 5e3539a19..9623b592c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesDangerous.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesDangerous.yml @@ -39,4 +39,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'kubernetes:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesSelective.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesSelective.yml index 3a564a66e..49ee4c649 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesSelective.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_destroy_associatedResourcesSelective.yml @@ -54,4 +54,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'kubernetes:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_availableUpgrades.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_availableUpgrades.yml index 9d75d1e38..894be9741 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_availableUpgrades.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_availableUpgrades.yml @@ -39,5 +39,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'kubernetes:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_cluster.yml index b6f619df6..0c90be8c8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_cluster.yml @@ -39,5 +39,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'kubernetes:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterLintResults.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterLintResults.yml index 2fc7a565c..1ab37cd19 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterLintResults.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterLintResults.yml @@ -43,5 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'kubernetes:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterUser.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterUser.yml index 616dd7279..2848f3a71 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterUser.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_clusterUser.yml @@ -37,5 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'kubernetes:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml index 09458f36c..23faf9bfd 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_credentials.yml @@ -54,4 +54,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'kubernetes:access_cluster' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_kubeconfig.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_kubeconfig.yml index ef897dc2b..e2c6f374a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_kubeconfig.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_kubeconfig.yml @@ -55,4 +55,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'kubernetes:access_cluster' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_nodePool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_nodePool.yml index 4a847ca55..d4759a377 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_nodePool.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_get_nodePool.yml @@ -40,5 +40,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'kubernetes:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_associatedResources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_associatedResources.yml index 74c5e6573..42951f192 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_associatedResources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_associatedResources.yml @@ -40,5 +40,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'kubernetes:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_clusters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_clusters.yml index dfddf129d..bc6662b2c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_clusters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_clusters.yml @@ -37,5 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'kubernetes:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_nodePools.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_nodePools.yml index a917c92ee..4e6898853 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_nodePools.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_nodePools.yml @@ -39,5 +39,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'kubernetes:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_options.yml index 305424118..71bfb1318 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_options.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_list_options.yml @@ -36,5 +36,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'kubernetes:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_recycle_nodePool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_recycle_nodePool.yml index 28a130858..2e57cc734 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_recycle_nodePool.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_recycle_nodePool.yml @@ -50,4 +50,4 @@ responses: $ref: '../../shared/responses/unexpected_error.yml' security: - bearer_auth: - - 'write' + - 'kubernetes:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registry.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registry.yml index 1de09cccc..15b9fc34b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registry.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_remove_registry.yml @@ -37,4 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'kubernetes:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_run_clusterLint.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_run_clusterLint.yml index d9c87dc44..b0b726264 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_run_clusterLint.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_run_clusterLint.yml @@ -52,5 +52,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'kubernetes:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_cluster.yml index c162cdd37..a76805cdc 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_cluster.yml @@ -48,4 +48,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'kubernetes:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_nodePool.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_nodePool.yml index b2d9bd160..e378ec43c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_nodePool.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_update_nodePool.yml @@ -50,4 +50,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'kubernetes:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_upgrade_cluster.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_upgrade_cluster.yml index 887e41512..34f7b4ea5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_upgrade_cluster.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/kubernetes/kubernetes_upgrade_cluster.yml @@ -55,4 +55,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'kubernetes:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_droplets.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_droplets.yml index f13a8583e..64fd3000f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_droplets.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_droplets.yml @@ -58,4 +58,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'load_balancer:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_forwardingRules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_forwardingRules.yml index 7fa4cfec5..b42dc6ddb 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_forwardingRules.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_add_forwardingRules.yml @@ -60,4 +60,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'load_balancer:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_create.yml index b12b1c848..6867dace8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_create.yml @@ -61,4 +61,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'load_balancer:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_delete.yml index e40295ba6..621815e61 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_delete.yml @@ -43,4 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'load_balancer:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_get.yml index 32039372f..9dd294263 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_get.yml @@ -39,5 +39,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'load_balancer:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_list.yml index 83c51b8a3..a9f0ad4cd 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_list.yml @@ -37,5 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'load_balancer:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_droplets.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_droplets.yml index 9e2c563ec..bcd143a28 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_droplets.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_droplets.yml @@ -55,4 +55,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'load_balancer:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_forwardingRules.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_forwardingRules.yml index 3d48c6acb..a948f9a93 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_forwardingRules.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_remove_forwardingRules.yml @@ -60,4 +60,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'load_balancer:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_update.yml index 8d5c78113..28295043f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/load_balancers/loadBalancers_update.yml @@ -55,4 +55,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'load_balancer:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml index 52b8cc5d2..367259a2a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_create_alertPolicy.yml @@ -69,4 +69,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'monitoring:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_delete_alertPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_delete_alertPolicy.yml index 50f5764df..ae8d185ff 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_delete_alertPolicy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_delete_alertPolicy.yml @@ -34,4 +34,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'monitoring:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_DropletCpuMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_DropletCpuMetrics.yml index ca19d8bb2..97192203d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_DropletCpuMetrics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_DropletCpuMetrics.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_alertPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_alertPolicy.yml index 740a70733..71cc273f1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_alertPolicy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_alertPolicy.yml @@ -34,5 +34,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml index 3ab45648c..fcafb53fb 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appCPUPercentageMetrics.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml index 2d66b0c11..6afa4d65a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appMemoryPercentageMetrics.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appRestartCountMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appRestartCountMetrics.yml index 3057fbf09..6ed2cdc89 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appRestartCountMetrics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_appRestartCountMetrics.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletBandwidthMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletBandwidthMetrics.yml index e68c81cfe..5669f6f04 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletBandwidthMetrics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletBandwidthMetrics.yml @@ -8,6 +8,8 @@ description: >- to specify if the results should be for the `private` or `public` interface. Use the `direction` query parameter to specify if the results should be for `inbound` or `outbound` traffic. + + The metrics in the response body are in megabits per second (Mbps). tags: - Monitoring @@ -41,5 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemFreeMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemFreeMetrics.yml index 6a02e4581..1a23003e3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemFreeMetrics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemFreeMetrics.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemSizeMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemSizeMetrics.yml index 427e5c655..7ffe74e07 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemSizeMetrics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletFilesystemSizeMetrics.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad15Metrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad15Metrics.yml index aefe48fde..62866b907 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad15Metrics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad15Metrics.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad1Metrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad1Metrics.yml index 4dc8e88f5..fca3fa4c6 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad1Metrics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad1Metrics.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad5Metrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad5Metrics.yml index 82f817bbd..0f7a5c4df 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad5Metrics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletLoad5Metrics.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryAvailableMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryAvailableMetrics.yml index cd2f56239..c2a51a24f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryAvailableMetrics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryAvailableMetrics.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryCachedMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryCachedMetrics.yml index 44d7a84f4..b95eaf193 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryCachedMetrics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryCachedMetrics.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryFreeMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryFreeMetrics.yml index 8b7d07b50..f20553fe9 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryFreeMetrics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryFreeMetrics.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryTotalMetrics.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryTotalMetrics.yml index 8623e31dd..b3dd063ed 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryTotalMetrics.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_get_dropletMemoryTotalMetrics.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_list_alertPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_list_alertPolicy.yml index 52fdeeb68..35926639b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_list_alertPolicy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_list_alertPolicy.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'monitoring:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml index 0d6641a0a..0bf239d38 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/monitoring_update_alertPolicy.yml @@ -74,4 +74,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'monitoring:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml index ea94bd258..6c5599e1b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/monitoring/parameters.yml @@ -50,7 +50,7 @@ network_direction: metric_timestamp_start: in: query name: start - description: Timestamp to start metric window. + description: UNIX timestamp to start metric window. example: "1620683817" required: true schema: @@ -59,7 +59,7 @@ metric_timestamp_start: metric_timestamp_end: in: query name: end - description: Timestamp to end metric window. + description: UNIX timestamp to end metric window. example: "1620705417" required: true schema: diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources.yml index 020003ee0..32c815292 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources.yml @@ -53,4 +53,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'project:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources_default.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources_default.yml index 162546435..ee556a8f3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources_default.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_assign_resources_default.yml @@ -50,4 +50,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'project:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_create.yml index f4796fd7e..8dc57bcbe 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_create.yml @@ -45,4 +45,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'project:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_delete.yml index 24a2995f7..3f4344d97 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_delete.yml @@ -46,4 +46,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'project:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get.yml index 4e53052a4..728d7d8de 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get.yml @@ -37,5 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'project:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get_default.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get_default.yml index 179da3ce3..dae4e3d24 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get_default.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_get_default.yml @@ -34,5 +34,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'project:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list.yml index f5906627e..b09b5623c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'project:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources.yml index dcfefefe5..8a988617a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources.yml @@ -40,5 +40,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'project:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources_default.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources_default.yml index 73a0daea5..7fc823f5c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources_default.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_list_resources_default.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'project:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch.yml index d88ada8d4..047dc4453 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch.yml @@ -50,4 +50,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'project:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch_default.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch_default.yml index 6678bfa04..8d8da40be 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch_default.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_patch_default.yml @@ -47,4 +47,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'project:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update.yml index 2f49f5628..18044e8ad 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update.yml @@ -54,4 +54,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'project:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update_default.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update_default.yml index bab9b0d38..1a099746f 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update_default.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/projects/projects_update_default.yml @@ -51,4 +51,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'project:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/regions/regions_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/regions/regions_list.yml index b2ab1f9c2..5f8fb1086 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/regions/regions_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/regions/regions_list.yml @@ -41,5 +41,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'regions:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_create.yml index 273679875..f7477b8cb 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_create.yml @@ -42,4 +42,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'registry:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete.yml index 27422667a..fc28fe2ec 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete.yml @@ -33,4 +33,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'registry:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryManifest.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryManifest.yml index 4c3a06660..d6078ead8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryManifest.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryManifest.yml @@ -47,4 +47,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'registry:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryTag.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryTag.yml index ab591d2b0..3fbf68156 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryTag.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_delete_repositoryTag.yml @@ -47,4 +47,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'registry:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get.yml index f690d8ab2..412da9e94 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get.yml @@ -30,5 +30,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml index bba897df0..bbcd750e0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_dockerCredentials.yml @@ -55,5 +55,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'registry:read' + - 'registry:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_garbageCollection.yml index b281a3eca..fce654c18 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_garbageCollection.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_garbageCollection.yml @@ -36,4 +36,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_options.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_options.yml index d3df86351..306b82146 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_options.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_options.yml @@ -41,5 +41,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_subscription.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_subscription.yml index 8ffe04586..c0ecae454 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_subscription.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_get_subscription.yml @@ -31,5 +31,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_garbageCollections.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_garbageCollections.yml index 20f24fa5e..69ffe66fb 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_garbageCollections.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_garbageCollections.yml @@ -38,4 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositories.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositories.yml index e2aac1954..f47013883 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositories.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositories.yml @@ -44,5 +44,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoriesV2.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoriesV2.yml index f40c3878e..81ebb19b7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoriesV2.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoriesV2.yml @@ -43,5 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryManifests.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryManifests.yml index 3bd76fa79..909a50b83 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryManifests.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryManifests.yml @@ -45,5 +45,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryTags.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryTags.yml index 6ca5ea2f2..70d0276ff 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryTags.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_list_repositoryTags.yml @@ -45,5 +45,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'registry:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_run_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_run_garbageCollection.yml index 10d81207c..57c8c0a64 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_run_garbageCollection.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_run_garbageCollection.yml @@ -56,4 +56,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'registry:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_garbageCollection.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_garbageCollection.yml index e942e6254..9de2dcd5e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_garbageCollection.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_garbageCollection.yml @@ -46,4 +46,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'registry:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_subscription.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_subscription.yml index 3260cb35e..66f902247 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_subscription.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_update_subscription.yml @@ -46,4 +46,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'registry:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_validate_name.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_validate_name.yml index 5e28e03e1..1384aef0c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_validate_name.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/registry/registry_validate_name.yml @@ -46,4 +46,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'registry:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_get.yml index caf0b14a0..101d38ac4 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_get.yml @@ -39,5 +39,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'reserved_ip:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_list.yml index 13afa0a72..dcb0f722d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_list.yml @@ -38,5 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'reserved_ip:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_post.yml index 4fdf52097..fbc267a6c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_post.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPsActions_post.yml @@ -62,4 +62,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'reserved_ip:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_create.yml index 4159156c4..548bfe372 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_create.yml @@ -50,4 +50,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'reserved_ip:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_delete.yml index 0af22624a..a1a116506 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_delete.yml @@ -42,4 +42,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'reserved_ip:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_get.yml index a78b27bca..211bc5d8c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_get.yml @@ -38,5 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'reserved_ip:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_list.yml index 78f012b1b..b0a04a25e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/reserved_ips/reservedIPs_list.yml @@ -36,5 +36,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'reserved_ip:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/sizes_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/sizes_list.yml index 79639c0a1..9f03e4043 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/sizes_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/sizes/sizes_list.yml @@ -40,4 +40,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'sizes:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/responses/not_a_snapshot.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/responses/not_a_snapshot.yml new file mode 100644 index 000000000..c4434e00b --- /dev/null +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/responses/not_a_snapshot.yml @@ -0,0 +1,18 @@ +description: Bad Request + +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: + $ref: '../../../shared/models/error.yml' + example: + id: bad_request + message: the resource is not a snapshot + request_id: bbd8d7d4-2beb-4be1-a374-338e6165e32d diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_delete.yml index af56c5a4f..318500321 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_delete.yml @@ -20,6 +20,9 @@ responses: '204': $ref: '../../shared/responses/no_content.yml' + '400': + $ref: 'responses/not_a_snapshot.yml' + '401': $ref: '../../shared/responses/unauthorized.yml' @@ -43,4 +46,5 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'image:delete' + - 'snapshot:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_get.yml index 90eb501f8..2655860e0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_get.yml @@ -19,6 +19,9 @@ responses: '200': $ref: 'responses/snapshots_existing.yml' + '400': + $ref: 'responses/not_a_snapshot.yml' + '401': $ref: '../../shared/responses/unauthorized.yml' @@ -42,5 +45,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'image:read' + - 'snapshot:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_list.yml index da0fae421..f343466c0 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/snapshots/snapshots_list.yml @@ -56,5 +56,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'image:read' + - 'snapshot:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_create.yml index f9fe4cd63..8d1cafd35 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_create.yml @@ -42,4 +42,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'ssh_key:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_delete.yml index 5510a6864..de01d8f12 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_delete.yml @@ -42,4 +42,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'ssh_key:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_get.yml index 447e91ee1..dfa87f63a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_get.yml @@ -42,5 +42,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'ssh_key:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_list.yml index 394a1ad9f..713878e06 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_list.yml @@ -39,5 +39,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'ssh_key:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_update.yml index c692038f1..7264e86bd 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/ssh_keys/sshKeys_update.yml @@ -53,4 +53,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'ssh_key:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_assign_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_assign_resources.yml index f5a25694b..9e2218149 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_assign_resources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_assign_resources.yml @@ -52,4 +52,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'tag:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_create.yml index c35d1bff4..0b1a9153a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_create.yml @@ -43,4 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'tag:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_delete.yml index 5ba6d6c08..3812ebf99 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_delete.yml @@ -40,4 +40,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'tag:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_get.yml index 1698b8fbf..22939e128 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_get.yml @@ -39,5 +39,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'tag:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_list.yml index 4a84e1221..2b232e6a8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_list.yml @@ -35,5 +35,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'tag:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_unassign_resources.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_unassign_resources.yml index 349ae56d9..999110e0c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_unassign_resources.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/tags/tags_unassign_resources.yml @@ -52,4 +52,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'tag:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_alert.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_alert.yml index eda030222..dba2ccb7b 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_alert.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_alert.yml @@ -63,5 +63,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' - + - 'uptime:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_check.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_check.yml index aa26239d2..326312f7a 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_check.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/create_check.yml @@ -49,4 +49,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'uptime:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_alert.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_alert.yml index ff8ec1d2f..c3f3d63e4 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_alert.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_alert.yml @@ -40,4 +40,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'uptime:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_check.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_check.yml index 414a7fb17..7f0a392c2 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_check.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/delete_check.yml @@ -40,4 +40,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'uptime:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_alert.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_alert.yml index 1b02ca5da..4bbb6576c 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_alert.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_alert.yml @@ -38,4 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'uptime:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check.yml index 2c9ece358..767756671 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check.yml @@ -36,4 +36,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'uptime:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check_state.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check_state.yml index e222f3d0e..93def8174 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check_state.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/get_check_state.yml @@ -37,4 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'uptime:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_alerts.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_alerts.yml index 9497eaa41..ce423eb38 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_alerts.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_alerts.yml @@ -38,4 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'uptime:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_checks.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_checks.yml index efe2e0f32..006519982 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_checks.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/list_checks.yml @@ -38,4 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'uptime:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_alert.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_alert.yml index 1dc7c7ab0..5dca2675d 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_alert.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_alert.yml @@ -53,4 +53,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'uptime:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_check.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_check.yml index 2af3a29a0..47422a9e5 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_check.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/uptime/update_check.yml @@ -46,4 +46,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'uptime:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_get.yml index 6e901204c..911fa6b9e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_get.yml @@ -42,5 +42,5 @@ x-codeSamples: security: - bearer_auth: - - 'read' + - 'block_storage_action:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_list.yml index 0d405f3e3..542ebc7f7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_list.yml @@ -41,5 +41,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'block_storage_action:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml index 0419f0fe5..ee2774fd8 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post.yml @@ -96,4 +96,4 @@ x-codeSamples: security: - bearer_auth: - - "write" + - "block_storage_action:create" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml index de0ff0eda..f3b1a7094 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeActions_post_byId.yml @@ -113,4 +113,4 @@ x-codeSamples: security: - bearer_auth: - - "write" + - "block_storage_action:create" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_create.yml index b940f9f08..d831f1ae6 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_create.yml @@ -61,4 +61,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'block_storage_snapshot:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_delete_byId.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_delete_byId.yml index 52c6873de..171aed129 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_delete_byId.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_delete_byId.yml @@ -4,7 +4,7 @@ summary: Delete a Volume Snapshot description: | To delete a volume snapshot, send a DELETE request to - `/v2/snapshots/$SNAPSHOT_ID`. + `/v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID`. A status of 204 will be given. This indicates that the request was processed successfully, but that no response body is needed. @@ -13,7 +13,7 @@ tags: - Block Storage parameters: - - $ref: '../snapshots/parameters.yml#/snapshot_id' + - $ref: 'parameters.yml#/volume_snapshot_id' responses: '204': @@ -42,4 +42,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'block_storage_snapshot:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_get_byId.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_get_byId.yml index 350cc4062..fb7a18ef1 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_get_byId.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_get_byId.yml @@ -4,13 +4,13 @@ summary: Retrieve an Existing Volume Snapshot description: >+ To retrieve the details of a snapshot that has been created from a volume, - send a GET request to `/v2/volumes/snapshots/$SNAPSHOT_ID`. + send a GET request to `/v2/volumes/snapshots/$VOLUME_SNAPSHOT_ID`. tags: - Block Storage parameters: - - $ref: "../snapshots/parameters.yml#/snapshot_id" + - $ref: 'parameters.yml#/volume_snapshot_id' responses: "200": @@ -37,4 +37,4 @@ x-codeSamples: security: - bearer_auth: - - "read" + - "block_storage_snapshot:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_list.yml index f7e979753..b0ce65ee7 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumeSnapshots_list.yml @@ -41,5 +41,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'block_storage_snapshot:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_create.yml index 88fdd1e01..ab84abe95 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_create.yml @@ -81,4 +81,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'block_storage:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete.yml index 2ebad04c8..c3f0cc3a3 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete.yml @@ -43,4 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'block_storage:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete_byName.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete_byName.yml index eaea80d73..b7d667491 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete_byName.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_delete_byName.yml @@ -43,4 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'block_storage:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_get.yml index 0fa65f65a..e22b5a523 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_get.yml @@ -39,5 +39,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'block_storage:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_list.yml index 9985b7292..ae268d365 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/volumes/volumes_list.yml @@ -63,4 +63,4 @@ x-codeSamples: security: - bearer_auth: - - "read" + - "block_storage:read" diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_create.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_create.yml index eb56c7668..5bdfdd47e 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_create.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_create.yml @@ -51,4 +51,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'vpc:create' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_delete.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_delete.yml index c2f4300d0..850a2a9af 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_delete.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_delete.yml @@ -43,4 +43,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'vpc:delete' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_get.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_get.yml index 3f7d7fda5..59aad0cc2 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_get.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_get.yml @@ -37,5 +37,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'vpc:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list.yml index 0b69fa7e3..446de6981 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list.yml @@ -38,5 +38,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'vpc:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_members.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_members.yml index b0e5002bb..2b0915b79 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_members.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_list_members.yml @@ -44,5 +44,4 @@ x-codeSamples: security: - bearer_auth: - - 'read' - + - 'vpc:read' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_patch.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_patch.yml index e8b17d2d9..5b48cbcdf 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_patch.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_patch.yml @@ -48,4 +48,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'vpc:update' diff --git a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_update.yml b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_update.yml index 20cea7d36..3bd002e52 100644 --- a/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_update.yml +++ b/packages/openapi-typescript/examples/digital-ocean-api/resources/vpcs/vpcs_update.yml @@ -51,4 +51,4 @@ x-codeSamples: security: - bearer_auth: - - 'write' + - 'vpc:update' 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 b8d13cc62..b3d4505ef 100644 --- a/packages/openapi-typescript/examples/github-api-export-type-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-export-type-immutable.ts @@ -231,9 +231,9 @@ export type paths = { }; /** * List installations for the authenticated app - * @description 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. + * @description The permissions the installation has are included under the `permissions` key. * - * The permissions the installation has are included under the `permissions` key. + * 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 get: operations["apps/list-installations"]; readonly put?: never; @@ -283,7 +283,13 @@ export type paths = { readonly put?: never; /** * Create an installation access token for an app - * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. + * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. + * + * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. + * + * 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. */ @@ -382,7 +388,15 @@ export type paths = { readonly put?: never; /** * Create a scoped access token - * @description Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify + * which repositories the token can access and which permissions are granted to the + * token. + * + * Invalid tokens will return `404 NOT FOUND`. + * + * You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) + * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + * as the username and password. */ readonly post: operations["apps/scope-token"]; readonly delete?: never; @@ -401,8 +415,6 @@ export type paths = { /** * Get an app * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - * - * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ readonly get: operations["apps/get-by-slug"]; readonly put?: never; @@ -593,6 +605,39 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/enterprises/{enterprise}/copilot/usage": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a summary of Copilot usage for enterprise members + * @description **Note**: This endpoint is in beta 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 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 response contains metrics for the prior 28 days. 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. + * + * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage + * metrics for the enterprise. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + */ + readonly get: operations["copilot/usage-metrics-for-enterprise"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/enterprises/{enterprise}/dependabot/alerts": { readonly parameters: { readonly query?: never; @@ -603,9 +648,12 @@ export type paths = { /** * List Dependabot alerts for an enterprise * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. - * To use this endpoint, you must be a member of the enterprise, and you must use an - * access token with the `repo` scope or `security_events` scope. + * + * The authenticated user must be a member of the enterprise to use this endpoint. + * * 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 the `repo` or `security_events` scope to use this endpoint. */ readonly get: operations["dependabot/list-alerts-for-enterprise"]; readonly put?: never; @@ -626,7 +674,12 @@ export type paths = { /** * List secret scanning alerts for an enterprise * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are 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). + * + * 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). + * + * 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 the `repo` scope or `security_events` scope to use this endpoint. */ readonly get: operations["secret-scanning/list-alerts-for-enterprise"]; readonly put?: never; @@ -666,16 +719,18 @@ export type paths = { }; /** * Get feeds - * @description GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: + * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * * * **Timeline**: The GitHub global public timeline - * * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * * **Current user public**: The public timeline for the authenticated user * * **Current user**: The private timeline for the authenticated user * * **Current user actor**: The private timeline for activity created by the authenticated user * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. * + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ readonly get: operations["activity/get-feeds"]; @@ -762,7 +817,15 @@ export type paths = { readonly path?: never; readonly cookie?: never; }; - /** Get a gist */ + /** + * Get a gist + * @description Gets a specified gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ readonly get: operations["gists/get"]; readonly put?: never; readonly post?: never; @@ -772,8 +835,16 @@ export type paths = { readonly head?: never; /** * Update a gist - * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. + * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files + * from the previous version of the gist that aren't explicitly changed during an edit + * are unchanged. + * * At least one of `description` or `files` is required. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ readonly patch: operations["gists/update"]; readonly trace?: never; @@ -785,10 +856,26 @@ export type paths = { readonly path?: never; readonly cookie?: never; }; - /** List gist comments */ + /** + * List gist comments + * @description Lists the comments on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ readonly get: operations["gists/list-comments"]; readonly put?: never; - /** Create a gist comment */ + /** + * Create a gist comment + * @description Creates a comment on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ readonly post: operations["gists/create-comment"]; readonly delete?: never; readonly options?: never; @@ -803,7 +890,15 @@ export type paths = { readonly path?: never; readonly cookie?: never; }; - /** Get a gist comment */ + /** + * Get a gist comment + * @description Gets a comment on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ readonly get: operations["gists/get-comment"]; readonly put?: never; readonly post?: never; @@ -811,7 +906,15 @@ export type paths = { readonly delete: operations["gists/delete-comment"]; readonly options?: never; readonly head?: never; - /** Update a gist comment */ + /** + * Update a gist comment + * @description Updates a comment on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ readonly patch: operations["gists/update-comment"]; readonly trace?: never; }; @@ -861,7 +964,7 @@ export type paths = { readonly get: operations["gists/check-is-starred"]; /** * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ readonly put: operations["gists/star"]; readonly post?: never; @@ -879,7 +982,15 @@ export type paths = { readonly path?: never; readonly cookie?: never; }; - /** Get a gist revision */ + /** + * Get a gist revision + * @description Gets a specified gist revision. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ readonly get: operations["gists/get-revision"]; readonly put?: never; readonly post?: never; @@ -918,8 +1029,11 @@ export type paths = { }; /** * Get a gitignore template - * @description The API also allows fetching the source of a single template. - * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. + * @description Get the content of a gitignore template. + * + * 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 .gitignore contents. */ readonly get: operations["gitignore/get-template"]; readonly put?: never; @@ -940,8 +1054,6 @@ export type paths = { /** * List repositories accessible to the app installation * @description List repositories that an app installation can access. - * - * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ readonly get: operations["apps/list-repos-accessible-to-installation"]; readonly put?: never; @@ -967,8 +1079,6 @@ export type paths = { * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. - * - * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ readonly delete: operations["apps/revoke-installation-access-token"]; readonly options?: never; @@ -989,11 +1099,17 @@ export type paths = { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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"]; readonly put?: never; @@ -1294,7 +1410,11 @@ export type paths = { readonly get: operations["activity/get-thread"]; readonly put?: never; readonly post?: never; - readonly delete?: never; + /** + * Mark a thread as done + * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications. + */ + readonly delete: operations["activity/mark-thread-as-done"]; readonly options?: never; readonly head?: never; /** @@ -1367,7 +1487,7 @@ export type paths = { }; /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub. + * @description Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -1389,9 +1509,26 @@ export type paths = { }; /** * Get an organization - * @description To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * @description Gets information about an organization. + * + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * + * To see the full details about an organization, the authenticated user must be an organization owner. + * + * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: * - * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + * + * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. */ readonly get: operations["orgs/get"]; readonly put?: never; @@ -1413,7 +1550,22 @@ export type paths = { * Update an organization * @description **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. + * Updates the organization's profile and member privileges. + * + * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * + * The authenticated user must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ readonly patch: operations["orgs/update"]; readonly trace?: never; @@ -1429,7 +1581,8 @@ export type paths = { * Get GitHub Actions cache usage for an organization * @description Gets the total GitHub Actions cache usage for an organization. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ readonly get: operations["actions/get-actions-cache-usage-for-org"]; readonly put?: never; @@ -1451,7 +1604,8 @@ export type paths = { * List repositories with GitHub Actions cache usage for an organization * @description Lists repositories and their GitHub Actions cache usage for an organization. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ readonly get: operations["actions/get-actions-cache-usage-by-repo-for-org"]; readonly put?: never; @@ -1472,15 +1626,15 @@ export type paths = { /** * Get the customization template for an OIDC subject claim for an organization * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. - * GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ readonly get: operations["oidc/get-oidc-custom-sub-template-for-org"]; /** * Set the customization template for an OIDC subject claim for an organization * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `write:org` scope to use this endpoint. - * GitHub Apps must have the `admin:org` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ readonly put: operations["oidc/update-oidc-custom-sub-template-for-org"]; readonly post?: never; @@ -1501,14 +1655,14 @@ export type paths = { * Get GitHub Actions permissions for an organization * @description Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["actions/get-github-actions-permissions-organization"]; /** * Set GitHub Actions permissions for an organization * @description Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["actions/set-github-actions-permissions-organization"]; readonly post?: never; @@ -1529,14 +1683,15 @@ export type paths = { * List selected repositories enabled for GitHub Actions in an organization * @description Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; /** * Set selected repositories enabled for GitHub Actions in an organization * @description Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; readonly post?: never; @@ -1558,7 +1713,7 @@ export type paths = { * Enable a selected repository for GitHub Actions in an organization * @description Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["actions/enable-selected-repository-github-actions-organization"]; readonly post?: never; @@ -1566,7 +1721,7 @@ export type paths = { * Disable a selected repository for GitHub Actions in an organization * @description Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["actions/disable-selected-repository-github-actions-organization"]; readonly options?: never; @@ -1583,16 +1738,16 @@ export type paths = { }; /** * Get allowed actions and reusable workflows for an organization - * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["actions/get-allowed-actions-organization"]; /** * Set allowed actions and reusable workflows for an organization * @description Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["actions/set-allowed-actions-organization"]; readonly post?: never; @@ -1615,7 +1770,7 @@ export type paths = { * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; /** @@ -1624,7 +1779,7 @@ export type paths = { * can submit approving pull request reviews. For more information, see * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; readonly post?: never; @@ -1645,10 +1800,9 @@ export type paths = { * List self-hosted runners for an organization * @description Lists all self-hosted runners configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/list-self-hosted-runners-for-org"]; readonly put?: never; @@ -1670,10 +1824,9 @@ export type paths = { * List runner applications for an organization * @description Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/list-runner-applications-for-org"]; readonly put?: never; @@ -1697,10 +1850,9 @@ export type paths = { * Create configuration for a just-in-time runner for an organization * @description Generates a configuration that can be passed to the runner application at startup. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * The authenticated user must have admin access to the organization. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/generate-runner-jitconfig-for-org"]; readonly delete?: never; @@ -1722,18 +1874,15 @@ export type paths = { * Create a registration token for an organization * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - * - * Example using registration token: - * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * * ``` * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` + * + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/create-registration-token-for-org"]; readonly delete?: never; @@ -1755,19 +1904,15 @@ export type paths = { * Create a remove token for an organization * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - * - * Example using remove token: - * - * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this - * endpoint. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * * ``` * ./config.sh remove --token TOKEN * ``` + * + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/create-remove-token-for-org"]; readonly delete?: never; @@ -1787,10 +1932,9 @@ export type paths = { * Get a self-hosted runner for an organization * @description Gets a specific self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/get-self-hosted-runner-for-org"]; readonly put?: never; @@ -1799,10 +1943,9 @@ export type paths = { * Delete a self-hosted runner from an organization * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-self-hosted-runner-from-org"]; readonly options?: never; @@ -1821,10 +1964,9 @@ export type paths = { * List labels for a self-hosted runner for an organization * @description Lists all labels for a self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; /** @@ -1832,20 +1974,18 @@ export type paths = { * @description Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; /** * Add custom labels to a self-hosted runner for an organization - * @description Add custom labels to a self-hosted runner configured in an organization. + * @description Adds custom labels to a self-hosted runner configured in an organization. + * + * Authenticated users must have admin access to the organization to use this endpoint. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; /** @@ -1853,10 +1993,9 @@ export type paths = { * @description Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; readonly options?: never; @@ -1882,10 +2021,9 @@ export type paths = { * This endpoint returns a `404 Not Found` status if the custom label is not * present on the runner. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; readonly options?: never; @@ -1905,10 +2043,9 @@ export type paths = { * @description Lists all secrets available in an organization without revealing their * encrypted values. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/list-org-secrets"]; readonly put?: never; @@ -1931,10 +2068,9 @@ export type paths = { * @description Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-org-public-key"]; readonly put?: never; @@ -1956,10 +2092,9 @@ export type paths = { * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-org-secret"]; /** @@ -1967,10 +2102,9 @@ export type paths = { * @description Creates or updates an organization secret with an encrypted value. 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)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/create-or-update-org-secret"]; readonly post?: never; @@ -1978,10 +2112,9 @@ export type paths = { * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-org-secret"]; readonly options?: never; @@ -2001,10 +2134,9 @@ export type paths = { * @description Lists all repositories that have been selected when the `visibility` * for repository access to a secret is set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/list-selected-repos-for-org-secret"]; /** @@ -2013,10 +2145,9 @@ export type paths = { * for repository access is set to `selected`. The visibility is set when you [Create * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly put: operations["actions/set-selected-repos-for-org-secret"]; readonly post?: never; @@ -2037,13 +2168,12 @@ export type paths = { /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or + * repository access is set to `selected`. For more information about setting the visibility, see [Create or * update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/add-selected-repo-to-org-secret"]; readonly post?: never; @@ -2053,10 +2183,9 @@ export type paths = { * for repository access is set to `selected`. The visibility is set when you [Create * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly delete: operations["actions/remove-selected-repo-from-org-secret"]; readonly options?: never; @@ -2074,7 +2203,10 @@ export type paths = { /** * List organization variables * @description Lists all organization variables. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/list-org-variables"]; readonly put?: never; @@ -2082,10 +2214,9 @@ export type paths = { * Create an organization variable * @description Creates an organization variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/create-org-variable"]; readonly delete?: never; @@ -2105,10 +2236,9 @@ export type paths = { * Get an organization variable * @description Gets a specific variable in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-org-variable"]; readonly put?: never; @@ -2117,10 +2247,9 @@ export type paths = { * Delete an organization variable * @description Deletes an organization variable using the variable name. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-org-variable"]; readonly options?: never; @@ -2129,10 +2258,9 @@ export type paths = { * Update an organization variable * @description Updates an organization variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly patch: operations["actions/update-org-variable"]; readonly trace?: never; @@ -2149,10 +2277,9 @@ export type paths = { * @description Lists all repositories that can access an organization variable * that is available to selected repositories. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/list-selected-repos-for-org-variable"]; /** @@ -2161,11 +2288,9 @@ export type paths = { * to selected repositories. Organization variables that are available to selected * repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this - * endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly put: operations["actions/set-selected-repos-for-org-variable"]; readonly post?: never; @@ -2188,10 +2313,9 @@ export type paths = { * @description Adds a repository to an organization variable that is available to selected repositories. * Organization variables that are available to selected repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/add-selected-repo-to-org-variable"]; readonly post?: never; @@ -2201,10 +2325,9 @@ export type paths = { * available to selected repositories. Organization variables that are available to * selected repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly delete: operations["actions/remove-selected-repo-from-org-variable"]; readonly options?: never; @@ -2271,9 +2394,9 @@ export type paths = { * List code scanning alerts for an organization * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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)." * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * For public repositories, you may instead use the `public_repo` scope. + * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope 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/list-alerts-for-org"]; readonly put?: never; @@ -2295,7 +2418,7 @@ export type paths = { * List codespaces for the organization * @description Lists the codespaces associated to a specified organization. * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["codespaces/list-in-organization"]; readonly put?: never; @@ -2318,7 +2441,7 @@ export type paths = { * Manage access control for organization codespaces * @deprecated * @description Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["codespaces/set-codespaces-access"]; readonly post?: never; @@ -2345,7 +2468,7 @@ export type paths = { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly post: operations["codespaces/set-codespaces-access-users"]; /** @@ -2356,7 +2479,7 @@ export type paths = { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["codespaces/delete-codespaces-access-users"]; readonly options?: never; @@ -2373,8 +2496,10 @@ export type paths = { }; /** * List organization secrets - * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Lists all Codespaces development environment secrets 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["codespaces/list-org-secrets"]; readonly put?: never; @@ -2394,7 +2519,8 @@ export type paths = { }; /** * Get an organization public key - * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["codespaces/get-org-public-key"]; readonly put?: never; @@ -2415,7 +2541,8 @@ export type paths = { /** * Get an organization secret * @description Gets an organization development environment secret without revealing its encrypted value. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["codespaces/get-org-secret"]; /** @@ -2423,14 +2550,15 @@ export type paths = { * @description Creates or updates an organization development environment secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["codespaces/create-or-update-org-secret"]; readonly post?: never; /** * Delete an organization secret - * @description Deletes an organization development environment secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Deletes an organization development environment secret using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["codespaces/delete-org-secret"]; readonly options?: never; @@ -2447,12 +2575,19 @@ export type paths = { }; /** * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Lists all repositories that have been selected when the `visibility` + * for repository access to a secret is set to `selected`. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["codespaces/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Replaces all repositories for an organization development environment secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["codespaces/set-selected-repos-for-org-secret"]; readonly post?: never; @@ -2472,13 +2607,18 @@ export type paths = { readonly get?: never; /** * Add selected repository to an organization secret - * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["codespaces/add-selected-repo-to-org-secret"]; readonly post?: never; /** * Remove selected repository from an organization secret - * @description Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Removes a repository from an organization development environment secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["codespaces/remove-selected-repo-from-org-secret"]; readonly options?: never; @@ -2494,15 +2634,16 @@ export type paths = { readonly cookie?: never; }; /** - * Get Copilot Business seat information and settings for an organization + * Get Copilot seat information and settings for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets information about an organization's Copilot Business subscription, including seat breakdown + * Gets information about an organization's Copilot subscription, including seat breakdown * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * + * Only organization owners can configure and view details about the organization's Copilot Business subscription. * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ readonly get: operations["copilot/get-copilot-organization-details"]; readonly put?: never; @@ -2521,13 +2662,14 @@ export type paths = { readonly cookie?: never; }; /** - * List all Copilot Business seat assignments for an organization + * List all Copilot seat assignments for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ readonly get: operations["copilot/list-copilot-seats"]; readonly put?: never; @@ -2548,33 +2690,35 @@ export type paths = { readonly get?: never; readonly put?: never; /** - * Add teams to the Copilot Business subscription for an organization + * Add teams to the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot Business seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + * Purchases a GitHub Copilot seat for all users within each specified team. + * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * + * Only organization owners can configure GitHub Copilot in their organization. * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * 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. + * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * - * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ - readonly post: operations["copilot/add-copilot-for-business-seats-for-teams"]; + readonly post: operations["copilot/add-copilot-seats-for-teams"]; /** - * Remove teams from the Copilot Business subscription for an organization + * Remove teams from the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot Business seat assignment for all members of each team specified. + * Cancels the Copilot seat assignment for all members of each team specified. * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can configure GitHub Copilot in their organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ readonly delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; readonly options?: never; @@ -2592,33 +2736,35 @@ export type paths = { readonly get?: never; readonly put?: never; /** - * Add users to the Copilot Business subscription for an organization + * Add users to the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot Business seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + * Purchases a GitHub Copilot seat for each user specified. + * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * + * Only organization owners can configure GitHub Copilot in their organization. * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * 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. + * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * - * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ - readonly post: operations["copilot/add-copilot-for-business-seats-for-users"]; + readonly post: operations["copilot/add-copilot-seats-for-users"]; /** - * Remove users from the Copilot Business subscription for an organization + * Remove users from the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot Business seat assignment for each user specified. + * Cancels the Copilot seat assignment for each user specified. * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)" + * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can configure GitHub Copilot in their organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ readonly delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; readonly options?: never; @@ -2626,6 +2772,39 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/copilot/usage": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a summary of Copilot usage for organization members + * @description **Note**: This endpoint is in beta 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 + * across an organization, 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 the prior 28 days. 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. + * + * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view + * Copilot usage metrics. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + */ + readonly get: operations["copilot/usage-metrics-for-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}/dependabot/alerts": { readonly parameters: { readonly query?: never; @@ -2637,11 +2816,9 @@ export type paths = { * List Dependabot alerts for an organization * @description Lists Dependabot alerts for an organization. * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * For public repositories, you may instead use the `public_repo` scope. - * - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `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["dependabot/list-alerts-for-org"]; readonly put?: never; @@ -2661,7 +2838,10 @@ export type paths = { }; /** * List organization secrets - * @description Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Lists all secrets available in an organization 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["dependabot/list-org-secrets"]; readonly put?: never; @@ -2681,7 +2861,10 @@ export type paths = { }; /** * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["dependabot/get-org-public-key"]; readonly put?: never; @@ -2701,7 +2884,9 @@ export type paths = { }; /** * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Gets a single organization secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["dependabot/get-org-secret"]; /** @@ -2709,15 +2894,15 @@ export type paths = { * @description Creates or updates an organization secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - * permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["dependabot/create-or-update-org-secret"]; readonly post?: never; /** * Delete an organization secret - * @description Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Deletes a secret in an organization using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["dependabot/delete-org-secret"]; readonly options?: never; @@ -2734,12 +2919,19 @@ export type paths = { }; /** * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Lists all repositories that have been selected when the `visibility` + * for repository access to a secret is set to `selected`. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["dependabot/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Replaces all repositories for an organization secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["dependabot/set-selected-repos-for-org-secret"]; readonly post?: never; @@ -2759,13 +2951,21 @@ export type paths = { readonly get?: never; /** * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Adds a repository to an organization secret when the `visibility` for + * repository access is set to `selected`. The visibility is set when you [Create or + * update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["dependabot/add-selected-repo-to-org-secret"]; readonly post?: never; /** * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Removes a repository from an organization secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["dependabot/remove-selected-repo-from-org-secret"]; readonly options?: never; @@ -2783,7 +2983,8 @@ export type paths = { /** * Get list of conflicting packages during Docker migration for organization * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ readonly get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; readonly put?: never; @@ -2838,12 +3039,23 @@ export type paths = { readonly path?: never; readonly cookie?: never; }; - /** List organization webhooks */ + /** + * List organization webhooks + * @description You 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. + */ readonly get: operations["orgs/list-webhooks"]; readonly put?: never; /** * Create an organization webhook - * @description Here's how you can create a hook that posts payloads in JSON format: + * @description Create a hook that posts payloads in JSON format. + * + * You 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. */ readonly post: operations["orgs/create-webhook"]; readonly delete?: never; @@ -2861,18 +3073,39 @@ export type paths = { }; /** * Get an organization webhook - * @description Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)." + * @description Returns a webhook configured in an organization. To get only the webhook + * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + * + * You 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. */ readonly get: operations["orgs/get-webhook"]; readonly put?: never; readonly post?: never; - /** Delete an organization webhook */ + /** + * Delete an organization webhook + * @description You 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. + */ readonly delete: operations["orgs/delete-webhook"]; readonly options?: never; readonly head?: never; /** * Update an organization webhook - * @description Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)." + * @description Updates a webhook configured in an organization. When you update a webhook, + * the `secret` will be overwritten. If you previously had a `secret` set, you must + * provide the same `secret` or set a new `secret` or the secret will be removed. If + * you are only updating individual webhook `config` properties, use "[Update a webhook + * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". + * + * You 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. */ readonly patch: operations["orgs/update-webhook"]; readonly trace?: never; @@ -2888,7 +3121,10 @@ export type paths = { * Get a webhook configuration for an organization * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." * - * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + * You 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. */ readonly get: operations["orgs/get-webhook-config-for-org"]; readonly put?: never; @@ -2900,7 +3136,10 @@ export type paths = { * Update a webhook configuration for an organization * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." * - * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + * You 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. */ readonly patch: operations["orgs/update-webhook-config-for-org"]; readonly trace?: never; @@ -2915,6 +3154,11 @@ export type paths = { /** * List deliveries for an organization webhook * @description Returns a list of webhook deliveries for a webhook configured in an organization. + * + * You 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. */ readonly get: operations["orgs/list-webhook-deliveries"]; readonly put?: never; @@ -2935,6 +3179,11 @@ export type paths = { /** * Get a webhook delivery for an organization webhook * @description Returns a delivery for a webhook configured in an organization. + * + * You 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. */ readonly get: operations["orgs/get-webhook-delivery"]; readonly put?: never; @@ -2957,6 +3206,11 @@ export type paths = { /** * Redeliver a delivery for an organization webhook * @description Redeliver a delivery for a webhook configured in an organization. + * + * You 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. */ readonly post: operations["orgs/redeliver-webhook-delivery"]; readonly delete?: never; @@ -2976,7 +3230,13 @@ export type paths = { readonly put?: never; /** * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) + * to be sent to the hook. + * + * You 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. */ readonly post: operations["orgs/ping-webhook"]; readonly delete?: never; @@ -3016,7 +3276,12 @@ export type paths = { }; /** * List app installations for an organization - * @description Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. + * @description Lists all GitHub Apps in an organization. The installation count includes + * all GitHub Apps installed on repositories in the organization. + * + * The authenticated user must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. */ readonly get: operations["orgs/list-app-installations"]; readonly put?: never; @@ -3139,6 +3404,13 @@ export type paths = { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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-for-org"]; readonly put?: never; @@ -3204,7 +3476,7 @@ export type paths = { * List codespaces for a user in organization * @description Lists the codespaces that a member of an organization has for repositories in that organization. * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["codespaces/get-codespaces-for-user-in-org"]; readonly put?: never; @@ -3229,10 +3501,7 @@ export type paths = { * Delete a codespace from the organization * @description Deletes a user's codespace. * - * To use this endpoint you must authenticate using one of the following methods: - * - * - An access token with the `admin:org` scope - * - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["codespaces/delete-from-organization"]; readonly options?: never; @@ -3253,10 +3522,7 @@ export type paths = { * Stop a codespace for an organization user * @description Stops a user's codespace. * - * To use this endpoint you must authenticate using one of the following methods: - * - * - An access token with the `admin:org` scope - * - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly post: operations["codespaces/stop-in-organization"]; readonly delete?: never; @@ -3273,12 +3539,14 @@ export type paths = { readonly cookie?: never; }; /** - * Get Copilot Business seat assignment details for a user + * Get Copilot seat assignment details for a user * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * + * Organization owners can view GitHub Copilot seat assignment details for members in their organization. * - * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ readonly get: operations["copilot/get-copilot-seat-details-for-user"]; readonly put?: never; @@ -3453,9 +3721,7 @@ export type paths = { }; /** * List organization fine-grained permissions for an organization - * @description **Note**: This operation is in beta and subject to change. - * - * Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." * @@ -3464,8 +3730,7 @@ export type paths = { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["orgs/list-organization-fine-grained-permissions"]; readonly put?: never; @@ -3485,33 +3750,27 @@ export type paths = { }; /** * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["orgs/list-org-roles"]; readonly put?: never; /** * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - * - * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly post: operations["orgs/create-custom-organization-role"]; readonly delete?: never; @@ -3532,12 +3791,11 @@ export type paths = { readonly post?: never; /** * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["orgs/revoke-all-org-roles-team"]; readonly options?: never; @@ -3555,22 +3813,21 @@ export type paths = { readonly get?: never; /** * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["orgs/assign-team-to-org-role"]; readonly post?: never; /** * Remove an organization role from a team - * @description Removes an organization role from a team. + * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["orgs/revoke-org-role-team"]; readonly options?: never; @@ -3590,12 +3847,11 @@ export type paths = { readonly post?: never; /** * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["orgs/revoke-all-org-roles-user"]; readonly options?: never; @@ -3613,22 +3869,21 @@ export type paths = { readonly get?: never; /** * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * 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. */ readonly put: operations["orgs/assign-user-to-org-role"]; readonly post?: never; /** * Remove an organization role from a user - * @description Remove an organization role from a user. + * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["orgs/revoke-org-role-user"]; readonly options?: never; @@ -3645,51 +3900,43 @@ export type paths = { }; /** * Get an organization role - * @description Gets an organization role that is available to this organization. + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["orgs/get-org-role"]; readonly put?: never; readonly post?: never; /** * Delete a custom organization role. - * @description Deletes a custom organization role. + * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - * - * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["orgs/delete-custom-organization-role"]; readonly options?: never; readonly head?: never; /** * Update a custom organization role - * @description Updates an existing custom organization role. Permission changes will apply to all assignees. + * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - * - * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly patch: operations["orgs/patch-custom-organization-role"]; readonly trace?: never; @@ -3703,12 +3950,11 @@ export type paths = { }; /** * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read permission to use this endpoint. + * To use this endpoint, you must be an administrator for the organization. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["orgs/list-org-role-teams"]; readonly put?: never; @@ -3728,12 +3974,11 @@ export type paths = { }; /** * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read permission to use this endpoint. + * To use this endpoint, you must be an administrator for the organization. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["orgs/list-org-role-users"]; readonly put?: never; @@ -3799,7 +4044,7 @@ export type paths = { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/list-packages-for-organization"]; readonly put?: never; @@ -3821,7 +4066,7 @@ export type paths = { * Get a package for an organization * @description Gets a specific package in an organization. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-for-organization"]; readonly put?: never; @@ -3830,9 +4075,9 @@ export type paths = { * Delete a package for an organization * @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-for-org"]; readonly options?: never; @@ -3857,9 +4102,9 @@ export type paths = { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-for-org"]; readonly delete?: never; @@ -3879,7 +4124,7 @@ export type paths = { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; readonly put?: never; @@ -3901,7 +4146,7 @@ export type paths = { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-version-for-organization"]; readonly put?: never; @@ -3910,9 +4155,9 @@ export type paths = { * Delete package version for an organization * @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-version-for-org"]; readonly options?: never; @@ -3937,9 +4182,9 @@ export type paths = { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-version-for-org"]; readonly delete?: never; @@ -3957,19 +4202,17 @@ export type paths = { }; /** * List requests to access organization resources with fine-grained personal access tokens - * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: read` permission. + * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly get: operations["orgs/list-pat-grant-requests"]; readonly put?: never; /** * Review requests to access organization resources with fine-grained personal access tokens - * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: write` permission. + * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly post: operations["orgs/review-pat-grant-requests-in-bulk"]; readonly delete?: never; @@ -3989,10 +4232,9 @@ export type paths = { readonly put?: never; /** * Review a request to access organization resources with a fine-grained personal access token - * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: write` permission. + * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly post: operations["orgs/review-pat-grant-request"]; readonly delete?: never; @@ -4010,10 +4252,9 @@ export type paths = { }; /** * List repositories requested to be accessed by a fine-grained personal access token - * @description Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: read` permission. + * @description Lists the repositories a fine-grained personal access token request is requesting access to. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly get: operations["orgs/list-pat-grant-request-repositories"]; readonly put?: never; @@ -4033,19 +4274,17 @@ export type paths = { }; /** * List fine-grained personal access tokens with access to organization resources - * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: read` permission. + * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly get: operations["orgs/list-pat-grants"]; readonly put?: never; /** * Update the access to organization resources via fine-grained personal access tokens - * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: write` permission. + * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly post: operations["orgs/update-pat-accesses"]; readonly delete?: never; @@ -4065,10 +4304,9 @@ export type paths = { readonly put?: never; /** * Update the access a fine-grained personal access token has to organization resources - * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: write` permission. + * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly post: operations["orgs/update-pat-access"]; readonly delete?: never; @@ -4086,10 +4324,9 @@ export type paths = { }; /** * List repositories a fine-grained personal access token has access to - * @description Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: read` permission. + * @description Lists the repositories a fine-grained personal access token has access to. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly get: operations["orgs/list-pat-grant-repositories"]; readonly put?: never; @@ -4134,7 +4371,7 @@ export type paths = { /** * Get all custom properties for an organization * @description Gets all custom properties defined for an organization. - * You must be an organization owner to use this endpoint. + * Organization members can read these properties. */ readonly get: operations["orgs/get-all-custom-properties"]; readonly put?: never; @@ -4145,7 +4382,10 @@ export type paths = { /** * Create or update custom properties for an organization * @description Creates new or updates existing custom properties defined for an organization in a batch. - * Only organization owners (or users with the proper permissions granted by them) can update these properties + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ readonly patch: operations["orgs/create-or-update-custom-properties"]; readonly trace?: never; @@ -4160,20 +4400,26 @@ export type paths = { /** * Get a custom property for an organization * @description Gets a custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * Organization members can read these properties. */ readonly get: operations["orgs/get-custom-property"]; /** * Create or update a custom property for an organization * @description Creates a new or updates an existing custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ readonly put: operations["orgs/create-or-update-custom-property"]; readonly post?: never; /** * Remove a custom property for an organization * @description Removes a custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ readonly delete: operations["orgs/remove-custom-property"]; readonly options?: never; @@ -4208,7 +4454,9 @@ export type paths = { * * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. * - * Only organization owners (or users with the proper permissions granted by them) can update these properties + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. */ readonly patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; readonly trace?: never; @@ -4249,7 +4497,7 @@ export type paths = { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ readonly put: operations["orgs/set-public-membership-for-authenticated-user"]; readonly post?: never; @@ -4282,12 +4530,7 @@ export type paths = { * Create an organization repository * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ readonly post: operations["repos/create-in-org"]; readonly delete?: never; @@ -4400,10 +4643,10 @@ export type paths = { /** * List secret scanning alerts for an organization * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * 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 `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/list-alerts-for-org"]; readonly put?: never; @@ -4425,7 +4668,9 @@ export type paths = { * List repository security advisories for an organization * @description Lists repository security advisories for an organization. * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ readonly get: operations["security-advisories/list-org-repository-advisories"]; readonly put?: never; @@ -4447,9 +4692,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)." * - * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ readonly get: operations["orgs/list-security-manager-teams"]; readonly put?: never; @@ -4472,9 +4717,9 @@ export type paths = { * 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." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ readonly put: operations["orgs/add-security-manager-team"]; readonly post?: never; @@ -4482,9 +4727,9 @@ export type paths = { * 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." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["orgs/remove-security-manager-team"]; readonly options?: never; @@ -4505,7 +4750,7 @@ export type paths = { * * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ readonly get: operations["billing/get-github-actions-billing-org"]; readonly put?: never; @@ -4529,7 +4774,7 @@ export type paths = { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ readonly get: operations["billing/get-github-packages-billing-org"]; readonly put?: never; @@ -4553,7 +4798,7 @@ export type paths = { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ readonly get: operations["billing/get-shared-storage-billing-org"]; readonly put?: never; @@ -4564,6 +4809,41 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/team/{team_slug}/copilot/usage": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a summary of Copilot usage for a team + * @description **Note**: This endpoint is in beta 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 a 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 the prior 28 days. 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 team had five or more members on that day. + * + * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, + * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + */ + readonly get: operations["copilot/usage-metrics-for-team"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/teams": { readonly parameters: { readonly query?: never; @@ -4635,19 +4915,23 @@ export type paths = { }; /** * List discussions - * @description List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List all discussions on a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/list-discussions-in-org"]; readonly put?: never; /** * Create a discussion - * @description Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Creates a new discussion post on a team's page. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["teams/create-discussion-in-org"]; readonly delete?: never; @@ -4665,27 +4949,33 @@ export type paths = { }; /** * Get a discussion - * @description Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Get a specific discussion on a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/get-discussion-in-org"]; readonly put?: never; readonly post?: never; /** * Delete a discussion - * @description Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Delete a discussion from a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly delete: operations["teams/delete-discussion-in-org"]; readonly options?: never; readonly head?: never; /** * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly patch: operations["teams/update-discussion-in-org"]; readonly trace?: never; @@ -4699,19 +4989,23 @@ export type paths = { }; /** * List discussion comments - * @description List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List all comments on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/list-discussion-comments-in-org"]; readonly put?: never; /** * Create a discussion comment - * @description Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Creates a new comment on a team discussion. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["teams/create-discussion-comment-in-org"]; readonly delete?: never; @@ -4729,27 +5023,33 @@ export type paths = { }; /** * Get a discussion comment - * @description Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Get a specific comment on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/get-discussion-comment-in-org"]; readonly put?: never; readonly post?: never; /** * Delete a discussion comment - * @description Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Deletes a comment on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly delete: operations["teams/delete-discussion-comment-in-org"]; readonly options?: never; readonly head?: never; /** * Update a discussion comment - * @description Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Edits the body text of a discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly patch: operations["teams/update-discussion-comment-in-org"]; readonly trace?: never; @@ -4763,17 +5063,23 @@ export type paths = { }; /** * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["reactions/list-for-team-discussion-comment-in-org"]; readonly put?: never; /** * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["reactions/create-for-team-discussion-comment-in-org"]; readonly delete?: never; @@ -4796,7 +5102,9 @@ export type paths = { * Delete team discussion comment reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly delete: operations["reactions/delete-for-team-discussion-comment"]; readonly options?: never; @@ -4813,17 +5121,23 @@ export type paths = { }; /** * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["reactions/list-for-team-discussion-in-org"]; readonly put?: never; /** * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["reactions/create-for-team-discussion-in-org"]; readonly delete?: never; @@ -4846,7 +5160,9 @@ export type paths = { * Delete team discussion reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly delete: operations["reactions/delete-for-team-discussion"]; readonly options?: never; @@ -5044,14 +5360,14 @@ export type paths = { * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * - * If the repository is private, you must have at least `read` permission for that repository and your token must have the `repo` scope. Otherwise, you will receive a `404 Not Found` response status. + * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ readonly get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions - * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * @@ -5104,14 +5420,11 @@ export type paths = { readonly put?: never; /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. - * - * To use this endpoint, you must be an organization owner or be member of a team with the security manager role. - * A token with the 'write:org' scope is also required. + * @description Enables or disables the specified security feature for all eligible repositories in 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)." * - * GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * 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)." + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ readonly post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; readonly delete?: never; @@ -5354,7 +5667,7 @@ export type paths = { * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." @@ -5392,10 +5705,12 @@ export type paths = { readonly post?: never; /** * Delete a repository - * @description Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + * @description Deleting a repository requires admin access. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. + * + * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. */ readonly delete: operations["repos/delete"]; readonly options?: never; @@ -5416,7 +5731,11 @@ export type paths = { }; /** * List artifacts for a repository - * @description Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Lists all artifacts for a repository. + * + * 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. */ readonly get: operations["actions/list-artifacts-for-repo"]; readonly put?: never; @@ -5436,14 +5755,19 @@ export type paths = { }; /** * Get an artifact - * @description Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific artifact for a workflow run. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-artifact"]; readonly put?: never; readonly post?: never; /** * Delete an artifact - * @description Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * @description Deletes an artifact for a workflow run. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-artifact"]; readonly options?: never; @@ -5463,8 +5787,7 @@ export type paths = { * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/download-artifact"]; readonly put?: never; @@ -5486,7 +5809,10 @@ export type paths = { * Get GitHub Actions cache usage for a repository * @description Gets GitHub Actions cache usage for a repository. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-actions-cache-usage"]; readonly put?: never; @@ -5507,8 +5833,8 @@ export type paths = { /** * List GitHub Actions caches for a repository * @description Lists the GitHub Actions caches for a repository. - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-actions-cache-list"]; readonly put?: never; @@ -5517,9 +5843,7 @@ export type paths = { * Delete GitHub Actions caches for a repository (using a cache key) * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-actions-cache-by-key"]; readonly options?: never; @@ -5541,9 +5865,7 @@ export type paths = { * Delete a GitHub Actions cache for a repository (using a cache ID) * @description Deletes a GitHub Actions cache for a repository, using a cache ID. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-actions-cache-by-id"]; readonly options?: never; @@ -5560,7 +5882,11 @@ export type paths = { }; /** * Get a job for a workflow run - * @description Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific job in a workflow run. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-job-for-workflow-run"]; readonly put?: never; @@ -5581,9 +5907,11 @@ export type paths = { /** * Download job logs for a workflow run * @description Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look - * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can - * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must - * have the `actions:read` permission to use this endpoint. + * for `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/download-job-logs-for-workflow-run"]; readonly put?: never; @@ -5607,8 +5935,7 @@ export type paths = { * Re-run a job from a workflow run * @description Re-run a job and its dependent jobs in a workflow run. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/re-run-job-for-workflow-run"]; readonly delete?: never; @@ -5627,15 +5954,15 @@ export type paths = { /** * Get the customization template for an OIDC subject claim for a repository * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-custom-oidc-sub-claim-for-repo"]; /** * Set the customization template for an OIDC subject claim for a repository * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/set-custom-oidc-sub-claim-for-repo"]; readonly post?: never; @@ -5657,9 +5984,9 @@ export type paths = { * @description Lists all organization secrets shared with a repository without revealing their encrypted * values. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/list-repo-organization-secrets"]; readonly put?: never; @@ -5679,11 +6006,11 @@ export type paths = { }; /** * List repository organization variables - * @description Lists all organiation variables shared with a repository. + * @description Lists all organization variables shared with a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/list-repo-organization-variables"]; readonly put?: never; @@ -5705,14 +6032,14 @@ export type paths = { * Get GitHub Actions permissions for a repository * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-github-actions-permissions-repository"]; /** * Set GitHub Actions permissions for a repository * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/set-github-actions-permissions-repository"]; readonly post?: never; @@ -5735,8 +6062,7 @@ export type paths = { * This endpoint only applies to private repositories. * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - * repository `administration` permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-workflow-access-to-repository"]; /** @@ -5745,8 +6071,7 @@ export type paths = { * This endpoint only applies to private repositories. * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - * repository `administration` permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/set-workflow-access-to-repository"]; readonly post?: never; @@ -5767,14 +6092,14 @@ export type paths = { * Get allowed actions and reusable workflows for a repository * @description Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-allowed-actions-repository"]; /** * Set allowed actions and reusable workflows for a repository * @description Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/set-allowed-actions-repository"]; readonly post?: never; @@ -5797,7 +6122,7 @@ export type paths = { * as well as if GitHub Actions can submit approving pull request reviews. * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-github-actions-default-workflow-permissions-repository"]; /** @@ -5806,7 +6131,7 @@ export type paths = { * can submit approving pull request reviews. * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/set-github-actions-default-workflow-permissions-repository"]; readonly post?: never; @@ -5827,9 +6152,9 @@ export type paths = { * List self-hosted runners for a repository * @description Lists all self-hosted runners configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/list-self-hosted-runners-for-repo"]; readonly put?: never; @@ -5851,9 +6176,9 @@ export type paths = { * List runner applications for a repository * @description Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/list-runner-applications-for-repo"]; readonly put?: never; @@ -5877,9 +6202,9 @@ export type paths = { * Create configuration for a just-in-time runner for a repository * @description Generates a configuration that can be passed to the runner application at startup. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * The authenticated user must have admin access to the repository. + * + * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. */ readonly post: operations["actions/generate-runner-jitconfig-for-repo"]; readonly delete?: never; @@ -5899,19 +6224,17 @@ export type paths = { readonly put?: never; /** * Create a registration token for a repository - * @description Returns a token that you can pass to the `config` script. The token - * expires after one hour. + * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * Example using registration token: + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided - * by this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/create-registration-token-for-repo"]; readonly delete?: never; @@ -5931,19 +6254,17 @@ export type paths = { readonly put?: never; /** * Create a remove token for a repository - * @description Returns a token that you can pass to remove a self-hosted runner from - * a repository. The token expires after one hour. + * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * Example using remove token: + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * To remove your self-hosted runner from a repository, replace TOKEN with - * the remove token provided by this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * ```config.sh remove --token TOKEN``` + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/create-remove-token-for-repo"]; readonly delete?: never; @@ -5963,9 +6284,9 @@ export type paths = { * Get a self-hosted runner for a repository * @description Gets a specific self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-self-hosted-runner-for-repo"]; readonly put?: never; @@ -5974,9 +6295,9 @@ export type paths = { * Delete a self-hosted runner from a repository * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-self-hosted-runner-from-repo"]; readonly options?: never; @@ -5995,9 +6316,9 @@ export type paths = { * List labels for a self-hosted runner for a repository * @description Lists all labels for a self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; /** @@ -6005,18 +6326,18 @@ export type paths = { * @description Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; /** * Add custom labels to a self-hosted runner for a repository - * @description Add custom labels to a self-hosted runner configured in a repository. + * @description Adds custom labels to a self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; /** @@ -6024,9 +6345,9 @@ export type paths = { * @description Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; readonly options?: never; @@ -6052,9 +6373,9 @@ export type paths = { * This endpoint returns a `404 Not Found` status if the custom label is not * present on the runner. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; readonly options?: never; @@ -6071,9 +6392,13 @@ export type paths = { }; /** * List workflow runs for a repository - * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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 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`. */ readonly get: operations["actions/list-workflow-runs-for-repo"]; readonly put?: never; @@ -6093,16 +6418,22 @@ export type paths = { }; /** * Get a workflow run - * @description Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific workflow run. + * + * 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. */ readonly get: operations["actions/get-workflow-run"]; readonly put?: never; readonly post?: never; /** * Delete a workflow run - * @description Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is - * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use - * this endpoint. + * @description Deletes a specific workflow run. + * + * Anyone with write access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-workflow-run"]; readonly options?: never; @@ -6119,7 +6450,9 @@ export type paths = { }; /** * Get the review history for a workflow run - * @description Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description 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. */ readonly get: operations["actions/get-reviews-for-run"]; readonly put?: never; @@ -6143,7 +6476,7 @@ export type paths = { * Approve a workflow run for a fork pull request * @description Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/approve-workflow-run"]; readonly delete?: never; @@ -6161,7 +6494,11 @@ export type paths = { }; /** * List workflow run artifacts - * @description Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Lists artifacts for a workflow run. + * + * 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. */ readonly get: operations["actions/list-workflow-run-artifacts"]; readonly put?: never; @@ -6181,10 +6518,11 @@ export type paths = { }; /** * Get a workflow run attempt - * @description Gets a specific workflow run attempt. Anyone with read access to the repository - * can use this endpoint. If the repository is private you must use an access token - * with the `repo` scope. GitHub Apps must have the `actions:read` permission to - * use this endpoint. + * @description Gets a specific workflow run attempt. + * + * 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. */ readonly get: operations["actions/get-workflow-run-attempt"]; readonly put?: never; @@ -6204,7 +6542,12 @@ export type paths = { }; /** * List jobs for a workflow run attempt - * @description Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information + * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + * + * 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. */ readonly get: operations["actions/list-jobs-for-workflow-run-attempt"]; readonly put?: never; @@ -6225,9 +6568,11 @@ export type paths = { /** * Download workflow run attempt logs * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to - * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * 1 minute. Look for `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/download-workflow-run-attempt-logs"]; readonly put?: never; @@ -6251,8 +6596,7 @@ export type paths = { * Cancel a workflow run * @description Cancels a workflow run using its `id`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/cancel-workflow-run"]; readonly delete?: never; @@ -6277,8 +6621,7 @@ export type paths = { * **Note:** GitHub Apps can only review their own custom deployment protection rules. * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have read and write permission for **Deployments** to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ readonly post: operations["actions/review-custom-gates-for-run"]; readonly delete?: never; @@ -6301,8 +6644,7 @@ export type paths = { * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/force-cancel-workflow-run"]; readonly delete?: never; @@ -6320,7 +6662,12 @@ export type paths = { }; /** * List jobs for a workflow run - * @description Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information + * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + * + * 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. */ readonly get: operations["actions/list-jobs-for-workflow-run"]; readonly put?: never; @@ -6341,16 +6688,20 @@ export type paths = { /** * Download workflow run logs * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use - * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have - * the `actions:read` permission to use this endpoint. + * `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/download-workflow-run-logs"]; readonly put?: never; readonly post?: never; /** * Delete workflow run logs - * @description Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * @description Deletes all logs for a workflow run. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-workflow-run-logs"]; readonly options?: never; @@ -6369,7 +6720,9 @@ export type paths = { * Get pending deployments for a workflow run * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-pending-deployments-for-run"]; readonly put?: never; @@ -6377,7 +6730,9 @@ export type paths = { * Review pending deployments for a workflow run * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint. + * Required reviewers with read access to the repository contents and deployments can use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/review-pending-deployments-for-run"]; readonly delete?: never; @@ -6397,7 +6752,9 @@ export type paths = { readonly put?: never; /** * Re-run a workflow - * @description Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * @description Re-runs your workflow run using its `id`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/re-run-workflow"]; readonly delete?: never; @@ -6417,7 +6774,9 @@ export type paths = { readonly put?: never; /** * Re-run failed jobs from a workflow run - * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. + * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/re-run-workflow-failed-jobs"]; readonly delete?: never; @@ -6437,7 +6796,9 @@ export type paths = { * Get workflow run usage * @description Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ readonly get: operations["actions/get-workflow-run-usage"]; readonly put?: never; @@ -6460,9 +6821,9 @@ export type paths = { * @description Lists all secrets available in a repository without revealing their encrypted * values. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/list-repo-secrets"]; readonly put?: never; @@ -6486,9 +6847,8 @@ export type paths = { * encrypt a secret before you can create or update secrets. * * Anyone with read access to the repository can use this endpoint. - * If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-repo-public-key"]; readonly put?: never; @@ -6510,9 +6870,9 @@ export type paths = { * Get a repository secret * @description Gets a single repository secret without revealing its encrypted value. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-repo-secret"]; /** @@ -6520,9 +6880,9 @@ export type paths = { * @description Creates or updates a repository secret with an encrypted value. 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)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/create-or-update-repo-secret"]; readonly post?: never; @@ -6530,9 +6890,9 @@ export type paths = { * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-repo-secret"]; readonly options?: never; @@ -6550,9 +6910,10 @@ export type paths = { /** * List repository variables * @description Lists all repository variables. - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + * * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/list-repo-variables"]; readonly put?: never; @@ -6560,9 +6921,9 @@ export type paths = { * Create a repository variable * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/create-repo-variable"]; readonly delete?: never; @@ -6582,9 +6943,9 @@ export type paths = { * Get a repository variable * @description Gets a specific variable in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-repo-variable"]; readonly put?: never; @@ -6593,9 +6954,9 @@ export type paths = { * Delete a repository variable * @description Deletes a repository variable using the variable name. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-repo-variable"]; readonly options?: never; @@ -6604,9 +6965,9 @@ export type paths = { * Update a repository variable * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly patch: operations["actions/update-repo-variable"]; readonly trace?: never; @@ -6620,7 +6981,11 @@ export type paths = { }; /** * List repository workflows - * @description Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Lists the workflows in a repository. + * + * 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. */ readonly get: operations["actions/list-repo-workflows"]; readonly put?: never; @@ -6640,7 +7005,12 @@ export type paths = { }; /** * Get a workflow - * @description Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific workflow. You can replace `workflow_id` with the workflow + * file name. For example, you could use `main.yaml`. + * + * 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. */ readonly get: operations["actions/get-workflow"]; readonly put?: never; @@ -6663,7 +7033,7 @@ export type paths = { * Disable a workflow * @description Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/disable-workflow"]; readonly post?: never; @@ -6688,7 +7058,7 @@ export type paths = { * * You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/create-workflow-dispatch"]; readonly delete?: never; @@ -6709,7 +7079,7 @@ export type paths = { * Enable a workflow * @description Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/enable-workflow"]; readonly post?: never; @@ -6728,9 +7098,11 @@ export type paths = { }; /** * List workflow runs for a workflow - * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + * 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. */ readonly get: operations["actions/list-workflow-runs"]; readonly put?: never; @@ -6752,7 +7124,11 @@ export type paths = { * Get workflow usage * @description Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * 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. */ readonly get: operations["actions/get-workflow-usage"]; readonly put?: never; @@ -6838,8 +7214,8 @@ export type paths = { readonly cookie?: never; }; /** - * List all autolinks of a repository - * @description This returns a list of autolinks configured for the given repository. + * Get all autolinks of a repository + * @description Gets all autolinks that are configured for a repository. * * Information about autolinks are only available to repository administrators. */ @@ -7183,28 +7559,28 @@ export type paths = { * Get apps with access to the protected branch * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ readonly get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * Set app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ readonly put: operations["repos/set-app-access-restrictions"]; /** * Add app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ readonly post: operations["repos/add-app-access-restrictions"]; /** * Remove app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ readonly delete: operations["repos/remove-app-access-restrictions"]; readonly options?: never; @@ -7319,17 +7695,9 @@ export type paths = { * * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". * - * The permissions required to use this endpoint depends on whether you are renaming the default branch. - * - * To rename a non-default branch: - * - * * Users must have push access. - * * GitHub Apps must have the `contents:write` repository permission. + * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * - * To rename the default branch: - * - * * Users must have admin or owner permissions. - * * GitHub Apps must have the `administration:write` repository permission. + * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. */ readonly post: operations["repos/rename-branch"]; readonly delete?: never; @@ -7349,11 +7717,13 @@ export type paths = { readonly put?: never; /** * Create a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Creates a new check run for a specific commit in a repository. * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + * + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ readonly post: operations["checks/create"]; readonly delete?: never; @@ -7371,9 +7741,11 @@ export type paths = { }; /** * Get a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Gets a single check run using its `id`. * - * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ readonly get: operations["checks/get"]; readonly put?: never; @@ -7383,9 +7755,11 @@ export type paths = { readonly head?: never; /** * Update a check run - * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * @description Updates a check run for a specific commit in a repository. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ readonly patch: operations["checks/update"]; readonly trace?: never; @@ -7399,7 +7773,9 @@ export type paths = { }; /** * List check run annotations - * @description Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. + * @description Lists annotations for a check run using the annotation `id`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ readonly get: operations["checks/list-annotations"]; readonly put?: never; @@ -7423,9 +7799,9 @@ export type paths = { * Rerequest a check run * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. - * * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ readonly post: operations["checks/rerequest-run"]; readonly delete?: never; @@ -7445,9 +7821,11 @@ export type paths = { readonly put?: never; /** * Create a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ readonly post: operations["checks/create-suite"]; readonly delete?: never; @@ -7471,7 +7849,8 @@ export type paths = { readonly head?: never; /** * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. + * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). + * You must have admin permissions in the repository to set preferences for check suites. */ readonly patch: operations["checks/set-suites-preferences"]; readonly trace?: never; @@ -7485,9 +7864,11 @@ export type paths = { }; /** * Get a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Gets a single check suite using its `id`. + * + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ readonly get: operations["checks/get-suite"]; readonly put?: never; @@ -7507,9 +7888,11 @@ export type paths = { }; /** * List check runs in a check suite - * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * @description Lists check runs for a check suite using its `id`. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ readonly get: operations["checks/list-for-suite"]; readonly put?: never; @@ -7533,7 +7916,7 @@ export type paths = { * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ readonly post: operations["checks/rerequest-suite"]; readonly delete?: never; @@ -7553,11 +7936,11 @@ export type paths = { * List code scanning alerts for a repository * @description Lists code scanning alerts. * - * To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. - * * The response includes a `most_recent_instance` object. * This provides details of the most recent instance of this alert * for the default branch (or for the specified Git reference if you used `ref` in the request). + * + * 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/list-alerts-for-repo"]; readonly put?: never; @@ -7577,7 +7960,9 @@ export type paths = { }; /** * Get a code scanning alert - * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. + * @description Gets a single 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-alert"]; readonly put?: never; @@ -7587,7 +7972,8 @@ export type paths = { readonly head?: never; /** * Update a code scanning alert - * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. + * @description Updates the status of a single 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 patch: operations["code-scanning/update-alert"]; readonly trace?: never; @@ -7602,8 +7988,8 @@ export type paths = { /** * List instances of a code scanning alert * @description Lists all instances of the specified code scanning alert. - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. + * + * 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/list-alert-instances"]; readonly put?: never; @@ -7634,11 +8020,10 @@ export type paths = { * For very old analyses this data is not available, * and `0` is returned in this field. * - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. - * * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * + * 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/list-recent-analyses"]; readonly put?: never; @@ -7659,8 +8044,6 @@ export type paths = { /** * Get a code scanning analysis for a repository * @description Gets a specified code scanning analysis for a repository. - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. * * The default JSON response contains fields that describe the analysis. * This includes the Git reference and commit SHA to which the analysis relates, @@ -7672,20 +8055,18 @@ export type paths = { * For very old analyses this data is not available, * and `0` is returned in this field. * - * If you use the Accept header `application/sarif+json`, - * the response contains the analysis data that was uploaded. - * This is formatted as - * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + * 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/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + * + * 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-analysis"]; readonly put?: never; readonly post?: never; /** * Delete a code scanning analysis from a repository - * @description Deletes a specified code scanning analysis from a repository. For - * private repositories, you must use an access token with the `repo` scope. For public repositories, - * you must use an access token with `public_repo` scope. - * GitHub Apps must have the `security_events` write permission to use this endpoint. + * @description Deletes a specified code scanning analysis from a repository. * * You can delete one analysis at a time. * To delete a series of analyses, start with the most recent analysis and work backwards. @@ -7747,6 +8128,8 @@ export type paths = { * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + * + * 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 delete: operations["code-scanning/delete-analysis"]; readonly options?: never; @@ -7765,8 +8148,7 @@ export type paths = { * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * For private repositories, you must use an access token with the `security_events` scope. - * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + * 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/list-codeql-databases"]; readonly put?: never; @@ -7794,8 +8176,7 @@ export type paths = { * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * For private repositories, you must use an access token with the `security_events` scope. - * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + * 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-codeql-database"]; readonly put?: never; @@ -7816,8 +8197,8 @@ export type paths = { /** * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. - * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. + * + * 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 get: operations["code-scanning/get-default-setup"]; readonly put?: never; @@ -7828,8 +8209,8 @@ export type paths = { /** * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. - * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. + * + * 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 patch: operations["code-scanning/update-default-setup"]; readonly trace?: never; @@ -7845,7 +8226,7 @@ export type paths = { readonly put?: never; /** * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." + * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -7856,7 +8237,7 @@ export type paths = { * ``` * gzip -c analysis-data.sarif | base64 -w0 * ``` - *
+ * * SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * @@ -7875,6 +8256,8 @@ export type paths = { * The `202 Accepted` response includes an `id` value. * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." + * + * 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/upload-sarif"]; readonly delete?: never; @@ -7892,7 +8275,8 @@ export type paths = { }; /** * Get information about a SARIF upload - * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. + * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." + * 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-sarif"]; readonly put?: never; @@ -7938,9 +8322,7 @@ export type paths = { * List codespaces in a repository for the authenticated user * @description Lists the codespaces associated to a specified repository and the authenticated user. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/list-in-repository-for-authenticated-user"]; readonly put?: never; @@ -7948,9 +8330,7 @@ export type paths = { * Create a codespace in a repository * @description Creates a codespace owned by the authenticated user in the specified repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly post: operations["codespaces/create-with-repo-for-authenticated-user"]; readonly delete?: never; @@ -7971,9 +8351,7 @@ export type paths = { * @description Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files * specify launchpoint configurations for codespaces created within the repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/list-devcontainers-in-repository-for-authenticated-user"]; readonly put?: never; @@ -7995,9 +8373,7 @@ export type paths = { * List available machine types for a repository * @description List the machine types available for a given repository based on its configuration. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/repo-machines-for-authenticated-user"]; readonly put?: never; @@ -8019,9 +8395,7 @@ export type paths = { * Get default attributes for a codespace * @description Gets the default attributes for codespaces created by the user with the repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"]; readonly put?: never; @@ -8043,9 +8417,7 @@ export type paths = { * Check if permissions defined by a devcontainer have been accepted by the authenticated user * @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/check-permissions-for-devcontainer"]; readonly put?: never; @@ -8065,7 +8437,10 @@ export type paths = { }; /** * List repository secrets - * @description Lists all development environment secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Lists all development environment secrets available in a repository without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["codespaces/list-repo-secrets"]; readonly put?: never; @@ -8085,7 +8460,12 @@ export type paths = { }; /** * Get a repository public key - * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["codespaces/get-repo-public-key"]; readonly put?: never; @@ -8105,7 +8485,9 @@ export type paths = { }; /** * Get a repository secret - * @description Gets a single repository development environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Gets a single repository development environment secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["codespaces/get-repo-secret"]; /** @@ -8113,15 +8495,15 @@ export type paths = { * @description Creates or updates a repository development environment secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - * repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["codespaces/create-or-update-repo-secret"]; readonly post?: never; /** * Delete a repository secret - * @description Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Deletes a development environment secret in a repository using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["codespaces/delete-repo-secret"]; readonly options?: never; @@ -8143,9 +8525,9 @@ export type paths = { * * Team members will include the members of child teams. * - * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - * endpoint. + * The authenticated user must have push access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ readonly get: operations["repos/list-collaborators"]; readonly put?: never; @@ -8169,9 +8551,9 @@ export type paths = { * * Team members will include the members of child teams. * - * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - * endpoint. + * The authenticated user must have push access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ readonly get: operations["repos/check-collaborator"]; /** @@ -8186,7 +8568,7 @@ export type paths = { * Cannot assign {member} permission of {role name} * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * @@ -8265,9 +8647,14 @@ export type paths = { }; /** * List commit comments for a repository - * @description Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. + * + * 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)." * - * Comments are ordered by ascending ID. + * - **`application/vnd.github-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["repos/list-commit-comments-for-repo"]; readonly put?: never; @@ -8285,7 +8672,17 @@ export type paths = { readonly path?: never; readonly cookie?: never; }; - /** Get a commit comment */ + /** + * Get a commit comment + * @description Gets a specified commit comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ readonly get: operations["repos/get-commit-comment"]; readonly put?: never; readonly post?: never; @@ -8293,7 +8690,17 @@ export type paths = { readonly delete: operations["repos/delete-commit-comment"]; readonly options?: never; readonly head?: never; - /** Update a commit comment */ + /** + * Update a commit comment + * @description Updates the contents of a specified commit comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ readonly patch: operations["repos/update-commit-comment"]; readonly trace?: never; }; @@ -8421,7 +8828,14 @@ export type paths = { }; /** * List commit comments - * @description Use the `:commit_sha` to specify the commit that will have its comments listed. + * @description Lists the comments for a specified commit. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["repos/list-comments-for-commit"]; readonly put?: never; @@ -8430,6 +8844,13 @@ export type paths = { * @description Create a comment for a commit using its `:commit_sha`. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly post: operations["repos/create-commit-comment"]; readonly delete?: never; @@ -8471,11 +8892,13 @@ export type paths = { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property. + * 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)." Pagination query parameters are not supported for these media types. * - * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. * * **Signature verification object** * @@ -8524,11 +8947,13 @@ export type paths = { }; /** * List check runs for a Git reference - * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ readonly get: operations["checks/list-for-ref"]; readonly put?: never; @@ -8548,9 +8973,11 @@ export type paths = { }; /** * List check suites for a Git reference - * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ readonly get: operations["checks/list-suites-for-ref"]; readonly put?: never; @@ -8649,9 +9076,14 @@ export type paths = { }; /** * Compare two commits - * @description Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * + * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. + * + * 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)." * - * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. * * The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. * @@ -8713,50 +9145,40 @@ export type paths = { }; /** * Get repository content - * @description Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit - * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. + * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. + * + * 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 file contents for files and symlinks. + * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + * + * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". * - * Files and symlinks support [a custom media type](https://docs.github.com/rest/overview/media-types) for - * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media - * type](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent - * object format. + * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + * + * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. * * **Notes**: - * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). - * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees - * API](https://docs.github.com/rest/git/trees#get-a-tree). - * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * Size limits: - * If the requested file's size is: - * * 1 MB or smaller: All features of this endpoint are supported. - * * Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * * Greater than 100 MB: This endpoint is not supported. - * - * If the content is a directory: - * The response will be an array of objects, one object for each item in the directory. - * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value - * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). - * In the next major version of the API, the type will be returned as "submodule". - * - * If the content is a symlink: - * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the - * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object - * describing the symlink itself. - * - * If the content is a submodule: - * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific - * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out - * the submodule at that specific commit. - * - * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the - * github.com URLs (`html_url` and `_links["html"]`) will have null values. + * + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). + * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve + * more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). + * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + * - If the requested file's size is: + * - 1 MB or smaller: All features of this endpoint are supported. + * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + * - Greater than 100 MB: This endpoint is not supported. */ readonly get: operations["repos/get-content"]; /** * Create or update file contents - * @description Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. + * @description Creates a new file or replaces an existing file in a repository. * * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ readonly put: operations["repos/create-or-update-file-contents"]; readonly post?: never; @@ -8809,9 +9231,7 @@ export type paths = { }; /** * List Dependabot alerts for a repository - * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * @description OAuth app tokens and personal access tokens (classic) need the `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["dependabot/list-alerts-for-repo"]; readonly put?: never; @@ -8831,9 +9251,7 @@ export type paths = { }; /** * Get a Dependabot alert - * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * @description OAuth app tokens and personal access tokens (classic) need the `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["dependabot/get-alert"]; readonly put?: never; @@ -8843,11 +9261,9 @@ export type paths = { readonly head?: never; /** * Update a Dependabot alert - * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** write permission to use this endpoint. + * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * - * To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + * OAuth app tokens and personal access tokens (classic) need the `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 patch: operations["dependabot/update-alert"]; readonly trace?: never; @@ -8861,7 +9277,10 @@ export type paths = { }; /** * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Lists all secrets available in a repository without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["dependabot/list-repo-secrets"]; readonly put?: never; @@ -8881,7 +9300,11 @@ export type paths = { }; /** * Get a repository public key - * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. 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 if the repository is private. */ readonly get: operations["dependabot/get-repo-public-key"]; readonly put?: never; @@ -8901,7 +9324,9 @@ export type paths = { }; /** * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Gets a single repository secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["dependabot/get-repo-secret"]; /** @@ -8909,15 +9334,15 @@ export type paths = { * @description Creates or updates a repository secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository - * permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["dependabot/create-or-update-repo-secret"]; readonly post?: never; /** * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Deletes a secret in a repository using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["dependabot/delete-repo-secret"]; readonly options?: never; @@ -8976,7 +9401,11 @@ export type paths = { readonly put?: never; /** * Create a snapshot of dependencies for a repository - * @description Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to. + * @description Create a new snapshot of a repository's dependencies. + * + * The authenticated user must have access to the repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["dependency-graph/create-repository-snapshot"]; readonly delete?: never; @@ -9026,8 +9455,6 @@ export type paths = { * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an * application with debugging enabled. * - * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. - * * Merged branch response: * * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating @@ -9048,6 +9475,8 @@ export type paths = { * * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ readonly post: operations["repos/create-deployment"]; readonly delete?: never; @@ -9069,7 +9498,7 @@ export type paths = { readonly post?: never; /** * Delete a deployment - * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. + * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. * * To set a deployment as inactive, you must: * @@ -9077,6 +9506,8 @@ export type paths = { * * Mark the active deployment as inactive by adding any non-successful deployment status. * * For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ readonly delete: operations["repos/delete-deployment"]; readonly options?: never; @@ -9101,7 +9532,7 @@ export type paths = { * Create a deployment status * @description Users with `push` access can create deployment statuses for a given deployment. * - * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. */ readonly post: operations["repos/create-deployment-status"]; readonly delete?: never; @@ -9145,12 +9576,9 @@ export type paths = { * * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * - * This endpoint requires write access to the repository by providing either: - * - * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. - * * This input example shows how you can use the `client_payload` as a test to debug your workflow. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["repos/create-dispatch-event"]; readonly delete?: never; @@ -9170,7 +9598,9 @@ export type paths = { * List environments * @description Lists the environments for a repository. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ readonly get: operations["repos/get-all-environments"]; readonly put?: never; @@ -9192,9 +9622,9 @@ export type paths = { * Get an environment * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * - * Anyone with read access to the repository can use this endpoint. If the - * repository is private, you must use an access token with the `repo` scope. GitHub - * Apps must have the `actions:read` permission to use this endpoint. + * 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. */ readonly get: operations["repos/get-environment"]; /** @@ -9205,13 +9635,13 @@ export type paths = { * * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["repos/create-or-update-environment"]; readonly post?: never; /** * Delete an environment - * @description You must authenticate using an access token with the repo scope to use this endpoint. + * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["repos/delete-an-environment"]; readonly options?: never; @@ -9230,7 +9660,9 @@ export type paths = { * List deployment branch policies * @description Lists the deployment branch policies for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ readonly get: operations["repos/list-deployment-branch-policies"]; readonly put?: never; @@ -9238,7 +9670,7 @@ export type paths = { * Create a deployment branch policy * @description Creates a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["repos/create-deployment-branch-policy"]; readonly delete?: never; @@ -9258,14 +9690,16 @@ export type paths = { * Get a deployment branch policy * @description Gets a deployment branch or tag policy for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ readonly get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy * @description Updates a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["repos/update-deployment-branch-policy"]; readonly post?: never; @@ -9273,7 +9707,7 @@ export type paths = { * Delete a deployment branch policy * @description Deletes a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["repos/delete-deployment-branch-policy"]; readonly options?: never; @@ -9290,9 +9724,11 @@ export type paths = { }; /** * Get all deployment protection rules for an environment - * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ readonly get: operations["repos/get-all-deployment-protection-rules"]; readonly put?: never; @@ -9300,9 +9736,11 @@ export type paths = { * Create a custom deployment protection rule on an environment * @description Enable a custom deployment protection rule for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["repos/create-deployment-protection-rule"]; readonly delete?: never; @@ -9320,11 +9758,13 @@ export type paths = { }; /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ readonly get: operations["repos/list-custom-deployment-rule-integrations"]; readonly put?: never; @@ -9344,9 +9784,11 @@ export type paths = { }; /** * Get a custom deployment protection rule - * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ readonly get: operations["repos/get-custom-deployment-protection-rule"]; readonly put?: never; @@ -9355,7 +9797,9 @@ export type paths = { * Disable a custom protection rule for an environment * @description Disables a custom deployment protection rule for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)". + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["repos/disable-deployment-protection-rule"]; readonly options?: never; @@ -9363,6 +9807,169 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly get: operations["actions/list-environment-secrets"]; + 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}/environments/{environment_name}/secrets/public-key": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly get: operations["actions/get-environment-public-key"]; + 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}/environments/{environment_name}/secrets/{secret_name}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly get: operations["actions/get-environment-secret"]; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. 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)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly put: operations["actions/create-or-update-environment-secret"]; + readonly post?: never; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly delete: operations["actions/delete-environment-secret"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly get: operations["actions/list-environment-variables"]; + readonly put?: never; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly post: operations["actions/create-environment-variable"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly get: operations["actions/get-environment-variable"]; + readonly put?: never; + readonly post?: never; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly delete: operations["actions/delete-environment-variable"]; + readonly options?: never; + readonly head?: never; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly patch: operations["actions/update-environment-variable"]; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/events": { readonly parameters: { readonly query?: never; @@ -9437,7 +10044,12 @@ export type paths = { * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * _Note_: This API supports blobs up to 100 megabytes in size. + * 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 blob data. + * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + * + * **Note** This endpoint supports blobs up to 100 megabytes in size. */ readonly get: operations["git/get-blob"]; readonly put?: never; @@ -9626,11 +10238,17 @@ export type paths = { readonly get?: never; readonly put?: never; readonly post?: never; - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ readonly delete: operations["git/delete-ref"]; readonly options?: never; readonly head?: never; - /** Update a reference */ + /** + * Update a reference + * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + */ readonly patch: operations["git/update-ref"]; readonly trace?: never; }; @@ -9840,7 +10458,7 @@ export type paths = { * Get a webhook configuration for a repository * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * - * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. */ readonly get: operations["repos/get-webhook-config-for-repo"]; readonly put?: never; @@ -9852,7 +10470,7 @@ export type paths = { * Update a webhook configuration for a repository * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * - * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. */ readonly patch: operations["repos/update-webhook-config-for-repo"]; readonly trace?: never; @@ -10250,6 +10868,13 @@ export type paths = { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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-for-repo"]; readonly put?: never; @@ -10259,6 +10884,13 @@ export type paths = { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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/create"]; readonly delete?: never; @@ -10279,6 +10911,13 @@ export type paths = { * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. * * By default, issue comments are ordered by ascending ID. + * + * 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-comments-for-repo"]; readonly put?: never; @@ -10299,6 +10938,13 @@ export type paths = { /** * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + * + * 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/get-comment"]; readonly put?: never; @@ -10313,6 +10959,13 @@ export type paths = { /** * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + * + * 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 patch: operations["issues/update-comment"]; readonly trace?: never; @@ -10412,7 +11065,7 @@ export type paths = { }; /** * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was + * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read @@ -10423,6 +11076,13 @@ export type paths = { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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/get"]; readonly put?: never; @@ -10433,6 +11093,13 @@ export type paths = { /** * Update an issue * @description Issue owners and users with push access can edit 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 patch: operations["issues/update"]; readonly trace?: never; @@ -10497,18 +11164,31 @@ export type paths = { * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * * Issue comments are ordered by ascending ID. + * + * 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-comments"]; readonly put?: never; /** * Create an issue comment - * @description - * You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). * 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/overview/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/create-comment"]; readonly delete?: never; @@ -10601,7 +11281,7 @@ export type paths = { * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ readonly put: operations["issues/lock"]; readonly post?: never; @@ -10806,7 +11486,10 @@ export type paths = { * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. + * 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 contents of the license. + * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ readonly get: operations["licenses/get-for-repo"]; readonly put?: never; @@ -10958,28 +11641,34 @@ export type paths = { * Get a GitHub Pages site * @description Gets information about a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["repos/get-pages"]; /** * Update information about a GitHub Pages site * @description Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["repos/update-information-about-pages-site"]; /** * Create a GitHub Pages site * @description Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["repos/create-pages-site"]; /** * Delete a GitHub Pages site * @description Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["repos/delete-pages-site"]; readonly options?: never; @@ -10998,7 +11687,7 @@ export type paths = { * List GitHub Pages builds * @description Lists builts of a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["repos/list-pages-builds"]; readonly put?: never; @@ -11026,7 +11715,7 @@ export type paths = { * Get latest Pages build * @description Gets information about the single most recent build of a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["repos/get-latest-pages-build"]; readonly put?: never; @@ -11048,7 +11737,7 @@ export type paths = { * Get GitHub Pages build * @description Gets information about a GitHub Pages build. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["repos/get-pages-build"]; readonly put?: never; @@ -11059,7 +11748,7 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; - readonly "/repos/{owner}/{repo}/pages/deployment": { + readonly "/repos/{owner}/{repo}/pages/deployments": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -11072,7 +11761,7 @@ export type paths = { * Create a GitHub Pages deployment * @description Create a GitHub Pages deployment for a repository. * - * Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint. + * The authenticated user must have write permission to the repository. */ readonly post: operations["repos/create-pages-deployment"]; readonly delete?: never; @@ -11081,6 +11770,50 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get the status of a GitHub Pages deployment + * @description Gets the current status of a GitHub Pages deployment. + * + * The authenticated user must have read permission for the GitHub Pages site. + */ + readonly get: operations["repos/get-pages-deployment"]; + 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}/pages/deployments/{pages_deployment_id}/cancel": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Cancel a GitHub Pages deployment + * @description Cancels a GitHub Pages deployment. + * + * The authenticated user must have write permissions for the GitHub Pages site. + */ + readonly post: operations["repos/cancel-pages-deployment"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/pages/health": { readonly parameters: { readonly query?: never; @@ -11094,7 +11827,9 @@ export type paths = { * * The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["repos/get-pages-health-check"]; readonly put?: never; @@ -11112,7 +11847,11 @@ export type paths = { readonly path?: never; readonly cookie?: never; }; - readonly get?: never; + /** + * Check if private vulnerability reporting is enabled for a repository + * @description Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + */ + readonly get: operations["repos/check-private-vulnerability-reporting"]; /** * Enable private vulnerability reporting for a repository * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." @@ -11171,7 +11910,14 @@ export type paths = { readonly delete?: never; readonly options?: never; readonly head?: never; - readonly patch?: never; + /** + * Create or update custom property values for a repository + * @description Create new or update existing custom property values for a repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + */ + readonly patch: operations["repos/create-or-update-custom-properties-values"]; readonly trace?: never; }; readonly "/repos/{owner}/{repo}/pulls": { @@ -11183,7 +11929,20 @@ export type paths = { }; /** * List pull requests - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Lists pull requests in a specified repository. + * + * Draft pull requests are available in public repositories with GitHub + * Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing + * plans, and in public and private repositories with GitHub Team and GitHub Enterprise + * Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) + * in the GitHub Help documentation. + * + * 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["pulls/list"]; readonly put?: never; @@ -11194,6 +11953,13 @@ export type paths = { * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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["pulls/create"]; readonly delete?: never; @@ -11211,7 +11977,15 @@ export type paths = { }; /** * List review comments in a repository - * @description Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. + * @description Lists review comments for all pull requests in a repository. By default, + * review comments are in ascending order by ID. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["pulls/list-review-comments-for-repo"]; readonly put?: never; @@ -11231,7 +12005,14 @@ export type paths = { }; /** * Get a review comment for a pull request - * @description Provides details for a review comment. + * @description Provides details for a specified review comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["pulls/get-review-comment"]; readonly put?: never; @@ -11245,7 +12026,14 @@ export type paths = { readonly head?: never; /** * Update a review comment for a pull request - * @description Enables you to edit a review comment. + * @description Edits the content of a specified review comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly patch: operations["pulls/update-review-comment"]; readonly trace?: never; @@ -11320,6 +12108,14 @@ export type paths = { * * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * + * 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`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ readonly get: operations["pulls/get"]; readonly put?: never; @@ -11332,6 +12128,13 @@ export type paths = { * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + * + * 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 patch: operations["pulls/update"]; readonly trace?: never; @@ -11349,9 +12152,7 @@ export type paths = { * Create a codespace from a pull request * @description Creates a codespace owned by the authenticated user for the specified pull request. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly post: operations["codespaces/create-with-pr-for-authenticated-user"]; readonly delete?: never; @@ -11369,21 +12170,35 @@ export type paths = { }; /** * List review comments on a pull request - * @description Lists all review comments for a pull request. By default, review comments are in ascending order by ID. + * @description Lists all review comments for a specified pull request. By default, review comments + * are in ascending order by ID. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["pulls/list-review-comments"]; readonly put?: never; /** * Create a review comment for a pull request - * @description - * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. + * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly post: operations["pulls/create-review-comment"]; readonly delete?: never; @@ -11407,6 +12222,13 @@ export type paths = { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly post: operations["pulls/create-reply-for-review-comment"]; readonly delete?: never; @@ -11424,7 +12246,16 @@ export type paths = { }; /** * List commits on a pull request - * @description Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. + * @description Lists a maximum of 250 commits for a pull request. To receive a complete + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) + * endpoint. + * + * 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["pulls/list-commits"]; readonly put?: never; @@ -11444,7 +12275,17 @@ export type paths = { }; /** * List pull requests files - * @description **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. + * @description Lists the files in a specified pull request. + * + * **Note:** Responses include a maximum of 3000 files. The paginated response + * returns 30 files per page by default. + * + * 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["pulls/list-files"]; readonly put?: never; @@ -11518,19 +12359,35 @@ export type paths = { }; /** * List reviews for a pull request - * @description The list of reviews returns in chronological order. + * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["pulls/list-reviews"]; readonly put?: never; /** * Create a review for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + * @description Creates a review on a specified pull request. + * + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly post: operations["pulls/create-review"]; readonly delete?: never; @@ -11549,17 +12406,38 @@ export type paths = { /** * Get a review for a pull request * @description Retrieves a pull request review by its ID. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["pulls/get-review"]; /** * Update a review for a pull request - * @description Update the review summary comment with new text. + * @description Updates the contents of a specified review summary comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly put: operations["pulls/update-review"]; readonly post?: never; /** * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly delete: operations["pulls/delete-pending-review"]; readonly options?: never; @@ -11576,7 +12454,14 @@ export type paths = { }; /** * List comments for a pull request review - * @description List comments for a specific pull request review. + * @description Lists comments for a specific pull request review. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["pulls/list-comments-for-review"]; readonly put?: never; @@ -11597,7 +12482,18 @@ export type paths = { readonly get?: never; /** * Dismiss a review for a pull request - * @description **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + * @description Dismisses a specified review on a pull request. + * + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), + * you must be a repository administrator or be included in the list of people or teams + * who can dismiss pull request reviews. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly put: operations["pulls/dismiss-review"]; readonly post?: never; @@ -11619,6 +12515,13 @@ export type paths = { /** * Submit a review for a pull request * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly post: operations["pulls/submit-review"]; readonly delete?: never; @@ -11658,7 +12561,10 @@ export type paths = { * Get a repository README * @description Gets the preferred README for a repository. * - * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + * 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 file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ readonly get: operations["repos/get-readme"]; readonly put?: never; @@ -11680,7 +12586,10 @@ export type paths = { * Get a repository README for a directory * @description Gets the README from a repository directory. * - * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + * 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 file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ readonly get: operations["repos/get-readme-in-directory"]; readonly put?: never; @@ -11815,7 +12724,11 @@ export type paths = { }; /** * Get a release - * @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). + * @description Gets a public release with the specified release ID. + * + * **Note:** This returns an `upload_url` key corresponding to the endpoint + * for uploading release assets. This key is a hypermedia resource. For more information, see + * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ readonly get: operations["repos/get-release"]; readonly put?: never; @@ -11846,7 +12759,7 @@ export type paths = { readonly put?: never; /** * Upload a release asset - * @description This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in + * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset. * * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. @@ -12046,10 +12959,10 @@ export type paths = { /** * List secret scanning alerts for a repository * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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/list-alerts-for-repo"]; readonly put?: never; @@ -12070,10 +12983,10 @@ export type paths = { /** * Get a secret scanning alert * @description Gets a single secret scanning alert detected in an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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-alert"]; readonly put?: never; @@ -12084,10 +12997,10 @@ export type paths = { /** * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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 patch: operations["secret-scanning/update-alert"]; readonly trace?: never; @@ -12102,10 +13015,10 @@ export type paths = { /** * List locations for a secret scanning alert * @description Lists all locations for a given secret scanning alert for an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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/list-locations-for-alert"]; readonly put?: never; @@ -12126,19 +13039,20 @@ export type paths = { /** * List repository security advisories * @description Lists security advisories in a repository. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - * in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to. * - * You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory. + * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ readonly get: operations["security-advisories/list-repository-advisories"]; readonly put?: never; /** * Create a repository security advisory * @description Creates a new repository security advisory. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. * - * In order to create a draft repository security advisory, you must be a security manager or administrator of that repository. + * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ readonly post: operations["security-advisories/create-repository-advisory"]; readonly delete?: never; @@ -12178,12 +13092,13 @@ export type paths = { /** * Get a repository security advisory * @description Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - * You can access any published security advisory on a public repository. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - * in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to. * - * You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a + * Anyone can access any published security advisory on a public repository. + * + * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a * collaborator on the security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ readonly get: operations["security-advisories/get-repository-advisory"]; readonly put?: never; @@ -12194,10 +13109,11 @@ export type paths = { /** * Update a repository security advisory * @description Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. * - * In order to update any security advisory, you must be a security manager or administrator of that repository, + * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, * or a collaborator on the repository security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ readonly patch: operations["security-advisories/update-repository-advisory"]; readonly trace?: never; @@ -12217,9 +13133,9 @@ export type paths = { * * You may request a CVE for public repositories, but cannot do so for private repositories. * - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + * In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. * - * In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ readonly post: operations["security-advisories/create-repository-advisory-cve-request"]; readonly delete?: never; @@ -12228,6 +13144,28 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Create a temporary private fork + * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. + * + * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + */ + readonly post: operations["security-advisories/create-fork"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/stargazers": { readonly parameters: { readonly query?: never; @@ -12239,7 +13177,9 @@ export type paths = { * List stargazers * @description Lists the people that have starred the repository. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * 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.star+json`**: Includes a timestamp of when the star was created. */ readonly get: operations["activity/list-stargazers-for-repo"]; readonly put?: never; @@ -12259,7 +13199,12 @@ export type paths = { }; /** * Get the weekly commit activity - * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * @description + * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * + * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains + * 10,000 or more commits, a 422 status code will be returned. + * */ readonly get: operations["repos/get-code-frequency-stats"]; readonly put?: never; @@ -12302,10 +13247,12 @@ export type paths = { * @description * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * - * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). * * `a` - Number of additions * * `d` - Number of deletions * * `c` - Number of commits + * + * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ readonly get: operations["repos/get-contributors-stats"]; readonly put?: never; @@ -12537,11 +13484,7 @@ export type paths = { * * For a public repository, a team is listed only if that team added the public repository explicitly. * - * Personal access tokens require the following scopes: - * * `public_repo` to call this endpoint on a public repository - * * `repo` to call this endpoint on a private repository (this scope also includes public repositories) - * - * This endpoint is not compatible with fine-grained personal access tokens. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. */ readonly get: operations["repos/list-teams"]; readonly put?: never; @@ -12662,7 +13605,6 @@ export type paths = { /** * Transfer a repository * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). - * You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. */ readonly post: operations["repos/transfer"]; readonly delete?: never; @@ -12738,12 +13680,7 @@ export type paths = { * Create a repository using a template * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ readonly post: operations["repos/create-using-template"]; readonly delete?: never; @@ -12776,170 +13713,6 @@ export type paths = { readonly patch?: never; readonly trace?: never; }; - readonly "/repositories/{repository_id}/environments/{environment_name}/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - readonly get: operations["actions/list-environment-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - readonly get: operations["actions/get-environment-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - readonly get: operations["actions/get-environment-secret"]; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. 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)." - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - readonly put: operations["actions/create-or-update-environment-secret"]; - readonly post?: never; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - readonly delete: operations["actions/delete-environment-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repositories/{repository_id}/environments/{environment_name}/variables": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List environment variables - * @description Lists all environment variables. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environments:read` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - readonly get: operations["actions/list-environment-variables"]; - readonly put?: never; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - readonly post: operations["actions/create-environment-variable"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environments:read` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - readonly get: operations["actions/get-environment-variable"]; - readonly put?: never; - readonly post?: never; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - readonly delete: operations["actions/delete-environment-variable"]; - readonly options?: never; - readonly head?: never; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - readonly patch: operations["actions/update-environment-variable"]; - readonly trace?: never; - }; readonly "/search/code": { readonly parameters: { readonly query?: never; @@ -13202,7 +13975,9 @@ export type paths = { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * - * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List all discussions on a team's page. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/list-discussions-legacy"]; readonly put?: never; @@ -13211,9 +13986,11 @@ export type paths = { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * - * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Creates a new discussion post on a team's page. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["teams/create-discussion-legacy"]; readonly delete?: never; @@ -13234,7 +14011,9 @@ export type paths = { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * - * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Get a specific discussion on a team's page. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/get-discussion-legacy"]; readonly put?: never; @@ -13244,7 +14023,9 @@ export type paths = { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * - * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a discussion from a team's page. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly delete: operations["teams/delete-discussion-legacy"]; readonly options?: never; @@ -13254,7 +14035,9 @@ export type paths = { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly patch: operations["teams/update-discussion-legacy"]; readonly trace?: never; @@ -13271,7 +14054,9 @@ export type paths = { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * - * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List all comments on a team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/list-discussion-comments-legacy"]; readonly put?: never; @@ -13280,9 +14065,11 @@ export type paths = { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * - * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Creates a new comment on a team discussion. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["teams/create-discussion-comment-legacy"]; readonly delete?: never; @@ -13303,7 +14090,9 @@ export type paths = { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * - * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Get a specific comment on a team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/get-discussion-comment-legacy"]; readonly put?: never; @@ -13313,7 +14102,9 @@ export type paths = { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * - * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Deletes a comment on a team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly delete: operations["teams/delete-discussion-comment-legacy"]; readonly options?: never; @@ -13323,7 +14114,9 @@ export type paths = { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * - * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Edits the body text of a discussion comment. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly patch: operations["teams/update-discussion-comment-legacy"]; readonly trace?: never; @@ -13340,7 +14133,9 @@ export type paths = { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["reactions/list-for-team-discussion-comment-legacy"]; readonly put?: never; @@ -13349,7 +14144,11 @@ export type paths = { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["reactions/create-for-team-discussion-comment-legacy"]; readonly delete?: never; @@ -13370,7 +14169,9 @@ export type paths = { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["reactions/list-for-team-discussion-legacy"]; readonly put?: never; @@ -13379,7 +14180,11 @@ export type paths = { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["reactions/create-for-team-discussion-legacy"]; readonly delete?: never; @@ -13464,7 +14269,7 @@ export type paths = { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ readonly put: operations["teams/add-member-legacy"]; readonly post?: never; @@ -13648,7 +14453,7 @@ export type paths = { * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ readonly put: operations["teams/add-or-update-repo-permissions-legacy"]; readonly post?: never; @@ -13695,9 +14500,7 @@ export type paths = { }; /** * Get the authenticated user - * @description If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information. - * - * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. */ readonly get: operations["users/get-authenticated"]; readonly put?: never; @@ -13771,9 +14574,7 @@ export type paths = { * List codespaces for the authenticated user * @description Lists the authenticated user's codespaces. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/list-for-authenticated-user"]; readonly put?: never; @@ -13783,9 +14584,7 @@ export type paths = { * * This endpoint requires either a `repository_id` OR a `pull_request` but not both. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly post: operations["codespaces/create-for-authenticated-user"]; readonly delete?: never; @@ -13806,9 +14605,9 @@ export type paths = { * @description Lists all development environment secrets available for a user's codespaces without revealing their * encrypted values. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly get: operations["codespaces/list-secrets-for-authenticated-user"]; readonly put?: never; @@ -13830,9 +14629,9 @@ export type paths = { * Get public key for the authenticated user * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly get: operations["codespaces/get-public-key-for-authenticated-user"]; readonly put?: never; @@ -13854,9 +14653,9 @@ export type paths = { * Get a secret for the authenticated user * @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly get: operations["codespaces/get-secret-for-authenticated-user"]; /** @@ -13864,9 +14663,9 @@ export type paths = { * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. 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)." * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; readonly post?: never; @@ -13874,9 +14673,9 @@ export type paths = { * Delete a secret for the authenticated user * @description Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly delete: operations["codespaces/delete-secret-for-authenticated-user"]; readonly options?: never; @@ -13895,18 +14694,18 @@ export type paths = { * List selected repositories for a user secret * @description List the repositories that have been granted the ability to use a user's development environment secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; /** * Set selected repositories for a user secret * @description Select the repositories that will use a user's development environment secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; readonly post?: never; @@ -13927,16 +14726,20 @@ export type paths = { /** * Add a selected repository to a user secret * @description Adds a repository to the selected repositories for a user's development environment secret. - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. + * + * The authenticated user must have Codespaces access to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; readonly post?: never; /** * Remove a selected repository from a user secret * @description Removes a repository from the selected repositories for a user's development environment secret. - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + * + * The authenticated user must have Codespaces access to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; readonly options?: never; @@ -13955,9 +14758,7 @@ export type paths = { * Get a codespace for the authenticated user * @description Gets information about a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/get-for-authenticated-user"]; readonly put?: never; @@ -13966,9 +14767,7 @@ export type paths = { * Delete a codespace for the authenticated user * @description Deletes a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly delete: operations["codespaces/delete-for-authenticated-user"]; readonly options?: never; @@ -13979,9 +14778,7 @@ export type paths = { * * If you specify a new machine type it will be applied the next time your codespace is started. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly patch: operations["codespaces/update-for-authenticated-user"]; readonly trace?: never; @@ -14001,9 +14798,7 @@ export type paths = { * * If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly post: operations["codespaces/export-for-authenticated-user"]; readonly delete?: never; @@ -14023,9 +14818,7 @@ export type paths = { * Get details about a codespace export * @description Gets information about an export of a codespace. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/get-export-details-for-authenticated-user"]; readonly put?: never; @@ -14047,9 +14840,7 @@ export type paths = { * List machine types for a codespace * @description List the machine types a codespace can transition to use. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/codespace-machines-for-authenticated-user"]; readonly put?: never; @@ -14077,9 +14868,7 @@ export type paths = { * * This will fail for a codespace that is already published, meaning it has an associated repository. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly post: operations["codespaces/publish-for-authenticated-user"]; readonly delete?: never; @@ -14101,9 +14890,7 @@ export type paths = { * Start a codespace for the authenticated user * @description Starts a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly post: operations["codespaces/start-for-authenticated-user"]; readonly delete?: never; @@ -14125,9 +14912,7 @@ export type paths = { * Stop a codespace for the authenticated user * @description Stops a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly post: operations["codespaces/stop-for-authenticated-user"]; readonly delete?: never; @@ -14146,7 +14931,8 @@ export type paths = { /** * Get list of conflicting packages during Docker migration for authenticated-user * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ readonly get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"]; readonly put?: never; @@ -14186,18 +14972,21 @@ export type paths = { }; /** * List email addresses for the authenticated user - * @description Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. + * @description Lists all of your email addresses, and specifies which one is visible + * to the public. + * + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ readonly get: operations["users/list-emails-for-authenticated-user"]; readonly put?: never; /** * Add an email address for the authenticated user - * @description This endpoint is accessible with the `user` scope. + * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ readonly post: operations["users/add-email-for-authenticated-user"]; /** * Delete an email address for the authenticated user - * @description This endpoint is accessible with the `user` scope. + * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ readonly delete: operations["users/delete-email-for-authenticated-user"]; readonly options?: never; @@ -14256,15 +15045,15 @@ export type paths = { readonly get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ readonly put: operations["users/follow"]; readonly post?: never; /** * Unfollow a user - * @description Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ readonly delete: operations["users/unfollow"]; readonly options?: never; @@ -14281,13 +15070,17 @@ export type paths = { }; /** * List GPG keys for the authenticated user - * @description Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Lists the current user's GPG keys. + * + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ readonly get: operations["users/list-gpg-keys-for-authenticated-user"]; readonly put?: never; /** * Create a GPG key for the authenticated user - * @description Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Adds a GPG key to the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ readonly post: operations["users/create-gpg-key-for-authenticated-user"]; readonly delete?: never; @@ -14305,14 +15098,18 @@ export type paths = { }; /** * Get a GPG key for the authenticated user - * @description View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description View extended details for a single GPG key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ readonly get: operations["users/get-gpg-key-for-authenticated-user"]; readonly put?: never; readonly post?: never; /** * Delete a GPG key for the authenticated user - * @description Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Removes a GPG key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. */ readonly delete: operations["users/delete-gpg-key-for-authenticated-user"]; readonly options?: never; @@ -14331,8 +15128,6 @@ export type paths = { * List app installations accessible to the user access token * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * * You can find the permissions for the installation under the `permissions` key. @@ -14359,8 +15154,6 @@ export type paths = { * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - * * The access the user has to each repository is included in the hash under the `permissions` key. */ readonly get: operations["apps/list-installation-repos-for-authenticated-user"]; @@ -14383,16 +15176,12 @@ export type paths = { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ readonly put: operations["apps/add-repo-to-installation-for-authenticated-user"]; readonly post?: never; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ readonly delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; readonly options?: never; @@ -14443,6 +15232,13 @@ export type paths = { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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-for-authenticated-user"]; readonly put?: never; @@ -14462,13 +15258,17 @@ export type paths = { }; /** * List public SSH keys for the authenticated user - * @description Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Lists the public SSH keys for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ readonly get: operations["users/list-public-ssh-keys-for-authenticated-user"]; readonly put?: never; /** * Create a public SSH key for the authenticated user - * @description Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Adds a public SSH key to the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ readonly post: operations["users/create-public-ssh-key-for-authenticated-user"]; readonly delete?: never; @@ -14486,14 +15286,18 @@ export type paths = { }; /** * Get a public SSH key for the authenticated user - * @description View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description View extended details for a single public SSH key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ readonly get: operations["users/get-public-ssh-key-for-authenticated-user"]; readonly put?: never; readonly post?: never; /** * Delete a public SSH key for the authenticated user - * @description Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Removes a public SSH key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. */ readonly delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; readonly options?: never; @@ -14510,7 +15314,7 @@ export type paths = { }; /** * List subscriptions for the authenticated user - * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + * @description Lists the active subscriptions for the authenticated user. */ readonly get: operations["apps/list-subscriptions-for-authenticated-user"]; readonly put?: never; @@ -14530,7 +15334,7 @@ export type paths = { }; /** * List subscriptions for the authenticated user (stubbed) - * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + * @description Lists the active subscriptions for the authenticated user. */ readonly get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; readonly put?: never; @@ -14731,9 +15535,7 @@ export type paths = { * List organizations for the authenticated user * @description List organizations for the authenticated user. * - * **OAuth scope requirements** - * - * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. */ readonly get: operations["orgs/list-for-authenticated-user"]; readonly put?: never; @@ -14755,7 +15557,7 @@ export type paths = { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/list-packages-for-authenticated-user"]; readonly put?: never; @@ -14777,7 +15579,7 @@ export type paths = { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-for-authenticated-user"]; readonly put?: never; @@ -14786,8 +15588,7 @@ export type paths = { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-for-authenticated-user"]; readonly options?: never; @@ -14812,7 +15613,7 @@ export type paths = { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-for-authenticated-user"]; readonly delete?: never; @@ -14832,7 +15633,7 @@ export type paths = { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; readonly put?: never; @@ -14854,7 +15655,7 @@ export type paths = { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-version-for-authenticated-user"]; readonly put?: never; @@ -14863,8 +15664,9 @@ export type paths = { * Delete a package version for the authenticated user * @description Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-version-for-authenticated-user"]; readonly options?: never; @@ -14889,7 +15691,7 @@ export type paths = { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-version-for-authenticated-user"]; readonly delete?: never; @@ -14927,7 +15729,11 @@ export type paths = { }; /** * List public email addresses for the authenticated user - * @description Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + * @description Lists your publicly visible email address, which you can set with the + * [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ readonly get: operations["users/list-public-emails-for-authenticated-user"]; readonly put?: never; @@ -14957,12 +15763,7 @@ export type paths = { * Create a repository for the authenticated user * @description Creates a new repository for the authenticated user. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ readonly post: operations["repos/create-for-authenticated-user"]; readonly delete?: never; @@ -15024,12 +15825,16 @@ export type paths = { readonly put?: never; /** * Add social accounts for the authenticated user - * @description Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope. + * @description Add one or more social accounts to the authenticated user's profile. + * + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ readonly post: operations["users/add-social-account-for-authenticated-user"]; /** * Delete social accounts for the authenticated user - * @description Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope. + * @description Deletes one or more social accounts from the authenticated user's profile. + * + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ readonly delete: operations["users/delete-social-account-for-authenticated-user"]; readonly options?: never; @@ -15046,13 +15851,17 @@ export type paths = { }; /** * List SSH signing keys for the authenticated user - * @description Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Lists the SSH signing keys for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ readonly get: operations["users/list-ssh-signing-keys-for-authenticated-user"]; readonly put?: never; /** * Create a SSH signing key for the authenticated user - * @description Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Creates an SSH signing key for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. */ readonly post: operations["users/create-ssh-signing-key-for-authenticated-user"]; readonly delete?: never; @@ -15070,14 +15879,18 @@ export type paths = { }; /** * Get an SSH signing key for the authenticated user - * @description Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Gets extended details for an SSH signing key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ readonly get: operations["users/get-ssh-signing-key-for-authenticated-user"]; readonly put?: never; readonly post?: never; /** * Delete an SSH signing key for the authenticated user - * @description Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Deletes an SSH signing key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. */ readonly delete: operations["users/delete-ssh-signing-key-for-authenticated-user"]; readonly options?: never; @@ -15096,7 +15909,9 @@ export type paths = { * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * 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.star+json`**: Includes a timestamp of when the star was created. */ readonly get: operations["activity/list-repos-starred-by-authenticated-user"]; readonly put?: never; @@ -15121,7 +15936,7 @@ export type paths = { readonly get: operations["activity/check-repo-is-starred-by-authenticated-user"]; /** * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ readonly put: operations["activity/star-repo-for-authenticated-user"]; readonly post?: never; @@ -15164,7 +15979,12 @@ export type paths = { }; /** * List teams for the authenticated user - * @description List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token. + * @description List all of the teams across all of the organizations to which the authenticated + * user belongs. + * + * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + * + * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. */ readonly get: operations["teams/list-for-authenticated-user"]; readonly put?: never; @@ -15208,9 +16028,7 @@ export type paths = { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" - * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". */ @@ -15233,7 +16051,8 @@ export type paths = { /** * Get list of conflicting packages during Docker migration for user * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ readonly get: operations["packages/list-docker-migration-conflicting-packages-for-user"]; readonly put?: never; @@ -15407,14 +16226,11 @@ export type paths = { }; /** * Get contextual information for a user - * @description Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["users/get-context-for-user"]; readonly put?: never; @@ -15500,7 +16316,7 @@ export type paths = { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/list-packages-for-user"]; readonly put?: never; @@ -15522,7 +16338,7 @@ export type paths = { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-for-user"]; readonly put?: never; @@ -15531,9 +16347,9 @@ export type paths = { * Delete a package for a user * @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-for-user"]; readonly options?: never; @@ -15558,9 +16374,9 @@ export type paths = { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-for-user"]; readonly delete?: never; @@ -15580,7 +16396,7 @@ export type paths = { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; readonly put?: never; @@ -15602,7 +16418,7 @@ export type paths = { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-version-for-user"]; readonly put?: never; @@ -15611,9 +16427,9 @@ export type paths = { * Delete package version for a user * @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-version-for-user"]; readonly options?: never; @@ -15638,9 +16454,9 @@ export type paths = { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-version-for-user"]; readonly delete?: never; @@ -15678,7 +16494,7 @@ export type paths = { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ readonly get: operations["activity/list-received-events-for-user"]; readonly put?: never; @@ -15715,7 +16531,7 @@ export type paths = { }; /** * List repositories for a user - * @description Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. + * @description Lists public repositories for the specified user. */ readonly get: operations["repos/list-for-user"]; readonly put?: never; @@ -15739,7 +16555,7 @@ export type paths = { * * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ readonly get: operations["billing/get-github-actions-billing-user"]; readonly put?: never; @@ -15763,7 +16579,7 @@ export type paths = { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ readonly get: operations["billing/get-github-packages-billing-user"]; readonly put?: never; @@ -15787,7 +16603,7 @@ export type paths = { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ readonly get: operations["billing/get-shared-storage-billing-user"]; readonly put?: never; @@ -15849,7 +16665,9 @@ export type paths = { * List repositories starred by a user * @description Lists repositories a user has starred. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * 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.star+json`**: Includes a timestamp of when the star was created. */ readonly get: operations["activity/list-repos-starred-by-user"]; readonly put?: never; @@ -15949,8 +16767,11 @@ export type components = { readonly following_url: string; /** Format: uri-template */ readonly gists_url: string; - /** Format: uri-template */ - readonly hub_url: string; + /** + * Format: uri-template + * @deprecated + */ + readonly hub_url?: string; /** Format: uri-template */ readonly issue_search_url: string; /** Format: uri-template */ @@ -15997,210 +16818,212 @@ export type components = { * @enum {string} */ readonly "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift"; - /** - * Simple User - * @description A GitHub user. - */ - readonly "simple-user": { - readonly name?: string | null; - readonly email?: string | null; - /** @example octocat */ - readonly login: string; - /** @example 1 */ - readonly id: number; - /** @example MDQ6VXNlcjE= */ - readonly node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; - /** - * Format: uri - * @example https://api.github.com/users/octocat - */ - readonly url: string; - /** - * Format: uri - * @example https://github.com/octocat - */ - readonly html_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/followers - */ - readonly followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions - */ - readonly subscriptions_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs - */ - readonly organizations_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/repos - */ - readonly repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events - */ - readonly received_events_url: string; - /** @example User */ - readonly type: string; - readonly site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - readonly starred_at?: string; - }; - /** - * @description The type of credit the user is receiving. - * @enum {string} - */ - readonly "security-advisory-credit-types": "analyst" | "finder" | "reporter" | "coordinator" | "remediation_developer" | "remediation_reviewer" | "remediation_verifier" | "tool" | "sponsor" | "other"; - /** @description A GitHub Security Advisory. */ - readonly "global-advisory": { - /** @description The GitHub Security Advisory ID. */ - readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - readonly cve_id: string | null; - /** @description The API URL for the advisory. */ - readonly url: string; - /** - * Format: uri - * @description The URL for the advisory. - */ - readonly html_url: string; - /** - * Format: uri - * @description The API URL for the repository advisory. - */ - readonly repository_advisory_url: string | null; - /** @description A short summary of the advisory. */ - readonly summary: string; - /** @description A detailed description of what the advisory entails. */ - readonly description: string | null; - /** - * @description The type of advisory. - * @enum {string} - */ - readonly type: "reviewed" | "unreviewed" | "malware"; - /** - * @description The severity of the advisory. - * @enum {string} - */ - readonly severity: "critical" | "high" | "medium" | "low" | "unknown"; - /** - * Format: uri - * @description The URL of the advisory's source code. - */ - readonly source_code_location: string | null; - readonly identifiers: { - /** - * @description The type of identifier. - * @enum {string} - */ - readonly type: "CVE" | "GHSA"; - /** @description The identifier value. */ - readonly value: string; - }[] | null; - readonly references: string[] | null; - /** - * Format: date-time - * @description The date and time of when the advisory was published, in ISO 8601 format. - */ - readonly published_at: string; - /** - * Format: date-time - * @description The date and time of when the advisory was last updated, in ISO 8601 format. - */ - readonly updated_at: string; - /** - * Format: date-time - * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. - */ - readonly github_reviewed_at: string | null; - /** - * Format: date-time - * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. - * This field is only populated when the advisory is imported from the National Vulnerability Database. - */ - readonly nvd_published_at: string | null; - /** - * Format: date-time - * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. - */ - readonly withdrawn_at: string | null; - /** @description The products and respective version ranges affected by the advisory. */ - readonly vulnerabilities: { - /** @description The name of the package affected by the vulnerability. */ - readonly package: { - readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ - readonly name: string | null; - } | null; - /** @description The range of the package versions affected by the vulnerability. */ - readonly vulnerable_version_range: string | null; - /** @description The package version that resolve the vulnerability. */ - readonly first_patched_version: string | null; - /** @description The functions in the package that are affected by the vulnerability. */ - readonly vulnerable_functions: string[] | null; - }[] | null; - readonly cvss: { - /** @description The CVSS vector. */ - readonly vector_string: string | null; - /** @description The CVSS score. */ - readonly score: number | null; + /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ + readonly vulnerability: { + /** @description The name of the package affected by the vulnerability. */ + readonly package: { + readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + readonly name: string | null; } | null; - readonly cwes: { - /** @description The Common Weakness Enumeration (CWE) identifier. */ - readonly cwe_id: string; - /** @description The name of the CWE. */ - readonly name: string; - }[] | null; - /** @description The users who contributed to the advisory. */ - readonly credits: { - readonly user: components["schemas"]["simple-user"]; - readonly type: components["schemas"]["security-advisory-credit-types"]; - }[] | null; - }; - /** - * Basic Error - * @description Basic Error - */ - readonly "basic-error": { - readonly message?: string; - readonly documentation_url?: string; - readonly url?: string; - readonly status?: string; - }; - /** - * Validation Error Simple - * @description Validation Error Simple - */ - readonly "validation-error-simple": { - readonly message: string; - readonly documentation_url: string; - readonly errors?: string[]; + /** @description The range of the package versions affected by the vulnerability. */ + readonly vulnerable_version_range: string | null; + /** @description The package version that resolves the vulnerability. */ + readonly first_patched_version: string | null; + /** @description The functions in the package that are affected by the vulnerability. */ + readonly vulnerable_functions: string[] | null; }; /** * Simple User * @description A GitHub user. */ - readonly "nullable-simple-user": { + readonly "simple-user": { + readonly name?: string | null; + readonly email?: string | null; + /** @example octocat */ + readonly login: string; + /** @example 1 */ + readonly id: number; + /** @example MDQ6VXNlcjE= */ + readonly node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + readonly avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + readonly gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + readonly url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + readonly html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + readonly followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + readonly following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + readonly gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + readonly starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + readonly subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + readonly organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + readonly repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + readonly events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + readonly received_events_url: string; + /** @example User */ + readonly type: string; + readonly site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + readonly starred_at?: string; + }; + /** + * @description The type of credit the user is receiving. + * @enum {string} + */ + readonly "security-advisory-credit-types": "analyst" | "finder" | "reporter" | "coordinator" | "remediation_developer" | "remediation_reviewer" | "remediation_verifier" | "tool" | "sponsor" | "other"; + /** @description A GitHub Security Advisory. */ + readonly "global-advisory": { + /** @description The GitHub Security Advisory ID. */ + readonly ghsa_id: string; + /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + readonly cve_id: string | null; + /** @description The API URL for the advisory. */ + readonly url: string; + /** + * Format: uri + * @description The URL for the advisory. + */ + readonly html_url: string; + /** + * Format: uri + * @description The API URL for the repository advisory. + */ + readonly repository_advisory_url: string | null; + /** @description A short summary of the advisory. */ + readonly summary: string; + /** @description A detailed description of what the advisory entails. */ + readonly description: string | null; + /** + * @description The type of advisory. + * @enum {string} + */ + readonly type: "reviewed" | "unreviewed" | "malware"; + /** + * @description The severity of the advisory. + * @enum {string} + */ + readonly severity: "critical" | "high" | "medium" | "low" | "unknown"; + /** + * Format: uri + * @description The URL of the advisory's source code. + */ + readonly source_code_location: string | null; + readonly identifiers: { + /** + * @description The type of identifier. + * @enum {string} + */ + readonly type: "CVE" | "GHSA"; + /** @description The identifier value. */ + readonly value: string; + }[] | null; + readonly references: string[] | null; + /** + * Format: date-time + * @description The date and time of when the advisory was published, in ISO 8601 format. + */ + readonly published_at: string; + /** + * Format: date-time + * @description The date and time of when the advisory was last updated, in ISO 8601 format. + */ + readonly updated_at: string; + /** + * Format: date-time + * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. + */ + readonly github_reviewed_at: string | null; + /** + * Format: date-time + * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. + * This field is only populated when the advisory is imported from the National Vulnerability Database. + */ + readonly nvd_published_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + */ + readonly withdrawn_at: string | null; + /** @description The products and respective version ranges affected by the advisory. */ + readonly vulnerabilities: components["schemas"]["vulnerability"][] | null; + readonly cvss: { + /** @description The CVSS vector. */ + readonly vector_string: string | null; + /** @description The CVSS score. */ + readonly score: number | null; + } | null; + readonly cwes: { + /** @description The Common Weakness Enumeration (CWE) identifier. */ + readonly cwe_id: string; + /** @description The name of the CWE. */ + readonly name: string; + }[] | null; + /** @description The users who contributed to the advisory. */ + readonly credits: { + readonly user: components["schemas"]["simple-user"]; + readonly type: components["schemas"]["security-advisory-credit-types"]; + }[] | null; + }; + /** + * Basic Error + * @description Basic Error + */ + readonly "basic-error": { + readonly message?: string; + readonly documentation_url?: string; + readonly url?: string; + readonly status?: string; + }; + /** + * Validation Error Simple + * @description Validation Error Simple + */ + readonly "validation-error-simple": { + readonly message: string; + readonly documentation_url: string; + readonly errors?: string[]; + }; + /** + * Simple User + * @description A GitHub user. + */ + readonly "nullable-simple-user": { readonly name?: string | null; readonly email?: string | null; /** @example octocat */ @@ -16346,7 +17169,7 @@ export type components = { readonly webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ readonly pem?: string; - }; + } | null; /** * Format: uri * @description The URL to which the payloads will be delivered. @@ -16642,11 +17465,21 @@ export type components = { * @enum {string} */ readonly checks?: "read" | "write"; + /** + * @description The level of permission to grant the access token to create, edit, delete, and list Codespaces. + * @enum {string} + */ + readonly codespaces?: "read" | "write"; /** * @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. * @enum {string} */ readonly contents?: "read" | "write"; + /** + * @description The leve of permission to grant the access token to manage Dependabot secrets. + * @enum {string} + */ + readonly dependabot_secrets?: "read" | "write"; /** * @description The level of permission to grant the access token for deployments and deployment statuses. * @enum {string} @@ -16682,6 +17515,11 @@ export type components = { * @enum {string} */ readonly pull_requests?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. + * @enum {string} + */ + readonly repository_custom_properties?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. * @enum {string} @@ -16738,20 +17576,35 @@ export type components = { */ readonly organization_administration?: "read" | "write"; /** - * @description The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for custom repository roles management. * @enum {string} */ readonly organization_custom_roles?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom organization roles management. + * @enum {string} + */ + readonly organization_custom_org_roles?: "read" | "write"; /** * @description The level of permission to grant the access token for custom property management. * @enum {string} */ readonly organization_custom_properties?: "read" | "write" | "admin"; + /** + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @enum {string} + */ + readonly organization_copilot_seat_management?: "write"; /** * @description The level of permission to grant the access token to view and manage announcement banners for an organization. * @enum {string} */ readonly organization_announcement_banners?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view events triggered by an activity in an organization. + * @enum {string} + */ + readonly organization_events?: "read"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for an organization. * @enum {string} @@ -16802,6 +17655,41 @@ export type components = { * @enum {string} */ readonly team_discussions?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the email addresses belonging to a user. + * @enum {string} + */ + readonly email_addresses?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the followers belonging to a user. + * @enum {string} + */ + readonly followers?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage git SSH keys. + * @enum {string} + */ + readonly git_ssh_keys?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and manage GPG keys belonging to a user. + * @enum {string} + */ + readonly gpg_keys?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and manage interaction limits on a repository. + * @enum {string} + */ + readonly interaction_limits?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the profile settings belonging to a user. + * @enum {string} + */ + readonly profile?: "write"; + /** + * @description The level of permission to grant the access token to list and manage repositories a user is starring. + * @enum {string} + */ + readonly starring?: "read" | "write"; }; /** * Installation @@ -16904,7 +17792,6 @@ export type components = { /** @example octocat/Hello-World */ readonly full_name: string; readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; readonly forks: number; readonly permissions?: { readonly admin: boolean; @@ -17072,7 +17959,7 @@ export type components = { /** @example 80 */ readonly watchers_count: number; /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ readonly size: number; @@ -17155,150 +18042,6 @@ export type components = { * @example true */ readonly allow_rebase_merge: boolean; - readonly template_repository?: { - readonly id?: number; - readonly node_id?: string; - readonly name?: string; - readonly full_name?: string; - readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; - readonly avatar_url?: string; - readonly gravatar_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly organizations_url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly received_events_url?: string; - readonly type?: string; - readonly site_admin?: boolean; - }; - readonly private?: boolean; - readonly html_url?: string; - readonly description?: string; - readonly fork?: boolean; - readonly url?: string; - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly downloads_url?: string; - readonly events_url?: string; - readonly forks_url?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly notifications_url?: string; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly ssh_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly clone_url?: string; - readonly mirror_url?: string; - readonly hooks_url?: string; - readonly svn_url?: string; - readonly homepage?: string; - readonly language?: string; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; - readonly pushed_at?: string; - readonly created_at?: string; - readonly updated_at?: string; - readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; - }; - readonly allow_rebase_merge?: boolean; - readonly temp_clone_token?: string; - readonly allow_squash_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_update_branch?: boolean; - readonly use_squash_pr_title_as_default?: boolean; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - readonly allow_merge_commit?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - } | null; readonly temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. @@ -17377,8 +18120,6 @@ export type components = { * @default false */ readonly web_commit_signoff_required: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; readonly open_issues: number; readonly watchers: number; readonly master_branch?: string; @@ -17907,6 +18648,51 @@ export type components = { /** Format: uri */ readonly html_url: string | null; }; + /** + * 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: { + /** @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; + }; /** @description The security alert number. */ readonly "alert-number": number; /** @description Details for the vulnerable package. */ @@ -19314,6 +20100,7 @@ export type components = { readonly codespaces?: string[]; readonly copilot?: string[]; readonly packages?: string[]; + readonly actions?: string[]; }; }; readonly "security-and-analysis": { @@ -19487,7 +20274,7 @@ export type components = { readonly forks_count?: number; readonly stargazers_count?: number; readonly watchers_count?: number; - /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */ + /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */ readonly size?: number; readonly default_branch?: string; readonly open_issues_count?: number; @@ -20122,11 +20909,13 @@ export type components = { readonly "code-scanning-alert-dismissed-reason": null | "false positive" | "won't fix" | "used in tests"; /** @description The dismissal comment associated with the dismissal of the alert. */ readonly "code-scanning-alert-dismissed-comment": string | null; - readonly "code-scanning-alert-rule": { + readonly "code-scanning-alert-rule-summary": { /** @description A unique identifier for the rule used to detect the alert. */ readonly id?: string | null; /** @description The name of the rule used to detect the alert. */ readonly name?: string; + /** @description A set of tags applicable for the rule. */ + readonly tags?: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -20139,14 +20928,6 @@ export type components = { readonly security_severity_level?: "low" | "medium" | "high" | "critical"; /** @description A short description of the rule used to detect the alert. */ readonly description?: string; - /** @description description of the rule used to detect the alert. */ - readonly full_description?: string; - /** @description A set of tags applicable for the rule. */ - readonly tags?: string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ readonly "code-scanning-analysis-tool-version": string | null; @@ -20206,7 +20987,7 @@ export type components = { readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - readonly rule: components["schemas"]["code-scanning-alert-rule"]; + readonly rule: components["schemas"]["code-scanning-alert-rule-summary"]; readonly tool: components["schemas"]["code-scanning-analysis-tool"]; readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; readonly repository: components["schemas"]["simple-repository"]; @@ -20496,7 +21277,17 @@ export type components = { * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. * @enum {string} */ - readonly copilot_chat?: "enabled" | "disabled" | "unconfigured"; + readonly ide_chat?: "enabled" | "disabled" | "unconfigured"; + /** + * @description The organization policy for allowing or disallowing organization members to use Copilot features within github.com. + * @enum {string} + */ + readonly platform_chat?: "enabled" | "disabled" | "unconfigured"; + /** + * @description The organization policy for allowing or disallowing organization members to use Copilot within their CLI. + * @enum {string} + */ + readonly cli?: "enabled" | "disabled" | "unconfigured"; /** * @description The mode of assigning new seats. * @enum {string} @@ -20902,7 +21693,7 @@ export type components = { readonly forks_count?: number; readonly stargazers_count?: number; readonly watchers_count?: number; - /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */ + /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */ readonly size?: number; readonly default_branch?: string; readonly open_issues_count?: number; @@ -21433,11 +22224,18 @@ export type components = { /** @description Whether the property is required. */ readonly required?: boolean; /** @description Default value of the property */ - readonly default_value?: string | null; + readonly default_value?: (string | string[]) | null; /** @description Short description of the property */ readonly description?: string | null; - /** @description Ordered list of allowed values of the property */ + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ readonly allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + readonly values_editable_by?: "org_actors" | "org_and_repo_actors"; }; /** * Custom Property Value @@ -21447,7 +22245,7 @@ export type components = { /** @description The name of the property */ readonly property_name: string; /** @description The value assigned to the property */ - readonly value: string | null; + readonly value: (string | string[]) | null; }; /** * Organization Repository Custom Property Values @@ -21464,1150 +22262,395 @@ export type components = { readonly properties: components["schemas"]["custom-property-value"][]; }; /** - * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). - * @enum {string} - */ - readonly "repository-rule-enforcement": "disabled" | "active" | "evaluate"; - /** - * Repository Ruleset Bypass Actor - * @description An actor that can bypass rules in a ruleset + * Repository + * @description A repository on GitHub. */ - readonly "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. */ - readonly actor_id: number; + readonly "nullable-repository": { /** - * @description The type of actor that can bypass a ruleset - * @enum {string} + * @description Unique identifier of the repository + * @example 42 */ - readonly actor_type: "RepositoryRole" | "Team" | "Integration" | "OrganizationAdmin"; + readonly id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + readonly node_id: string; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. - * @enum {string} + * @description The name of the repository. + * @example Team Environment */ - readonly bypass_mode: "always" | "pull_request"; - }; - /** - * Repository ruleset conditions for ref names - * @description Parameters for a repository ruleset ref name condition - */ - readonly "repository-ruleset-conditions": { - readonly ref_name?: { - /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */ - readonly include?: string[]; - /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */ - readonly exclude?: string[]; - }; - }; - /** - * Repository ruleset conditions for repository names - * @description Parameters for a repository name condition - */ - readonly "repository-ruleset-conditions-repository-name-target": { - readonly repository_name: { - /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */ - readonly include?: string[]; - /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */ - readonly exclude?: string[]; - /** @description Whether renaming of target repositories is prevented. */ - readonly protected?: boolean; - }; - }; - /** - * Repository ruleset conditions for repository IDs - * @description Parameters for a repository ID condition - */ - readonly "repository-ruleset-conditions-repository-id-target": { - readonly repository_id: { - /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */ - readonly repository_ids?: number[]; - }; - }; - /** - * Organization ruleset conditions - * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - * - */ - 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"]); - /** - * creation - * @description Only allow users with bypass permission to create matching refs. - */ - readonly "repository-rule-creation": { - /** @enum {string} */ - readonly type: "creation"; - }; - /** - * update - * @description Only allow users with bypass permission to update matching refs. - */ - readonly "repository-rule-update": { - /** @enum {string} */ - readonly type: "update"; - readonly parameters?: { - /** @description Branch can pull changes from its upstream repository */ - readonly update_allows_fetch_and_merge: boolean; - }; - }; - /** - * deletion - * @description Only allow users with bypass permissions to delete matching refs. - */ - readonly "repository-rule-deletion": { - /** @enum {string} */ - readonly type: "deletion"; - }; - /** - * required_linear_history - * @description Prevent merge commits from being pushed to matching refs. - */ - readonly "repository-rule-required-linear-history": { - /** @enum {string} */ - readonly type: "required_linear_history"; - }; - /** - * required_deployments - * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. - */ - readonly "repository-rule-required-deployments": { - /** @enum {string} */ - readonly type: "required_deployments"; - readonly parameters?: { - /** @description The environments that must be successfully deployed to before branches can be merged. */ - readonly required_deployment_environments: string[]; - }; - }; - /** - * required_signatures - * @description Commits pushed to matching refs must have verified signatures. - */ - readonly "repository-rule-required-signatures": { - /** @enum {string} */ - readonly type: "required_signatures"; - }; - /** - * pull_request - * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. - */ - readonly "repository-rule-pull-request": { - /** @enum {string} */ - readonly type: "pull_request"; - readonly parameters?: { - /** @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. */ - readonly require_code_owner_review: boolean; - /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */ - readonly require_last_push_approval: boolean; - /** @description The number of approving reviews that are required before a pull request can be merged. */ - readonly required_approving_review_count: number; - /** @description All conversations on code must be resolved before a pull request can be merged. */ - readonly required_review_thread_resolution: boolean; - }; - }; - /** - * StatusCheckConfiguration - * @description Required status check - */ - readonly "repository-rule-params-status-check-configuration": { - /** @description The status check context name that must be present on the commit. */ - readonly context: string; - /** @description The optional integration ID that this status check must originate from. */ - readonly integration_id?: number; - }; - /** - * required_status_checks - * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. - */ - readonly "repository-rule-required-status-checks": { - /** @enum {string} */ - readonly type: "required_status_checks"; - readonly parameters?: { - /** @description Status checks that are required. */ - readonly required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; - /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ - readonly strict_required_status_checks_policy: boolean; - }; - }; - /** - * non_fast_forward - * @description Prevent users with push access from force pushing to refs. - */ - readonly "repository-rule-non-fast-forward": { - /** @enum {string} */ - readonly type: "non_fast_forward"; - }; - /** - * commit_message_pattern - * @description Parameters to be used for the commit_message_pattern rule - */ - readonly "repository-rule-commit-message-pattern": { - /** @enum {string} */ - readonly type: "commit_message_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - readonly pattern: string; - }; - }; - /** - * commit_author_email_pattern - * @description Parameters to be used for the commit_author_email_pattern rule - */ - readonly "repository-rule-commit-author-email-pattern": { - /** @enum {string} */ - readonly type: "commit_author_email_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - readonly pattern: string; - }; - }; - /** - * committer_email_pattern - * @description Parameters to be used for the committer_email_pattern rule - */ - readonly "repository-rule-committer-email-pattern": { - /** @enum {string} */ - readonly type: "committer_email_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - readonly pattern: string; - }; - }; - /** - * branch_name_pattern - * @description Parameters to be used for the branch_name_pattern rule - */ - readonly "repository-rule-branch-name-pattern": { - /** @enum {string} */ - readonly type: "branch_name_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - readonly pattern: string; - }; - }; - /** - * tag_name_pattern - * @description Parameters to be used for the tag_name_pattern rule - */ - readonly "repository-rule-tag-name-pattern": { - /** @enum {string} */ - readonly type: "tag_name_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - readonly pattern: string; - }; - }; - /** - * WorkflowFileReference - * @description A workflow that must run for this rule to pass - */ - readonly "repository-rule-params-workflow-file-reference": { - /** @description The path to the workflow file */ - readonly path: string; - /** @description The ref (branch or tag) of the workflow file to use */ - readonly ref?: string; - /** @description The ID of the repository where the workflow is defined */ - readonly repository_id: number; - /** @description The commit SHA of the workflow file to use */ - readonly sha?: string; - }; - /** - * workflows - * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged. - */ - readonly "repository-rule-workflows": { - /** @enum {string} */ - readonly type: "workflows"; - readonly parameters?: { - /** @description Workflows that must pass for this rule to pass. */ - readonly workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; - }; - }; - /** - * Repository Rule - * @description A repository rule. - */ - readonly "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-workflows"]; - /** - * Repository ruleset - * @description A set of rules to apply when specified conditions are met. - */ - readonly "repository-ruleset": { - /** @description The ID of the ruleset */ - readonly id: number; - /** @description The name of the ruleset */ readonly name: string; + /** @example octocat/Hello-World */ + readonly full_name: string; + readonly license: components["schemas"]["nullable-license-simple"]; + readonly forks: number; + readonly permissions?: { + readonly admin: boolean; + readonly pull: boolean; + readonly triage?: boolean; + readonly push: boolean; + readonly maintain?: boolean; + }; + readonly owner: components["schemas"]["simple-user"]; /** - * @description The target of the ruleset - * @enum {string} + * @description Whether the repository is private or public. + * @default false */ - readonly target?: "branch" | "tag"; + readonly private: boolean; /** - * @description The type of the source of the ruleset - * @enum {string} + * Format: uri + * @example https://github.com/octocat/Hello-World */ - readonly source_type?: "Repository" | "Organization"; - /** @description The name of the source */ - readonly source: string; - readonly enforcement: components["schemas"]["repository-rule-enforcement"]; - /** @description The actors that can bypass the rules in this ruleset */ - readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + readonly html_url: string; + /** @example This your first repo! */ + readonly description: string | null; + readonly fork: boolean; /** - * @description The bypass type of the user making the API request for this ruleset. This field is only returned when - * querying the repository-level endpoint. - * @enum {string} + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World */ - readonly current_user_can_bypass?: "always" | "pull_requests_only" | "never"; - readonly node_id?: string; - readonly _links?: { - readonly self?: { - /** @description The URL of the ruleset */ - readonly href?: string; - }; - readonly html?: { - /** @description The html URL of the ruleset */ - readonly href?: string; - }; - }; - readonly conditions?: components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]; - readonly rules?: components["schemas"]["repository-rule"][]; - /** Format: date-time */ - readonly created_at?: string; - /** Format: date-time */ - readonly updated_at?: string; - }; - /** - * Rule Suites - * @description Response - */ - readonly "rule-suites": { - /** @description The unique identifier of the rule insight. */ - readonly id?: number; - /** @description The number that identifies the user. */ - readonly actor_id?: number; - /** @description The handle for the GitHub user account. */ - readonly actor_name?: string; - /** @description The first commit sha before the push evaluation. */ - readonly before_sha?: string; - /** @description The last commit sha in the push evaluation. */ - readonly after_sha?: string; - /** @description The ref name that the evaluation ran on. */ - readonly ref?: string; - /** @description The ID of the repository associated with the rule evaluation. */ - readonly repository_id?: number; - /** @description The name of the repository without the `.git` extension. */ - readonly repository_name?: string; + readonly url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ + readonly archive_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ + readonly assignees_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ + readonly blobs_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ + readonly branches_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ + readonly collaborators_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ + readonly comments_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ + readonly commits_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ + readonly compare_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ + readonly contents_url: string; /** - * Format: date-time - * @example 2011-01-26T19:06:43Z + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly pushed_at?: string; + readonly contributors_url: string; /** - * @description The result of the rule evaluations for rules with the `active` enforcement status. - * @enum {string} + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly result?: "pass" | "fail" | "bypass"; + readonly deployments_url: string; /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly evaluation_result?: "pass" | "fail"; - }[]; - /** - * Rule Suite - * @description Response - */ - readonly "rule-suite": { - /** @description The unique identifier of the rule insight. */ - readonly id?: number; - /** @description The number that identifies the user. */ - readonly actor_id?: number; - /** @description The handle for the GitHub user account. */ - readonly actor_name?: string; - /** @description The first commit sha before the push evaluation. */ - readonly before_sha?: string; - /** @description The last commit sha in the push evaluation. */ - readonly after_sha?: string; - /** @description The ref name that the evaluation ran on. */ - readonly ref?: string; - /** @description The ID of the repository associated with the rule evaluation. */ - readonly repository_id?: number; - /** @description The name of the repository without the `.git` extension. */ - readonly repository_name?: string; + readonly downloads_url: string; /** - * Format: date-time - * @example 2011-01-26T19:06:43Z + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly pushed_at?: string; + readonly events_url: string; /** - * @description The result of the rule evaluations for rules with the `active` enforcement status. - * @enum {string} + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly result?: "pass" | "fail" | "bypass"; - /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} - */ - readonly evaluation_result?: "pass" | "fail"; - /** @description Details on the evaluated rules. */ - readonly rule_evaluations?: { - readonly rule_source?: { - /** @description The type of rule source. */ - readonly type?: string; - /** @description The ID of the rule source. */ - readonly id?: number | null; - /** @description The name of the rule source. */ - readonly name?: string | null; - }; - /** - * @description The enforcement level of this rule source. - * @enum {string} - */ - readonly enforcement?: "active" | "evaluate" | "deleted ruleset"; - /** - * @description The result of the evaluation of the individual rule. - * @enum {string} - */ - readonly result?: "pass" | "fail"; - /** @description The type of rule. */ - readonly rule_type?: string; - /** @description Any associated details with the rule evaluation. */ - readonly details?: string; - }[]; - }; - /** @description A product affected by the vulnerability detailed in a repository security advisory. */ - readonly "repository-advisory-vulnerability": { - /** @description The name of the package affected by the vulnerability. */ - readonly package: { - readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ - readonly name: string | null; - } | null; - /** @description The range of the package versions affected by the vulnerability. */ - readonly vulnerable_version_range: string | null; - /** @description The package version(s) that resolve the vulnerability. */ - readonly patched_versions: string | null; - /** @description The functions in the package that are affected. */ - readonly vulnerable_functions: string[] | null; - }; - /** @description A credit given to a user for a repository security advisory. */ - readonly "repository-advisory-credit": { - readonly user: components["schemas"]["simple-user"]; - readonly type: components["schemas"]["security-advisory-credit-types"]; - /** - * @description The state of the user's acceptance of the credit. - * @enum {string} - */ - readonly state: "accepted" | "declined" | "pending"; - }; - /** @description A repository security advisory. */ - readonly "repository-advisory": { - /** @description The GitHub Security Advisory ID. */ - readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - readonly cve_id: string | null; + readonly forks_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ + readonly git_commits_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ + readonly git_refs_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ + readonly git_tags_url: string; + /** @example git:github.com/octocat/Hello-World.git */ + readonly git_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ + readonly issue_comment_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ + readonly issue_events_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ + readonly issues_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ + readonly keys_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ + readonly labels_url: string; /** * Format: uri - * @description The API URL for the advisory. + * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly url: string; + readonly languages_url: string; /** * Format: uri - * @description The URL for the advisory. - */ - readonly html_url: string; - /** @description A short summary of the advisory. */ - readonly summary: string; - /** @description A detailed description of what the advisory entails. */ - readonly description: string | null; - /** - * @description The severity of the advisory. - * @enum {string|null} + * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly severity: "critical" | "high" | "medium" | "low"; - /** @description The author of the advisory. */ - readonly author: components["schemas"]["simple-user"] | null; - /** @description The publisher of the advisory. */ - readonly publisher: components["schemas"]["simple-user"] | null; - readonly identifiers: { - /** - * @description The type of identifier. - * @enum {string} - */ - readonly type: "CVE" | "GHSA"; - /** @description The identifier value. */ - readonly value: string; - }[]; + readonly merges_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ + readonly milestones_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ + readonly notifications_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ + readonly pulls_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ + readonly releases_url: string; + /** @example git@github.com:octocat/Hello-World.git */ + readonly ssh_url: string; /** - * @description The state of the advisory. - * @enum {string} + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly state: "published" | "closed" | "withdrawn" | "draft" | "triage"; + readonly stargazers_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ + readonly statuses_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was created, in ISO 8601 format. + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly created_at: string | null; + readonly subscribers_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly updated_at: string | null; + readonly subscription_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was published, in ISO 8601 format. + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly published_at: string | null; + readonly tags_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was closed, in ISO 8601 format. + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly closed_at: string | null; + readonly teams_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ + readonly trees_url: string; + /** @example https://github.com/octocat/Hello-World.git */ + readonly clone_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * Format: uri + * @example git:git.example.com/octocat/Hello-World */ - readonly withdrawn_at: string | null; - readonly submission: { - /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ - readonly accepted: boolean; - } | null; - readonly vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; - readonly cvss: { - /** @description The CVSS vector. */ - readonly vector_string: string | null; - /** @description The CVSS score. */ - readonly score: number | null; - } | null; - readonly cwes: { - /** @description The Common Weakness Enumeration (CWE) identifier. */ - readonly cwe_id: string; - /** @description The name of the CWE. */ - readonly name: string; - }[] | null; - /** @description A list of only the CWE IDs. */ - readonly cwe_ids: string[] | null; - readonly credits: { - /** @description The username of the user credited. */ - readonly login?: string; - readonly type?: components["schemas"]["security-advisory-credit-types"]; - }[] | null; - readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null; - /** @description A list of users that collaborate on the advisory. */ - readonly collaborating_users: components["schemas"]["simple-user"][] | null; - /** @description A list of teams that collaborate on the advisory. */ - readonly collaborating_teams: components["schemas"]["team"][] | null; - /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ - readonly private_fork: components["schemas"]["simple-repository"] | null; - }; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly "team-simple": { + readonly mirror_url: string | null; /** - * @description Unique identifier of the team - * @example 1 + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly id: number; - /** @example MDQ6VGVhbTE= */ - readonly node_id: string; + readonly hooks_url: string; /** * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @example https://svn.github.com/octocat/Hello-World */ - readonly url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; + readonly svn_url: string; /** - * @description Name of the team - * @example Justice League + * Format: uri + * @example https://github.com */ - readonly name: string; + readonly homepage: string | null; + readonly language: string | null; + /** @example 9 */ + readonly forks_count: number; + /** @example 80 */ + readonly stargazers_count: number; + /** @example 80 */ + readonly watchers_count: number; /** - * @description Description of the team - * @example A great team. + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + * @example 108 */ - readonly description: string | null; + readonly size: number; /** - * @description Permission that the team will have for its repositories - * @example admin + * @description The default branch of the repository. + * @example master */ - readonly permission: string; + readonly default_branch: string; + /** @example 0 */ + readonly open_issues_count: number; /** - * @description The level of privacy this team should have - * @example closed + * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false + * @example true */ - readonly privacy?: string; + readonly is_template: boolean; + readonly topics?: string[]; /** - * @description The notification setting the team has set - * @example notifications_enabled + * @description Whether issues are enabled. + * @default true + * @example true */ - readonly notification_setting?: string; + readonly has_issues: boolean; /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description Whether projects are enabled. + * @default true + * @example true */ - readonly html_url: string; + readonly has_projects: boolean; /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos + * @description Whether the wiki is enabled. + * @default true + * @example true */ - readonly repositories_url: string; - /** @example justice-league */ - readonly slug: string; + readonly has_wiki: boolean; + readonly has_pages: boolean; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com + * @deprecated + * @description Whether downloads are enabled. + * @default true + * @example true */ - readonly ldap_dn?: string; - }; - readonly "actions-billing-usage": { - /** @description The sum of the free and paid GitHub Actions minutes used. */ - readonly total_minutes_used: number; - /** @description The total paid GitHub Actions minutes used. */ - readonly total_paid_minutes_used: number; - /** @description The amount of free GitHub Actions minutes available. */ - readonly included_minutes: number; - readonly minutes_used_breakdown: { - /** @description Total minutes used on Ubuntu runner machines. */ - readonly UBUNTU?: number; - /** @description Total minutes used on macOS runner machines. */ - readonly MACOS?: number; - /** @description Total minutes used on Windows runner machines. */ - readonly WINDOWS?: number; - /** @description Total minutes used on Ubuntu 4 core runner machines. */ - readonly ubuntu_4_core?: number; - /** @description Total minutes used on Ubuntu 8 core runner machines. */ - readonly ubuntu_8_core?: number; - /** @description Total minutes used on Ubuntu 16 core runner machines. */ - readonly ubuntu_16_core?: number; - /** @description Total minutes used on Ubuntu 32 core runner machines. */ - readonly ubuntu_32_core?: number; - /** @description Total minutes used on Ubuntu 64 core runner machines. */ - readonly ubuntu_64_core?: number; - /** @description Total minutes used on Windows 4 core runner machines. */ - readonly windows_4_core?: number; - /** @description Total minutes used on Windows 8 core runner machines. */ - readonly windows_8_core?: number; - /** @description Total minutes used on Windows 16 core runner machines. */ - readonly windows_16_core?: number; - /** @description Total minutes used on Windows 32 core runner machines. */ - readonly windows_32_core?: number; - /** @description Total minutes used on Windows 64 core runner machines. */ - readonly windows_64_core?: number; - /** @description Total minutes used on macOS 12 core runner machines. */ - readonly macos_12_core?: number; - /** @description Total minutes used on all runner machines. */ - readonly total?: number; - }; - }; - readonly "packages-billing-usage": { - /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ - readonly total_gigabytes_bandwidth_used: number; - /** @description Total paid storage space (GB) for GitHuub Packages. */ - readonly total_paid_gigabytes_bandwidth_used: number; - /** @description Free storage space (GB) for GitHub Packages. */ - readonly included_gigabytes_bandwidth: number; - }; - readonly "combined-billing-usage": { - /** @description Numbers of days left in billing cycle. */ - readonly days_left_in_billing_cycle: number; - /** @description Estimated storage space (GB) used in billing cycle. */ - readonly estimated_paid_storage_for_month: number; - /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ - readonly estimated_storage_for_month: number; - }; - /** - * Team Organization - * @description Team Organization - */ - readonly "team-organization": { - /** @example github */ - readonly login: string; - /** @example 1 */ - readonly id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + readonly has_downloads: boolean; /** - * Format: uri - * @example https://api.github.com/orgs/github + * @description Whether discussions are enabled. + * @default false + * @example true */ - readonly url: string; + readonly has_discussions: boolean; /** - * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description Whether the repository is archived. + * @default false */ - readonly repos_url: string; + readonly archived: boolean; + /** @description Returns whether or not this repository disabled. */ + readonly disabled: boolean; /** - * Format: uri - * @example https://api.github.com/orgs/github/events + * @description The repository visibility: public, private, or internal. + * @default public */ - 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; - /** @example github */ - readonly name?: string; - /** @example GitHub */ - readonly company?: string; + readonly visibility: string; /** - * Format: uri - * @example https://github.com/blog + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - readonly blog?: string; - /** @example San Francisco */ - readonly location?: string; + readonly pushed_at: string | null; /** - * Format: email - * @example octocat@github.com + * Format: date-time + * @example 2011-01-26T19:01:12Z */ - readonly email?: string; - /** @example github */ - readonly twitter_username?: string | null; - /** @example true */ - readonly is_verified?: boolean; - /** @example true */ - readonly has_organization_projects: boolean; - /** @example true */ - readonly has_repository_projects: boolean; - /** @example 2 */ - readonly public_repos: number; - /** @example 1 */ - readonly public_gists: number; - /** @example 20 */ - readonly followers: number; - /** @example 0 */ - readonly following: number; + readonly created_at: string | null; /** - * Format: uri - * @example https://github.com/octocat + * Format: date-time + * @example 2011-01-26T19:14:43Z */ - readonly html_url: string; + readonly updated_at: string | null; /** - * Format: date-time - * @example 2008-01-14T04:33:35Z + * @description Whether to allow rebase merges for pull requests. + * @default true + * @example true */ - readonly created_at: string; - /** @example Organization */ - readonly type: string; - /** @example 100 */ - readonly total_private_repos?: number; - /** @example 100 */ - readonly owned_private_repos?: number; - /** @example 81 */ - readonly private_gists?: number | null; - /** @example 10000 */ - readonly disk_usage?: number | null; - /** @example 8 */ - readonly collaborators?: number | null; + readonly allow_rebase_merge: boolean; + readonly temp_clone_token?: string; /** - * Format: email - * @example org@example.com + * @description Whether to allow squash merges for pull requests. + * @default true + * @example true */ - readonly billing_email?: string | null; - readonly plan?: { - readonly name: string; - readonly space: number; - readonly private_repos: number; - readonly filled_seats?: number; - readonly seats?: number; - }; - readonly default_repository_permission?: string | null; - /** @example true */ - readonly members_can_create_repositories?: boolean | null; - /** @example true */ - readonly two_factor_requirement_enabled?: boolean | null; - /** @example all */ - readonly members_allowed_repository_creation_type?: string; - /** @example true */ - readonly members_can_create_public_repositories?: boolean; - /** @example true */ - readonly members_can_create_private_repositories?: boolean; - /** @example true */ - readonly members_can_create_internal_repositories?: boolean; - /** @example true */ - readonly members_can_create_pages?: boolean; - /** @example true */ - readonly members_can_create_public_pages?: boolean; - /** @example true */ - readonly members_can_create_private_pages?: boolean; - /** @example false */ - readonly members_can_fork_private_repositories?: boolean | null; - /** @example false */ - readonly web_commit_signoff_required?: boolean; - /** Format: date-time */ - readonly updated_at: string; - /** Format: date-time */ - readonly archived_at: string | null; - }; - /** - * Full Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly "team-full": { + readonly allow_squash_merge: boolean; /** - * @description Unique identifier of the team - * @example 42 + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false */ - readonly id: number; - /** @example MDQ6VGVhbTE= */ - readonly node_id: string; + readonly allow_auto_merge: boolean; /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false */ - readonly url: string; + readonly delete_branch_on_merge: boolean; /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + * @default false + * @example false */ - readonly html_url: string; + readonly allow_update_branch: boolean; /** - * @description Name of the team - * @example Developers + * @deprecated + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false */ - readonly name: string; - /** @example justice-league */ - readonly slug: string; - /** @example A great team. */ - readonly description: string | null; + readonly use_squash_pr_title_as_default: boolean; /** - * @description The level of privacy this team should have - * @example closed + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly privacy?: "closed" | "secret"; + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description The notification setting the team has set - * @example notifications_enabled + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** - * @description Permission that the team will have for its repositories - * @example push - */ - readonly permission: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos - */ - readonly repositories_url: string; - readonly parent?: components["schemas"]["nullable-team-simple"]; - /** @example 3 */ - readonly members_count: number; - /** @example 10 */ - readonly repos_count: number; - /** - * Format: date-time - * @example 2017-07-14T16:53:42Z - */ - readonly created_at: string; - /** - * Format: date-time - * @example 2017-08-17T12:37:15Z - */ - readonly updated_at: string; - readonly organization: components["schemas"]["team-organization"]; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - readonly ldap_dn?: string; - }; - /** - * Team Discussion - * @description A team discussion is a persistent record of a free-form conversation within a team. - */ - readonly "team-discussion": { - readonly author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the discussion. - * @example Please suggest improvements to our workflow in comments. - */ - readonly body: string; - /** @example

Hi! This is an area for us to collaborate as a team

*/ - readonly body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - readonly body_version: string; - /** @example 0 */ - readonly comments_count: number; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments - */ - readonly comments_url: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - readonly created_at: string; - /** Format: date-time */ - readonly last_edited_at: string | null; - /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1 - */ - readonly html_url: string; - /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ - readonly node_id: string; + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The unique sequence number of a team discussion. - * @example 42 + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} */ - readonly number: number; + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** - * @description Whether or not this discussion should be pinned for easy retrieval. - * @example true + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} */ - readonly pinned: boolean; + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** - * @description Whether or not this discussion should be restricted to team members and organization owners. + * @description Whether to allow merge commits for pull requests. + * @default true * @example true */ - readonly private: boolean; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027 - */ - readonly team_url: string; - /** - * @description The title of the discussion. - * @example How can we improve our workflow? - */ - readonly title: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - readonly updated_at: string; + readonly allow_merge_commit: boolean; + /** @description Whether to allow forking this repo */ + readonly allow_forking?: boolean; /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1 + * @description Whether to require contributors to sign off on web-based commits + * @default false */ - readonly url: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; + readonly web_commit_signoff_required: boolean; + readonly open_issues: number; + readonly watchers: number; + readonly master_branch?: string; + /** @example "2020-07-09T00:17:42Z" */ + readonly starred_at?: string; + /** @description Whether anonymous git access is enabled for this repository */ + readonly anonymous_access_enabled?: boolean; + } | null; /** - * Team Discussion Comment - * @description A reply to a discussion within a team. + * Code Of Conduct Simple + * @description Code of Conduct Simple */ - readonly "team-discussion-comment": { - readonly author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the comment. - * @example I agree with this suggestion. - */ - readonly body: string; - /** @example

Do you like apples?

*/ - readonly body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - readonly body_version: string; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - readonly created_at: string; - /** Format: date-time */ - readonly last_edited_at: string | null; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1 - */ - readonly discussion_url: string; - /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 - */ - readonly html_url: string; - /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ - readonly node_id: string; - /** - * @description The unique sequence number of a team discussion comment. - * @example 42 - */ - readonly number: number; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - readonly updated_at: string; + readonly "code-of-conduct-simple": { /** * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - */ - readonly url: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Reaction - * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. - */ - readonly reaction: { - /** @example 1 */ - readonly id: number; - /** @example MDg6UmVhY3Rpb24x */ - readonly node_id: string; - readonly user: components["schemas"]["nullable-simple-user"]; - /** - * @description The reaction to use - * @example heart - * @enum {string} - */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** - * Format: date-time - * @example 2016-05-20T20:09:31Z + * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - readonly created_at: string; - }; - /** - * Team Membership - * @description Team Membership - */ - readonly "team-membership": { - /** Format: uri */ readonly url: string; + /** @example citizen_code_of_conduct */ + readonly key: string; + /** @example Citizen Code of Conduct */ + readonly name: string; /** - * @description The role of the user in the team. - * @default member - * @example member - * @enum {string} - */ - readonly role: "member" | "maintainer"; - /** - * @description The state of the user's membership in the team. - * @enum {string} + * Format: uri + * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - readonly state: "active" | "pending"; - }; - /** - * Team Project - * @description A team's access to a project. - */ - readonly "team-project": { - readonly owner_url: string; - readonly url: string; - readonly html_url: string; - readonly columns_url: string; - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly body: string | null; - readonly number: number; - readonly state: string; - readonly creator: components["schemas"]["simple-user"]; - readonly created_at: string; - readonly updated_at: string; - /** @description The organization permission for this project. Only present when owner is an organization. */ - readonly organization_permission?: string; - /** @description Whether the project is private or not. Only present when owner is an organization. */ - readonly private?: boolean; - readonly permissions: { - readonly read: boolean; - readonly write: boolean; - readonly admin: boolean; - }; + readonly html_url: string | null; }; /** - * Team Repository - * @description A team's access to a repository. + * Full Repository + * @description Full Repository */ - readonly "team-repository": { - /** - * @description Unique identifier of the repository - * @example 42 - */ + readonly "full-repository": { + /** @example 1296269 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ readonly node_id: string; - /** - * @description The name of the repository. - * @example Team Environment - */ + /** @example Hello-World */ readonly name: string; /** @example octocat/Hello-World */ readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; - /** @example admin */ - readonly role_name?: string; - readonly owner: components["schemas"]["nullable-simple-user"]; - /** - * @description Whether the repository is private or public. - * @default false - */ + readonly owner: components["schemas"]["simple-user"]; readonly private: boolean; /** * Format: uri @@ -22761,790 +22804,1375 @@ export type components = { readonly stargazers_count: number; /** @example 80 */ readonly watchers_count: number; - /** @example 108 */ - readonly size: number; /** - * @description The default branch of the repository. - * @example master + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + * @example 108 */ + readonly size: number; + /** @example master */ readonly default_branch: string; /** @example 0 */ readonly open_issues_count: number; - /** - * @description Whether this repository acts as a template that can be used to generate new repositories. - * @default false - * @example true - */ - readonly is_template: boolean; + /** @example true */ + readonly is_template?: boolean; + /** @example [ + * "octocat", + * "atom", + * "electron", + * "API" + * ] */ readonly topics?: string[]; - /** - * @description Whether issues are enabled. - * @default true - * @example true - */ + /** @example true */ readonly has_issues: boolean; - /** - * @description Whether projects are enabled. - * @default true - * @example true - */ + /** @example true */ readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - * @example true - */ + /** @example true */ readonly has_wiki: boolean; readonly has_pages: boolean; - /** - * @description Whether downloads are enabled. - * @default true - * @example true - */ - readonly has_downloads: boolean; - /** - * @description Whether the repository is archived. - * @default false - */ + /** @example true */ + readonly has_downloads?: boolean; + /** @example true */ + readonly has_discussions: boolean; readonly archived: boolean; /** @description Returns whether or not this repository disabled. */ readonly disabled: boolean; /** * @description The repository visibility: public, private, or internal. - * @default public + * @example public */ - readonly visibility: string; + readonly visibility?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + readonly pushed_at: string; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + readonly created_at: string; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + readonly updated_at: string; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly push: boolean; + readonly triage?: boolean; + readonly pull: boolean; + }; + /** @example true */ + readonly allow_rebase_merge?: boolean; + readonly template_repository?: components["schemas"]["nullable-repository"]; + readonly temp_clone_token?: string | null; + /** @example true */ + readonly allow_squash_merge?: boolean; + /** @example false */ + readonly allow_auto_merge?: boolean; + /** @example false */ + readonly delete_branch_on_merge?: boolean; + /** @example true */ + readonly allow_merge_commit?: boolean; + /** @example true */ + readonly allow_update_branch?: boolean; + /** @example false */ + readonly use_squash_pr_title_as_default?: boolean; /** - * @description Whether to allow rebase merges for pull requests. - * @default true - * @example true + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @example PR_TITLE + * @enum {string} */ - readonly allow_rebase_merge: boolean; - readonly temp_clone_token?: string; + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether to allow squash merges for pull requests. - * @default true - * @example true + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @example PR_BODY + * @enum {string} */ - readonly allow_squash_merge: boolean; + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description Whether to allow Auto-merge to be used on pull requests. - * @default false - * @example false + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @example PR_TITLE + * @enum {string} */ - readonly allow_auto_merge: boolean; + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** - * @description Whether to delete head branches when pull requests are merged - * @default false - * @example false + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @example PR_BODY + * @enum {string} */ - readonly delete_branch_on_merge: boolean; + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** @example true */ + readonly allow_forking?: boolean; + /** @example false */ + readonly web_commit_signoff_required?: boolean; + /** @example 42 */ + readonly subscribers_count: number; + /** @example 0 */ + readonly network_count: number; + readonly license: components["schemas"]["nullable-license-simple"]; + readonly organization?: components["schemas"]["nullable-simple-user"]; + readonly parent?: components["schemas"]["repository"]; + readonly source?: components["schemas"]["repository"]; + readonly forks: number; + readonly master_branch?: string; + readonly open_issues: number; + readonly watchers: number; /** - * @description Whether to allow merge commits for pull requests. + * @description Whether anonymous git access is allowed. * @default true - * @example true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow forking this repo - * @default false - * @example false */ - readonly allow_forking: boolean; - /** - * @description Whether to require contributors to sign off on web-based commits - * @default false - * @example false - */ - readonly web_commit_signoff_required: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; + readonly anonymous_access_enabled: boolean; + readonly code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; + readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + readonly custom_properties?: { + readonly [key: string]: unknown; + }; }; /** - * Project Card - * @description Project cards represent a scope of work. + * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). + * @enum {string} */ - readonly "project-card": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/cards/1478 - */ - readonly url: string; - /** - * @description The project card's ID - * @example 42 - */ - readonly id: number; - /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ - readonly node_id: string; - /** @example Add payload for delete Project column */ - readonly note: string | null; - readonly creator: components["schemas"]["nullable-simple-user"]; + readonly "repository-rule-enforcement": "disabled" | "active" | "evaluate"; + /** + * Repository Ruleset Bypass Actor + * @description An actor that can bypass rules in a ruleset + */ + readonly "repository-ruleset-bypass-actor": { + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. + * */ + readonly actor_id?: number | null; /** - * Format: date-time - * @example 2016-09-05T14:21:06Z + * @description The type of actor that can bypass a ruleset. + * + * @enum {string} */ - readonly created_at: string; + readonly actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** - * Format: date-time - * @example 2016-09-05T14:20:22Z + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. + * + * @enum {string} */ - readonly updated_at: string; - /** - * @description Whether or not the card is archived - * @example false - */ - readonly archived?: boolean; - readonly column_name?: string; - readonly project_id?: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - readonly column_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test/issues/3 - */ - readonly content_url?: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - readonly project_url: string; + readonly bypass_mode: "always" | "pull_request"; }; /** - * Project Column - * @description Project columns contain cards of work. + * Repository ruleset conditions for ref names + * @description Parameters for a repository ruleset ref name condition */ - readonly "project-column": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - readonly url: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - readonly project_url: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367/cards - */ - readonly cards_url: string; - /** - * @description The unique identifier of the project column - * @example 42 - */ - readonly id: number; - /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - readonly node_id: string; - /** - * @description Name of the project column - * @example Remaining tasks - */ + readonly "repository-ruleset-conditions": { + readonly ref_name?: { + /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */ + readonly include?: string[]; + /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */ + readonly exclude?: string[]; + }; + }; + /** + * Repository ruleset conditions for repository names + * @description Parameters for a repository name condition + */ + readonly "repository-ruleset-conditions-repository-name-target": { + readonly repository_name: { + /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */ + readonly include?: string[]; + /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */ + readonly exclude?: string[]; + /** @description Whether renaming of target repositories is prevented. */ + readonly protected?: boolean; + }; + }; + /** + * Repository ruleset conditions for repository IDs + * @description Parameters for a repository ID condition + */ + readonly "repository-ruleset-conditions-repository-id-target": { + readonly repository_id: { + /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */ + readonly repository_ids?: number[]; + }; + }; + /** + * Repository ruleset property targeting definition + * @description Parameters for a targeting a repository property + */ + readonly "repository-ruleset-conditions-repository-property-spec": { + /** @description The name of the repository property to target */ readonly name: string; - /** - * Format: date-time - * @example 2016-09-05T14:18:44Z - */ - readonly created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:22:28Z - */ - readonly updated_at: string; + /** @description The values to match for the repository property */ + readonly property_values: string[]; }; /** - * Project Collaborator Permission - * @description Project Collaborator Permission + * Repository ruleset conditions for repository properties + * @description Parameters for a repository property condition */ - readonly "project-collaborator-permission": { - readonly permission: string; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly "repository-ruleset-conditions-repository-property-target": { + readonly repository_property: { + /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */ + readonly include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */ + readonly exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + }; }; - /** Rate Limit */ - readonly "rate-limit": { - readonly limit: number; - readonly remaining: number; - readonly reset: number; - readonly used: number; + /** + * Organization ruleset conditions + * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * + */ + 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"]); + /** + * creation + * @description Only allow users with bypass permission to create matching refs. + */ + readonly "repository-rule-creation": { + /** @enum {string} */ + readonly type: "creation"; }; /** - * Rate Limit Overview - * @description Rate Limit Overview + * update + * @description Only allow users with bypass permission to update matching refs. */ - readonly "rate-limit-overview": { - readonly resources: { - readonly core: components["schemas"]["rate-limit"]; - readonly graphql?: components["schemas"]["rate-limit"]; - readonly search: components["schemas"]["rate-limit"]; - readonly code_search?: components["schemas"]["rate-limit"]; - readonly source_import?: components["schemas"]["rate-limit"]; - readonly integration_manifest?: components["schemas"]["rate-limit"]; - readonly code_scanning_upload?: components["schemas"]["rate-limit"]; - readonly actions_runner_registration?: components["schemas"]["rate-limit"]; - readonly scim?: components["schemas"]["rate-limit"]; - readonly dependency_snapshots?: components["schemas"]["rate-limit"]; + readonly "repository-rule-update": { + /** @enum {string} */ + readonly type: "update"; + readonly parameters?: { + /** @description Branch can pull changes from its upstream repository */ + readonly update_allows_fetch_and_merge: boolean; }; - readonly rate: components["schemas"]["rate-limit"]; }; /** - * Repository - * @description A repository on GitHub. + * deletion + * @description Only allow users with bypass permissions to delete matching refs. */ - readonly "nullable-repository": { + readonly "repository-rule-deletion": { + /** @enum {string} */ + readonly type: "deletion"; + }; + /** + * required_linear_history + * @description Prevent merge commits from being pushed to matching refs. + */ + readonly "repository-rule-required-linear-history": { + /** @enum {string} */ + readonly type: "required_linear_history"; + }; + /** + * required_deployments + * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. + */ + readonly "repository-rule-required-deployments": { + /** @enum {string} */ + readonly type: "required_deployments"; + readonly parameters?: { + /** @description The environments that must be successfully deployed to before branches can be merged. */ + readonly required_deployment_environments: string[]; + }; + }; + /** + * required_signatures + * @description Commits pushed to matching refs must have verified signatures. + */ + readonly "repository-rule-required-signatures": { + /** @enum {string} */ + readonly type: "required_signatures"; + }; + /** + * pull_request + * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. + */ + readonly "repository-rule-pull-request": { + /** @enum {string} */ + readonly type: "pull_request"; + readonly parameters?: { + /** @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. */ + readonly require_code_owner_review: boolean; + /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */ + readonly require_last_push_approval: boolean; + /** @description The number of approving reviews that are required before a pull request can be merged. */ + readonly required_approving_review_count: number; + /** @description All conversations on code must be resolved before a pull request can be merged. */ + readonly required_review_thread_resolution: boolean; + }; + }; + /** + * StatusCheckConfiguration + * @description Required status check + */ + readonly "repository-rule-params-status-check-configuration": { + /** @description The status check context name that must be present on the commit. */ + readonly context: string; + /** @description The optional integration ID that this status check must originate from. */ + readonly integration_id?: number; + }; + /** + * required_status_checks + * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. + */ + readonly "repository-rule-required-status-checks": { + /** @enum {string} */ + readonly type: "required_status_checks"; + readonly parameters?: { + /** @description Status checks that are required. */ + readonly required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; + /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ + readonly strict_required_status_checks_policy: boolean; + }; + }; + /** + * non_fast_forward + * @description Prevent users with push access from force pushing to refs. + */ + readonly "repository-rule-non-fast-forward": { + /** @enum {string} */ + readonly type: "non_fast_forward"; + }; + /** + * commit_message_pattern + * @description Parameters to be used for the commit_message_pattern rule + */ + readonly "repository-rule-commit-message-pattern": { + /** @enum {string} */ + readonly type: "commit_message_pattern"; + readonly parameters?: { + /** @description How this rule will appear to users. */ + readonly name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + readonly negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + readonly pattern: string; + }; + }; + /** + * commit_author_email_pattern + * @description Parameters to be used for the commit_author_email_pattern rule + */ + readonly "repository-rule-commit-author-email-pattern": { + /** @enum {string} */ + readonly type: "commit_author_email_pattern"; + readonly parameters?: { + /** @description How this rule will appear to users. */ + readonly name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + readonly negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + readonly pattern: string; + }; + }; + /** + * committer_email_pattern + * @description Parameters to be used for the committer_email_pattern rule + */ + readonly "repository-rule-committer-email-pattern": { + /** @enum {string} */ + readonly type: "committer_email_pattern"; + readonly parameters?: { + /** @description How this rule will appear to users. */ + readonly name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + readonly negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + readonly pattern: string; + }; + }; + /** + * branch_name_pattern + * @description Parameters to be used for the branch_name_pattern rule + */ + readonly "repository-rule-branch-name-pattern": { + /** @enum {string} */ + readonly type: "branch_name_pattern"; + readonly parameters?: { + /** @description How this rule will appear to users. */ + readonly name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + readonly negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + readonly pattern: string; + }; + }; + /** + * tag_name_pattern + * @description Parameters to be used for the tag_name_pattern rule + */ + readonly "repository-rule-tag-name-pattern": { + /** @enum {string} */ + readonly type: "tag_name_pattern"; + readonly parameters?: { + /** @description How this rule will appear to users. */ + readonly name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + readonly negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + readonly pattern: string; + }; + }; + /** + * RestrictedCommits + * @description Restricted commit + */ + readonly "repository-rule-params-restricted-commits": { + /** @description Full or abbreviated commit hash to reject */ + readonly oid: string; + /** @description Reason for restriction */ + readonly reason?: string; + }; + /** + * WorkflowFileReference + * @description A workflow that must run for this rule to pass + */ + readonly "repository-rule-params-workflow-file-reference": { + /** @description The path to the workflow file */ + readonly path: string; + /** @description The ref (branch or tag) of the workflow file to use */ + readonly ref?: string; + /** @description The ID of the repository where the workflow is defined */ + readonly repository_id: number; + /** @description The commit SHA of the workflow file to use */ + readonly sha?: string; + }; + /** + * workflows + * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged. + */ + readonly "repository-rule-workflows": { + /** @enum {string} */ + readonly type: "workflows"; + readonly parameters?: { + /** @description Workflows that must pass for this rule to pass. */ + readonly workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; + }; + }; + /** + * CodeScanningTool + * @description A tool that must provide code scanning results for this rule to pass. + */ + readonly "repository-rule-params-code-scanning-tool": { /** - * @description Unique identifier of the repository - * @example 42 + * @description The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + * @enum {string} */ - readonly id: number; - /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + readonly alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; /** - * @description The name of the repository. - * @example Team Environment + * @description The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + * @enum {string} */ - readonly name: string; - /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; + readonly security_alerts_threshold: "none" | "critical" | "high_or_higher" | "medium_or_higher" | "all"; + /** @description The name of a code scanning tool */ + readonly tool: string; + }; + /** + * Repository Rule + * @description A repository rule. + */ + readonly "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { + /** @enum {string} */ + readonly type: "file_path_restriction"; + readonly parameters?: { + /** @description The file paths that are restricted from being pushed to the commit graph. */ + readonly restricted_file_paths: string[]; }; - readonly owner: components["schemas"]["simple-user"]; + } | { + /** @enum {string} */ + readonly type: "max_file_path_length"; + readonly parameters?: { + /** @description The maximum amount of characters allowed in file paths */ + readonly max_file_path_length: number; + }; + } | { + /** @enum {string} */ + readonly type: "file_extension_restriction"; + readonly parameters?: { + /** @description The file extensions that are restricted from being pushed to the commit graph. */ + readonly restricted_file_extensions: string[]; + }; + } | { + /** @enum {string} */ + readonly type: "max_file_size"; + readonly parameters?: { + /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ + readonly max_file_size: number; + }; + } | components["schemas"]["repository-rule-workflows"]; + /** + * Repository ruleset + * @description A set of rules to apply when specified conditions are met. + */ + readonly "repository-ruleset": { + /** @description The ID of the ruleset */ + readonly id: number; + /** @description The name of the ruleset */ + readonly name: string; /** - * @description Whether the repository is private or public. - * @default false + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. + * @enum {string} */ - readonly private: boolean; + readonly target?: "branch" | "tag" | "push"; /** - * Format: uri - * @example https://github.com/octocat/Hello-World + * @description The type of the source of the ruleset + * @enum {string} */ - readonly html_url: string; - /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + readonly source_type?: "Repository" | "Organization"; + /** @description The name of the source */ + readonly source: string; + readonly enforcement: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World + * @description The bypass type of the user making the API request for this ruleset. This field is only returned when + * querying the repository-level endpoint. + * @enum {string} */ - readonly url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + readonly current_user_can_bypass?: "always" | "pull_requests_only" | "never"; + readonly node_id?: string; + readonly _links?: { + readonly self?: { + /** @description The URL of the ruleset */ + readonly href?: string; + }; + readonly html?: { + /** @description The html URL of the ruleset */ + readonly href?: string; + }; + }; + readonly conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; + readonly rules?: components["schemas"]["repository-rule"][]; + /** Format: date-time */ + readonly created_at?: string; + /** Format: date-time */ + readonly updated_at?: string; + }; + /** + * Rule Suites + * @description Response + */ + readonly "rule-suites": { + /** @description The unique identifier of the rule insight. */ + readonly id?: number; + /** @description The number that identifies the user. */ + readonly actor_id?: number; + /** @description The handle for the GitHub user account. */ + readonly actor_name?: string; + /** @description The first commit sha before the push evaluation. */ + readonly before_sha?: string; + /** @description The last commit sha in the push evaluation. */ + readonly after_sha?: string; + /** @description The ref name that the evaluation ran on. */ + readonly ref?: string; + /** @description The ID of the repository associated with the rule evaluation. */ + readonly repository_id?: number; + /** @description The name of the repository without the `.git` extension. */ + readonly repository_name?: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/contributors + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - readonly contributors_url: string; + readonly pushed_at?: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} */ - readonly deployments_url: string; + readonly result?: "pass" | "fail" | "bypass"; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + * @enum {string} */ - readonly downloads_url: string; + readonly evaluation_result?: "pass" | "fail"; + }[]; + /** + * Rule Suite + * @description Response + */ + readonly "rule-suite": { + /** @description The unique identifier of the rule insight. */ + readonly id?: number; + /** @description The number that identifies the user. */ + readonly actor_id?: number | null; + /** @description The handle for the GitHub user account. */ + readonly actor_name?: string | null; + /** @description The first commit sha before the push evaluation. */ + readonly before_sha?: string; + /** @description The last commit sha in the push evaluation. */ + readonly after_sha?: string; + /** @description The ref name that the evaluation ran on. */ + readonly ref?: string; + /** @description The ID of the repository associated with the rule evaluation. */ + readonly repository_id?: number; + /** @description The name of the repository without the `.git` extension. */ + readonly repository_name?: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/events + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - readonly events_url: string; + readonly pushed_at?: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/forks + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} */ - readonly forks_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; - /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + readonly result?: "pass" | "fail" | "bypass"; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/languages + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + * @enum {string} */ - readonly languages_url: string; + readonly evaluation_result?: "pass" | "fail"; + /** @description Details on the evaluated rules. */ + readonly rule_evaluations?: { + readonly rule_source?: { + /** @description The type of rule source. */ + readonly type?: string; + /** @description The ID of the rule source. */ + readonly id?: number | null; + /** @description The name of the rule source. */ + readonly name?: string | null; + }; + /** + * @description The enforcement level of this rule source. + * @enum {string} + */ + readonly enforcement?: "active" | "evaluate" | "deleted ruleset"; + /** + * @description The result of the evaluation of the individual rule. + * @enum {string} + */ + readonly result?: "pass" | "fail"; + /** @description The type of rule. */ + readonly rule_type?: string; + /** @description Any associated details with the rule evaluation. */ + readonly details?: string; + }[]; + }; + /** @description A product affected by the vulnerability detailed in a repository security advisory. */ + readonly "repository-advisory-vulnerability": { + /** @description The name of the package affected by the vulnerability. */ + readonly package: { + readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + readonly name: string | null; + } | null; + /** @description The range of the package versions affected by the vulnerability. */ + readonly vulnerable_version_range: string | null; + /** @description The package version(s) that resolve the vulnerability. */ + readonly patched_versions: string | null; + /** @description The functions in the package that are affected. */ + readonly vulnerable_functions: string[] | null; + }; + /** @description A credit given to a user for a repository security advisory. */ + readonly "repository-advisory-credit": { + readonly user: components["schemas"]["simple-user"]; + readonly type: components["schemas"]["security-advisory-credit-types"]; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/merges + * @description The state of the user's acceptance of the credit. + * @enum {string} */ - readonly merges_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; - /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + readonly state: "accepted" | "declined" | "pending"; + }; + /** @description A repository security advisory. */ + readonly "repository-advisory": { + /** @description The GitHub Security Advisory ID. */ + readonly ghsa_id: string; + /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + readonly cve_id: string | null; /** * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @description The API URL for the advisory. */ - readonly stargazers_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + readonly url: string; /** * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @description The URL for the advisory. */ - readonly subscribers_url: string; + readonly html_url: string; + /** @description A short summary of the advisory. */ + readonly summary: string; + /** @description A detailed description of what the advisory entails. */ + readonly description: string | null; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @description The severity of the advisory. + * @enum {string|null} */ - readonly subscription_url: string; + readonly severity: "critical" | "high" | "medium" | "low"; + /** @description The author of the advisory. */ + readonly author: components["schemas"]["simple-user"] | null; + /** @description The publisher of the advisory. */ + readonly publisher: components["schemas"]["simple-user"] | null; + readonly identifiers: { + /** + * @description The type of identifier. + * @enum {string} + */ + readonly type: "CVE" | "GHSA"; + /** @description The identifier value. */ + readonly value: string; + }[]; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/tags + * @description The state of the advisory. + * @enum {string} */ - readonly tags_url: string; + readonly state: "published" | "closed" | "withdrawn" | "draft" | "triage"; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/teams + * Format: date-time + * @description The date and time of when the advisory was created, in ISO 8601 format. */ - readonly teams_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; - /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + readonly created_at: string | null; /** - * Format: uri - * @example git:git.example.com/octocat/Hello-World + * Format: date-time + * @description The date and time of when the advisory was last updated, in ISO 8601 format. */ - readonly mirror_url: string | null; + readonly updated_at: string | null; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/hooks + * Format: date-time + * @description The date and time of when the advisory was published, in ISO 8601 format. */ - readonly hooks_url: string; + readonly published_at: string | null; /** - * Format: uri - * @example https://svn.github.com/octocat/Hello-World + * Format: date-time + * @description The date and time of when the advisory was closed, in ISO 8601 format. */ - readonly svn_url: string; + readonly closed_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + */ + readonly withdrawn_at: string | null; + readonly submission: { + /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ + readonly accepted: boolean; + } | null; + readonly vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; + readonly cvss: { + /** @description The CVSS vector. */ + readonly vector_string: string | null; + /** @description The CVSS score. */ + readonly score: number | null; + } | null; + readonly cwes: { + /** @description The Common Weakness Enumeration (CWE) identifier. */ + readonly cwe_id: string; + /** @description The name of the CWE. */ + readonly name: string; + }[] | null; + /** @description A list of only the CWE IDs. */ + readonly cwe_ids: string[] | null; + readonly credits: { + /** @description The username of the user credited. */ + readonly login?: string; + readonly type?: components["schemas"]["security-advisory-credit-types"]; + }[] | null; + readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null; + /** @description A list of users that collaborate on the advisory. */ + readonly collaborating_users: components["schemas"]["simple-user"][] | null; + /** @description A list of teams that collaborate on the advisory. */ + readonly collaborating_teams: components["schemas"]["team"][] | null; + /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ + readonly private_fork: components["schemas"]["simple-repository"] | null; + }; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + readonly "team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + readonly id: number; + /** @example MDQ6VGVhbTE= */ + readonly node_id: string; /** * Format: uri - * @example https://github.com + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 */ - readonly homepage: string | null; - readonly language: string | null; - /** @example 9 */ - readonly forks_count: number; - /** @example 80 */ - readonly stargazers_count: number; - /** @example 80 */ - readonly watchers_count: number; + readonly url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + readonly members_url: string; /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. - * @example 108 + * @description Name of the team + * @example Justice League */ - readonly size: number; + readonly name: string; /** - * @description The default branch of the repository. - * @example master + * @description Description of the team + * @example A great team. */ - readonly default_branch: string; - /** @example 0 */ - readonly open_issues_count: number; + readonly description: string | null; /** - * @description Whether this repository acts as a template that can be used to generate new repositories. - * @default false - * @example true + * @description Permission that the team will have for its repositories + * @example admin */ - readonly is_template: boolean; - readonly topics?: string[]; + readonly permission: string; /** - * @description Whether issues are enabled. - * @default true - * @example true + * @description The level of privacy this team should have + * @example closed */ - readonly has_issues: boolean; + readonly privacy?: string; /** - * @description Whether projects are enabled. - * @default true - * @example true + * @description The notification setting the team has set + * @example notifications_enabled */ - readonly has_projects: boolean; + readonly notification_setting?: string; /** - * @description Whether the wiki is enabled. - * @default true - * @example true + * Format: uri + * @example https://github.com/orgs/rails/teams/core */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + readonly html_url: string; /** - * @deprecated - * @description Whether downloads are enabled. - * @default true - * @example true + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos */ - readonly has_downloads: boolean; + readonly repositories_url: string; + /** @example justice-league */ + readonly slug: string; /** - * @description Whether discussions are enabled. - * @default false - * @example true + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com */ - readonly has_discussions: boolean; + readonly ldap_dn?: string; + }; + readonly "actions-billing-usage": { + /** @description The sum of the free and paid GitHub Actions minutes used. */ + readonly total_minutes_used: number; + /** @description The total paid GitHub Actions minutes used. */ + readonly total_paid_minutes_used: number; + /** @description The amount of free GitHub Actions minutes available. */ + readonly included_minutes: number; + readonly minutes_used_breakdown: { + /** @description Total minutes used on Ubuntu runner machines. */ + readonly UBUNTU?: number; + /** @description Total minutes used on macOS runner machines. */ + readonly MACOS?: number; + /** @description Total minutes used on Windows runner machines. */ + readonly WINDOWS?: number; + /** @description Total minutes used on Ubuntu 4 core runner machines. */ + readonly ubuntu_4_core?: number; + /** @description Total minutes used on Ubuntu 8 core runner machines. */ + readonly ubuntu_8_core?: number; + /** @description Total minutes used on Ubuntu 16 core runner machines. */ + readonly ubuntu_16_core?: number; + /** @description Total minutes used on Ubuntu 32 core runner machines. */ + readonly ubuntu_32_core?: number; + /** @description Total minutes used on Ubuntu 64 core runner machines. */ + readonly ubuntu_64_core?: number; + /** @description Total minutes used on Windows 4 core runner machines. */ + readonly windows_4_core?: number; + /** @description Total minutes used on Windows 8 core runner machines. */ + readonly windows_8_core?: number; + /** @description Total minutes used on Windows 16 core runner machines. */ + readonly windows_16_core?: number; + /** @description Total minutes used on Windows 32 core runner machines. */ + readonly windows_32_core?: number; + /** @description Total minutes used on Windows 64 core runner machines. */ + readonly windows_64_core?: number; + /** @description Total minutes used on macOS 12 core runner machines. */ + readonly macos_12_core?: number; + /** @description Total minutes used on all runner machines. */ + readonly total?: number; + }; + }; + readonly "packages-billing-usage": { + /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ + readonly total_gigabytes_bandwidth_used: number; + /** @description Total paid storage space (GB) for GitHuub Packages. */ + readonly total_paid_gigabytes_bandwidth_used: number; + /** @description Free storage space (GB) for GitHub Packages. */ + readonly included_gigabytes_bandwidth: number; + }; + readonly "combined-billing-usage": { + /** @description Numbers of days left in billing cycle. */ + readonly days_left_in_billing_cycle: number; + /** @description Estimated storage space (GB) used in billing cycle. */ + readonly estimated_paid_storage_for_month: number; + /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ + readonly estimated_storage_for_month: number; + }; + /** + * Team Organization + * @description Team Organization + */ + readonly "team-organization": { + /** @example github */ + readonly login: string; + /** @example 1 */ + readonly id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + readonly node_id: string; /** - * @description Whether the repository is archived. - * @default false + * Format: uri + * @example https://api.github.com/orgs/github */ - readonly archived: boolean; - /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + readonly url: string; /** - * @description The repository visibility: public, private, or internal. - * @default public + * Format: uri + * @example https://api.github.com/orgs/github/repos */ - readonly visibility: string; + readonly repos_url: string; /** - * Format: date-time - * @example 2011-01-26T19:06:43Z + * Format: uri + * @example https://api.github.com/orgs/github/events */ - readonly pushed_at: string | null; + 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; + /** @example github */ + readonly name?: string; + /** @example GitHub */ + readonly company?: string; /** - * Format: date-time - * @example 2011-01-26T19:01:12Z + * Format: uri + * @example https://github.com/blog */ - readonly created_at: string | null; + readonly blog?: string; + /** @example San Francisco */ + readonly location?: string; + /** + * Format: email + * @example octocat@github.com + */ + readonly email?: string; + /** @example github */ + readonly twitter_username?: string | null; + /** @example true */ + readonly is_verified?: boolean; + /** @example true */ + readonly has_organization_projects: boolean; + /** @example true */ + readonly has_repository_projects: boolean; + /** @example 2 */ + readonly public_repos: number; + /** @example 1 */ + readonly public_gists: number; + /** @example 20 */ + readonly followers: number; + /** @example 0 */ + readonly following: number; + /** + * Format: uri + * @example https://github.com/octocat + */ + readonly html_url: string; /** * Format: date-time - * @example 2011-01-26T19:14:43Z + * @example 2008-01-14T04:33:35Z */ - readonly updated_at: string | null; + readonly created_at: string; + /** @example Organization */ + readonly type: string; + /** @example 100 */ + readonly total_private_repos?: number; + /** @example 100 */ + readonly owned_private_repos?: number; + /** @example 81 */ + readonly private_gists?: number | null; + /** @example 10000 */ + readonly disk_usage?: number | null; + /** @example 8 */ + readonly collaborators?: number | null; /** - * @description Whether to allow rebase merges for pull requests. - * @default true - * @example true + * Format: email + * @example org@example.com */ - readonly allow_rebase_merge: boolean; - readonly template_repository?: { - readonly id?: number; - readonly node_id?: string; - readonly name?: string; - readonly full_name?: string; - readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; - readonly avatar_url?: string; - readonly gravatar_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly organizations_url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly received_events_url?: string; - readonly type?: string; - readonly site_admin?: boolean; - }; - readonly private?: boolean; - readonly html_url?: string; - readonly description?: string; - readonly fork?: boolean; - readonly url?: string; - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly downloads_url?: string; - readonly events_url?: string; - readonly forks_url?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly notifications_url?: string; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly ssh_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly clone_url?: string; - readonly mirror_url?: string; - readonly hooks_url?: string; - readonly svn_url?: string; - readonly homepage?: string; - readonly language?: string; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; - readonly pushed_at?: string; - readonly created_at?: string; - readonly updated_at?: string; - readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; - }; - readonly allow_rebase_merge?: boolean; - readonly temp_clone_token?: string; - readonly allow_squash_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_update_branch?: boolean; - readonly use_squash_pr_title_as_default?: boolean; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - readonly allow_merge_commit?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - } | null; - readonly temp_clone_token?: string; + readonly billing_email?: string | null; + readonly plan?: { + readonly name: string; + readonly space: number; + readonly private_repos: number; + readonly filled_seats?: number; + readonly seats?: number; + }; + readonly default_repository_permission?: string | null; + /** @example true */ + readonly members_can_create_repositories?: boolean | null; + /** @example true */ + readonly two_factor_requirement_enabled?: boolean | null; + /** @example all */ + readonly members_allowed_repository_creation_type?: string; + /** @example true */ + readonly members_can_create_public_repositories?: boolean; + /** @example true */ + readonly members_can_create_private_repositories?: boolean; + /** @example true */ + readonly members_can_create_internal_repositories?: boolean; + /** @example true */ + readonly members_can_create_pages?: boolean; + /** @example true */ + readonly members_can_create_public_pages?: boolean; + /** @example true */ + readonly members_can_create_private_pages?: boolean; + /** @example false */ + readonly members_can_fork_private_repositories?: boolean | null; + /** @example false */ + readonly web_commit_signoff_required?: boolean; + /** Format: date-time */ + readonly updated_at: string; + /** Format: date-time */ + readonly archived_at: string | null; + }; + /** + * Full Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + readonly "team-full": { /** - * @description Whether to allow squash merges for pull requests. - * @default true - * @example true + * @description Unique identifier of the team + * @example 42 */ - readonly allow_squash_merge: boolean; + readonly id: number; + /** @example MDQ6VGVhbTE= */ + readonly node_id: string; /** - * @description Whether to allow Auto-merge to be used on pull requests. - * @default false - * @example false + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 */ - readonly allow_auto_merge: boolean; + readonly url: string; /** - * @description Whether to delete head branches when pull requests are merged - * @default false - * @example false + * Format: uri + * @example https://github.com/orgs/rails/teams/core */ - readonly delete_branch_on_merge: boolean; + readonly html_url: string; /** - * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. - * @default false - * @example false + * @description Name of the team + * @example Developers */ - readonly allow_update_branch: boolean; + readonly name: string; + /** @example justice-league */ + readonly slug: string; + /** @example A great team. */ + readonly description: string | null; /** - * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false + * @description The level of privacy this team should have + * @example closed + * @enum {string} */ - readonly use_squash_pr_title_as_default: boolean; + readonly privacy?: "closed" | "secret"; /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @description The notification setting the team has set + * @example notifications_enabled * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} + * @description Permission that the team will have for its repositories + * @example push */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + readonly permission: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + readonly members_url: string; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + readonly repositories_url: string; + readonly parent?: components["schemas"]["nullable-team-simple"]; + /** @example 3 */ + readonly members_count: number; + /** @example 10 */ + readonly repos_count: number; /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} + * Format: date-time + * @example 2017-07-14T16:53:42Z */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + readonly created_at: string; /** - * @description Whether to allow merge commits for pull requests. - * @default true - * @example true + * Format: date-time + * @example 2017-08-17T12:37:15Z */ - readonly allow_merge_commit: boolean; - /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; + readonly updated_at: string; + readonly organization: components["schemas"]["team-organization"]; /** - * @description Whether to require contributors to sign off on web-based commits - * @default false + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com */ - readonly web_commit_signoff_required: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; - /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; - /** @description Whether anonymous git access is enabled for this repository */ - readonly anonymous_access_enabled?: boolean; - } | null; + readonly ldap_dn?: string; + }; /** - * Code Of Conduct Simple - * @description Code of Conduct Simple + * Team Discussion + * @description A team discussion is a persistent record of a free-form conversation within a team. */ - readonly "code-of-conduct-simple": { + readonly "team-discussion": { + readonly author: components["schemas"]["nullable-simple-user"]; + /** + * @description The main text of the discussion. + * @example Please suggest improvements to our workflow in comments. + */ + readonly body: string; + /** @example

Hi! This is an area for us to collaborate as a team

*/ + readonly body_html: string; + /** + * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. + * @example 0307116bbf7ced493b8d8a346c650b71 + */ + readonly body_version: string; + /** @example 0 */ + readonly comments_count: number; /** * Format: uri - * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments + */ + readonly comments_url: string; + /** + * Format: date-time + * @example 2018-01-25T18:56:31Z + */ + readonly created_at: string; + /** Format: date-time */ + readonly last_edited_at: string | null; + /** + * Format: uri + * @example https://github.com/orgs/github/teams/justice-league/discussions/1 + */ + readonly html_url: string; + /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ + readonly node_id: string; + /** + * @description The unique sequence number of a team discussion. + * @example 42 + */ + readonly number: number; + /** + * @description Whether or not this discussion should be pinned for easy retrieval. + * @example true + */ + readonly pinned: boolean; + /** + * @description Whether or not this discussion should be restricted to team members and organization owners. + * @example true + */ + readonly private: boolean; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/2343027 + */ + readonly team_url: string; + /** + * @description The title of the discussion. + * @example How can we improve our workflow? + */ + readonly title: string; + /** + * Format: date-time + * @example 2018-01-25T18:56:31Z + */ + readonly updated_at: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/2343027/discussions/1 */ readonly url: string; - /** @example citizen_code_of_conduct */ - readonly key: string; - /** @example Citizen Code of Conduct */ - readonly name: string; + readonly reactions?: components["schemas"]["reaction-rollup"]; + }; + /** + * Team Discussion Comment + * @description A reply to a discussion within a team. + */ + readonly "team-discussion-comment": { + readonly author: components["schemas"]["nullable-simple-user"]; + /** + * @description The main text of the comment. + * @example I agree with this suggestion. + */ + readonly body: string; + /** @example

Do you like apples?

*/ + readonly body_html: string; + /** + * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. + * @example 0307116bbf7ced493b8d8a346c650b71 + */ + readonly body_version: string; + /** + * Format: date-time + * @example 2018-01-15T23:53:58Z + */ + readonly created_at: string; + /** Format: date-time */ + readonly last_edited_at: string | null; /** * Format: uri - * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @example https://api.github.com/organizations/1/team/2403582/discussions/1 */ - readonly html_url: string | null; + readonly discussion_url: string; + /** + * Format: uri + * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + */ + readonly html_url: string; + /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ + readonly node_id: string; + /** + * @description The unique sequence number of a team discussion comment. + * @example 42 + */ + readonly number: number; + /** + * Format: date-time + * @example 2018-01-15T23:53:58Z + */ + readonly updated_at: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + */ + readonly url: string; + readonly reactions?: components["schemas"]["reaction-rollup"]; }; /** - * Full Repository - * @description Full Repository + * Reaction + * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ - readonly "full-repository": { - /** @example 1296269 */ + readonly reaction: { + /** @example 1 */ + readonly id: number; + /** @example MDg6UmVhY3Rpb24x */ + readonly node_id: string; + readonly user: components["schemas"]["nullable-simple-user"]; + /** + * @description The reaction to use + * @example heart + * @enum {string} + */ + readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Format: date-time + * @example 2016-05-20T20:09:31Z + */ + readonly created_at: string; + }; + /** + * Team Membership + * @description Team Membership + */ + readonly "team-membership": { + /** Format: uri */ + readonly url: string; + /** + * @description The role of the user in the team. + * @default member + * @example member + * @enum {string} + */ + readonly role: "member" | "maintainer"; + /** + * @description The state of the user's membership in the team. + * @enum {string} + */ + readonly state: "active" | "pending"; + }; + /** + * Team Project + * @description A team's access to a project. + */ + readonly "team-project": { + readonly owner_url: string; + readonly url: string; + readonly html_url: string; + readonly columns_url: string; + readonly id: number; + readonly node_id: string; + readonly name: string; + readonly body: string | null; + readonly number: number; + readonly state: string; + readonly creator: components["schemas"]["simple-user"]; + readonly created_at: string; + readonly updated_at: string; + /** @description The organization permission for this project. Only present when owner is an organization. */ + readonly organization_permission?: string; + /** @description Whether the project is private or not. Only present when owner is an organization. */ + readonly private?: boolean; + readonly permissions: { + readonly read: boolean; + readonly write: boolean; + readonly admin: boolean; + }; + }; + /** + * Team Repository + * @description A team's access to a repository. + */ + readonly "team-repository": { + /** + * @description Unique identifier of the repository + * @example 42 + */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ readonly node_id: string; - /** @example Hello-World */ + /** + * @description The name of the repository. + * @example Team Environment + */ readonly name: string; /** @example octocat/Hello-World */ readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; + readonly license: components["schemas"]["nullable-license-simple"]; + readonly forks: number; + readonly permissions?: { + readonly admin: boolean; + readonly pull: boolean; + readonly triage?: boolean; + readonly push: boolean; + readonly maintain?: boolean; + }; + /** @example admin */ + readonly role_name?: string; + readonly owner: components["schemas"]["nullable-simple-user"]; + /** + * @description Whether the repository is private or public. + * @default false + */ readonly private: boolean; /** * Format: uri @@ -23698,142 +24326,252 @@ export type components = { readonly stargazers_count: number; /** @example 80 */ readonly watchers_count: number; + /** @example 108 */ + readonly size: number; /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. - * @example 108 + * @description The default branch of the repository. + * @example master */ - readonly size: number; - /** @example master */ readonly default_branch: string; /** @example 0 */ readonly open_issues_count: number; - /** @example true */ - readonly is_template?: boolean; - /** @example [ - * "octocat", - * "atom", - * "electron", - * "API" - * ] */ + /** + * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false + * @example true + */ + readonly is_template: boolean; readonly topics?: string[]; - /** @example true */ + /** + * @description Whether issues are enabled. + * @default true + * @example true + */ readonly has_issues: boolean; - /** @example true */ + /** + * @description Whether projects are enabled. + * @default true + * @example true + */ readonly has_projects: boolean; - /** @example true */ + /** + * @description Whether the wiki is enabled. + * @default true + * @example true + */ readonly has_wiki: boolean; readonly has_pages: boolean; - /** @example true */ - readonly has_downloads?: boolean; - /** @example true */ - readonly has_discussions: boolean; + /** + * @description Whether downloads are enabled. + * @default true + * @example true + */ + readonly has_downloads: boolean; + /** + * @description Whether the repository is archived. + * @default false + */ readonly archived: boolean; /** @description Returns whether or not this repository disabled. */ readonly disabled: boolean; /** * @description The repository visibility: public, private, or internal. - * @example public + * @default public */ - readonly visibility?: string; + readonly visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string; + readonly pushed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + readonly created_at: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly push: boolean; - readonly triage?: boolean; - readonly pull: boolean; - }; - /** @example true */ - readonly allow_rebase_merge?: boolean; - readonly template_repository?: components["schemas"]["nullable-repository"]; - readonly temp_clone_token?: string | null; - /** @example true */ - readonly allow_squash_merge?: boolean; - /** @example false */ - readonly allow_auto_merge?: boolean; - /** @example false */ - readonly delete_branch_on_merge?: boolean; - /** @example true */ - readonly allow_merge_commit?: boolean; - /** @example true */ - readonly allow_update_branch?: boolean; - /** @example false */ - readonly use_squash_pr_title_as_default?: boolean; + readonly updated_at: string | null; /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @example PR_TITLE - * @enum {string} + * @description Whether to allow rebase merges for pull requests. + * @default true + * @example true */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly allow_rebase_merge: boolean; + readonly temp_clone_token?: string; /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @example PR_BODY - * @enum {string} + * @description Whether to allow squash merges for pull requests. + * @default true + * @example true */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + readonly allow_squash_merge: boolean; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @example PR_TITLE - * @enum {string} + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + readonly allow_auto_merge: boolean; /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @example PR_BODY - * @enum {string} + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** @example true */ - readonly allow_forking?: boolean; - /** @example false */ - readonly web_commit_signoff_required?: boolean; - /** @example 42 */ - readonly subscribers_count: number; - /** @example 0 */ - readonly network_count: number; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly parent?: components["schemas"]["repository"]; - readonly source?: components["schemas"]["repository"]; - readonly forks: number; - readonly master_branch?: string; + readonly delete_branch_on_merge: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + * @example true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow forking this repo + * @default false + * @example false + */ + readonly allow_forking: boolean; + /** + * @description Whether to require contributors to sign off on web-based commits + * @default false + * @example false + */ + readonly web_commit_signoff_required: boolean; + readonly subscribers_count?: number; + readonly network_count?: number; readonly open_issues: number; readonly watchers: number; + readonly master_branch?: string; + }; + /** + * Project Card + * @description Project cards represent a scope of work. + */ + readonly "project-card": { /** - * @description Whether anonymous git access is allowed. - * @default true + * Format: uri + * @example https://api.github.com/projects/columns/cards/1478 */ - readonly anonymous_access_enabled: boolean; - readonly code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; - readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; + readonly url: string; + /** + * @description The project card's ID + * @example 42 + */ + readonly id: number; + /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ + readonly node_id: string; + /** @example Add payload for delete Project column */ + readonly note: string | null; + readonly creator: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @example 2016-09-05T14:21:06Z + */ + readonly created_at: string; + /** + * Format: date-time + * @example 2016-09-05T14:20:22Z + */ + readonly updated_at: string; + /** + * @description Whether or not the card is archived + * @example false + */ + readonly archived?: boolean; + readonly column_name?: string; + readonly project_id?: string; + /** + * Format: uri + * @example https://api.github.com/projects/columns/367 + */ + readonly column_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/api-playground/projects-test/issues/3 + */ + readonly content_url?: string; + /** + * Format: uri + * @example https://api.github.com/projects/120 + */ + readonly project_url: string; + }; + /** + * Project Column + * @description Project columns contain cards of work. + */ + readonly "project-column": { + /** + * Format: uri + * @example https://api.github.com/projects/columns/367 + */ + readonly url: string; + /** + * Format: uri + * @example https://api.github.com/projects/120 + */ + readonly project_url: string; + /** + * Format: uri + * @example https://api.github.com/projects/columns/367/cards + */ + readonly cards_url: string; + /** + * @description The unique identifier of the project column + * @example 42 + */ + readonly id: number; + /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ + readonly node_id: string; + /** + * @description Name of the project column + * @example Remaining tasks + */ + readonly name: string; + /** + * Format: date-time + * @example 2016-09-05T14:18:44Z + */ + readonly created_at: string; + /** + * Format: date-time + * @example 2016-09-05T14:22:28Z + */ + readonly updated_at: string; + }; + /** + * Project Collaborator Permission + * @description Project Collaborator Permission + */ + readonly "project-collaborator-permission": { + readonly permission: string; + readonly user: components["schemas"]["nullable-simple-user"]; + }; + /** Rate Limit */ + readonly "rate-limit": { + readonly limit: number; + readonly remaining: number; + readonly reset: number; + readonly used: number; + }; + /** + * Rate Limit Overview + * @description Rate Limit Overview + */ + readonly "rate-limit-overview": { + readonly resources: { + readonly core: components["schemas"]["rate-limit"]; + readonly graphql?: components["schemas"]["rate-limit"]; + readonly search: components["schemas"]["rate-limit"]; + readonly code_search?: components["schemas"]["rate-limit"]; + readonly source_import?: components["schemas"]["rate-limit"]; + readonly integration_manifest?: components["schemas"]["rate-limit"]; + readonly code_scanning_upload?: components["schemas"]["rate-limit"]; + readonly actions_runner_registration?: components["schemas"]["rate-limit"]; + readonly scim?: components["schemas"]["rate-limit"]; + readonly dependency_snapshots?: components["schemas"]["rate-limit"]; + }; + readonly rate: components["schemas"]["rate-limit"]; }; /** * Artifact @@ -23951,7 +24689,7 @@ export type components = { * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting"; + readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @description The outcome of the job. * @example success @@ -24118,7 +24856,7 @@ export type components = { * @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the * repository. * - * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization. + * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. * @enum {string} */ readonly access_level: "none" | "user" | "organization"; @@ -25284,11 +26022,11 @@ export type components = { /** @example https://example.com */ readonly details_url: string | null; /** - * @description The phase of the lifecycle that the check is currently in. + * @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed"; + readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @example neutral * @enum {string|null} @@ -25419,10 +26157,11 @@ export type components = { */ readonly head_sha: string; /** + * @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. * @example completed * @enum {string|null} */ - readonly status: "queued" | "in_progress" | "completed"; + readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @example neutral * @enum {string|null} @@ -25460,21 +26199,6 @@ export type components = { }; readonly repository: components["schemas"]["minimal-repository"]; }; - readonly "code-scanning-alert-rule-summary": { - /** @description A unique identifier for the rule used to detect the alert. */ - readonly id?: string | null; - /** @description The name of the rule used to detect the alert. */ - readonly name?: string; - /** @description A set of tags applicable for the rule. */ - readonly tags?: string[] | null; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - readonly severity?: "none" | "note" | "warning" | "error"; - /** @description A short description of the rule used to detect the alert. */ - readonly description?: string; - }; readonly "code-scanning-alert-items": { readonly number: components["schemas"]["alert-number"]; readonly created_at: components["schemas"]["alert-created-at"]; @@ -25492,6 +26216,32 @@ export type components = { readonly tool: components["schemas"]["code-scanning-analysis-tool"]; readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; }; + readonly "code-scanning-alert-rule": { + /** @description A unique identifier for the rule used to detect the alert. */ + readonly id?: string | null; + /** @description The name of the rule used to detect the alert. */ + readonly name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + readonly severity?: "none" | "note" | "warning" | "error"; + /** + * @description The security severity of the alert. + * @enum {string|null} + */ + readonly security_severity_level?: "low" | "medium" | "high" | "critical"; + /** @description A short description of the rule used to detect the alert. */ + readonly description?: string; + /** @description description of the rule used to detect the alert. */ + readonly full_description?: string; + /** @description A set of tags applicable for the rule. */ + readonly tags?: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + readonly help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + readonly help_uri?: string | null; + }; readonly "code-scanning-alert": { readonly number: components["schemas"]["alert-number"]; readonly created_at: components["schemas"]["alert-created-at"]; @@ -25659,7 +26409,7 @@ export type components = { }; /** * @description The full Git reference, formatted as `refs/heads/`, - * `refs/pull//merge`, or `refs/pull//head`. + * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main */ readonly "code-scanning-ref-full": string; @@ -27447,24 +28197,7 @@ export type components = { * ] */ readonly events: string[]; - readonly config: { - /** @example "foo@bar.com" */ - readonly email?: string; - /** @example "foo" */ - readonly password?: string; - /** @example "roomer" */ - readonly room?: string; - /** @example "foo" */ - readonly subdomain?: string; - readonly url?: components["schemas"]["webhook-config-url"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - /** @example "sha256" */ - readonly digest?: string; - readonly secret?: components["schemas"]["webhook-config-secret"]; - /** @example "abc" */ - readonly token?: string; - }; + readonly config: components["schemas"]["webhook-config"]; /** * Format: date-time * @example 2011-09-06T20:39:23Z @@ -28772,10 +29505,12 @@ export type components = { * @description The GitHub Pages deployment status. */ readonly "page-deployment": { + /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ + readonly id: number | string; /** * Format: uri * @description The URI to monitor GitHub Pages deployment status. - * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status + * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 */ readonly status_url: string; /** @@ -28791,6 +29526,14 @@ export type components = { */ readonly preview_url?: string; }; + /** GitHub Pages deployment status */ + readonly "pages-deployment-status": { + /** + * @description The current status of the deployment. + * @enum {string} + */ + readonly status?: "deployment_in_progress" | "syncing_files" | "finished_file_sync" | "updating_pages" | "purging_cdn" | "deployment_cancelled" | "deployment_failed" | "deployment_content_failed" | "deployment_attempt_error" | "deployment_lost" | "succeed"; + }; /** * Pages Health Check Status * @description Pages Health Check Status @@ -29728,6 +30471,42 @@ export type components = { /** @description The API URL to get the associated commit resource */ readonly commit_url: string; }; + /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ + readonly "secret-scanning-location-wiki-commit": { + /** + * @description The file path of the wiki page + * @example /example/Home.md + */ + readonly path: string; + /** @description Line number at which the secret starts in the file */ + readonly start_line: number; + /** @description Line number at which the secret ends in the file */ + readonly end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ + readonly start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ + readonly end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + readonly blob_sha: string; + /** + * @description The GitHub URL to get the associated wiki page + * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + readonly page_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + readonly commit_sha: string; + /** + * @description The GitHub URL to get the associated wiki commit + * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + readonly commit_url: string; + }; /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ readonly "secret-scanning-location-issue-title": { /** @@ -29755,14 +30534,86 @@ export type components = { */ readonly issue_comment_url: string; }; + /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ + readonly "secret-scanning-location-discussion-title": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082 + */ + readonly discussion_title_url: string; + }; + /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ + readonly "secret-scanning-location-discussion-body": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussion-4566270 + */ + readonly discussion_body_url: string; + }; + /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ + readonly "secret-scanning-location-discussion-comment": { + /** + * Format: uri + * @description The API URL to get the discussion comment where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + */ + readonly discussion_comment_url: string; + }; + /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ + readonly "secret-scanning-location-pull-request-title": { + /** + * 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 + */ + readonly pull_request_title_url: string; + }; + /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ + readonly "secret-scanning-location-pull-request-body": { + /** + * 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 + */ + readonly pull_request_body_url: string; + }; + /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ + readonly "secret-scanning-location-pull-request-comment": { + /** + * Format: uri + * @description The API URL to get the pull request comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + readonly pull_request_comment_url: string; + }; + /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ + readonly "secret-scanning-location-pull-request-review": { + /** + * Format: uri + * @description The API URL to get the pull request review where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + */ + readonly pull_request_review_url: string; + }; + /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ + readonly "secret-scanning-location-pull-request-review-comment": { + /** + * Format: uri + * @description The API URL to get the pull request review comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + */ + readonly pull_request_review_comment_url: string; + }; readonly "secret-scanning-location": { /** - * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found. + * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. * @example commit * @enum {string} */ - readonly type: "commit" | "issue_title" | "issue_body" | "issue_comment"; - readonly details: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"]; + readonly type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; + readonly details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; readonly "repository-advisory-create": { /** @description A short summary of the advisory. */ @@ -29801,6 +30652,11 @@ export type components = { readonly severity?: "critical" | "high" | "medium" | "low"; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ readonly cvss_vector_string?: string | null; + /** + * @description Whether to create a temporary private fork of the repository to collaborate on a fix. + * @default false + */ + readonly start_private_fork: boolean; }; readonly "private-vulnerability-report-create": { /** @description A short summary of the advisory. */ @@ -29831,6 +30687,11 @@ export type components = { readonly severity?: "critical" | "high" | "medium" | "low"; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ readonly cvss_vector_string?: string | null; + /** + * @description Whether to create a temporary private fork of the repository to collaborate on a fix. + * @default false + */ + readonly start_private_fork: boolean; }; readonly "repository-advisory-update": { /** @description A short summary of the advisory. */ @@ -31311,7 +32172,7 @@ export type components = { /** @example 80 */ readonly watchers_count: number; /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ readonly size: number; @@ -31698,6 +32559,50 @@ export type components = { /** @example "2020-07-09T00:17:55Z" */ readonly starred_at?: string; }; + /** + * branch protection rule + * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + */ + readonly webhooks_rule: { + readonly admin_enforced: boolean; + /** @enum {string} */ + readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; + readonly authorized_actor_names: string[]; + readonly authorized_actors_only: boolean; + readonly authorized_dismissal_actors_only: boolean; + readonly create_protected?: boolean; + /** Format: date-time */ + readonly created_at: string; + readonly dismiss_stale_reviews_on_push: boolean; + readonly id: number; + readonly ignore_approvals_from_contributors: boolean; + /** @enum {string} */ + readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + readonly name: string; + /** @enum {string} */ + readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; + readonly repository_id: number; + readonly require_code_owner_review: boolean; + /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ + readonly require_last_push_approval?: boolean; + readonly required_approving_review_count: number; + /** @enum {string} */ + readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; + readonly required_status_checks: string[]; + /** @enum {string} */ + readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + readonly strict_required_status_checks_policy: boolean; + /** Format: date-time */ + readonly updated_at: string; + }; /** @description A suite of checks performed on the code of a given code change */ readonly "simple-check-suite": { /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ @@ -31799,15 +32704,68 @@ export type components = { /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ readonly url: string; }; - /** - * Discussion - * @description A Discussion in a repository. - */ - readonly discussion: { - readonly active_lock_reason: string | null; - readonly answer_chosen_at: string | null; + /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + readonly webhooks_code_scanning_commit_oid: string; + /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + readonly webhooks_code_scanning_ref: string; + /** @description The pusher type for the event. Can be either `user` or a deploy key. */ + readonly webhooks_deploy_pusher_type: string; + /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ + readonly webhooks_ref_0: string; + /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ + readonly webhooks_deploy_key: { + readonly added_by?: string | null; + readonly created_at: string; + readonly id: number; + readonly key: string; + readonly last_used?: string | null; + readonly read_only: boolean; + readonly title: string; + /** Format: uri */ + readonly url: string; + readonly verified: boolean; + }; + /** Workflow */ + readonly webhooks_workflow: { + /** Format: uri */ + readonly badge_url: string; + /** Format: date-time */ + readonly created_at: string; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly name: string; + readonly node_id: string; + readonly path: string; + readonly state: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + } | null; + readonly webhooks_approver: { + 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; + 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 webhooks_reviewers: { /** User */ - readonly answer_chosen_by: { + readonly reviewer?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -31843,7 +32801,57 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - readonly answer_html_url: string | null; + /** @enum {string} */ + readonly type?: "User"; + }[]; + readonly webhooks_workflow_job_run: { + readonly conclusion: unknown; + readonly created_at: string; + readonly environment: string; + readonly html_url: string; + readonly id: number; + readonly name: unknown; + readonly status: string; + readonly updated_at: string; + }; + /** User */ + readonly webhooks_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; + 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 webhooks_answer: { /** * AuthorAssociation * @description How the author is associated with the repository. @@ -31851,27 +32859,14 @@ export type components = { */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; readonly body: string; - readonly category: { - /** Format: date-time */ - readonly created_at: string; - readonly description: string; - readonly emoji: string; - readonly id: number; - readonly is_answerable: boolean; - readonly name: string; - readonly node_id?: string; - readonly repository_id: number; - readonly slug: string; - readonly updated_at: string; - }; - readonly comments: number; + readonly child_comment_count: number; /** Format: date-time */ readonly created_at: string; + readonly discussion_id: number; readonly html_url: string; readonly id: number; - readonly locked: boolean; readonly node_id: string; - readonly number: number; + readonly parent_id: unknown; /** Reactions */ readonly reactions?: { readonly "+1": number; @@ -31887,21 +32882,6 @@ export type components = { readonly url: string; }; readonly repository_url: string; - /** - * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. - * @enum {string} - */ - readonly state: "open" | "closed" | "locked" | "converting" | "transferring"; - /** - * @description The reason for the current state - * @example resolved - * @enum {string|null} - */ - readonly state_reason: "resolved" | "outdated" | "duplicate" | "reopened"; - readonly timeline_url?: string; - readonly title: string; /** Format: date-time */ readonly updated_at: string; /** User */ @@ -31943,11797 +32923,2518 @@ export type components = { } | null; }; /** - * Merge Group - * @description A group of pull requests that the merge queue has grouped together to be merged. - * - */ - readonly "merge-group": { - /** @description The SHA of the merge group. */ - readonly head_sha: string; - /** @description The full ref of the merge group. */ - readonly head_ref: string; - /** @description The SHA of the merge group's parent commit. */ - readonly base_sha: string; - /** @description The full ref of the branch the merge group will be merged into. */ - readonly base_ref: string; - readonly head_commit: components["schemas"]["simple-commit"]; - }; - /** - * Repository - * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * Discussion + * @description A Discussion in a repository. */ - readonly "nullable-repository-webhooks": { + readonly discussion: { + readonly active_lock_reason: string | null; + readonly answer_chosen_at: string | null; + /** User */ + readonly answer_chosen_by: { + /** 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 answer_html_url: string | null; /** - * @description Unique identifier of the repository - * @example 42 + * 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"; + readonly body: string; + readonly category: { + /** Format: date-time */ + readonly created_at: string; + readonly description: string; + readonly emoji: string; + readonly id: number; + readonly is_answerable: boolean; + readonly name: string; + readonly node_id?: string; + readonly repository_id: number; + readonly slug: string; + readonly updated_at: string; + }; + readonly comments: number; + /** Format: date-time */ + readonly created_at: string; + readonly html_url: string; readonly id: number; - /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + readonly locked: boolean; readonly node_id: string; + readonly number: 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; + }; + readonly repository_url: string; /** - * @description The name of the repository. - * @example Team Environment + * @description The current state of the discussion. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. + * @enum {string} */ - readonly name: string; - /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; - readonly owner: components["schemas"]["simple-user"]; + readonly state: "open" | "closed" | "locked" | "converting" | "transferring"; /** - * @description Whether the repository is private or public. - * @default false + * @description The reason for the current state + * @example resolved + * @enum {string|null} */ - readonly private: boolean; + readonly state_reason: "resolved" | "outdated" | "duplicate" | "reopened"; + readonly timeline_url?: string; + readonly title: string; + /** Format: date-time */ + readonly updated_at: 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; + 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 webhooks_comment: { /** - * Format: uri - * @example https://github.com/octocat/Hello-World + * 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"; + readonly body: string; + readonly child_comment_count: number; + readonly created_at: string; + readonly discussion_id: number; readonly html_url: string; - /** @example This your first repo! */ + readonly id: number; + readonly node_id: string; + readonly parent_id: number | null; + /** 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; + }; + readonly repository_url: string; + readonly updated_at: 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; + 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; + }; + /** Label */ + readonly webhooks_label: { + /** @description 6-character hex code, without the leading #, identifying the color */ + readonly color: string; + readonly default: boolean; readonly description: string | null; - readonly fork: boolean; + readonly id: number; + /** @description The name of the label. */ + readonly name: string; + readonly node_id: string; /** * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World + * @description URL for the label */ readonly url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + }; + /** @description An array of repository objects that the installation can access. */ + readonly webhooks_repositories: { + readonly full_name: string; + /** @description Unique identifier of the repository */ + readonly id: number; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + }[]; + /** @description An array of repository objects, which were added to the installation. */ + readonly webhooks_repositories_added: { + readonly full_name: string; + /** @description Unique identifier of the repository */ + readonly id: number; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + }[]; + /** + * @description Describe whether all repositories have been selected or there's a selection involved + * @enum {string} + */ + readonly webhooks_repository_selection: "all" | "selected"; + /** + * issue comment + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. + */ + readonly webhooks_issue_comment: { /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/contributors + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} */ - readonly contributors_url: string; + readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue comment */ + readonly body: string; + /** Format: date-time */ + readonly created_at: string; + /** Format: uri */ + readonly html_url: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/deployments + * Format: int64 + * @description Unique identifier of the issue comment */ - readonly deployments_url: string; + readonly id: number; + /** Format: uri */ + readonly issue_url: string; + readonly node_id: string; + readonly performed_via_github_app: components["schemas"]["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 - * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @description URL for the issue comment */ - readonly downloads_url: string; + 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; + 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; + } | null; + }; + /** @description The changes to the comment. */ + readonly webhooks_changes: { + readonly body?: { + /** @description The previous version of the body. */ + readonly from: string; + }; + }; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + readonly webhooks_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; + } | null; + readonly assignees: ({ + /** 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; + } | null)[]; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/events + * 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 - * @example http://api.github.com/repos/octocat/Hello-World/forks - */ - readonly forks_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; - /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ + /** Format: uri */ + readonly html_url: string; + /** Format: int64 */ + readonly id: number; + readonly labels?: { + /** @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: uri - * @example http://api.github.com/repos/octocat/Hello-World/languages - */ - readonly languages_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/merges + * Milestone + * @description A collection of related issues and pull requests. */ - readonly merges_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; - /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/stargazers - */ - readonly stargazers_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/subscribers - */ - readonly subscribers_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/subscription - */ - readonly subscription_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/tags - */ - readonly tags_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/teams - */ - readonly teams_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; - /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; - /** - * Format: uri - * @example git:git.example.com/octocat/Hello-World - */ - readonly mirror_url: string | null; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/hooks - */ - readonly hooks_url: string; - /** - * Format: uri - * @example https://svn.github.com/octocat/Hello-World - */ - readonly svn_url: string; - /** - * Format: uri - * @example https://github.com - */ - readonly homepage: string | null; - readonly language: string | null; - /** @example 9 */ - readonly forks_count: number; - /** @example 80 */ - readonly stargazers_count: number; - /** @example 80 */ - readonly watchers_count: number; - /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. - * @example 108 - */ - readonly size: number; - /** - * @description The default branch of the repository. - * @example master - */ - readonly default_branch: string; - /** @example 0 */ - readonly open_issues_count: number; - /** - * @description Whether this repository acts as a template that can be used to generate new repositories. - * @default false - * @example true - */ - readonly is_template: boolean; - readonly topics?: string[]; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; - }; - /** - * @description Whether issues are enabled. - * @default true - * @example true - */ - readonly has_issues: boolean; - /** - * @description Whether projects are enabled. - * @default true - * @example true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - * @example true - */ - readonly has_wiki: boolean; - readonly has_pages: boolean; - /** - * @description Whether downloads are enabled. - * @default true - * @example true - */ - readonly has_downloads: boolean; - /** - * @description Whether discussions are enabled. - * @default false - * @example true - */ - readonly has_discussions: boolean; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; - /** - * @description The repository visibility: public, private, or internal. - * @default public - */ - readonly visibility: string; - /** - * Format: date-time - * @example 2011-01-26T19:06:43Z - */ - readonly pushed_at: string | null; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - readonly created_at: string | null; - /** - * Format: date-time - * @example 2011-01-26T19:14:43Z - */ - readonly updated_at: string | null; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - * @example true - */ - readonly allow_rebase_merge: boolean; - readonly template_repository?: { - readonly id?: number; - readonly node_id?: string; - readonly name?: string; - readonly full_name?: string; - readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: 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 gravatar_id?: string; - readonly url?: string; - readonly html_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 starred_url?: string; - readonly subscriptions_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; - readonly repos_url?: string; - readonly events_url?: string; + /** Format: uri */ readonly received_events_url?: string; - readonly type?: string; + /** Format: uri */ + readonly repos_url?: string; readonly site_admin?: boolean; - }; - readonly private?: boolean; - readonly html_url?: string; - readonly description?: string; - readonly fork?: boolean; - readonly url?: string; - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly downloads_url?: string; - readonly events_url?: string; - readonly forks_url?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly notifications_url?: string; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly ssh_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly clone_url?: string; - readonly mirror_url?: string; - readonly hooks_url?: string; - readonly svn_url?: string; - readonly homepage?: string; - readonly language?: string; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; - readonly pushed_at?: string; - readonly created_at?: string; - readonly updated_at?: string; - readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; - }; - readonly allow_rebase_merge?: boolean; - readonly temp_clone_token?: string; - readonly allow_squash_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_update_branch?: boolean; - readonly use_squash_pr_title_as_default?: boolean; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** 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; + } | 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 default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * @description The state of the milestone. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - readonly allow_merge_commit?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; + 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 temp_clone_token?: string; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - * @example true - */ - readonly allow_squash_merge: boolean; - /** - * @description Whether to allow Auto-merge to be used on pull requests. - * @default false - * @example false - */ - readonly allow_auto_merge: boolean; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - * @example false - */ - readonly delete_branch_on_merge: boolean; - /** - * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. - * @default false - * @example false - */ - readonly allow_update_branch: boolean; - /** - * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; + readonly node_id: string; + readonly number: number; /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} + * 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 squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + 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?: ("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; + } | 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; + }; + /** 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 The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + 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; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} + * Format: uri + * @description URL for the issue */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - * @example true - */ - readonly allow_merge_commit: boolean; - /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; - /** - * @description Whether to require contributors to sign off on web-based commits - * @default false - */ - readonly web_commit_signoff_required: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; - /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; - /** @description Whether anonymous git access is enabled for this repository */ - readonly anonymous_access_enabled?: boolean; - } | null; - /** - * Personal Access Token Request - * @description Details of a Personal Access Token Request. - */ - readonly "personal-access-token-request": { - /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */ - readonly id: number; - readonly owner: components["schemas"]["simple-user"]; - /** @description New requested permissions, categorized by type of permission. */ - readonly permissions_added: { - readonly organization?: { - readonly [key: string]: string | undefined; - }; - readonly repository?: { - readonly [key: string]: string | undefined; - }; - readonly other?: { - readonly [key: string]: string | undefined; - }; - }; - /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ - readonly permissions_upgraded: { - readonly organization?: { - readonly [key: string]: string | undefined; - }; - readonly repository?: { - readonly [key: string]: string | undefined; - }; - readonly other?: { - readonly [key: string]: string | undefined; - }; - }; - /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ - readonly permissions_result: { - readonly organization?: { - readonly [key: string]: string | undefined; - }; - readonly repository?: { - readonly [key: string]: string | undefined; - }; - readonly other?: { - readonly [key: string]: string | undefined; - }; - }; - /** - * @description Type of repository selection requested. - * @enum {string} - */ - readonly repository_selection: "none" | "all" | "subset"; - /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ - readonly repository_count: number | null; - /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ - readonly repositories: { - readonly full_name: string; - /** @description Unique identifier of the repository */ + 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; readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[] | null; - /** @description Date and time when the request for access was created. */ - readonly created_at: string; - /** @description Whether the associated fine-grained personal access token has expired. */ - readonly token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ - readonly token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ - readonly token_last_used_at: string | null; + 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; + } | null; }; /** - * Projects v2 Project - * @description A projects v2 project + * Milestone + * @description A collection of related issues and pull requests. */ - readonly "projects-v2": { - readonly id: number; - readonly node_id: string; - readonly owner: components["schemas"]["simple-user"]; - readonly creator: components["schemas"]["simple-user"]; - readonly title: string; - readonly description: string | null; - readonly public: boolean; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ + readonly webhooks_milestone: { + /** Format: date-time */ readonly closed_at: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ + readonly closed_issues: number; + /** Format: date-time */ readonly created_at: string; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly updated_at: string; - readonly number: number; - readonly short_description: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly deleted_at: string | null; - readonly deleted_by: components["schemas"]["nullable-simple-user"]; - }; - /** - * Projects v2 Item Content Type - * @description The type of content tracked in a project item - * @enum {string} - */ - readonly "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; - /** - * Projects v2 Item - * @description An item belonging to a project - */ - readonly "projects-v2-item": { + /** 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; + } | null; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; + /** Format: uri */ + readonly html_url: string; readonly id: number; - readonly node_id?: string; - readonly project_node_id?: string; - readonly content_node_id: string; - readonly content_type: components["schemas"]["projects-v2-item-content-type"]; - readonly creator?: components["schemas"]["simple-user"]; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly created_at: string; + /** Format: uri */ + readonly labels_url: string; + readonly node_id: string; + /** @description The number of the milestone. */ + readonly number: number; + readonly open_issues: number; /** - * Format: date-time - * @example 2022-04-28T12:00:00Z + * @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: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly archived_at: string | null; + /** Format: uri */ + readonly url: string; }; /** - * @description The reason for resolving the alert. - * @enum {string|null} + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited"; - readonly "secret-scanning-alert-webhook": { - readonly number?: components["schemas"]["alert-number"]; - readonly created_at?: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["nullable-alert-updated-at"]; - readonly url?: components["schemas"]["alert-url"]; - readonly html_url?: components["schemas"]["alert-html-url"]; - /** - * Format: uri - * @description The REST API URL of the code locations for this alert. - */ - readonly locations_url?: string; - readonly resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; - /** - * Format: date-time - * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly resolved_at?: string | null; - readonly resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ - readonly resolution_comment?: string | null; - /** @description The type of secret that secret scanning detected. */ - readonly secret_type?: string; - /** @description Whether push protection was bypassed for the detected secret. */ - readonly push_protection_bypassed?: boolean | null; - readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; - /** - * Format: date-time - * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly push_protection_bypassed_at?: string | null; - }; - /** branch protection configuration disabled event */ - readonly "webhook-branch-protection-configuration-disabled": { - /** @enum {string} */ - readonly action: "disabled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection configuration enabled event */ - readonly "webhook-branch-protection-configuration-enabled": { - /** @enum {string} */ - readonly action: "enabled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection rule created event */ - readonly "webhook-branch-protection-rule-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - readonly rule: { - readonly admin_enforced: boolean; - /** @enum {string} */ - readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - readonly authorized_actor_names: string[]; - readonly authorized_actors_only: boolean; - readonly authorized_dismissal_actors_only: boolean; - readonly create_protected?: boolean; - /** Format: date-time */ - readonly created_at: string; - readonly dismiss_stale_reviews_on_push: boolean; + readonly webhooks_issue_2: { + /** @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 ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - readonly name: string; - /** @enum {string} */ - readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; - readonly repository_id: number; - readonly require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - readonly require_last_push_approval?: boolean; - readonly required_approving_review_count: number; - /** @enum {string} */ - readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; - readonly required_status_checks: string[]; + 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 required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + readonly assignees: ({ + /** 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 signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - readonly strict_required_status_checks_policy: boolean; - /** Format: date-time */ - readonly updated_at: string; - }; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection rule deleted event */ - readonly "webhook-branch-protection-rule-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null)[]; /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} */ - readonly rule: { - readonly admin_enforced: boolean; - /** @enum {string} */ - readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - readonly authorized_actor_names: string[]; - readonly authorized_actors_only: boolean; - readonly authorized_dismissal_actors_only: boolean; - readonly create_protected?: boolean; - /** Format: date-time */ - readonly created_at: string; - readonly dismiss_stale_reviews_on_push: boolean; + 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?: { + /** @description 6-character hex code, without the leading #, identifying the color */ + readonly color: string; + readonly default: boolean; + readonly description: string | null; readonly id: number; - readonly ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + /** @description The name of the label. */ readonly name: string; - /** @enum {string} */ - readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; - readonly repository_id: number; - readonly require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - readonly require_last_push_approval?: boolean; - readonly required_approving_review_count: number; - /** @enum {string} */ - readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; - readonly required_status_checks: string[]; - /** @enum {string} */ - readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - readonly strict_required_status_checks_policy: boolean; - /** Format: date-time */ - readonly updated_at: string; - }; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection rule edited event */ - readonly "webhook-branch-protection-rule-edited": { - /** @enum {string} */ - readonly action: "edited"; - /** @description If the action was `edited`, the changes to the rule. */ - readonly changes?: { - readonly admin_enforced?: { - readonly from: boolean | null; - }; - readonly authorized_actor_names?: { - readonly from: string[]; - }; - readonly authorized_actors_only?: { - readonly from: boolean | null; - }; - readonly authorized_dismissal_actors_only?: { - readonly from: boolean | null; - }; - readonly linear_history_requirement_enforcement_level?: { - /** @enum {string} */ - readonly from: "off" | "non_admins" | "everyone"; - }; - readonly required_status_checks?: { - readonly from: string[]; - }; - readonly required_status_checks_enforcement_level?: { - /** @enum {string} */ - readonly from: "off" | "non_admins" | "everyone"; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; + readonly node_id: string; + /** + * Format: uri + * @description URL for the label + */ + readonly url: string; + }[]; + /** Format: uri-template */ + readonly labels_url: string; + readonly locked?: boolean; /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + * Milestone + * @description A collection of related issues and pull requests. */ - readonly rule: { - readonly admin_enforced: boolean; - /** @enum {string} */ - readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - readonly authorized_actor_names: string[]; - readonly authorized_actors_only: boolean; - readonly authorized_dismissal_actors_only: boolean; - readonly create_protected?: boolean; + readonly milestone: { + /** Format: date-time */ + readonly closed_at: string | null; + readonly closed_issues: number; /** Format: date-time */ readonly created_at: string; - readonly dismiss_stale_reviews_on_push: boolean; - readonly id: number; - readonly ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - readonly name: string; - /** @enum {string} */ - readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; - readonly repository_id: number; - readonly require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - readonly require_last_push_approval?: boolean; - readonly required_approving_review_count: number; - /** @enum {string} */ - readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; - readonly required_status_checks: string[]; - /** @enum {string} */ - readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - readonly strict_required_status_checks_policy: boolean; + /** 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"; + /** Format: uri */ + readonly url?: 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?: ("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 */ + 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; + } | 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"; + /** @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; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + /** 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} + */ + 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; + 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; }; - /** Check Run Completed Event */ - readonly "webhook-check-run-completed": { + /** User */ + readonly webhooks_user_mannequin: { + /** 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 action?: "completed"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** - * Check Run Completed Event - * @description The check_run.completed webhook encoded with URL encoding - */ - readonly "webhook-check-run-completed-form-encoded": { - /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + readonly url?: string; + } | null; + /** Marketplace Purchase */ + readonly webhooks_marketplace_purchase: { + readonly account: { + readonly id: number; + readonly login: string; + readonly node_id: string; + readonly organization_billing_email: string | null; + readonly type: string; + }; + readonly billing_cycle: string; + readonly free_trial_ends_on: string | null; + readonly next_billing_date: string | null; + readonly on_free_trial: boolean; + readonly plan: { + readonly bullets: (string | null)[]; + readonly description: string; + readonly has_free_trial: boolean; + readonly id: number; + readonly monthly_price_in_cents: number; + readonly name: string; + /** @enum {string} */ + readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + readonly unit_name: string | null; + readonly yearly_price_in_cents: number; + }; + readonly unit_count: number; }; - /** Check Run Created Event */ - readonly "webhook-check-run-created": { - /** @enum {string} */ - readonly action?: "created"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + /** Marketplace Purchase */ + readonly webhooks_previous_marketplace_purchase: { + readonly account: { + readonly id: number; + readonly login: string; + readonly node_id: string; + readonly organization_billing_email: string | null; + readonly type: string; + }; + readonly billing_cycle: string; + readonly free_trial_ends_on: unknown; + readonly next_billing_date?: string | null; + readonly on_free_trial: boolean; + readonly plan: { + readonly bullets: string[]; + readonly description: string; + readonly has_free_trial: boolean; + readonly id: number; + readonly monthly_price_in_cents: number; + readonly name: string; + /** @enum {string} */ + readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + readonly unit_name: string | null; + readonly yearly_price_in_cents: number; + }; + readonly unit_count: number; }; /** - * Check Run Created Event - * @description The check_run.created webhook encoded with URL encoding + * Team + * @description Groups of organization members that gives permissions on specified repositories. */ - readonly "webhook-check-run-created-form-encoded": { - /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; - }; - /** Check Run Requested Action Event */ - readonly "webhook-check-run-requested-action": { + readonly webhooks_team: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** + * @description Whether team members will receive notifications when their team is @mentioned + * @enum {string} + */ + readonly notification_setting: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; /** @enum {string} */ - readonly action: "requested_action"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - /** @description The action requested by the user. */ - readonly requested_action?: { - /** @description The integrator reference of the action requested by the user. */ - readonly identifier?: string; - }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly privacy?: "open" | "closed" | "secret"; + /** @enum {string} */ + readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; }; /** - * Check Run Requested Action Event - * @description The check_run.requested_action webhook encoded with URL encoding + * Merge Group + * @description A group of pull requests that the merge queue has grouped together to be merged. + * */ - readonly "webhook-check-run-requested-action-form-encoded": { - /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; - }; - /** Check Run Re-Requested Event */ - readonly "webhook-check-run-rerequested": { - /** @enum {string} */ - readonly action?: "rerequested"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly "merge-group": { + /** @description The SHA of the merge group. */ + readonly head_sha: string; + /** @description The full ref of the merge group. */ + readonly head_ref: string; + /** @description The SHA of the merge group's parent commit. */ + readonly base_sha: string; + /** @description The full ref of the branch the merge group will be merged into. */ + readonly base_ref: string; + readonly head_commit: components["schemas"]["simple-commit"]; }; /** - * Check Run Re-Requested Event - * @description The check_run.rerequested webhook encoded with URL encoding + * Repository + * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property + * when the event occurs from activity in a repository. */ - readonly "webhook-check-run-rerequested-form-encoded": { - /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; - }; - /** check_suite completed event */ - readonly "webhook-check-suite-completed": { - /** @enum {string} */ - readonly action: "completed"; - /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - readonly check_suite: { - readonly after: string | null; - /** - * 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 app: { - /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; - /** @description The list of events for the GitHub app */ - readonly 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" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; - /** 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; - } | 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; - }; - readonly before: string | null; - /** Format: uri */ - readonly check_runs_url: string; - /** - * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. - * @enum {string|null} - */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ - readonly created_at: string; - /** @description The head branch name the changes are on. */ - readonly head_branch: string | null; - /** SimpleCommit */ - readonly head_commit: { - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly author: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly committer: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; - }; - /** @description The SHA of the head commit that is being checked. */ - readonly head_sha: string; - readonly id: number; - readonly latest_check_runs_count: number; - readonly node_id: string; - /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; - /** - * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - * @enum {string|null} - */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; - /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL that points to the check suite API resource. - */ - readonly url: string; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** check_suite requested event */ - readonly "webhook-check-suite-requested": { - /** @enum {string} */ - readonly action: "requested"; - /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - readonly check_suite: { - readonly after: string | null; - /** - * 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 app: { - /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; - /** @description The list of events for the GitHub app */ - readonly 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" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; - /** 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; - } | 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; - }; - readonly before: string | null; - /** Format: uri */ - readonly check_runs_url: string; - /** - * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. - * @enum {string|null} - */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; - /** Format: date-time */ - readonly created_at: string; - /** @description The head branch name the changes are on. */ - readonly head_branch: string | null; - /** SimpleCommit */ - readonly head_commit: { - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly author: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly committer: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; - }; - /** @description The SHA of the head commit that is being checked. */ - readonly head_sha: string; - readonly id: number; - readonly latest_check_runs_count: number; - readonly node_id: string; - /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; - /** - * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - * @enum {string|null} - */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL that points to the check suite API resource. - */ - readonly url: string; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** check_suite rerequested event */ - readonly "webhook-check-suite-rerequested": { - /** @enum {string} */ - readonly action: "rerequested"; - /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - readonly check_suite: { - readonly after: string | null; - /** - * 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 app: { - /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; - /** @description The list of events for the GitHub app */ - readonly 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" | "merge_queue_entry" | "workflow_job")[]; - /** 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; - } | 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; - }; - readonly before: string | null; - /** Format: uri */ - readonly check_runs_url: string; - /** - * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. - * @enum {string|null} - */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - readonly created_at: string; - /** @description The head branch name the changes are on. */ - readonly head_branch: string | null; - /** SimpleCommit */ - readonly head_commit: { - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly author: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly committer: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; - }; - /** @description The SHA of the head commit that is being checked. */ - readonly head_sha: string; - readonly id: number; - readonly latest_check_runs_count: number; - readonly node_id: string; - /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; - /** - * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - * @enum {string|null} - */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL that points to the check suite API resource. - */ - readonly url: string; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert appeared_in_branch event */ - readonly "webhook-code-scanning-alert-appeared-in-branch": { - /** @enum {string} */ - readonly action: "appeared_in_branch"; - /** @description The code scanning alert involved in the event. */ - readonly alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - readonly created_at: string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly dismissed_at: string | null; - /** User */ - readonly dismissed_by: { - /** 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; - /** - * @description The reason for dismissing or closing the alert. - * @enum {string|null} - */ - readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly html_url: string; - /** Alert Instance */ - readonly most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: string[]; - readonly commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; - }; - readonly message?: { - readonly text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { - /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - readonly severity: "none" | "note" | "warning" | "error" | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - readonly tool: { - /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; - /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; - }; - /** Format: uri */ - readonly url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly commit_oid: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly ref: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert closed_by_user event */ - readonly "webhook-code-scanning-alert-closed-by-user": { - /** @enum {string} */ - readonly action: "closed_by_user"; - /** @description The code scanning alert involved in the event. */ - readonly alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - readonly created_at: string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly dismissed_at: string; - /** User */ - readonly dismissed_by: { - /** 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; - /** - * @description The reason for dismissing or closing the alert. - * @enum {string|null} - */ - readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly html_url: string; - /** Alert Instance */ - readonly most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: string[]; - readonly commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; - }; - readonly message?: { - readonly text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { - /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "dismissed" | "fixed"; - readonly tool: { - readonly guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; - /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; - }; - /** Format: uri */ - readonly url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly commit_oid: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly ref: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert created event */ - readonly "webhook-code-scanning-alert-created": { - /** @enum {string} */ - readonly action: "created"; - /** @description The code scanning alert involved in the event. */ - readonly alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - readonly created_at: string | null; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: unknown; - readonly dismissed_by: unknown; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - readonly dismissed_reason: unknown; - readonly fixed_at?: unknown; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly html_url: string; - readonly instances_url?: string; - /** Alert Instance */ - readonly most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: string[]; - readonly commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; - }; - readonly message?: { - readonly text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { - /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed"; - readonly tool: { - readonly guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; - /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; - } | null; - readonly updated_at?: string | null; - /** Format: uri */ - readonly url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly commit_oid: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly ref: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert fixed event */ - readonly "webhook-code-scanning-alert-fixed": { - /** @enum {string} */ - readonly action: "fixed"; - /** @description The code scanning alert involved in the event. */ - readonly alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - readonly created_at: string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly dismissed_at: string | null; - /** User */ - readonly dismissed_by: { - /** 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; - /** - * @description The reason for dismissing or closing the alert. - * @enum {string|null} - */ - readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly html_url: string; - /** Format: uri */ - readonly instances_url?: string; - /** Alert Instance */ - readonly most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: string[]; - readonly commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; - }; - readonly message?: { - readonly text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { - /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "fixed"; - readonly tool: { - readonly guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; - /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; - }; - /** Format: uri */ - readonly url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly commit_oid: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly ref: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert reopened event */ - readonly "webhook-code-scanning-alert-reopened": { - /** @enum {string} */ - readonly action: "reopened"; - /** @description The code scanning alert involved in the event. */ - readonly alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - readonly created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: string | null; - readonly dismissed_by: Record; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - readonly dismissed_reason: string | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly html_url: string; - /** Alert Instance */ - readonly most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: string[]; - readonly commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; - }; - readonly message?: { - readonly text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { - /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - readonly tool: { - readonly guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; - /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; - }; - /** Format: uri */ - readonly url: string; - } | null; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly commit_oid: string | null; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly ref: string | null; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert reopened_by_user event */ - readonly "webhook-code-scanning-alert-reopened-by-user": { - /** @enum {string} */ - readonly action: "reopened_by_user"; - /** @description The code scanning alert involved in the event. */ - readonly alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - readonly created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: unknown; - readonly dismissed_by: unknown; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - readonly dismissed_reason: unknown; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly html_url: string; - /** Alert Instance */ - readonly most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: string[]; - readonly commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; - }; - readonly message?: { - readonly text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { - /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - readonly severity: "none" | "note" | "warning" | "error" | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "fixed"; - readonly tool: { - /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; - /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; - }; - /** Format: uri */ - readonly url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly commit_oid: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly ref: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** commit_comment created event */ - readonly "webhook-commit-comment-created": { - /** - * @description The action performed. Can be `created`. - * @enum {string} - */ - readonly action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ - readonly comment: { - /** - * 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 The text of the comment. */ - readonly body: string; - /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; - readonly created_at: string; - /** Format: uri */ - readonly html_url: string; - /** @description The ID of the commit comment. */ - readonly id: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; - /** @description The node ID of the commit comment. */ - readonly node_id: string; - /** @description The relative path of the file to which the comment applies. */ - readonly path: string | null; - /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; - /** 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; - }; - readonly updated_at: string; - /** Format: uri */ - 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; - 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 enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** create event */ - readonly "webhook-create": { - /** @description The repository's current description. */ - readonly description: string | null; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The name of the repository's default branch (usually `main`). */ - readonly master_branch: string; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The pusher type for the event. Can be either `user` or a deploy key. */ - readonly pusher_type: string; - /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ - readonly ref: string; - /** - * @description The type of Git ref object created in the repository. - * @enum {string} - */ - readonly ref_type: "tag" | "branch"; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** custom property created event */ - readonly "webhook-custom-property-created": { - /** @enum {string} */ - readonly action: "created"; - readonly definition: components["schemas"]["org-custom-property"]; - 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-webhooks"]; - }; - /** custom property deleted event */ - readonly "webhook-custom-property-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly definition: { - /** @description The name of the property that was deleted. */ - readonly property_name: string; - }; - 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-webhooks"]; - }; - /** custom property updated event */ - readonly "webhook-custom-property-updated": { - /** @enum {string} */ - readonly action: "updated"; - readonly definition: components["schemas"]["org-custom-property"]; - 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-webhooks"]; - }; - /** Custom property values updated event */ - readonly "webhook-custom-property-values-updated": { - /** @enum {string} */ - readonly action: "updated"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - /** @description The new custom property values for the repository. */ - readonly new_property_values: components["schemas"]["custom-property-value"][]; - /** @description The old custom property values for the repository. */ - readonly old_property_values: components["schemas"]["custom-property-value"][]; - }; - /** delete event */ - readonly "webhook-delete": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The pusher type for the event. Can be either `user` or a deploy key. */ - readonly pusher_type: string; - /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ - readonly ref: string; - /** - * @description The type of Git ref object deleted in the repository. - * @enum {string} - */ - readonly ref_type: "tag" | "branch"; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert auto-dismissed event */ - readonly "webhook-dependabot-alert-auto-dismissed": { - /** @enum {string} */ - readonly action: "auto_dismissed"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert auto-reopened event */ - readonly "webhook-dependabot-alert-auto-reopened": { - /** @enum {string} */ - readonly action: "auto_reopened"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert created event */ - readonly "webhook-dependabot-alert-created": { - /** @enum {string} */ - readonly action: "created"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert dismissed event */ - readonly "webhook-dependabot-alert-dismissed": { - /** @enum {string} */ - readonly action: "dismissed"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert fixed event */ - readonly "webhook-dependabot-alert-fixed": { - /** @enum {string} */ - readonly action: "fixed"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert reintroduced event */ - readonly "webhook-dependabot-alert-reintroduced": { - /** @enum {string} */ - readonly action: "reintroduced"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert reopened event */ - readonly "webhook-dependabot-alert-reopened": { - /** @enum {string} */ - readonly action: "reopened"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** deploy_key created event */ - readonly "webhook-deploy-key-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ - readonly key: { - readonly added_by?: string | null; - readonly created_at: string; - readonly id: number; - readonly key: string; - readonly last_used?: string | null; - readonly read_only: boolean; - readonly title: string; - /** Format: uri */ - readonly url: string; - readonly verified: boolean; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** deploy_key deleted event */ - readonly "webhook-deploy-key-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ - readonly key: { - readonly added_by?: string | null; - readonly created_at: string; - readonly id: number; - readonly key: string; - readonly last_used?: string | null; - readonly read_only: boolean; - readonly title: string; - /** Format: uri */ - readonly url: string; - readonly verified: boolean; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** deployment created event */ - readonly "webhook-deployment-created": { - /** @enum {string} */ - readonly action: "created"; - /** - * Deployment - * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). - */ - readonly deployment: { - 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"; - /** Format: uri */ - readonly url?: string; - } | null; - readonly description: string | null; - readonly environment: string; - readonly id: number; - readonly node_id: string; - readonly original_environment: string; - readonly payload: Record | string; - /** - * 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?: ("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" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; - /** 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; - } | 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"; - /** @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 production_environment?: boolean; - readonly ref: string; - /** Format: uri */ - readonly repository_url: string; - readonly sha: string; - /** Format: uri */ - readonly statuses_url: string; - readonly task: string; - readonly transient_environment?: boolean; - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - readonly workflow: { - /** Format: uri */ - readonly badge_url: string; - /** Format: date-time */ - readonly created_at: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly state: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - } | null; - /** Deployment Workflow Run */ - readonly workflow_run: { - /** User */ - readonly actor: { - /** 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 artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; - /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - readonly created_at: string; - readonly display_title: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: unknown; - readonly head_repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: unknown; - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly referenced_workflows?: { - readonly path: string; - readonly ref?: string; - readonly sha: string; - }[] | null; - readonly repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; - /** Format: date-time */ - readonly run_started_at: string; - /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ - readonly triggering_actor?: { - /** 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; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; - } | null; - }; - /** deployment protection rule requested event */ - readonly "webhook-deployment-protection-rule-requested": { - /** @enum {string} */ - readonly action?: "requested"; - /** @description The name of the environment that has the deployment protection rule. */ - readonly environment?: string; - /** @description The event that triggered the deployment protection rule. */ - readonly event?: string; - /** - * Format: uri - * @description The URL to review the deployment protection rule. - */ - readonly deployment_callback_url?: string; - readonly deployment?: components["schemas"]["deployment"]; - readonly pull_requests?: components["schemas"]["pull-request"][]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - readonly "webhook-deployment-review-approved": { - /** @enum {string} */ - readonly action: "approved"; - readonly approver?: { - 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; - 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 comment?: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly reviewers?: { - /** User */ - readonly reviewer?: { - /** 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; - /** @enum {string} */ - readonly type?: "User"; - }[]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly since: string; - readonly workflow_job_run?: { - readonly conclusion: unknown; - readonly created_at: string; - readonly environment: string; - readonly html_url: string; - readonly id: number; - readonly name: unknown; - readonly status: string; - readonly updated_at: string; - }; - readonly workflow_job_runs?: { - readonly conclusion?: unknown; - readonly created_at?: string; - readonly environment?: string; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly status?: string; - readonly updated_at?: string; - }[]; - /** Deployment Workflow Run */ - readonly workflow_run: { - /** User */ - readonly actor: { - /** 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 artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; - /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - readonly created_at: string; - readonly display_title: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: Record; - readonly head_repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly referenced_workflows?: { - readonly path: string; - readonly ref?: string; - readonly sha: string; - }[] | null; - readonly repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; - /** Format: date-time */ - readonly run_started_at: string; - /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ - readonly triggering_actor: { - /** 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; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; - } | null; - }; - readonly "webhook-deployment-review-rejected": { - /** @enum {string} */ - readonly action: "rejected"; - readonly approver?: { - 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; - 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 comment?: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly reviewers?: { - /** User */ - readonly reviewer?: { - /** 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; - /** @enum {string} */ - readonly type?: "User"; - }[]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly since: string; - readonly workflow_job_run?: { - readonly conclusion: unknown; - readonly created_at: string; - readonly environment: string; - readonly html_url: string; - readonly id: number; - readonly name: unknown; - readonly status: string; - readonly updated_at: string; - }; - readonly workflow_job_runs?: { - readonly conclusion?: string | null; - readonly created_at?: string; - readonly environment?: string; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly status?: string; - readonly updated_at?: string; - }[]; - /** Deployment Workflow Run */ - readonly workflow_run: { - /** User */ - readonly actor: { - /** 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 artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; - /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - readonly created_at: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: Record; - readonly head_repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly referenced_workflows?: { - readonly path: string; - readonly ref?: string; - readonly sha: string; - }[] | null; - readonly repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; - /** Format: date-time */ - readonly run_started_at: string; - /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; - /** User */ - readonly triggering_actor: { - /** 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; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; - readonly display_title: string; - } | null; - }; - readonly "webhook-deployment-review-requested": { - /** @enum {string} */ - readonly action: "requested"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly environment: string; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - /** User */ - readonly requestor: { - /** 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 reviewers: { - /** User */ - readonly reviewer?: { - /** 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; - /** @enum {string} */ - readonly type?: "User" | "Team"; - }[]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly since: string; - readonly workflow_job_run: { - readonly conclusion: unknown; - readonly created_at: string; - readonly environment: string; - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly status: string; - readonly updated_at: string; - }; - /** Deployment Workflow Run */ - readonly workflow_run: { - /** User */ - readonly actor: { - /** 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 artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; - /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - readonly created_at: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: Record; - readonly head_repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly referenced_workflows?: { - readonly path: string; - readonly ref?: string; - readonly sha: string; - }[] | null; - readonly repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; - /** Format: date-time */ - readonly run_started_at: string; - /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ - readonly triggering_actor: { - /** 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; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; - readonly display_title: string; - } | null; - }; - /** deployment_status created event */ - readonly "webhook-deployment-status-created": { - /** @enum {string} */ - readonly action: "created"; - readonly check_run?: { - /** Format: date-time */ - readonly completed_at: string | null; - /** - * @description The result of the completed check run. This value will be `null` until the check run has completed. - * @enum {string|null} - */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; - /** Format: uri */ - readonly details_url: string; - readonly external_id: string; - /** @description The SHA of the commit that is being checked. */ - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - /** @description The id of the check. */ - readonly id: number; - /** @description The name of the check run. */ - readonly name: string; - readonly node_id: string; - /** Format: date-time */ - readonly started_at: string; - /** - * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. - * @enum {string} - */ - readonly status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; - /** Format: uri */ - readonly url: string; - } | null; - /** - * Deployment - * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). - */ - readonly deployment: { - 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"; - /** Format: uri */ - readonly url?: string; - } | null; - readonly description: string | null; - readonly environment: string; - readonly id: number; - readonly node_id: string; - readonly original_environment: string; - readonly payload: (string | Record) | null; - /** - * 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?: ("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" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; - /** 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; - } | 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"; - /** @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 production_environment?: boolean; - readonly ref: string; - /** Format: uri */ - readonly repository_url: string; - readonly sha: string; - /** Format: uri */ - readonly statuses_url: string; - readonly task: string; - readonly transient_environment?: boolean; - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ - readonly deployment_status: { - 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"; - /** Format: uri */ - readonly url?: string; - } | null; - /** Format: uri */ - readonly deployment_url: string; - /** @description The optional human-readable description added to the status. */ - readonly description: string; - readonly environment: string; - /** Format: uri */ - readonly environment_url?: string; - readonly id: number; - /** Format: uri */ - readonly log_url?: string; - readonly node_id: string; - /** - * 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?: ("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" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; - /** 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; - } | 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"; - /** @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; - /** Format: uri */ - readonly repository_url: string; - /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ - readonly state: string; - /** @description The optional link added to the status. */ - readonly target_url: string; - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - readonly workflow?: { - /** Format: uri */ - readonly badge_url: string; - /** Format: date-time */ - readonly created_at: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly state: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - } | null; - /** Deployment Workflow Run */ - readonly workflow_run?: { - /** User */ - readonly actor: { - /** 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 artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; - /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; - /** Format: date-time */ - readonly created_at: string; - readonly display_title: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: unknown; - readonly head_repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: unknown; - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly referenced_workflows?: { - readonly path: string; - readonly ref?: string; - readonly sha: string; - }[] | null; - readonly repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; - /** Format: date-time */ - readonly run_started_at: string; - /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ - readonly triggering_actor: { - /** 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; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; - } | null; - }; - /** discussion answered event */ - readonly "webhook-discussion-answered": { - /** @enum {string} */ - readonly action: "answered"; - readonly answer: { - /** - * 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"; - readonly body: string; - readonly child_comment_count: number; - /** Format: date-time */ - readonly created_at: string; - readonly discussion_id: number; - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly parent_id: unknown; - /** 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; - }; - readonly repository_url: string; - /** Format: date-time */ - readonly updated_at: 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; - 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 discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion category changed event */ - readonly "webhook-discussion-category-changed": { - /** @enum {string} */ - readonly action: "category_changed"; - readonly changes: { - readonly category: { - readonly from: { - /** Format: date-time */ - readonly created_at: string; - readonly description: string; - readonly emoji: string; - readonly id: number; - readonly is_answerable: boolean; - readonly name: string; - readonly node_id?: string; - readonly repository_id: number; - readonly slug: string; - readonly updated_at: string; - }; - }; - }; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion closed event */ - readonly "webhook-discussion-closed": { - /** @enum {string} */ - readonly action: "closed"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion_comment created event */ - readonly "webhook-discussion-comment-created": { - /** @enum {string} */ - readonly action: "created"; - readonly comment: { - /** - * 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"; - readonly body: string; - readonly child_comment_count: number; - readonly created_at: string; - readonly discussion_id: number; - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly parent_id: number | null; - /** 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; - }; - readonly repository_url: string; - readonly updated_at: 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; - 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 discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion_comment deleted event */ - readonly "webhook-discussion-comment-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly comment: { - /** - * 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"; - readonly body: string; - readonly child_comment_count: number; - readonly created_at: string; - readonly discussion_id: number; - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly parent_id: number | null; - /** 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; - }; - readonly repository_url: string; - readonly updated_at: 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; - 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 discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion_comment edited event */ - readonly "webhook-discussion-comment-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly body: { - readonly from: string; - }; - }; - readonly comment: { - /** - * 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"; - readonly body: string; - readonly child_comment_count: number; - readonly created_at: string; - readonly discussion_id: number; - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly parent_id: number | null; - /** 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; - }; - readonly repository_url: string; - readonly updated_at: 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; - 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 discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion created event */ - readonly "webhook-discussion-created": { - /** @enum {string} */ - readonly action: "created"; - readonly discussion: { - readonly active_lock_reason: string | null; - readonly answer_chosen_at: string | null; - /** User */ - readonly answer_chosen_by: { - /** 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 answer_html_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"; - readonly body: string | null; - readonly category: { - /** Format: date-time */ - readonly created_at: string; - readonly description: string; - readonly emoji: string; - readonly id: number; - readonly is_answerable: boolean; - readonly name: string; - readonly node_id?: string; - readonly repository_id: number; - readonly slug: string; - readonly updated_at: string; - }; - readonly comments: number; - /** Format: date-time */ - readonly created_at: string; - readonly html_url: string; - readonly id: number; - readonly locked: boolean; - readonly node_id: string; - readonly number: 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; - }; - readonly repository_url: string; - /** @enum {string} */ - readonly state: "open" | "locked" | "converting" | "transferring"; - readonly timeline_url?: string; - readonly title: string; - /** Format: date-time */ - readonly updated_at: 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; - 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 active_lock_reason?: unknown; - readonly answer_chosen_at: unknown; - readonly answer_chosen_by: unknown; - readonly answer_html_url: string | null; - readonly author_association?: string; - readonly body?: string | null; - readonly category?: { - readonly created_at?: string; - readonly description?: string; - readonly emoji?: string; - readonly id?: number; - readonly is_answerable?: boolean; - readonly name?: string; - readonly node_id?: string; - readonly repository_id?: number; - readonly slug?: string; - readonly updated_at?: string; - }; - readonly comments?: number; - readonly created_at?: string; - readonly html_url?: string; - readonly id?: number; - /** @enum {boolean} */ - readonly locked: false; - readonly node_id?: string; - readonly number?: number; - 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: "open" | "converting" | "transferring"; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: 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; - 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 enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion deleted event */ - readonly "webhook-discussion-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion edited event */ - readonly "webhook-discussion-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes?: { - readonly body?: { - readonly from: string; - }; - readonly title?: { - readonly from: string; - }; - }; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion labeled event */ - readonly "webhook-discussion-labeled": { - /** @enum {string} */ - readonly action: "labeled"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** Label */ - readonly label: { - /** @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 organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion locked event */ - readonly "webhook-discussion-locked": { - /** @enum {string} */ - readonly action: "locked"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion pinned event */ - readonly "webhook-discussion-pinned": { - /** @enum {string} */ - readonly action: "pinned"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion reopened event */ - readonly "webhook-discussion-reopened": { - /** @enum {string} */ - readonly action: "reopened"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion transferred event */ - readonly "webhook-discussion-transferred": { - /** @enum {string} */ - readonly action: "transferred"; - readonly changes: { - readonly new_discussion: components["schemas"]["discussion"]; - readonly new_repository: components["schemas"]["repository-webhooks"]; - }; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unanswered event */ - readonly "webhook-discussion-unanswered": { - /** @enum {string} */ - readonly action: "unanswered"; - readonly discussion: components["schemas"]["discussion"]; - readonly old_answer: { - /** - * 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"; - readonly body: string; - readonly child_comment_count: number; - /** Format: date-time */ - readonly created_at: string; - readonly discussion_id: number; - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly parent_id: unknown; - /** 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; - }; - readonly repository_url: string; - /** Format: date-time */ - readonly updated_at: 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; - 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 organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unlabeled event */ - readonly "webhook-discussion-unlabeled": { - /** @enum {string} */ - readonly action: "unlabeled"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** Label */ - readonly label: { - /** @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 organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unlocked event */ - readonly "webhook-discussion-unlocked": { - /** @enum {string} */ - readonly action: "unlocked"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unpinned event */ - readonly "webhook-discussion-unpinned": { - /** @enum {string} */ - readonly action: "unpinned"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** - * fork event - * @description A user forks a repository. - */ - readonly "webhook-fork": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */ - readonly forkee: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; - /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: 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; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - } & { - readonly allow_forking?: boolean; - readonly archive_url?: string; - readonly archived?: boolean; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly clone_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly created_at?: string; - readonly default_branch?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly disabled?: boolean; - readonly downloads_url?: string; - readonly events_url?: string; - /** @enum {boolean} */ - readonly fork?: true; - readonly forks?: number; - readonly forks_count?: number; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly has_downloads?: boolean; - readonly has_issues?: boolean; - readonly has_pages?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly homepage?: string | null; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly is_template?: boolean; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly language?: unknown; - readonly languages_url?: string; - readonly license?: Record; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly mirror_url?: unknown; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly open_issues?: number; - readonly open_issues_count?: number; - readonly owner?: { - 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; - 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 private?: boolean; - readonly public?: boolean; - readonly pulls_url?: string; - readonly pushed_at?: string; - readonly releases_url?: string; - readonly size?: number; - readonly ssh_url?: string; - readonly stargazers_count?: number; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly svn_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly topics?: unknown[]; - readonly trees_url?: string; - readonly updated_at?: string; - readonly url?: string; - readonly visibility?: string; - readonly watchers?: number; - readonly watchers_count?: number; - }; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** github_app_authorization revoked event */ - readonly "webhook-github-app-authorization-revoked": { - /** @enum {string} */ - readonly action: "revoked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** gollum event */ - readonly "webhook-gollum": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The pages that were updated. */ - readonly pages: { - /** - * @description The action that was performed on the page. Can be `created` or `edited`. - * @enum {string} - */ - readonly action: "created" | "edited"; - /** - * Format: uri - * @description Points to the HTML wiki page. - */ - readonly html_url: string; - /** @description The name of the page. */ - readonly page_name: string; - /** @description The latest commit SHA of the page. */ - readonly sha: string; - readonly summary: string | null; - /** @description The current page title. */ - readonly title: string; - }[]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation created event */ - readonly "webhook-installation-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - readonly repositories?: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - readonly repository?: components["schemas"]["repository-webhooks"]; - /** User */ - readonly requester?: { - /** 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 sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation deleted event */ - readonly "webhook-installation-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - readonly repositories?: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation new_permissions_accepted event */ - readonly "webhook-installation-new-permissions-accepted": { - /** @enum {string} */ - readonly action: "new_permissions_accepted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - readonly repositories?: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation_repositories added event */ - readonly "webhook-installation-repositories-added": { - /** @enum {string} */ - readonly action: "added"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects, which were added to the installation. */ - readonly repositories_added: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - /** @description An array of repository objects, which were removed from the installation. */ - readonly repositories_removed: { - readonly full_name?: string; - /** @description Unique identifier of the repository */ - readonly id?: number; - /** @description The name of the repository. */ - readonly name?: string; - readonly node_id?: string; - /** @description Whether the repository is private or public. */ - readonly private?: boolean; - }[]; - readonly repository?: components["schemas"]["repository-webhooks"]; - /** - * @description Describe whether all repositories have been selected or there's a selection involved - * @enum {string} - */ - readonly repository_selection: "all" | "selected"; - /** User */ - readonly requester: { - /** 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 sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation_repositories removed event */ - readonly "webhook-installation-repositories-removed": { - /** @enum {string} */ - readonly action: "removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects, which were added to the installation. */ - readonly repositories_added: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - /** @description An array of repository objects, which were removed from the installation. */ - readonly repositories_removed: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - readonly repository?: components["schemas"]["repository-webhooks"]; - /** - * @description Describe whether all repositories have been selected or there's a selection involved - * @enum {string} - */ - readonly repository_selection: "all" | "selected"; - /** User */ - readonly requester: { - /** 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 sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation suspend event */ - readonly "webhook-installation-suspend": { - /** @enum {string} */ - readonly action: "suspend"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - readonly repositories?: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - readonly "webhook-installation-target-renamed": { - readonly account: { - readonly archived_at?: string | null; - readonly avatar_url: string; - readonly created_at?: string; - readonly description?: unknown; - readonly events_url?: string; - readonly followers?: number; - readonly followers_url?: string; - readonly following?: number; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly has_organization_projects?: boolean; - readonly has_repository_projects?: boolean; - readonly hooks_url?: string; - readonly html_url: string; - readonly id: number; - readonly is_verified?: boolean; - readonly issues_url?: string; - readonly login?: string; - readonly members_url?: string; - readonly name?: string; - readonly node_id: string; - readonly organizations_url?: string; - readonly public_gists?: number; - readonly public_members_url?: string; - readonly public_repos?: number; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly slug?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly updated_at?: string; - readonly url?: string; - readonly website_url?: unknown; - }; - /** @enum {string} */ - readonly action: "renamed"; - readonly changes: { - readonly login?: { - readonly from: string; - }; - readonly slug?: { - readonly from: string; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - readonly target_type: string; - }; - /** installation unsuspend event */ - readonly "webhook-installation-unsuspend": { - /** @enum {string} */ - readonly action: "unsuspend"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - readonly repositories?: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issue_comment created event */ - readonly "webhook-issue-comment-created": { - /** @enum {string} */ - readonly action: "created"; - /** - * issue comment - * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. - */ - readonly comment: { - /** - * 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 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; - 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 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; - } | null; - readonly assignees: ({ - /** 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; - } | 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?: { - /** @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; - /** - * 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; - } | 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?: ("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; - } | 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; - 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} - */ - 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; - 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; - } | 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; - } | null; - readonly assignees?: 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: { - /** @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; - 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-webhooks"]; - }; - /** issue_comment deleted event */ - readonly "webhook-issue-comment-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - /** - * issue comment - * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. - */ - readonly comment: { - /** - * 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 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; - 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; - } | 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; - } | null; - readonly assignees: ({ - /** 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; - } | 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?: { - /** @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; - /** - * 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; - } | 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?: ("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 */ - 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; - } | 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"; - /** @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; - }; - /** 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} - */ - 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; - 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; - } | 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; - } | null; - readonly assignees?: 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: { - /** @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; - 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-webhooks"]; - }; - /** issue_comment edited event */ - readonly "webhook-issue-comment-edited": { - /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the comment. */ - readonly changes: { - readonly body?: { - /** @description The previous version of the body. */ - readonly from: string; - }; - }; - /** - * issue comment - * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. - */ - readonly comment: { - /** - * 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 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; - 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; - } | 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; - } | null; - readonly assignees: ({ - /** 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; - } | 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?: { - /** @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; - /** - * 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; - } | 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?: ("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; - } | 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; - }; - /** 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} - */ - 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; - 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; - } | 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; - } | null; - readonly assignees?: 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: { - /** @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; - 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-webhooks"]; - }; - /** issues assigned event */ - readonly "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - readonly action: "assigned"; - /** 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 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" | "Mannequin"; - /** Format: uri */ - readonly url?: string; - } | null; - readonly assignees: ({ - /** 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; - } | 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?: { - /** @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; - /** - * 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; - } | 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?: ("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; - } | 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; - }; - /** 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} - */ - 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; - 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; - } | null; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** 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; - /** 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; - } | null; - readonly assignees: ({ - /** 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; - } | 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?: { - /** @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; - /** - * 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; - } | 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?: ("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 */ - 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; - } | 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; - }; - /** 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} - */ - 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; - 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; - } | null; - } & { - readonly active_lock_reason?: string | null; - readonly assignee?: Record; - readonly assignees?: 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?: 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; - 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-webhooks"]; - }; - /** issues deleted event */ - readonly "webhook-issues-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - 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: ({ - /** 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?: { - /** @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; - /** - * 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"; - /** Format: uri */ - readonly url?: 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?: ("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; - } | 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"; - /** @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; - }; - /** 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} - */ - 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; - 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 organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues demilestoned event */ - readonly "webhook-issues-demilestoned": { - /** @enum {string} */ - readonly action: "demilestoned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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; - } | null; - readonly assignees: ({ - /** 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; - } | 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?: { - /** @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; - /** - * 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; - } | 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?: ("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 */ - 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; - } | 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; - }; - /** 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} - */ - 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; - 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; - } | null; - } & { - readonly active_lock_reason?: string | null; - readonly assignee?: Record; - readonly assignees?: 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?: Record[]; - 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; - } | 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; - 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; - readonly state?: string; - 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; - 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 "nullable-repository-webhooks": { /** - * Milestone - * @description A collection of related issues and pull requests. + * @description Unique identifier of the repository + * @example 42 */ - 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; - } | 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; + readonly id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + readonly node_id: string; + /** + * @description The name of the repository. + * @example Team Environment + */ + readonly name: string; + /** @example octocat/Hello-World */ + readonly full_name: string; + readonly license: components["schemas"]["nullable-license-simple"]; + readonly organization?: components["schemas"]["nullable-simple-user"]; + readonly forks: number; + readonly permissions?: { + readonly admin: boolean; + readonly pull: boolean; + readonly triage?: boolean; + readonly push: boolean; + readonly maintain?: boolean; }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues edited event */ - readonly "webhook-issues-edited": { - /** @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 owner: components["schemas"]["simple-user"]; + /** + * @description Whether the repository is private or public. + * @default false + */ + readonly private: boolean; + /** + * Format: uri + * @example https://github.com/octocat/Hello-World + */ + readonly html_url: string; + /** @example This your first repo! */ + readonly description: string | null; + readonly fork: boolean; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World + */ + readonly url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ + readonly archive_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ + readonly assignees_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ + readonly blobs_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ + readonly branches_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ + readonly collaborators_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ + readonly comments_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ + readonly commits_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ + readonly compare_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ + readonly contents_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/contributors + */ + readonly contributors_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/deployments + */ + readonly deployments_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/downloads + */ + readonly downloads_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/events + */ + readonly events_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/forks + */ + readonly forks_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ + readonly git_commits_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ + readonly git_refs_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ + readonly git_tags_url: string; + /** @example git:github.com/octocat/Hello-World.git */ + readonly git_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ + readonly issue_comment_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ + readonly issue_events_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ + readonly issues_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ + readonly keys_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ + readonly labels_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/languages + */ + readonly languages_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/merges + */ + readonly merges_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ + readonly milestones_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ + readonly notifications_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ + readonly pulls_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ + readonly releases_url: string; + /** @example git@github.com:octocat/Hello-World.git */ + readonly ssh_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/stargazers + */ + readonly stargazers_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ + readonly statuses_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/subscribers + */ + readonly subscribers_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/subscription + */ + readonly subscription_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/tags + */ + readonly tags_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/teams + */ + readonly teams_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ + readonly trees_url: string; + /** @example https://github.com/octocat/Hello-World.git */ + readonly clone_url: string; + /** + * Format: uri + * @example git:git.example.com/octocat/Hello-World + */ + readonly mirror_url: string | null; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/hooks + */ + readonly hooks_url: string; + /** + * Format: uri + * @example https://svn.github.com/octocat/Hello-World + */ + readonly svn_url: string; + /** + * Format: uri + * @example https://github.com + */ + readonly homepage: string | null; + readonly language: string | null; + /** @example 9 */ + readonly forks_count: number; + /** @example 80 */ + readonly stargazers_count: number; + /** @example 80 */ + readonly watchers_count: number; + /** + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + * @example 108 + */ + readonly size: number; + /** + * @description The default branch of the repository. + * @example master + */ + readonly default_branch: string; + /** @example 0 */ + readonly open_issues_count: number; + /** + * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false + * @example true + */ + readonly is_template: boolean; + readonly topics?: string[]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + readonly custom_properties?: { + readonly [key: string]: unknown; }; - 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. + * @description Whether issues are enabled. + * @default true + * @example true */ - readonly issue: { - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ - readonly assignee?: { - /** Format: uri */ + readonly has_issues: boolean; + /** + * @description Whether projects are enabled. + * @default true + * @example true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + * @example true + */ + readonly has_wiki: boolean; + readonly has_pages: boolean; + /** + * @description Whether downloads are enabled. + * @default true + * @example true + */ + readonly has_downloads: boolean; + /** + * @description Whether discussions are enabled. + * @default false + * @example true + */ + readonly has_discussions: boolean; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** @description Returns whether or not this repository disabled. */ + readonly disabled: boolean; + /** + * @description The repository visibility: public, private, or internal. + * @default public + */ + readonly visibility: string; + /** + * Format: date-time + * @example 2011-01-26T19:06:43Z + */ + readonly pushed_at: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + readonly created_at: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:14:43Z + */ + readonly updated_at: string | null; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + * @example true + */ + readonly allow_rebase_merge: boolean; + readonly template_repository?: { + readonly id?: number; + readonly node_id?: string; + readonly name?: string; + readonly full_name?: string; + readonly owner?: { + readonly login?: string; + readonly id?: number; + readonly node_id?: string; 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; - } | null; - readonly assignees: ({ - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ + readonly html_url?: string; 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 starred_url?: string; + readonly subscriptions_url?: string; readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ readonly repos_url?: string; + readonly events_url?: string; + readonly received_events_url?: string; + readonly type?: 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; - } | null)[]; + }; + readonly private?: boolean; + readonly html_url?: string; + readonly description?: string; + readonly fork?: boolean; + readonly url?: string; + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly downloads_url?: string; + readonly events_url?: string; + readonly forks_url?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly git_url?: string; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly notifications_url?: string; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly ssh_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly clone_url?: string; + readonly mirror_url?: string; + readonly hooks_url?: string; + readonly svn_url?: string; + readonly homepage?: string; + readonly language?: string; + readonly forks_count?: number; + readonly stargazers_count?: number; + readonly watchers_count?: number; + readonly size?: number; + readonly default_branch?: string; + readonly open_issues_count?: number; + readonly is_template?: boolean; + readonly topics?: string[]; + readonly has_issues?: boolean; + readonly has_projects?: boolean; + readonly has_wiki?: boolean; + readonly has_pages?: boolean; + readonly has_downloads?: boolean; + readonly archived?: boolean; + readonly disabled?: boolean; + readonly visibility?: string; + readonly pushed_at?: string; + readonly created_at?: string; + readonly updated_at?: string; + readonly permissions?: { + readonly admin?: boolean; + readonly maintain?: boolean; + readonly push?: boolean; + readonly triage?: boolean; + readonly pull?: boolean; + }; + readonly allow_rebase_merge?: boolean; + readonly temp_clone_token?: string; + readonly allow_squash_merge?: boolean; + readonly allow_auto_merge?: boolean; + readonly delete_branch_on_merge?: boolean; + readonly allow_update_branch?: boolean; + readonly use_squash_pr_title_as_default?: boolean; /** - * AuthorAssociation - * @description How the author is associated with the repository. + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @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?: { - /** @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; - /** - * 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; - } | 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; + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * 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. + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} */ - 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?: ("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 */ - 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; - } | 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; - }; - /** 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; + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description State of the issue; either 'open' or 'closed' + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @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; + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** - * Format: uri - * @description URL for the issue + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} */ - 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; - 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; - } | null; - }; - /** Label */ - readonly label?: { - /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + readonly allow_merge_commit?: boolean; + readonly subscribers_count?: number; + readonly network_count?: number; + } | null; + readonly temp_clone_token?: string; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + * @example true + */ + readonly allow_squash_merge: boolean; + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ + readonly allow_auto_merge: boolean; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ + readonly delete_branch_on_merge: boolean; + /** + * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + * @default false + * @example false + */ + readonly allow_update_branch: boolean; + /** + * @deprecated + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + * @example true + */ + readonly allow_merge_commit: boolean; + /** @description Whether to allow forking this repo */ + readonly allow_forking?: boolean; + /** + * @description Whether to require contributors to sign off on web-based commits + * @default false + */ + readonly web_commit_signoff_required: boolean; + readonly subscribers_count?: number; + readonly network_count?: number; + readonly open_issues: number; + readonly watchers: number; + readonly master_branch?: string; + /** @example "2020-07-09T00:17:42Z" */ + readonly starred_at?: string; + /** @description Whether anonymous git access is enabled for this repository */ + readonly anonymous_access_enabled?: boolean; + } | null; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + readonly webhooks_milestone_3: { + /** 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; - /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; - /** - * Format: uri - * @description URL for the label - */ - readonly url: string; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues labeled event */ - readonly "webhook-issues-labeled": { - /** @enum {string} */ - readonly action: "labeled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + 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 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; /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + * @description The state of the milestone. + * @enum {string} */ - 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; - } | null; - readonly assignees: ({ - /** 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; - } | 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; + 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; + }; + /** + * Membership + * @description The membership between the user and the organization. Not present when the action is `member_invited`. + */ + readonly webhooks_membership: { + /** Format: uri */ + readonly organization_url: string; + readonly role: string; + readonly state: string; + /** Format: uri */ + readonly url: string; + /** User */ + readonly user: { /** Format: uri */ - readonly comments_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; /** Format: uri */ - readonly events_url: string; + 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 html_url?: string; readonly id: number; - readonly labels?: { - /** @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 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 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; - } | 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?: ("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 */ - 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; - } | 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; - }; - /** 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; - }; + readonly starred_url?: string; /** 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; + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; /** 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; - 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; - } | null; + readonly url?: string; + } | null; + }; + /** + * Personal Access Token Request + * @description Details of a Personal Access Token Request. + */ + readonly "personal-access-token-request": { + /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */ + readonly id: number; + readonly owner: components["schemas"]["simple-user"]; + /** @description New requested permissions, categorized by type of permission. */ + readonly permissions_added: { + readonly organization?: { + readonly [key: string]: string | undefined; + }; + readonly repository?: { + readonly [key: string]: string | undefined; + }; + readonly other?: { + readonly [key: string]: string | undefined; + }; }; - /** Label */ - readonly label?: { - /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; + /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ + readonly permissions_upgraded: { + readonly organization?: { + readonly [key: string]: string | undefined; + }; + readonly repository?: { + readonly [key: string]: string | undefined; + }; + readonly other?: { + readonly [key: string]: string | undefined; + }; + }; + /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ + readonly permissions_result: { + readonly organization?: { + readonly [key: string]: string | undefined; + }; + readonly repository?: { + readonly [key: string]: string | undefined; + }; + readonly other?: { + readonly [key: string]: string | undefined; + }; + }; + /** + * @description Type of repository selection requested. + * @enum {string} + */ + readonly repository_selection: "none" | "all" | "subset"; + /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + readonly repository_count: number | null; + /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + readonly repositories: { + readonly full_name: string; + /** @description Unique identifier of the repository */ readonly id: number; - /** @description The name of the label. */ + /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** - * Format: uri - * @description URL for the label - */ - readonly url: string; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + }[] | null; + /** @description Date and time when the request for access was created. */ + readonly created_at: string; + /** @description Whether the associated fine-grained personal access token has expired. */ + readonly token_expired: boolean; + /** @description Date and time when the associated fine-grained personal access token expires. */ + readonly token_expires_at: string | null; + /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + readonly token_last_used_at: string | null; }; - /** issues locked event */ - readonly "webhook-issues-locked": { - /** @enum {string} */ - readonly action: "locked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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: ({ - /** 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; + /** Project Card */ + readonly webhooks_project_card: { + readonly after_id?: number | null; + /** @description Whether or not the card is archived */ + readonly archived: boolean; + readonly column_id: number; + /** Format: uri */ + readonly column_url: string; + /** Format: uri */ + readonly content_url?: string; + /** Format: date-time */ + readonly created_at: string; + /** User */ + readonly creator: { /** Format: uri */ - readonly comments_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; /** Format: uri */ - readonly events_url: string; + 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 html_url?: string; readonly id: number; - readonly labels?: { - /** @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 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 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"; - /** Format: uri */ - readonly url?: 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?: ("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 */ - 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; - } | 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"; - /** @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; - }; - /** 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; - }; + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + /** @description The project card's ID */ + readonly id: number; + readonly node_id: string; + readonly note: string | null; + /** Format: uri */ + readonly project_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + }; + /** Project */ + readonly webhooks_project: { + /** @description Body of the project */ + readonly body: string | null; + /** Format: uri */ + readonly columns_url: string; + /** 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 repository_url: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; + readonly url?: string; + } | null; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + /** @description Name of the project */ + readonly name: string; + readonly node_id: string; + readonly number: number; + /** Format: uri */ + readonly owner_url: string; + /** + * @description State of the project; either 'open' or 'closed' + * @enum {string} + */ + readonly state: "open" | "closed"; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + }; + /** Project Column */ + readonly webhooks_project_column: { + readonly after_id?: number | null; + /** Format: uri */ + readonly cards_url: string; + /** Format: date-time */ + readonly created_at: string; + /** @description The unique identifier of the project column */ + readonly id: number; + /** @description Name of the project column */ + readonly name: string; + readonly node_id: string; + /** Format: uri */ + readonly project_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + }; + /** + * Projects v2 Project + * @description A projects v2 project + */ + readonly "projects-v2": { + readonly id: number; + readonly node_id: string; + readonly owner: components["schemas"]["simple-user"]; + readonly creator: components["schemas"]["simple-user"]; + readonly title: string; + readonly description: string | null; + readonly public: boolean; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly closed_at: string | null; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly created_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly updated_at: string; + readonly number: number; + readonly short_description: string | null; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly deleted_at: string | null; + readonly deleted_by: components["schemas"]["nullable-simple-user"]; + }; + readonly webhooks_project_changes: { + readonly archived_at?: { /** 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; + readonly from?: string | null; + /** Format: date-time */ + readonly to?: string | null; + }; + }; + /** + * Projects v2 Item Content Type + * @description The type of content tracked in a project item + * @enum {string} + */ + readonly "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + readonly "projects-v2-item": { + readonly id: number; + readonly node_id?: string; + readonly project_node_id?: string; + readonly content_node_id: string; + readonly content_type: components["schemas"]["projects-v2-item-content-type"]; + readonly creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly created_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly updated_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly archived_at: string | null; + }; + /** @description The pull request number. */ + readonly webhooks_number: number; + readonly "pull-request-webhook": components["schemas"]["pull-request"] & { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow updating the pull request's branch. */ + readonly allow_update_branch?: boolean; + /** + * @description Whether to delete head branches when pull requests are merged. + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** + * @description The default value for a merge commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** + * @description The default value for a squash merge commit message: + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; + }; + /** Pull Request */ + readonly webhooks_pull_request_5: { + readonly _links: { + /** Link */ + readonly comments: { /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; + readonly href: string; + }; + /** Link */ + readonly commits: { /** Format: uri-template */ - readonly following_url?: string; + readonly href: string; + }; + /** Link */ + readonly html: { /** 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; + readonly href: string; + }; + /** Link */ + readonly issue: { /** 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; - } & { - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly assignee?: Record; - readonly assignees?: 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 href: string; + }; + /** Link */ + readonly review_comment: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly statuses: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** @enum {string|null} */ + readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; + /** 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 labels?: Record[]; - readonly labels_url?: string; - /** @enum {boolean} */ - readonly locked: true; - readonly milestone?: Record; + readonly id: number; + readonly login: string; + readonly name?: string; 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; - readonly state?: string; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: 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?: { - 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; - 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-webhooks"]; - }; - /** issues milestoned event */ - readonly "webhook-issues-milestoned": { - /** @enum {string} */ - readonly action: "milestoned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly issue: { - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + } | null; + readonly assignees: ({ + /** 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; + } | 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"; + /** + * PullRequestAutoMerge + * @description The status of auto merging a pull request. + */ + readonly auto_merge: { + /** @description Commit message for the merge commit. */ + readonly commit_message: string | null; + /** @description Title for the merge commit message. */ + readonly commit_title: string | null; /** User */ - readonly assignee?: { + readonly enabled_by: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -43769,174 +35470,189 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - readonly assignees: ({ - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + /** + * @description The merge method to use. + * @enum {string} + */ + readonly merge_method: "merge" | "squash" | "rebase"; + } | null; + readonly base: { + readonly label: string; + readonly ref: string; + /** + * Repository + * @description A git repository + */ + readonly repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; /** Format: uri-template */ - readonly following_url?: string; + readonly assignees_url: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; /** Format: uri */ - readonly organizations_url?: string; + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; /** Format: uri */ - readonly received_events_url?: string; + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; + readonly downloads_url: string; /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; /** 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?: { - /** @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; + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; /** - * Format: uri - * @description URL for the label + * @description Whether downloads are enabled. + * @default true */ - readonly url: string; - }[]; - /** 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; - } | null; - readonly description: string | null; - /** Format: date-time */ - readonly due_on: string | null; + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; /** Format: uri */ readonly html_url: string; + /** @description Unique identifier of the repository */ readonly id: number; - /** Format: uri */ + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ readonly labels_url: string; - readonly node_id: string; - /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; /** - * @description The state of the milestone. + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @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?: ("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 merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly external_url: string | null; + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; /** 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 mirror_url: string | null; + /** @description The name of the repository. */ readonly name: string; readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: string; /** User */ readonly owner: { /** Format: uri */ @@ -43974,129 +35690,77 @@ export type components = { /** Format: uri */ readonly url?: 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"; + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; }; - /** @description The slug name of the GitHub app */ - readonly slug?: string; - /** Format: date-time */ - readonly updated_at: string | null; - } | null; - readonly pull_request?: { + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; /** Format: uri */ - readonly diff_url?: string; + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; /** Format: uri */ - readonly html_url?: string; - /** Format: date-time */ - readonly merged_at?: string | null; + readonly subscribers_url: string; /** Format: uri */ - readonly patch_url?: string; + readonly subscription_url: string; /** Format: uri */ - readonly url?: string; - }; - /** 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; + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; }; - /** 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; + readonly sha: string; /** User */ readonly user: { /** Format: uri */ @@ -44104,64 +35768,233 @@ export type components = { readonly deleted?: boolean; readonly email?: string | null; /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; + 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 body: string | null; + readonly changed_files?: number; + /** Format: date-time */ + readonly closed_at: string | null; + readonly comments?: number; + /** Format: uri */ + readonly comments_url: string; + readonly commits?: number; + /** Format: uri */ + readonly commits_url: string; + /** Format: date-time */ + readonly created_at: string; + readonly deletions?: number; + /** Format: uri */ + readonly diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ + readonly draft: boolean; + readonly head: { + readonly label: string; + readonly ref: string; + /** + * Repository + * @description A git repository + */ + readonly repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; /** Format: uri-template */ - readonly following_url?: string; + readonly issues_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; + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; /** Format: uri */ - readonly received_events_url?: string; + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + readonly merges_url: string; /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly milestones_url: string; /** Format: uri */ - readonly url?: string; - } | null; - } & { - readonly active_lock_reason?: string | null; - readonly assignee?: Record; - readonly assignees?: 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?: Record[]; - 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; + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: string; /** User */ - readonly creator: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -44193,76 +36026,185 @@ 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; } | 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; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; /** - * @description The state of the milestone. + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly state: "open" | "closed"; - /** @description The title of the milestone. */ - readonly title: string; + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; }; - 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; - readonly state?: string; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: string; - readonly url?: string; - readonly user?: { + readonly sha: 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; - readonly id?: number; - readonly login?: 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; - readonly type?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ readonly url?: string; - }; + } | null; }; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + /** Format: uri */ + readonly issue_url: string; + readonly labels: { + /** @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 locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; + readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ + readonly merged_at: string | null; + /** User */ + readonly merged_by?: { + /** 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; + } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -44333,875 +36275,1231 @@ export type components = { readonly updated_at: string; /** Format: uri */ readonly url: string; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues opened event */ - readonly "webhook-issues-opened": { - /** @enum {string} */ - readonly action: "opened"; - readonly changes?: { - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - readonly old_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: ({ - /** 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?: { - /** @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; - /** - * 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"; - /** Format: uri */ - readonly url?: 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; + } | null; + readonly node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ + readonly number: number; + /** Format: uri */ + readonly patch_url: string; + readonly rebaseable?: boolean | null; + readonly requested_reviewers: (({ + /** 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 deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; 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?: ("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 */ - 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; - } | 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"; - /** @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; - }; - /** 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; - }; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repository_url: string; + readonly repositories_url: string; + readonly slug: string; /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} + * Format: uri + * @description URL for the team */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; + })[]; + readonly requested_teams: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; - /** Format: date-time */ - readonly updated_at: string; + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; /** * Format: uri - * @description URL for the issue + * @description URL for the team */ 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; - 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; } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; /** - * Repository - * @description A git repository + * Format: uri + * @description URL for the team */ - readonly old_repository: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + readonly url?: string; + }[]; + /** Format: uri-template */ + readonly review_comment_url: string; + readonly review_comments?: number; + /** Format: uri */ + readonly review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + readonly state: "open" | "closed"; + /** Format: uri */ + readonly statuses_url: string; + /** @description The title of the pull request. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + 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; + 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; + } | null; + }; + /** + * Pull Request Review Comment + * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. + */ + readonly webhooks_review_comment: { + readonly _links: { + /** Link */ + readonly html: { /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; + readonly href: string; + }; + /** Link */ + readonly pull_request: { /** Format: uri-template */ - readonly assignees_url: string; + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** + * 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 The text of the comment. */ + readonly body: string; + /** @description The SHA of the commit to which the comment applies. */ + readonly commit_id: string; + /** Format: date-time */ + readonly created_at: string; + /** @description The diff of the line that the comment refers to. */ + readonly diff_hunk: string; + /** + * Format: uri + * @description HTML URL for the pull request review comment. + */ + readonly html_url: string; + /** @description The ID of the pull request review comment. */ + readonly id: number; + /** @description The comment ID to reply to. */ + readonly in_reply_to_id?: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + readonly line: number | null; + /** @description The node ID of the pull request review comment. */ + readonly node_id: string; + /** @description The SHA of the original commit to which the comment applies. */ + readonly original_commit_id: string; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + readonly original_line: number; + /** @description The index of the original line in the diff to which the comment applies. */ + readonly original_position: number; + /** @description The first line of the range for a multi-line comment. */ + readonly original_start_line: number | null; + /** @description The relative path of the file to which the comment applies. */ + readonly path: string; + /** @description The line index in the diff to which the comment applies. */ + readonly position: number | null; + /** @description The ID of the pull request review to which the comment belongs. */ + readonly pull_request_review_id: number | null; + /** + * Format: uri + * @description URL for the pull request that the review comment belongs to. + */ + readonly pull_request_url: string; + /** 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; + }; + /** + * @description The side of the first line of the range for a multi-line comment. + * @enum {string} + */ + readonly side: "LEFT" | "RIGHT"; + /** @description The first line of the range for a multi-line comment. */ + readonly start_line: number | null; + /** + * @description The side of the first line of the range for a multi-line comment. + * @default RIGHT + * @enum {string|null} + */ + readonly start_side: "LEFT" | "RIGHT" | null; + /** + * @description The level at which the comment is targeted, can be a diff line or a file. + * @enum {string} + */ + readonly subject_type?: "line" | "file"; + /** Format: date-time */ + readonly updated_at: string; + /** + * Format: uri + * @description URL for the pull request review 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; + 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; + }; + /** @description The review that was affected. */ + readonly webhooks_review: { + readonly _links: { + /** Link */ + readonly html: { /** Format: uri-template */ - readonly blobs_url: string; + readonly href: string; + }; + /** Link */ + readonly pull_request: { /** Format: uri-template */ - readonly branches_url: string; + readonly href: string; + }; + }; + /** + * 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 The text of the review. */ + readonly body: string | null; + /** @description A commit SHA for the review. */ + readonly commit_id: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the review */ + readonly id: number; + readonly node_id: string; + /** Format: uri */ + readonly pull_request_url: string; + readonly state: string; + /** Format: date-time */ + readonly submitted_at: string | null; + /** 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; + 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 webhooks_nullable_string: string | null; + /** + * Release + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. + */ + readonly webhooks_release: { + readonly assets: { + /** Format: uri */ + readonly browser_download_url: string; + readonly content_type: string; + /** Format: date-time */ + readonly created_at: string; + readonly download_count: number; + readonly id: number; + readonly label: string | null; + /** @description The file name of the asset. */ + readonly name: string; + readonly node_id: string; + readonly size: number; + /** + * @description State of the release asset. + * @enum {string} + */ + readonly state: "uploaded"; + /** Format: date-time */ + readonly updated_at: string; + /** User */ + readonly uploader?: { /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly commits_url: string; + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; /** Format: uri-template */ - readonly compare_url: string; + readonly following_url?: string; /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; + readonly gists_url?: string; + readonly gravatar_id?: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly downloads_url: string; + readonly organizations_url?: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + readonly received_events_url?: string; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; + readonly repos_url?: string; + readonly site_admin?: boolean; /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** @description Whether the repository has discussions enabled. */ - readonly has_discussions?: boolean; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; + readonly starred_url?: string; /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; + readonly url?: string; + } | null; + /** Format: uri */ + readonly url: string; + }[]; + /** Format: uri */ + readonly assets_url: string; + /** User */ + readonly author: { + /** 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 body: string | null; + /** Format: date-time */ + readonly created_at: string | null; + /** Format: uri */ + readonly discussion_url?: string; + /** @description Whether the release is a draft or published */ + readonly draft: boolean; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly name: string | null; + readonly node_id: string; + /** @description Whether the release is identified as a prerelease or a full release. */ + readonly prerelease: boolean; + /** Format: date-time */ + readonly published_at: string | null; + /** 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; + }; + /** @description The name of the tag. */ + readonly tag_name: string; + /** Format: uri */ + readonly tarball_url: string | null; + /** @description Specifies the commitish value that determines where the Git tag is created from. */ + readonly target_commitish: string; + /** Format: uri-template */ + readonly upload_url: string; + /** Format: uri */ + readonly url: string; + /** Format: uri */ + readonly zipball_url: string | null; + }; + /** + * Release + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. + */ + readonly webhooks_release_1: { + readonly assets: ({ + /** Format: uri */ + readonly browser_download_url: string; + readonly content_type: string; + /** Format: date-time */ + readonly created_at: string; + readonly download_count: number; + readonly id: number; + readonly label: string | null; + /** @description The file name of the asset. */ + readonly name: string; + readonly node_id: string; + readonly size: number; + /** + * @description State of the release asset. + * @enum {string} + */ + readonly state: "uploaded"; + /** Format: date-time */ + readonly updated_at: string; + /** User */ + readonly uploader?: { /** Format: uri */ - readonly merges_url: string; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly milestones_url: string; + readonly events_url?: string; /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: 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; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + readonly followers_url?: string; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + readonly following_url?: string; /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; + readonly gists_url?: string; + readonly gravatar_id?: string; /** Format: uri */ - readonly subscription_url: string; + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly svn_url: string; + readonly organizations_url?: string; /** Format: uri */ - readonly tags_url: string; + readonly received_events_url?: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; + readonly repos_url?: string; + readonly site_admin?: boolean; /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; + readonly starred_url?: string; /** Format: uri */ - readonly url: string; + readonly subscriptions_url?: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require commit signoff. */ - readonly web_commit_signoff_required?: boolean; - }; + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + /** Format: uri */ + readonly url: string; + } | null)[]; + /** Format: uri */ + readonly assets_url: string; + /** User */ + readonly author: { + /** 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 body: string | null; + /** Format: date-time */ + readonly created_at: string | null; + /** Format: uri */ + readonly discussion_url?: string; + /** @description Whether the release is a draft or published */ + readonly draft: boolean; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly name: string | null; + readonly node_id: string; + /** @description Whether the release is identified as a prerelease or a full release. */ + readonly prerelease: boolean; + /** Format: date-time */ + readonly published_at: string | null; + /** 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; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + /** @description The name of the tag. */ + readonly tag_name: string; + /** Format: uri */ + readonly tarball_url: string | null; + /** @description Specifies the commitish value that determines where the Git tag is created from. */ + readonly target_commitish: string; + /** Format: uri-template */ + readonly upload_url: string; + /** Format: uri */ + readonly url: string; + /** Format: uri */ + readonly zipball_url: string | null; + }; + /** + * Repository Vulnerability Alert Alert + * @description The security alert of the vulnerable dependency. + */ + readonly webhooks_alert: { + readonly affected_package_name: string; + readonly affected_range: string; + readonly created_at: string; + readonly dismiss_reason?: string; + readonly dismissed_at?: string; + /** User */ + readonly dismisser?: { + /** 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 external_identifier: string; + /** Format: uri */ + readonly external_reference: string | null; + readonly fix_reason?: string; + /** Format: date-time */ + readonly fixed_at?: string; + readonly fixed_in?: string; + readonly ghsa_id: string; + readonly id: number; + readonly node_id: string; + readonly number: number; + readonly severity: string; + /** @enum {string} */ + readonly state: "open"; + }; + /** + * @description The reason for resolving the alert. + * @enum {string|null} + */ + readonly "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited"; + readonly "secret-scanning-alert-webhook": { + readonly number?: components["schemas"]["alert-number"]; + readonly created_at?: components["schemas"]["alert-created-at"]; + readonly updated_at?: components["schemas"]["nullable-alert-updated-at"]; + readonly url?: components["schemas"]["alert-url"]; + readonly html_url?: components["schemas"]["alert-html-url"]; /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + * Format: uri + * @description The REST API URL of the code locations for this alert. */ - 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; + readonly locations_url?: string; + readonly resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly resolved_at?: string | null; + readonly resolved_by?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment to resolve an alert. */ + readonly resolution_comment?: string | null; + /** @description The type of secret that secret scanning detected. */ + readonly secret_type?: string; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + readonly validity?: "active" | "inactive" | "unknown"; + /** @description Whether push protection was bypassed for the detected secret. */ + readonly push_protection_bypassed?: boolean | null; + readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly push_protection_bypassed_at?: string | null; + }; + /** @description The details of the security advisory, including summary, description, and severity. */ + readonly webhooks_security_advisory: { + readonly cvss: { + readonly score: number; + readonly vector_string: string | null; + }; + readonly cwes: { + readonly cwe_id: string; + readonly name: string; + }[]; + readonly description: string; + readonly ghsa_id: string; + readonly identifiers: { + readonly type: string; + readonly value: string; + }[]; + readonly published_at: string; + readonly references: { + /** Format: uri */ + readonly url: string; + }[]; + readonly severity: string; + readonly summary: string; + readonly updated_at: string; + readonly vulnerabilities: { + readonly first_patched_version: { + readonly identifier: string; } | null; - readonly assignees: ({ - /** 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; + readonly package: { + readonly ecosystem: string; + readonly name: string; + }; + readonly severity: string; + readonly vulnerable_version_range: string; + }[]; + readonly withdrawn_at: string | null; + }; + readonly webhooks_sponsorship: { + readonly created_at: string; + readonly maintainer?: { + 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; + 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 node_id: string; + readonly privacy_level: string; + /** User */ + readonly sponsor: { /** Format: uri */ - readonly comments_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; /** Format: uri */ - readonly events_url: string; + 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 html_url?: string; readonly id: number; - readonly labels?: { - /** @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 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 labels_url: string; - readonly locked?: boolean; + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + /** User */ + readonly sponsorable: { + /** 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; + /** + * Sponsorship Tier + * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. + */ + readonly tier: { + readonly created_at: string; + readonly description: string; + readonly is_custom_ammount?: boolean; + readonly is_custom_amount?: boolean; + readonly is_one_time: boolean; + readonly monthly_price_in_cents: number; + readonly monthly_price_in_dollars: number; + readonly name: string; + readonly node_id: string; + }; + }; + /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ + readonly webhooks_effective_date: string; + readonly webhooks_changes_8: { + readonly tier: { /** - * Milestone - * @description A collection of related issues and pull requests. + * Sponsorship Tier + * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. */ - readonly milestone: { - /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; - /** Format: date-time */ + readonly from: { 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; - } | 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 description: string; + readonly is_custom_ammount?: boolean; + readonly is_custom_amount?: boolean; + readonly is_one_time: boolean; + readonly monthly_price_in_cents: number; + readonly monthly_price_in_dollars: number; + readonly name: 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; + }; + }; + }; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + readonly webhooks_team_1: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; readonly node_id: string; - readonly number: number; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** + * @description Whether team members will receive notifications when their team is @mentioned + * @enum {string} + */ + readonly notification_setting: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** + * @description Whether team members will receive notifications when their team is @mentioned + * @enum {string} + */ + readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; + }; + /** branch protection configuration disabled event */ + readonly "webhook-branch-protection-configuration-disabled": { + /** @enum {string} */ + readonly action: "disabled"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection configuration enabled event */ + readonly "webhook-branch-protection-configuration-enabled": { + /** @enum {string} */ + readonly action: "enabled"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection rule created event */ + readonly "webhook-branch-protection-rule-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly rule: components["schemas"]["webhooks_rule"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection rule deleted event */ + readonly "webhook-branch-protection-rule-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly rule: components["schemas"]["webhooks_rule"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection rule edited event */ + readonly "webhook-branch-protection-rule-edited": { + /** @enum {string} */ + readonly action: "edited"; + /** @description If the action was `edited`, the changes to the rule. */ + readonly changes?: { + readonly admin_enforced?: { + readonly from: boolean | null; + }; + readonly authorized_actor_names?: { + readonly from: string[]; + }; + readonly authorized_actors_only?: { + readonly from: boolean | null; + }; + readonly authorized_dismissal_actors_only?: { + readonly from: boolean | null; + }; + readonly linear_history_requirement_enforcement_level?: { + /** @enum {string} */ + readonly from: "off" | "non_admins" | "everyone"; + }; + readonly required_status_checks?: { + readonly from: string[]; + }; + readonly required_status_checks_enforcement_level?: { + /** @enum {string} */ + readonly from: "off" | "non_admins" | "everyone"; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly rule: components["schemas"]["webhooks_rule"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Check Run Completed Event */ + readonly "webhook-check-run-completed": { + /** @enum {string} */ + readonly action?: "completed"; + readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Completed Event + * @description The check_run.completed webhook encoded with URL encoding + */ + readonly "webhook-check-run-completed-form-encoded": { + /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */ + readonly payload: string; + }; + /** Check Run Created Event */ + readonly "webhook-check-run-created": { + /** @enum {string} */ + readonly action?: "created"; + readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Created Event + * @description The check_run.created webhook encoded with URL encoding + */ + readonly "webhook-check-run-created-form-encoded": { + /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */ + readonly payload: string; + }; + /** Check Run Requested Action Event */ + readonly "webhook-check-run-requested-action": { + /** @enum {string} */ + readonly action: "requested_action"; + readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + /** @description The action requested by the user. */ + readonly requested_action?: { + /** @description The integrator reference of the action requested by the user. */ + readonly identifier?: string; + }; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Requested Action Event + * @description The check_run.requested_action webhook encoded with URL encoding + */ + readonly "webhook-check-run-requested-action-form-encoded": { + /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */ + readonly payload: string; + }; + /** Check Run Re-Requested Event */ + readonly "webhook-check-run-rerequested": { + /** @enum {string} */ + readonly action?: "rerequested"; + readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Re-Requested Event + * @description The check_run.rerequested webhook encoded with URL encoding + */ + readonly "webhook-check-run-rerequested-form-encoded": { + /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */ + readonly payload: string; + }; + /** check_suite completed event */ + readonly "webhook-check-suite-completed": { + /** @enum {string} */ + readonly action: "completed"; + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ + readonly check_suite: { + readonly after: string | null; /** * 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?: { + readonly app: { /** Format: date-time */ readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly 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")[]; + readonly 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" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -45301,7 +37599,7 @@ export type components = { /** @enum {string} */ readonly repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + readonly repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ readonly secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ @@ -45325,232 +37623,135 @@ export type components = { 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; - 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 before: string | null; + /** Format: uri */ + readonly check_runs_url: string; + /** + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. + * @enum {string|null} + */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; + /** Format: date-time */ + readonly created_at: string; + /** @description The head branch name the changes are on. */ + readonly head_branch: string | null; + /** SimpleCommit */ + readonly head_commit: { + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly author: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly committer: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + readonly id: string; + readonly message: string; + readonly timestamp: string; + readonly tree_id: string; + }; + /** @description The SHA of the head commit that is being checked. */ + readonly head_sha: string; + readonly id: number; + readonly latest_check_runs_count: number; + readonly node_id: string; + /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly id: number; + readonly number: number; /** Format: uri */ readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; + }[]; + readonly rerequestable?: boolean; + readonly runs_rerequestable?: boolean; /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} + * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + * @enum {string|null} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; - /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; + readonly status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; /** Format: date-time */ readonly updated_at: string; /** * Format: uri - * @description URL for the issue + * @description URL that points to the check suite API resource. */ 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; - 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 enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** issues pinned event */ - readonly "webhook-issues-pinned": { + /** check_suite requested event */ + readonly "webhook-check-suite-requested": { /** @enum {string} */ - readonly action: "pinned"; - 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: ({ - /** 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 action: "requested"; + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ + readonly check_suite: { + readonly after: string | null; /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} + * 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 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?: { - /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; + readonly app: { + /** Format: date-time */ + readonly created_at: string | null; readonly description: string | null; - readonly id: number; - /** @description The name of the label. */ + /** @description The list of events for the GitHub app */ + readonly 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" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; + /** 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; - /** - * Format: uri - * @description URL for the label - */ - readonly url: string; - }[]; - /** 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: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -45586,42 +37787,201 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - readonly description: 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 due_on: string | null; - /** Format: uri */ - readonly html_url: string; + readonly updated_at: string | null; + }; + readonly before: string | null; + /** Format: uri */ + readonly check_runs_url: string; + /** + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. + * @enum {string|null} + */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; + /** Format: date-time */ + readonly created_at: string; + /** @description The head branch name the changes are on. */ + readonly head_branch: string | null; + /** SimpleCommit */ + readonly head_commit: { + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly author: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly committer: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + readonly id: string; + readonly message: string; + readonly timestamp: string; + readonly tree_id: string; + }; + /** @description The SHA of the head commit that is being checked. */ + readonly head_sha: string; + readonly id: number; + readonly latest_check_runs_count: number; + readonly node_id: string; + /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: 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; + }[]; + readonly rerequestable?: boolean; + readonly runs_rerequestable?: boolean; + /** + * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + * @enum {string|null} + */ + readonly status: "requested" | "in_progress" | "completed" | "queued" | null; + /** Format: date-time */ + readonly updated_at: string; + /** + * Format: uri + * @description URL that points to the check suite API resource. + */ + readonly url: string; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** check_suite rerequested event */ + readonly "webhook-check-suite-rerequested": { + /** @enum {string} */ + readonly action: "rerequested"; + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ + readonly check_suite: { + readonly after: string | null; /** * 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?: { + readonly app: { /** Format: date-time */ readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly 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")[]; + readonly 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" | "merge_queue_entry" | "workflow_job")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -45705,7 +38065,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} */ @@ -45721,7 +38081,7 @@ export type components = { /** @enum {string} */ readonly repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + readonly repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ readonly secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ @@ -45745,54 +38105,125 @@ export type components = { 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; - 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 before: string | null; + /** Format: uri */ + readonly check_runs_url: string; + /** + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. + * @enum {string|null} + */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + readonly created_at: string; + /** @description The head branch name the changes are on. */ + readonly head_branch: string | null; + /** SimpleCommit */ + readonly head_commit: { + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly author: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly committer: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + readonly id: string; + readonly message: string; + readonly timestamp: string; + readonly tree_id: string; + }; + /** @description The SHA of the head commit that is being checked. */ + readonly head_sha: string; + readonly id: number; + readonly latest_check_runs_count: number; + readonly node_id: string; + /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly id: number; + readonly number: number; /** Format: uri */ readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; + }[]; + readonly rerequestable?: boolean; + readonly runs_rerequestable?: boolean; /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} + * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + * @enum {string|null} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; - /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; + readonly status: "requested" | "in_progress" | "completed" | "queued" | null; /** Format: date-time */ readonly updated_at: string; /** * Format: uri - * @description URL for the issue + * @description URL that points to the check suite API resource. */ readonly url: string; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert appeared_in_branch event */ + readonly "webhook-code-scanning-alert-appeared-in-branch": { + /** @enum {string} */ + readonly action: "appeared_in_branch"; + /** @description The code scanning alert involved in the event. */ + readonly alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + readonly created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly dismissed_at: string | null; /** User */ - readonly user: { + readonly dismissed_by: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -45828,22 +38259,97 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; + /** + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + readonly html_url: string; + /** Alert Instance */ + readonly most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + readonly analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + readonly category?: string; + readonly classifications?: string[]; + readonly commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + readonly environment: string; + readonly location?: { + readonly end_column?: number; + readonly end_line?: number; + readonly path?: string; + readonly start_column?: number; + readonly start_line?: number; + }; + readonly message?: { + readonly text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + readonly ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + readonly state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + readonly number: number; + readonly rule: { + /** @description A short description of the rule used to detect the alert. */ + readonly description: string; + /** @description A unique identifier for the rule used to detect the alert. */ + readonly id: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + readonly severity: "none" | "note" | "warning" | "error" | null; + }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + readonly state: "open" | "dismissed" | "fixed"; + readonly tool: { + /** @description The name of the tool used to generate the code scanning analysis alert. */ + readonly name: string; + /** @description The version of the tool used to detect the alert. */ + readonly version: string | null; + }; + /** Format: uri */ + readonly url: string; }; + readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** issues reopened event */ - readonly "webhook-issues-reopened": { + /** code_scanning_alert closed_by_user event */ + readonly "webhook-code-scanning-alert-closed-by-user": { /** @enum {string} */ - readonly action: "reopened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly issue: { - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly action: "closed_by_user"; + /** @description The code scanning alert involved in the event. */ + readonly alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + readonly created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly dismissed_at: string; /** User */ - readonly assignee?: { + readonly dismissed_by: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -45879,7 +38385,199 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - readonly assignees: ({ + /** + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + readonly html_url: string; + /** Alert Instance */ + readonly most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + readonly analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + readonly category?: string; + readonly classifications?: string[]; + readonly commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + readonly environment: string; + readonly location?: { + readonly end_column?: number; + readonly end_line?: number; + readonly path?: string; + readonly start_column?: number; + readonly start_line?: number; + }; + readonly message?: { + readonly text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + readonly ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + readonly state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + readonly number: number; + readonly rule: { + /** @description A short description of the rule used to detect the alert. */ + readonly description: string; + readonly full_description?: string; + readonly help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + readonly help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + readonly id: string; + readonly name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + readonly severity: "none" | "note" | "warning" | "error" | null; + readonly tags?: string[] | null; + }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + readonly state: "dismissed" | "fixed"; + readonly tool: { + readonly guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + readonly name: string; + /** @description The version of the tool used to detect the alert. */ + readonly version: string | null; + }; + /** Format: uri */ + readonly url: string; + }; + readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert created event */ + readonly "webhook-code-scanning-alert-created": { + /** @enum {string} */ + readonly action: "created"; + /** @description The code scanning alert involved in the event. */ + readonly alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + readonly created_at: string | null; + /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly dismissed_at: unknown; + readonly dismissed_by: unknown; + readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + readonly dismissed_reason: unknown; + readonly fixed_at?: unknown; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + readonly html_url: string; + readonly instances_url?: string; + /** Alert Instance */ + readonly most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + readonly analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + readonly category?: string; + readonly classifications?: string[]; + readonly commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + readonly environment: string; + readonly location?: { + readonly end_column?: number; + readonly end_line?: number; + readonly path?: string; + readonly start_column?: number; + readonly start_line?: number; + }; + readonly message?: { + readonly text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + readonly ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + readonly state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + readonly number: number; + readonly rule: { + /** @description A short description of the rule used to detect the alert. */ + readonly description: string; + readonly full_description?: string; + readonly help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + readonly help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + readonly id: string; + readonly name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + readonly severity: "none" | "note" | "warning" | "error" | null; + readonly tags?: string[] | null; + }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + readonly state: "open" | "dismissed"; + readonly tool: { + readonly guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + readonly name: string; + /** @description The version of the tool used to detect the alert. */ + readonly version: string | null; + } | null; + readonly updated_at?: string | null; + /** Format: uri */ + readonly url: string; + }; + readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert fixed event */ + readonly "webhook-code-scanning-alert-fixed": { + /** @enum {string} */ + readonly action: "fixed"; + /** @description The code scanning alert involved in the event. */ + readonly alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + readonly created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly dismissed_at: string | null; + /** User */ + readonly dismissed_by: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -45911,271 +38609,303 @@ 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; - } | null)[]; + } | null; /** - * AuthorAssociation - * @description How the author is associated with the repository. + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + readonly html_url: string; + /** Format: uri */ + readonly instances_url?: string; + /** Alert Instance */ + readonly most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + readonly analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + readonly category?: string; + readonly classifications?: string[]; + readonly commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + readonly environment: string; + readonly location?: { + readonly end_column?: number; + readonly end_line?: number; + readonly path?: string; + readonly start_column?: number; + readonly start_line?: number; + }; + readonly message?: { + readonly text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + readonly ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + readonly state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + readonly number: number; + readonly rule: { + /** @description A short description of the rule used to detect the alert. */ + readonly description: string; + readonly full_description?: string; + readonly help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + readonly help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + readonly id: string; + readonly name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + readonly severity: "none" | "note" | "warning" | "error" | null; + readonly tags?: string[] | null; + }; + /** + * @description State of a code scanning alert. * @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; + readonly state: "fixed"; + readonly tool: { + readonly guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + readonly name: string; + /** @description The version of the tool used to detect the alert. */ + readonly version: string | null; + }; /** Format: uri */ - readonly comments_url: string; - /** Format: date-time */ + readonly url: string; + }; + readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert reopened event */ + readonly "webhook-code-scanning-alert-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + /** @description The code scanning alert involved in the event. */ + readonly alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ readonly created_at: string; - readonly draft?: boolean; - /** Format: uri */ - readonly events_url: string; - /** Format: uri */ + /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly dismissed_at: string | null; + readonly dismissed_by: Record; + /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + readonly dismissed_reason: string | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ readonly html_url: string; - /** Format: int64 */ - readonly id: number; - readonly labels?: { - /** @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; + /** Alert Instance */ + readonly most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + readonly analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + readonly category?: string; + readonly classifications?: string[]; + readonly commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + readonly environment: string; + readonly location?: { + readonly end_column?: number; + readonly end_line?: number; + readonly path?: string; + readonly start_column?: number; + readonly start_line?: number; + }; + readonly message?: { + readonly text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + readonly ref: string; /** - * Format: uri - * @description URL for the label + * @description State of a code scanning alert. + * @enum {string} */ - readonly url: string; - }[]; - /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + readonly state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + readonly number: number; + readonly rule: { + /** @description A short description of the rule used to detect the alert. */ + readonly description: string; + readonly full_description?: string; + readonly help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + readonly help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + readonly id: string; + readonly name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + readonly severity: "none" | "note" | "warning" | "error" | null; + readonly tags?: string[] | null; + }; /** - * Milestone - * @description A collection of related issues and pull requests. + * @description State of a code scanning alert. + * @enum {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; - } | 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; + readonly state: "open" | "dismissed" | "fixed"; + readonly tool: { + readonly guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + readonly name: string; + /** @description The version of the tool used to detect the alert. */ + readonly version: string | null; + }; + /** Format: uri */ + readonly url: string; + } | null; + /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + readonly commit_oid: string | null; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + readonly ref: string | null; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert reopened_by_user event */ + readonly "webhook-code-scanning-alert-reopened-by-user": { + /** @enum {string} */ + readonly action: "reopened_by_user"; + /** @description The code scanning alert involved in the event. */ + readonly alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + readonly created_at: string; + /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly dismissed_at: unknown; + readonly dismissed_by: unknown; + /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + readonly dismissed_reason: unknown; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + readonly html_url: string; + /** Alert Instance */ + readonly most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + readonly analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + readonly category?: string; + readonly classifications?: string[]; + readonly commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + readonly environment: string; + readonly location?: { + readonly end_column?: number; + readonly end_line?: number; + readonly path?: string; + readonly start_column?: number; + readonly start_line?: number; + }; + readonly message?: { + readonly text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + readonly ref: string; /** - * @description The state of the milestone. + * @description State of a code scanning alert. * @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; + readonly state: "open" | "dismissed" | "fixed"; } | null; - readonly node_id: string; + /** @description The code scanning alert number. */ readonly number: number; + readonly rule: { + /** @description A short description of the rule used to detect the alert. */ + readonly description: string; + /** @description A unique identifier for the rule used to detect the alert. */ + readonly id: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + readonly severity: "none" | "note" | "warning" | "error" | null; + }; /** - * 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. + * @description State of a code scanning alert. + * @enum {string} */ - 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?: ("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 */ - readonly html_url: string; - /** @description Unique identifier of the GitHub app */ - readonly id: number | null; - /** @description The name of the GitHub app */ + readonly state: "open" | "fixed"; + readonly tool: { + /** @description The name of the tool used to generate the code scanning analysis alert. */ 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; - } | 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; + /** @description The version of the tool used to detect the alert. */ + readonly version: string | null; }; + /** Format: uri */ + readonly url: string; + }; + readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** commit_comment created event */ + readonly "webhook-commit-comment-created": { + /** + * @description The action performed. Can be `created`. + * @enum {string} + */ + readonly action: "created"; + /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ + readonly comment: { + /** + * 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 The text of the comment. */ + readonly body: string; + /** @description The SHA of the commit to which the comment applies. */ + readonly commit_id: string; + readonly created_at: string; + /** Format: uri */ + readonly html_url: string; + /** @description The ID of the commit comment. */ + readonly id: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + readonly line: number | null; + /** @description The node ID of the commit comment. */ + readonly node_id: string; + /** @description The relative path of the file to which the comment applies. */ + readonly path: string | null; + /** @description The line index in the diff to which the comment applies. */ + readonly position: number | null; /** Reactions */ - readonly reactions: { + readonly reactions?: { readonly "+1": number; readonly "-1": number; readonly confused: number; @@ -46188,24 +38918,8 @@ export type components = { /** Format: uri */ readonly url: string; }; - /** 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 - */ + /** Format: uri */ readonly url: string; /** User */ readonly user: { @@ -46240,453 +38954,271 @@ 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; } | null; - } & { - readonly active_lock_reason?: string | null; - readonly assignee?: Record; - readonly assignees?: 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?: 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: "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; - 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 enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** issues transferred event */ - readonly "webhook-issues-transferred": { + /** create event */ + readonly "webhook-create": { + /** @description The repository's current description. */ + readonly description: string | null; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + /** @description The name of the repository's default branch (usually `main`). */ + readonly master_branch: string; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; + readonly ref: components["schemas"]["webhooks_ref_0"]; + /** + * @description The type of Git ref object created in the repository. + * @enum {string} + */ + readonly ref_type: "tag" | "branch"; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** custom property created event */ + readonly "webhook-custom-property-created": { /** @enum {string} */ - readonly action: "transferred"; - readonly changes: { - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - readonly new_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: ({ - /** 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?: { - /** @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; - /** - * 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"; - /** Format: uri */ - readonly url?: 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?: ("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 */ - 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; - } | 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"; - /** @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; - }; - /** 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; - }; + readonly action: "created"; + readonly definition: components["schemas"]["org-custom-property"]; + 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-webhooks"]; + }; + /** custom property deleted event */ + readonly "webhook-custom-property-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly definition: { + /** @description The name of the property that was deleted. */ + readonly property_name: string; + }; + 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-webhooks"]; + }; + /** custom property updated event */ + readonly "webhook-custom-property-updated": { + /** @enum {string} */ + readonly action: "updated"; + readonly definition: components["schemas"]["org-custom-property"]; + 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-webhooks"]; + }; + /** Custom property values updated event */ + readonly "webhook-custom-property-values-updated": { + /** @enum {string} */ + readonly action: "updated"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + /** @description The new custom property values for the repository. */ + readonly new_property_values: components["schemas"]["custom-property-value"][]; + /** @description The old custom property values for the repository. */ + readonly old_property_values: components["schemas"]["custom-property-value"][]; + }; + /** delete event */ + readonly "webhook-delete": { + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; + readonly ref: components["schemas"]["webhooks_ref_0"]; + /** + * @description The type of Git ref object deleted in the repository. + * @enum {string} + */ + readonly ref_type: "tag" | "branch"; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert auto-dismissed event */ + readonly "webhook-dependabot-alert-auto-dismissed": { + /** @enum {string} */ + readonly action: "auto_dismissed"; + readonly alert: components["schemas"]["dependabot-alert"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert auto-reopened event */ + readonly "webhook-dependabot-alert-auto-reopened": { + /** @enum {string} */ + readonly action: "auto_reopened"; + readonly alert: components["schemas"]["dependabot-alert"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert created event */ + readonly "webhook-dependabot-alert-created": { + /** @enum {string} */ + readonly action: "created"; + readonly alert: components["schemas"]["dependabot-alert"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert dismissed event */ + readonly "webhook-dependabot-alert-dismissed": { + /** @enum {string} */ + readonly action: "dismissed"; + readonly alert: components["schemas"]["dependabot-alert"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert fixed event */ + readonly "webhook-dependabot-alert-fixed": { + /** @enum {string} */ + readonly action: "fixed"; + readonly alert: components["schemas"]["dependabot-alert"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert reintroduced event */ + readonly "webhook-dependabot-alert-reintroduced": { + /** @enum {string} */ + readonly action: "reintroduced"; + readonly alert: components["schemas"]["dependabot-alert"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert reopened event */ + readonly "webhook-dependabot-alert-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + readonly alert: components["schemas"]["dependabot-alert"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** deploy_key created event */ + readonly "webhook-deploy-key-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly key: components["schemas"]["webhooks_deploy_key"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** deploy_key deleted event */ + readonly "webhook-deploy-key-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly key: components["schemas"]["webhooks_deploy_key"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** deployment created event */ + readonly "webhook-deployment-created": { + /** @enum {string} */ + readonly action: "created"; + /** + * Deployment + * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). + */ + readonly deployment: { + readonly created_at: string; + /** User */ + readonly creator: { /** 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; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; + 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 description: string | null; + readonly environment: string; + readonly id: number; + readonly node_id: string; + readonly original_environment: string; + readonly payload: Record | string; + /** + * 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 updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - readonly url: string; + readonly created_at: string | null; + readonly description: string | null; + /** @description The list of events for the GitHub app */ + readonly 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" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; + /** 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 user: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -46722,265 +39254,665 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - }; - /** - * Repository - * @description A git repository - */ - readonly new_repository: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + /** @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"; + /** @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 production_environment?: boolean; + readonly ref: string; + /** Format: uri */ + readonly repository_url: string; + readonly sha: string; + /** Format: uri */ + readonly statuses_url: string; + readonly task: string; + readonly transient_environment?: boolean; + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly workflow: components["schemas"]["webhooks_workflow"]; + /** Deployment Workflow Run */ + readonly workflow_run: { + /** User */ + readonly actor: { + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; /** Format: uri-template */ - readonly assignees_url: string; + readonly following_url?: string; /** Format: uri-template */ - readonly blobs_url: string; + 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 branches_url: string; + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + readonly artifacts_url?: string; + readonly cancel_url?: string; + readonly check_suite_id: number; + readonly check_suite_node_id: string; + readonly check_suite_url?: string; + /** @enum {string|null} */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + readonly created_at: string; + readonly display_title: string; + readonly event: string; + readonly head_branch: string; + readonly head_commit?: unknown; + readonly head_repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: unknown; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { + 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; + 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 private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly url?: string; + }; + readonly head_sha: string; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly jobs_url?: string; + readonly logs_url?: string; + readonly name: string; + readonly node_id: string; + readonly path: string; + readonly previous_attempt_url?: unknown; + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly id: number; + readonly number: number; + /** Format: uri */ + readonly url: string; + }[]; + readonly referenced_workflows?: { + readonly path: string; + readonly ref?: string; + readonly sha: string; + }[] | null; + readonly repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: unknown; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { + 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; + 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 private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly url?: string; + }; + readonly rerun_url?: string; + readonly run_attempt: number; + readonly run_number: number; + /** Format: date-time */ + readonly run_started_at: string; + /** @enum {string} */ + readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + /** User */ + readonly triggering_actor?: { /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly commits_url: string; + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; /** Format: uri-template */ - readonly compare_url: string; + readonly following_url?: string; /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; + readonly gists_url?: string; + readonly gravatar_id?: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly downloads_url: string; + readonly organizations_url?: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + readonly received_events_url?: string; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; + readonly repos_url?: string; + readonly site_admin?: boolean; /** Format: uri-template */ - readonly git_tags_url: string; + readonly starred_url?: string; /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly homepage: string | null; + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly hooks_url: string; + readonly url?: string; + } | null; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + readonly workflow_id: number; + readonly workflow_url?: string; + } | null; + }; + /** deployment protection rule requested event */ + readonly "webhook-deployment-protection-rule-requested": { + /** @enum {string} */ + readonly action?: "requested"; + /** @description The name of the environment that has the deployment protection rule. */ + readonly environment?: string; + /** @description The event that triggered the deployment protection rule. */ + readonly event?: string; + /** + * Format: uri + * @description The URL to review the deployment protection rule. + */ + readonly deployment_callback_url?: string; + readonly deployment?: components["schemas"]["deployment"]; + readonly pull_requests?: components["schemas"]["pull-request"][]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + readonly "webhook-deployment-review-approved": { + /** @enum {string} */ + readonly action: "approved"; + readonly approver?: components["schemas"]["webhooks_approver"]; + readonly comment?: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly reviewers?: components["schemas"]["webhooks_reviewers"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly since: string; + readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; + readonly workflow_job_runs?: { + readonly conclusion?: unknown; + readonly created_at?: string; + readonly environment?: string; + readonly html_url?: string; + readonly id?: number; + readonly name?: string | null; + readonly status?: string; + readonly updated_at?: string; + }[]; + /** Deployment Workflow Run */ + readonly workflow_run: { + /** User */ + readonly actor: { /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly issues_url: string; + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; /** Format: uri-template */ - readonly keys_url: string; + readonly following_url?: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + readonly gists_url?: string; + readonly gravatar_id?: string; /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; + readonly organizations_url?: string; /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; - /** User */ - readonly owner: { - /** Format: uri */ + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + readonly artifacts_url?: string; + readonly cancel_url?: string; + readonly check_suite_id: number; + readonly check_suite_node_id: string; + readonly check_suite_url?: string; + /** @enum {string|null} */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + readonly created_at: string; + readonly display_title: string; + readonly event: string; + readonly head_branch: string; + readonly head_commit?: Record; + readonly head_repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: string | null; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { 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 id?: number; + readonly login?: 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 type?: string; readonly url?: string; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; + readonly private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly url?: string; + }; + readonly head_sha: string; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly jobs_url?: string; + readonly logs_url?: string; + readonly name: string; + readonly node_id: string; + readonly path: string; + readonly previous_attempt_url?: string | null; + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly id: number; + readonly number: number; /** Format: uri */ readonly url: string; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + }[]; + readonly referenced_workflows?: { + readonly path: string; + readonly ref?: string; + readonly sha: string; + }[] | null; + readonly repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: string | null; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { + 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; + 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 private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly url?: string; }; - }; - 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; + readonly rerun_url?: string; + readonly run_attempt: number; + readonly run_number: number; + /** Format: date-time */ + readonly run_started_at: string; + /** @enum {string} */ + readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - readonly assignee?: { + readonly triggering_actor: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -47016,7 +39948,41 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - readonly assignees: ({ + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + readonly workflow_id: number; + readonly workflow_url?: string; + } | null; + }; + readonly "webhook-deployment-review-rejected": { + /** @enum {string} */ + readonly action: "rejected"; + readonly approver?: components["schemas"]["webhooks_approver"]; + readonly comment?: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly reviewers?: components["schemas"]["webhooks_reviewers"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly since: string; + readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; + readonly workflow_job_runs?: { + readonly conclusion?: string | null; + readonly created_at?: string; + readonly environment?: string; + readonly html_url?: string; + readonly id?: number; + readonly name?: string | null; + readonly status?: string; + readonly updated_at?: string; + }[]; + /** Deployment Workflow Run */ + readonly workflow_run: { + /** User */ + readonly actor: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -47051,301 +40017,205 @@ export type components = { 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; + } | null; + readonly artifacts_url?: string; + readonly cancel_url?: string; + readonly check_suite_id: number; + readonly check_suite_node_id: string; + readonly check_suite_url?: string; + /** @enum {string|null} */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** 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?: { - /** @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; - /** - * 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 event: string; + readonly head_branch: string; + readonly head_commit?: Record; + readonly head_repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: string | null; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { 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 id?: number; + readonly login?: 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 type?: string; readonly url?: string; - } | null; - readonly description: string | null; - /** Format: date-time */ - readonly due_on: string | null; - /** Format: uri */ - readonly html_url: string; + }; + readonly private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly url?: string; + }; + readonly head_sha: string; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly jobs_url?: string; + readonly logs_url?: string; + readonly name: string; + readonly node_id: string; + readonly path: string; + readonly previous_attempt_url?: string | null; + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: 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?: ("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 */ - 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 referenced_workflows?: { + readonly path: string; + readonly ref?: string; + readonly sha: string; + }[] | null; + readonly repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: string | null; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { 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 id?: number; + readonly login?: 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 type?: string; readonly url?: 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"; - /** @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 private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; readonly url?: string; }; - /** 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} - */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; - /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; + readonly rerun_url?: string; + readonly run_attempt: number; + readonly run_number: number; /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - readonly url: string; + readonly run_started_at: string; + /** @enum {string} */ + readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; /** User */ - readonly user: { + readonly triggering_actor: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -47353,94 +40223,55 @@ export type components = { /** 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 organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues unassigned event */ - readonly "webhook-issues-unassigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - readonly action: "unassigned"; - /** 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"; + 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; + /** Format: date-time */ + readonly updated_at: string; /** Format: uri */ - readonly url?: string; + readonly url: string; + readonly workflow_id: number; + readonly workflow_url?: string; + readonly display_title: string; } | null; + }; + readonly "webhook-deployment-review-requested": { + /** @enum {string} */ + readonly action: "requested"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly environment: string; 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; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly requestor: components["schemas"]["webhooks_user"]; + readonly reviewers: { /** User */ - readonly assignee?: { + readonly reviewer?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -47457,7 +40288,7 @@ export type components = { /** Format: uri */ readonly html_url?: string; readonly id: number; - readonly login: string; + readonly login?: string; readonly name?: string; readonly node_id?: string; /** Format: uri */ @@ -47472,11 +40303,29 @@ 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; } | null; - readonly assignees: ({ + /** @enum {string} */ + readonly type?: "User" | "Team"; + }[]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly since: string; + readonly workflow_job_run: { + readonly conclusion: unknown; + readonly created_at: string; + readonly environment: string; + readonly html_url: string; + readonly id: number; + readonly name: string | null; + readonly status: string; + readonly updated_at: string; + }; + /** Deployment Workflow Run */ + readonly workflow_run: { + /** User */ + readonly actor: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -47508,359 +40357,208 @@ 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; - } | 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; + } | null; + readonly artifacts_url?: string; + readonly cancel_url?: string; + readonly check_suite_id: number; + readonly check_suite_node_id: string; + readonly check_suite_url?: string; + /** @enum {string|null} */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** 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?: { - /** @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; - /** - * 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 event: string; + readonly head_branch: string; + readonly head_commit?: Record; + readonly head_repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: string | null; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { 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 id?: number; + readonly login?: 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 type?: string; readonly url?: string; - } | null; - readonly description: string | null; - /** Format: date-time */ - readonly due_on: string | null; - /** Format: uri */ - readonly html_url: string; + }; + readonly private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly url?: string; + }; + readonly head_sha: string; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly jobs_url?: string; + readonly logs_url?: string; + readonly name: string; + readonly node_id: string; + readonly path: string; + readonly previous_attempt_url?: string | null; + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: 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?: ("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 referenced_workflows?: { + readonly path: string; + readonly ref?: string; + readonly sha: string; + }[] | null; + readonly repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: string | null; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { 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 id?: number; + readonly login?: 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; - /** @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; - }; - /** 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} - */ - 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; - 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 type?: string; + readonly url?: string; + }; + readonly private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; readonly url?: string; - } | null; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues unlabeled event */ - readonly "webhook-issues-unlabeled": { - /** @enum {string} */ - readonly action: "unlabeled"; - 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; + }; + readonly rerun_url?: string; + readonly run_attempt: number; + readonly run_number: number; + /** Format: date-time */ + readonly run_started_at: string; + /** @enum {string} */ + readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - readonly assignee?: { + readonly triggering_actor: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -47892,11 +40590,61 @@ 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; } | null; - readonly assignees: ({ + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + readonly workflow_id: number; + readonly workflow_url?: string; + readonly display_title: string; + } | null; + }; + /** deployment_status created event */ + readonly "webhook-deployment-status-created": { + /** @enum {string} */ + readonly action: "created"; + readonly check_run?: { + /** Format: date-time */ + readonly completed_at: string | null; + /** + * @description The result of the completed check run. This value will be `null` until the check run has completed. + * @enum {string|null} + */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; + /** Format: uri */ + readonly details_url: string; + readonly external_id: string; + /** @description The SHA of the commit that is being checked. */ + readonly head_sha: string; + /** Format: uri */ + readonly html_url: string; + /** @description The id of the check. */ + readonly id: number; + /** @description The name of the check run. */ + readonly name: string; + readonly node_id: string; + /** Format: date-time */ + readonly started_at: string; + /** + * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. + * @enum {string} + */ + readonly status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; + /** Format: uri */ + readonly url: string; + } | null; + /** + * Deployment + * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). + */ + readonly deployment: { + readonly created_at: string; + /** User */ + readonly creator: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -47928,123 +40676,16 @@ 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; - } | 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?: { - /** @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; - /** - * 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; - } | 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 description: string | null; + readonly environment: string; + readonly id: number; readonly node_id: string; - readonly number: number; + readonly original_environment: string; + readonly payload: (string | Record) | null; /** * 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. @@ -48054,7 +40695,7 @@ export type components = { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly 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")[]; + readonly 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" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -48138,7 +40779,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} */ @@ -48150,333 +40791,99 @@ export type components = { /** @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; - }; - /** 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} - */ - 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; - 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; - } | null; - }; - /** Label */ - readonly label?: { - /** @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 organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues unlocked event */ - readonly "webhook-issues-unlocked": { - /** @enum {string} */ - readonly action: "unlocked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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: ({ - /** 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?: { - /** @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; - /** - * 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; + readonly pull_requests?: "read" | "write"; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - } | null; - readonly description: string | null; + 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 due_on: string | null; + readonly updated_at: string | null; + } | null; + readonly production_environment?: boolean; + readonly ref: string; + /** Format: uri */ + readonly repository_url: string; + readonly sha: string; + /** Format: uri */ + readonly statuses_url: string; + readonly task: string; + readonly transient_environment?: boolean; + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + }; + /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ + readonly deployment_status: { + readonly created_at: string; + /** User */ + readonly creator: { /** Format: uri */ - readonly html_url: string; + 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 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; + readonly organizations_url?: string; /** Format: uri */ - readonly url: string; + 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; + /** Format: uri */ + readonly deployment_url: string; + /** @description The optional human-readable description added to the status. */ + readonly description: string; + readonly environment: string; + /** Format: uri */ + readonly environment_url?: string; + readonly id: number; + /** Format: uri */ + readonly log_url?: string; 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. @@ -48486,7 +40893,7 @@ export type components = { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly 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")[]; + readonly 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" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -48611,167 +41018,26 @@ export type components = { /** 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; - 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} - */ - 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 */ + /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ + readonly state: string; + /** @description The optional link added to the status. */ + readonly target_url: string; readonly updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ + /** Format: uri */ 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; - 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 active_lock_reason: unknown; - readonly assignee?: Record; - readonly assignees?: 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?: Record[]; - readonly labels_url?: string; - /** @enum {boolean} */ - readonly locked: false; - readonly milestone?: Record; - readonly node_id?: string; - readonly number?: number; - readonly performed_via_github_app?: unknown; - 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; - readonly state?: string; - 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; - 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 enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues unpinned event */ - readonly "webhook-issues-unpinned": { - /** @enum {string} */ - readonly action: "unpinned"; - 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; + readonly workflow?: components["schemas"]["webhooks_workflow"]; + /** Deployment Workflow Run */ + readonly workflow_run?: { /** User */ - readonly assignee?: { + readonly actor: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -48807,336 +41073,205 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - readonly assignees: ({ - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ + readonly artifacts_url?: string; + readonly cancel_url?: string; + readonly check_suite_id: number; + readonly check_suite_node_id: string; + readonly check_suite_url?: string; + /** @enum {string|null} */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; + /** Format: date-time */ + readonly created_at: string; + readonly display_title: string; + readonly event: string; + readonly head_branch: string; + readonly head_commit?: unknown; + readonly head_repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: unknown; + readonly downloads_url?: string; 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 fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; readonly html_url?: string; - readonly id: number; - readonly login: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: 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?: { - /** @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; - /** - * 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 notifications_url?: string; + readonly owner?: { 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 id?: number; + readonly login?: 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 type?: string; readonly url?: string; - } | null; - readonly description: string | null; - /** Format: date-time */ - readonly due_on: string | null; - /** Format: uri */ - readonly html_url: string; + }; + readonly private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly url?: string; + }; + readonly head_sha: string; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly jobs_url?: string; + readonly logs_url?: string; + readonly name: string; + readonly node_id: string; + readonly path: string; + readonly previous_attempt_url?: unknown; + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: 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?: ("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 */ - 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 referenced_workflows?: { + readonly path: string; + readonly ref?: string; + readonly sha: string; + }[] | null; + readonly repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: unknown; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { 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 id?: number; + readonly login?: 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 type?: string; readonly url?: 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"; - /** @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 private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; readonly url?: string; }; - /** 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} - */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; - /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; + readonly rerun_url?: string; + readonly run_attempt: number; + readonly run_number: number; /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - readonly url: string; + readonly run_started_at: string; + /** @enum {string} */ + readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - readonly user: { + readonly triggering_actor: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -49172,1055 +41307,930 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + readonly workflow_id: number; + readonly workflow_url?: string; + } | null; + }; + /** discussion answered event */ + readonly "webhook-discussion-answered": { + /** @enum {string} */ + readonly action: "answered"; + readonly answer: components["schemas"]["webhooks_answer"]; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion category changed event */ + readonly "webhook-discussion-category-changed": { + /** @enum {string} */ + readonly action: "category_changed"; + readonly changes: { + readonly category: { + readonly from: { + /** Format: date-time */ + readonly created_at: string; + readonly description: string; + readonly emoji: string; + readonly id: number; + readonly is_answerable: boolean; + readonly name: string; + readonly node_id?: string; + readonly repository_id: number; + readonly slug: string; + readonly updated_at: string; + }; + }; }; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** label created event */ - readonly "webhook-label-created": { + /** discussion closed event */ + readonly "webhook-discussion-closed": { + /** @enum {string} */ + readonly action: "closed"; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion_comment created event */ + readonly "webhook-discussion-comment-created": { /** @enum {string} */ readonly action: "created"; + readonly comment: components["schemas"]["webhooks_comment"]; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** Label */ - readonly label: { - /** @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 organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** label deleted event */ - readonly "webhook-label-deleted": { + /** discussion_comment deleted event */ + readonly "webhook-discussion-comment-deleted": { /** @enum {string} */ readonly action: "deleted"; + readonly comment: components["schemas"]["webhooks_comment"]; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** Label */ - readonly label: { - /** @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 organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** label edited event */ - readonly "webhook-label-edited": { + /** discussion_comment edited event */ + readonly "webhook-discussion-comment-edited": { /** @enum {string} */ readonly action: "edited"; - /** @description The changes to the label if the action was `edited`. */ - readonly changes?: { - readonly color?: { - /** @description The previous version of the color if the action was `edited`. */ + readonly changes: { + readonly body: { readonly from: string; }; - readonly description?: { - /** @description The previous version of the description if the action was `edited`. */ + }; + readonly comment: components["schemas"]["webhooks_comment"]; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion created event */ + readonly "webhook-discussion-created": { + /** @enum {string} */ + readonly action: "created"; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion deleted event */ + readonly "webhook-discussion-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion edited event */ + readonly "webhook-discussion-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes?: { + readonly body?: { readonly from: string; }; - readonly name?: { - /** @description The previous version of the name if the action was `edited`. */ + readonly title?: { readonly from: string; }; }; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** Label */ - readonly label: { - /** @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 organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase cancelled event */ - readonly "webhook-marketplace-purchase-cancelled": { + /** discussion labeled event */ + readonly "webhook-discussion-labeled": { /** @enum {string} */ - readonly action: "cancelled"; - readonly effective_date: string; + readonly action: "labeled"; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - } & { - readonly account?: { - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organization_billing_email?: string | null; - readonly type?: string; - }; - readonly billing_cycle?: string; - readonly free_trial_ends_on?: string | null; - readonly next_billing_date: string | null; - readonly on_free_trial?: boolean; - readonly plan?: { - readonly bullets?: (string | null)[]; - readonly description?: string; - readonly has_free_trial?: boolean; - readonly id?: number; - readonly monthly_price_in_cents?: number; - readonly name?: string; - /** @enum {string} */ - readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name?: string | null; - readonly yearly_price_in_cents?: number; - }; - readonly unit_count?: number; - }; + readonly label: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - readonly previous_marketplace_purchase?: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: unknown; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase changed event */ - readonly "webhook-marketplace-purchase-changed": { + /** discussion locked event */ + readonly "webhook-discussion-locked": { /** @enum {string} */ - readonly action: "changed"; - readonly effective_date: string; + readonly action: "locked"; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - } & { - readonly account?: { - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organization_billing_email?: string | null; - readonly type?: string; - }; - readonly billing_cycle?: string; - readonly free_trial_ends_on?: string | null; - readonly next_billing_date: string | null; - readonly on_free_trial?: boolean; - readonly plan?: { - readonly bullets?: (string | null)[]; - readonly description?: string; - readonly has_free_trial?: boolean; - readonly id?: number; - readonly monthly_price_in_cents?: number; - readonly name?: string; - /** @enum {string} */ - readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name?: string | null; - readonly yearly_price_in_cents?: number; - }; - readonly unit_count?: number; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion pinned event */ + readonly "webhook-discussion-pinned": { + /** @enum {string} */ + readonly action: "pinned"; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion reopened event */ + readonly "webhook-discussion-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion transferred event */ + readonly "webhook-discussion-transferred": { + /** @enum {string} */ + readonly action: "transferred"; + readonly changes: { + readonly new_discussion: components["schemas"]["discussion"]; + readonly new_repository: components["schemas"]["repository-webhooks"]; }; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - readonly previous_marketplace_purchase?: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean | null; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase pending_change event */ - readonly "webhook-marketplace-purchase-pending-change": { + /** discussion unanswered event */ + readonly "webhook-discussion-unanswered": { /** @enum {string} */ - readonly action: "pending_change"; - readonly effective_date: string; + readonly action: "unanswered"; + readonly discussion: components["schemas"]["discussion"]; + readonly old_answer: components["schemas"]["webhooks_answer"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion unlabeled event */ + readonly "webhook-discussion-unlabeled": { + /** @enum {string} */ + readonly action: "unlabeled"; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - } & { - readonly account?: { - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organization_billing_email?: string | null; - readonly type?: string; - }; - readonly billing_cycle?: string; - readonly free_trial_ends_on?: string | null; - readonly next_billing_date: string | null; - readonly on_free_trial?: boolean; - readonly plan?: { - readonly bullets?: (string | null)[]; - readonly description?: string; - readonly has_free_trial?: boolean; - readonly id?: number; - readonly monthly_price_in_cents?: number; - readonly name?: string; - /** @enum {string} */ - readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name?: string | null; - readonly yearly_price_in_cents?: number; - }; - readonly unit_count?: number; - }; + readonly label: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - readonly previous_marketplace_purchase?: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase pending_change_cancelled event */ - readonly "webhook-marketplace-purchase-pending-change-cancelled": { + /** discussion unlocked event */ + readonly "webhook-discussion-unlocked": { /** @enum {string} */ - readonly action: "pending_change_cancelled"; - readonly effective_date: string; + readonly action: "unlocked"; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: unknown; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - } & { - readonly next_billing_date: string; - }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - readonly previous_marketplace_purchase?: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: unknown; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase purchased event */ - readonly "webhook-marketplace-purchase-purchased": { + /** discussion unpinned event */ + readonly "webhook-discussion-unpinned": { /** @enum {string} */ - readonly action: "purchased"; - readonly effective_date: string; + readonly action: "unpinned"; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * fork event + * @description A user forks a repository. + */ + readonly "webhook-fork": { + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */ + readonly forkee: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + readonly custom_properties?: { + readonly [key: string]: unknown; }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: 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 price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; }; - readonly unit_count: number; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; } & { - readonly account?: { + readonly allow_forking?: boolean; + readonly archive_url?: string; + readonly archived?: boolean; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly clone_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly created_at?: string; + readonly default_branch?: string; + readonly deployments_url?: string; + readonly description?: string | null; + readonly disabled?: boolean; + readonly downloads_url?: string; + readonly events_url?: string; + /** @enum {boolean} */ + readonly fork?: true; + readonly forks?: number; + readonly forks_count?: number; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly git_url?: string; + readonly has_downloads?: boolean; + readonly has_issues?: boolean; + readonly has_pages?: boolean; + readonly has_projects?: boolean; + readonly has_wiki?: boolean; + readonly homepage?: string | null; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly is_template?: boolean; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly language?: unknown; + readonly languages_url?: string; + readonly license?: Record; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly mirror_url?: unknown; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly open_issues?: number; + readonly open_issues_count?: number; + readonly owner?: { + 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; readonly id?: number; readonly login?: string; readonly node_id?: string; - readonly organization_billing_email?: string | null; + 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 billing_cycle?: string; - readonly free_trial_ends_on?: string | null; - readonly next_billing_date: string | null; - readonly on_free_trial?: boolean; - readonly plan?: { - readonly bullets?: (string | null)[]; - readonly description?: string; - readonly has_free_trial?: boolean; - readonly id?: number; - readonly monthly_price_in_cents?: number; - readonly name?: string; - /** @enum {string} */ - readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name?: string | null; - readonly yearly_price_in_cents?: number; - }; - readonly unit_count?: number; + readonly private?: boolean; + readonly public?: boolean; + readonly pulls_url?: string; + readonly pushed_at?: string; + readonly releases_url?: string; + readonly size?: number; + readonly ssh_url?: string; + readonly stargazers_count?: number; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly svn_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly topics?: unknown[]; + readonly trees_url?: string; + readonly updated_at?: string; + readonly url?: string; + readonly visibility?: string; + readonly watchers?: number; + readonly watchers_count?: number; }; + readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - readonly previous_marketplace_purchase?: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: unknown; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** member added event */ - readonly "webhook-member-added": { + /** github_app_authorization revoked event */ + readonly "webhook-github-app-authorization-revoked": { /** @enum {string} */ - readonly action: "added"; - readonly changes?: { - readonly permission?: { - /** @enum {string} */ - readonly to: "write" | "admin" | "read"; - }; - }; + readonly action: "revoked"; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** gollum event */ + readonly "webhook-gollum": { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** User */ - readonly member: { - /** 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 organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description The pages that were updated. */ + readonly pages: { + /** + * @description The action that was performed on the page. Can be `created` or `edited`. + * @enum {string} + */ + readonly action: "created" | "edited"; + /** + * Format: uri + * @description Points to the HTML wiki page. + */ + readonly html_url: string; + /** @description The name of the page. */ + readonly page_name: string; + /** @description The latest commit SHA of the page. */ + readonly sha: string; + readonly summary: string | null; + /** @description The current page title. */ + readonly title: string; + }[]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** member edited event */ - readonly "webhook-member-edited": { + /** installation created event */ + readonly "webhook-installation-created": { /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the collaborator permissions */ - readonly changes: { - readonly old_permission?: { - /** @description The previous permissions of the collaborator if the action was edited. */ - readonly from: string; - }; - readonly permission?: { - readonly from?: string | null; - readonly to?: string | null; - }; - }; + readonly action: "created"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** User */ - readonly member: { - /** 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 installation: components["schemas"]["installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; + readonly repositories?: components["schemas"]["webhooks_repositories"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly requester?: components["schemas"]["webhooks_user"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** member removed event */ - readonly "webhook-member-removed": { + /** installation deleted event */ + readonly "webhook-installation-deleted": { /** @enum {string} */ - readonly action: "removed"; + readonly action: "deleted"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** User */ - readonly member: { - /** 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 installation: components["schemas"]["installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; + readonly repositories?: components["schemas"]["webhooks_repositories"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly requester?: unknown; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** membership added event */ - readonly "webhook-membership-added": { + /** installation new_permissions_accepted event */ + readonly "webhook-installation-new-permissions-accepted": { + /** @enum {string} */ + readonly action: "new_permissions_accepted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation: components["schemas"]["installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repositories?: components["schemas"]["webhooks_repositories"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly requester?: unknown; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** installation_repositories added event */ + readonly "webhook-installation-repositories-added": { /** @enum {string} */ readonly action: "added"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** User */ - readonly member: { - /** 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 installation: components["schemas"]["installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repositories_added: components["schemas"]["webhooks_repositories_added"]; + /** @description An array of repository objects, which were removed from the installation. */ + readonly repositories_removed: { + readonly full_name?: string; + /** @description Unique identifier of the repository */ + readonly id?: number; + /** @description The name of the repository. */ 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 organization: components["schemas"]["organization-simple-webhooks"]; + /** @description Whether the repository is private or public. */ + readonly private?: boolean; + }[]; readonly repository?: components["schemas"]["repository-webhooks"]; - /** - * @description The scope of the membership. Currently, can only be `team`. - * @enum {string} - */ - readonly scope: "team"; - /** User */ - readonly sender: { - /** 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; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** @enum {string} */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }; + readonly repository_selection: components["schemas"]["webhooks_repository_selection"]; + readonly requester: components["schemas"]["webhooks_user"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** membership removed event */ - readonly "webhook-membership-removed": { + /** installation_repositories removed event */ + readonly "webhook-installation-repositories-removed": { /** @enum {string} */ readonly action: "removed"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** User */ - readonly member: { - /** 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 installation: components["schemas"]["installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repositories_added: components["schemas"]["webhooks_repositories_added"]; + /** @description An array of repository objects, which were removed from the installation. */ + readonly repositories_removed: { + readonly full_name: string; + /** @description Unique identifier of the repository */ 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 organization: components["schemas"]["organization-simple-webhooks"]; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + }[]; readonly repository?: components["schemas"]["repository-webhooks"]; - /** - * @description The scope of the membership. Currently, can only be `team`. - * @enum {string} - */ - readonly scope: "team" | "organization"; - /** User */ - readonly sender: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ + readonly repository_selection: components["schemas"]["webhooks_repository_selection"]; + readonly requester: components["schemas"]["webhooks_user"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** installation suspend event */ + readonly "webhook-installation-suspend": { + /** @enum {string} */ + readonly action: "suspend"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation: components["schemas"]["installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repositories?: components["schemas"]["webhooks_repositories"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly requester?: unknown; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + readonly "webhook-installation-target-renamed": { + readonly account: { + readonly archived_at?: string | null; + readonly avatar_url: string; + readonly created_at?: string; + readonly description?: unknown; readonly events_url?: string; - /** Format: uri */ + readonly followers?: number; readonly followers_url?: string; - /** Format: uri-template */ + readonly following?: number; readonly following_url?: string; - /** Format: uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; + readonly has_organization_projects?: boolean; + readonly has_repository_projects?: boolean; + readonly hooks_url?: string; + readonly html_url: string; readonly id: number; - readonly login: string; + readonly is_verified?: boolean; + readonly issues_url?: string; + readonly login?: string; + readonly members_url?: string; readonly name?: string; - readonly node_id?: string; - /** Format: uri */ + readonly node_id: string; readonly organizations_url?: string; - /** Format: uri */ + readonly public_gists?: number; + readonly public_members_url?: string; + readonly public_repos?: number; readonly received_events_url?: string; - /** Format: uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + readonly slug?: string; readonly starred_url?: string; - /** Format: uri */ readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** @enum {string} */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ + readonly type?: string; + readonly updated_at?: string; readonly url?: string; + readonly website_url?: unknown; }; - }; - readonly "webhook-merge-group-checks-requested": { /** @enum {string} */ - readonly action: "checks_requested"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly merge_group: components["schemas"]["merge-group"]; + readonly action: "renamed"; + readonly changes: { + readonly login?: { + readonly from: string; + }; + readonly slug?: { + readonly from: string; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly target_type: string; }; - readonly "webhook-merge-group-destroyed": { + /** installation unsuspend event */ + readonly "webhook-installation-unsuspend": { /** @enum {string} */ - readonly action: "destroyed"; - /** - * @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated). - * @enum {string} - */ - readonly reason?: "merged" | "invalidated" | "dequeued"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly merge_group: components["schemas"]["merge-group"]; + readonly action: "unsuspend"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation: components["schemas"]["installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly requester?: unknown; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** meta deleted event */ - readonly "webhook-meta-deleted": { + /** issue_comment created event */ + readonly "webhook-issue-comment-created": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ - readonly hook: { - readonly active: boolean; - readonly config: { - /** @enum {string} */ - readonly content_type: "json" | "form"; - readonly insecure_ssl: string; - readonly secret?: string; + readonly action: "created"; + /** + * issue comment + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. + */ + readonly comment: { + /** + * 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 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; }; - readonly created_at: string; - readonly events: ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[]; - readonly id: number; - readonly name: string; - readonly type: 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; + 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; }; - /** @description The id of the modified webhook. */ - readonly hook_id: number; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone closed event */ - readonly "webhook-milestone-closed": { - /** @enum {string} */ - readonly action: "closed"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** - * 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; + /** @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 creator: { + 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; + } | null; + readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -50228,161 +42238,328 @@ export type components = { /** 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; + 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; + } | 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?: { + /** @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; + /** + * 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; + } | 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?: ("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; + } | 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; - 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: date-time */ + readonly merged_at?: string | null; /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly patch_url?: string; /** Format: uri */ readonly url?: string; - } | null; - readonly description: string | null; - /** Format: date-time */ - readonly due_on: string | null; - /** Format: uri */ - readonly html_url: string; - readonly id: 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 labels_url: string; - readonly node_id: string; - /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + readonly repository_url: string; /** - * @description The state of the milestone. + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; - /** @description The title of the milestone. */ + 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 */ - readonly url: string; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone created event */ - readonly "webhook-milestone-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * 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"; - /** Format: uri */ - readonly url?: 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} + * Format: uri + * @description URL for the issue */ - 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; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone deleted event */ - readonly "webhook-milestone-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * 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: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -50418,67 +42595,10 @@ export type components = { /** Format: uri */ readonly url?: 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; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone edited event */ - readonly "webhook-milestone-edited": { - /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the milestone if the action was `edited`. */ - readonly changes: { - readonly description?: { - /** @description The previous version of the description if the action was `edited`. */ - readonly from: string; - }; - readonly due_on?: { - /** @description The previous version of the due date if the action was `edited`. */ - readonly from: string; - }; - readonly title?: { - /** @description The previous version of the title if the action was `edited`. */ - readonly from: string; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * 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; + } & { + readonly active_lock_reason?: string | null; /** User */ - readonly creator: { + readonly assignee: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -50514,228 +42634,97 @@ export type components = { /** Format: uri */ readonly url?: 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; + readonly assignees?: 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: { + /** @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 The state of the milestone. + * @description State of the issue; either 'open' or 'closed' * @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; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone opened event */ - readonly "webhook-milestone-opened": { - /** @enum {string} */ - readonly action: "opened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * 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 timeline_url?: string; + readonly title?: string; + readonly updated_at?: string; + readonly url?: string; + readonly user?: { 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 id?: number; + readonly login?: 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 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; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** org_block blocked event */ - readonly "webhook-org-block-blocked": { - /** @enum {string} */ - readonly action: "blocked"; - /** User */ - readonly blocked_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; - 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 enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** org_block unblocked event */ - readonly "webhook-org-block-unblocked": { - /** @enum {string} */ - readonly action: "unblocked"; - /** User */ - readonly blocked_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; - 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 enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; + 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-webhooks"]; }; - /** organization deleted event */ - readonly "webhook-organization-deleted": { + /** 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"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - readonly membership?: { - /** Format: uri */ - readonly organization_url: string; - readonly role: string; - readonly state: string; - /** Format: uri */ - readonly url: string; + /** @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 user: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -50767,34 +42756,11 @@ 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; - }; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** organization member_added event */ - readonly "webhook-organization-member-added": { - /** @enum {string} */ - readonly action: "member_added"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - readonly membership: { - /** Format: uri */ - readonly organization_url: string; - readonly role: string; - readonly state: string; - /** Format: uri */ - readonly url: string; - /** User */ - readonly user: { + readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -50826,34 +42792,304 @@ 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; - }; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** organization member_invited event */ - readonly "webhook-organization-member-invited": { - /** @enum {string} */ - readonly action: "member_invited"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The invitation for the user or email if the action is `member_invited`. */ - readonly invitation: { + } | 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 created_at: string; - readonly email: string | null; + readonly closed_at: string | null; + readonly comments: number; + /** Format: uri */ + readonly comments_url: string; /** Format: date-time */ - readonly failed_at: string | null; - readonly failed_reason: string | null; + 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?: { + /** @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; + /** + * 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; + } | 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?: ("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 */ + 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; + } | 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"; + /** @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; + }; + /** 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 invitation_teams_url: string; + 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 inviter: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -50885,76 +43121,14 @@ 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; - readonly login: string | null; - readonly node_id: string; - readonly role: string; - readonly team_count: number; - readonly invitation_source?: string; - }; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - /** 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; - 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; - }; - /** organization member_removed event */ - readonly "webhook-organization-member-removed": { - /** @enum {string} */ - readonly action: "member_removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - readonly membership: { - /** Format: uri */ - readonly organization_url: string; - readonly role: string; - readonly state: string; - /** Format: uri */ - readonly url: string; + } & { + readonly active_lock_reason?: string | null; /** User */ - readonly user: { + readonly assignee: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -50986,39 +43160,102 @@ 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; + readonly assignees?: 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: { + /** @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; + 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 organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** organization renamed event */ - readonly "webhook-organization-renamed": { + /** issue_comment edited event */ + readonly "webhook-issue-comment-edited": { /** @enum {string} */ - readonly action: "renamed"; - readonly changes?: { - readonly login?: { - readonly from?: string; - }; - }; + 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"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - readonly membership?: { - /** Format: uri */ - readonly organization_url: string; - readonly role: string; - readonly state: string; - /** Format: uri */ - readonly url: string; + /** @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 user: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51050,53 +43287,11 @@ 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; - }; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Ruby Gems metadata */ - readonly "webhook-rubygems-metadata": { - readonly name?: string; - readonly description?: string; - readonly readme?: string; - readonly homepage?: string; - readonly version_info?: { - readonly version?: string; - }; - readonly platform?: string; - readonly metadata?: { - readonly [key: string]: string | undefined; - }; - readonly repo?: string; - readonly dependencies?: { - readonly [key: string]: string | undefined; - }[]; - readonly commit_oid?: string; - }; - /** package published event */ - readonly "webhook-package-published": { - /** @enum {string} */ - readonly action: "published"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description Information about the package. */ - readonly package: { - readonly created_at: string | null; - readonly description: string | null; - readonly ecosystem: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; - /** User */ - readonly owner: { + readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51128,14 +43323,62 @@ 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; - readonly package_type: string; - readonly package_version: { + } | 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?: { + /** @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; + /** + * 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 author?: { + readonly creator: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51167,193 +43410,399 @@ 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; - readonly body?: string | Record; - readonly body_html?: string; - readonly container_metadata?: { - readonly labels?: Record; - readonly manifest?: Record; - readonly tag?: { - readonly digest?: string; - readonly name?: string; - }; - } | null; - readonly created_at?: string; - readonly description: string; - readonly docker_metadata?: { - readonly tags?: string[]; - }[]; - readonly draft?: boolean; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; /** Format: uri */ readonly html_url: string; readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: { - readonly [key: string]: unknown; - }[]; + /** 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?: ("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 npm_metadata?: { - readonly name?: string; - readonly version?: string; - readonly npm_user?: string; - readonly author?: Record; - readonly bugs?: Record; - readonly dependencies?: Record; - readonly dev_dependencies?: Record; - readonly peer_dependencies?: Record; - readonly optional_dependencies?: Record; - readonly description?: string; - readonly dist?: Record; - readonly git_head?: string; - readonly homepage?: string; - readonly license?: string; - readonly main?: string; - readonly repository?: Record; - readonly scripts?: Record; - readonly id?: string; - readonly node_version?: string; - readonly npm_version?: string; - readonly has_shrinkwrap?: boolean; - readonly maintainers?: Record[]; - readonly contributors?: Record[]; - readonly engines?: Record; - readonly keywords?: string[]; - readonly files?: string[]; - readonly bin?: Record; - readonly man?: Record; - readonly directories?: Record; - readonly os?: string[]; - readonly cpu?: string[]; - readonly readme?: string; - readonly installation_command?: string; - readonly release_id?: number; - readonly commit_oid?: string; - readonly published_via_actions?: boolean; - readonly deleted_by_id?: number; - } | null; - readonly nuget_metadata?: { - readonly id?: number | string; - readonly name?: string; - readonly value?: boolean | string | number | { - readonly url?: string; - readonly branch?: string; - readonly commit?: string; - readonly type?: string; - }; - }[] | null; - readonly package_files: { - readonly content_type: string; - readonly created_at: string; + readonly node_id: string; + /** User */ + readonly owner: { /** Format: uri */ - readonly download_url: string; - readonly id: number; - readonly md5: string | null; - readonly name: string; - readonly sha1: string | null; - readonly sha256: string | null; - readonly size: number; - readonly state: string | null; - readonly updated_at: string; - }[]; - readonly package_url?: string; - readonly prerelease?: boolean; - readonly release?: { - /** User */ - readonly author: { - /** 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 created_at: string; - readonly draft: boolean; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; /** Format: uri */ - readonly html_url: string; + 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 name: string | null; - readonly prerelease: boolean; - readonly published_at: string; - readonly tag_name: string; - readonly target_commitish: string; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly url: string; + 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; + /** @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"; }; - readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - readonly source_url?: string; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish?: string; - readonly target_oid?: string; - readonly updated_at?: string; - readonly version: string; + /** @description The slug name of the GitHub app */ + readonly slug?: string; + /** Format: date-time */ + readonly updated_at: string | null; } | null; - readonly registry: { + 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; + 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} + */ + 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; + 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; + } | 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 about_url: string; - readonly name: string; - readonly type: string; + readonly organizations_url?: string; /** Format: uri */ - readonly url: string; - readonly vendor: string; + 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; } | null; - readonly updated_at: string | null; + readonly assignees?: 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: { + /** @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; + 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 repository?: components["schemas"]["repository-webhooks"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** package updated event */ - readonly "webhook-package-updated": { - /** @enum {string} */ - readonly action: "updated"; + /** 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"]; + readonly issue: components["schemas"]["webhooks_issue"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description Information about the package. */ - readonly package: { - readonly created_at: string; - readonly description: string | null; - readonly ecosystem: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** 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; /** User */ - readonly owner: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51385,14 +43834,98 @@ 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; - readonly package_type: string; - readonly package_version: { + readonly assignees: ({ + /** 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; + } | 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?: { + /** @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; + /** + * 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 author: { + readonly creator: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51424,130 +43957,217 @@ 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; - readonly body: string; - readonly body_html: string; - readonly created_at: string; - readonly description: string; - readonly docker_metadata?: { - readonly tags?: string[]; - }[]; - readonly draft?: boolean; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; /** Format: uri */ readonly html_url: string; readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: { - readonly [key: string]: unknown; - }[]; + /** 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?: ("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 */ + 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 package_files: { - readonly content_type: string; - readonly created_at: string; + readonly node_id: string; + /** User */ + readonly owner: { /** Format: uri */ - readonly download_url: string; - readonly id: number; - readonly md5: string | null; - readonly name: string; - readonly sha1: string | null; - readonly sha256: string; - readonly size: number; - readonly state: string; - readonly updated_at: string; - }[]; - readonly package_url?: string; - readonly prerelease?: boolean; - readonly release?: { - /** User */ - readonly author: { - /** 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 created_at: string; - readonly draft: boolean; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; /** Format: uri */ - readonly html_url: string; + 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 name: string; - readonly prerelease: boolean; - readonly published_at: string; - readonly tag_name: string; - readonly target_commitish: string; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly url: string; + 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; + /** @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"; }; - readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + /** @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 source_url?: string; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish: string; - readonly target_oid: string; - readonly updated_at: string; - readonly version: string; - }; - readonly registry: { + readonly diff_url?: string; /** Format: uri */ - readonly about_url: string; - readonly name: string; - readonly type: string; + 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; + 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; - readonly vendor: string; - } | null; - readonly updated_at: string; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** page_build event */ - readonly "webhook-page-build": { - /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ - readonly build: { - readonly commit: string | null; - readonly created_at: string; - readonly duration: number; - readonly error: { - readonly message: string | null; }; + /** 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 pusher: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51579,137 +44199,89 @@ 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; - readonly status: string; - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly id: number; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** personal_access_token_request approved event */ - readonly "webhook-personal-access-token-request-approved": { - /** @enum {string} */ - readonly action: "approved"; - readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly installation: components["schemas"]["simple-installation"]; - }; - /** personal_access_token_request cancelled event */ - readonly "webhook-personal-access-token-request-cancelled": { - /** @enum {string} */ - readonly action: "cancelled"; - readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly installation: components["schemas"]["simple-installation"]; - }; - /** personal_access_token_request created event */ - readonly "webhook-personal-access-token-request-created": { - /** @enum {string} */ - readonly action: "created"; - readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly installation: components["schemas"]["simple-installation"]; - }; - /** personal_access_token_request denied event */ - readonly "webhook-personal-access-token-request-denied": { - /** @enum {string} */ - readonly action: "denied"; - readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly installation: components["schemas"]["simple-installation"]; - }; - readonly "webhook-ping": { - /** - * Webhook - * @description The webhook that is being pinged - */ - readonly hook?: { - /** @description Determines whether the hook is actually triggered for the events it subscribes to. */ - readonly active: boolean; - /** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */ - readonly app_id?: number; - readonly config: { - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly url?: components["schemas"]["webhook-config-url"]; + } & { + readonly active_lock_reason?: string | null; + readonly assignee?: Record; + readonly assignees?: 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?: 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; }; - /** Format: date-time */ - readonly created_at: string; - /** Format: uri */ - readonly deliveries_url?: string; - /** @description Determines what events the hook is triggered for. Default: ['push']. */ - readonly events: string[]; - /** @description Unique identifier of the webhook. */ - readonly id: number; - readonly last_response?: components["schemas"]["hook-response"]; - /** - * @description The type of webhook. The only valid value is 'web'. - * @enum {string} - */ - readonly name: "web"; - /** Format: uri */ - readonly ping_url?: string; - /** Format: uri */ - readonly test_url?: string; - readonly type: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ + 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; + 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; + }; }; - /** @description The ID of the webhook that triggered the ping. */ - readonly hook_id?: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - /** @description Random string of GitHub zen. */ - readonly zen?: string; - }; - /** @description The webhooks ping payload encoded with URL encoding. */ - readonly "webhook-ping-form-encoded": { - /** @description A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** project_card converted event */ - readonly "webhook-project-card-converted": { + /** issues deleted event */ + readonly "webhook-issues-deleted": { /** @enum {string} */ - readonly action: "converted"; - readonly changes: { - readonly note: { - readonly from: string; - }; - }; + readonly action: "deleted"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - readonly project_card: { - readonly after_id?: number | null; - /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number; - /** Format: uri */ - readonly column_url: string; - /** Format: uri */ - readonly content_url?: string; - /** Format: date-time */ - readonly created_at: string; + /** + * 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 creator: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51745,41 +44317,336 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - /** @description The project card's ID */ + readonly assignees: ({ + /** 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?: { + /** @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; + /** + * 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"; + /** Format: uri */ + readonly url?: 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 note: string | null; + 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?: ("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; + } | 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"; + /** @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; + }; + /** 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 project_url: string; + 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 */ + /** + * Format: uri + * @description URL for the issue + */ readonly url: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_card created event */ - readonly "webhook-project-card-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - readonly project_card: { - readonly after_id?: number | null; - /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number; - /** Format: uri */ - readonly column_url: string; - /** Format: uri */ - readonly content_url?: string; - /** Format: date-time */ - readonly created_at: string; /** User */ - readonly creator: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51815,41 +44682,26 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - /** @description The project card's ID */ - readonly id: number; - readonly node_id: string; - readonly note: string | null; - /** Format: uri */ - readonly project_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; }; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** project_card deleted event */ - readonly "webhook-project-card-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"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - readonly project_card: { - readonly after_id?: number | null; - /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number | null; - /** Format: uri */ - readonly column_url: string; - /** Format: uri */ - readonly content_url?: string; - /** Format: date-time */ - readonly created_at: string; + /** + * 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 creator: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51885,46 +44737,7 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - /** @description The project card's ID */ - readonly id: number; - readonly node_id: string; - readonly note: string | null; - /** Format: uri */ - readonly project_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_card edited event */ - readonly "webhook-project-card-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly note: { - readonly from: string | null; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - readonly project_card: { - readonly after_id?: number | null; - /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number; - /** Format: uri */ - readonly column_url: string; - /** Format: uri */ - readonly content_url?: string; - /** Format: date-time */ - readonly created_at: string; - /** User */ - readonly creator: { + readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51956,147 +44769,304 @@ 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; - /** @description The project card's ID */ - readonly id: number; - readonly node_id: string; - readonly note: string | null; - /** Format: uri */ - readonly project_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 updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_card moved event */ - readonly "webhook-project-card-moved": { - /** @enum {string} */ - readonly action: "moved"; - readonly changes?: { - readonly column_id: { - readonly from: number; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly project_card: { - readonly after_id?: number | null; - /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number; - /** Format: uri */ - readonly column_url: string; + readonly closed_at: string | null; + readonly comments: number; /** Format: uri */ - readonly content_url?: string; + readonly comments_url: string; /** Format: date-time */ readonly created_at: string; - /** User */ - readonly creator: { + readonly draft?: boolean; + /** Format: uri */ + readonly events_url: string; + /** Format: uri */ + readonly html_url: string; + /** Format: int64 */ + readonly id: number; + readonly labels?: ({ + /** @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; + } | null; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; + readonly html_url: string; + readonly id: number; /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + 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 html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + 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?: ("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 organizations_url?: string; + readonly external_url: string | null; /** Format: uri */ - readonly received_events_url?: string; + 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; + } | 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 repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; + readonly diff_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly html_url?: string; + /** Format: date-time */ + readonly merged_at?: string | null; + /** Format: uri */ + readonly patch_url?: string; /** Format: uri */ readonly url?: string; - } | null; - /** @description The project card's ID */ - readonly id: number; - readonly node_id: string; - readonly note: string | null; - /** Format: uri */ - readonly project_url: string; - /** Format: date-time */ - readonly updated_at: string; + }; + /** 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 url: string; - } & { - readonly after_id: number | null; - readonly archived?: boolean; - readonly column_id?: number; - readonly column_url?: string; - readonly created_at?: string; - readonly creator?: { - 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; - 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; - } | null; - readonly id?: number; - readonly node_id?: string; - readonly note?: string | null; - readonly project_url?: string; - readonly updated_at?: string; - readonly url?: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project closed event */ - readonly "webhook-project-closed": { - /** @enum {string} */ - readonly action: "closed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - readonly project: { - /** @description Body of the project */ - readonly body: string | null; + 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 columns_url: string; + readonly timeline_url?: string; + /** @description Title of the issue */ + readonly title: string; /** Format: date-time */ - readonly created_at: string; + readonly updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + readonly url: string; /** User */ - readonly creator: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -52128,170 +45098,42 @@ 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; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - /** @description Name of the project */ - readonly name: string; - readonly node_id: string; - readonly number: number; - /** Format: uri */ - readonly owner_url: string; - /** - * @description State of the project; either 'open' or 'closed' - * @enum {string} - */ - readonly state: "open" | "closed"; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_column created event */ - readonly "webhook-project-column-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - readonly project_column: { - readonly after_id?: number | null; - /** Format: uri */ - readonly cards_url: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The unique identifier of the project column */ - readonly id: number; - /** @description Name of the project column */ - readonly name: string; - readonly node_id: string; - /** Format: uri */ - readonly project_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** project_column deleted event */ - readonly "webhook-project-column-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + readonly milestone?: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - readonly project_column: { - readonly after_id?: number | null; - /** Format: uri */ - readonly cards_url: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The unique identifier of the project column */ - readonly id: number; - /** @description Name of the project column */ - readonly name: string; - readonly node_id: string; - /** Format: uri */ - readonly project_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** project_column edited event */ - readonly "webhook-project-column-edited": { + /** issues edited event */ + readonly "webhook-issues-edited": { /** @enum {string} */ readonly action: "edited"; + /** @description The changes to the issue. */ readonly changes: { - readonly name?: { + 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"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - readonly project_column: { - readonly after_id?: number | null; - /** Format: uri */ - readonly cards_url: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The unique identifier of the project column */ - readonly id: number; - /** @description Name of the project column */ - readonly name: string; - readonly node_id: string; - /** Format: uri */ - readonly project_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** project_column moved event */ - readonly "webhook-project-column-moved": { - /** @enum {string} */ - readonly action: "moved"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - readonly project_column: { - readonly after_id?: number | null; - /** Format: uri */ - readonly cards_url: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The unique identifier of the project column */ - readonly id: number; - /** @description Name of the project column */ - readonly name: string; - readonly node_id: string; - /** Format: uri */ - readonly project_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project created event */ - readonly "webhook-project-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - readonly project: { - /** @description Body of the project */ - readonly body: string | null; - /** Format: uri */ - readonly columns_url: string; - /** Format: date-time */ - readonly created_at: string; + /** + * 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 creator: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -52323,49 +45165,340 @@ 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; + readonly assignees: ({ + /** 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; + } | 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; - /** @description Name of the project */ - readonly name: string; + readonly labels?: { + /** @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; + /** + * 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; + } | 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?: ("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 */ + 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; + } | 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; + }; + /** 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 owner_url: string; + readonly repository_url: string; /** - * @description State of the project; either 'open' or 'closed' + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; + 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 */ + /** + * Format: uri + * @description URL for the issue + */ readonly url: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project deleted event */ - readonly "webhook-project-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - readonly project: { - /** @description Body of the project */ - readonly body: string | null; - /** Format: uri */ - readonly columns_url: string; - /** Format: date-time */ - readonly created_at: string; /** User */ - readonly creator: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -52397,60 +45530,31 @@ 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; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - /** @description Name of the project */ - readonly name: string; - readonly node_id: string; - readonly number: number; - /** Format: uri */ - readonly owner_url: string; - /** - * @description State of the project; either 'open' or 'closed' - * @enum {string} - */ - readonly state: "open" | "closed"; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; }; - readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + 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-webhooks"]; }; - /** project edited event */ - readonly "webhook-project-edited": { + /** issues labeled event */ + readonly "webhook-issues-labeled": { /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the project if the action was `edited`. */ - readonly changes?: { - readonly body?: { - /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; - }; - readonly name?: { - /** @description The changes to the project if the action was `edited`. */ - readonly from: string; - }; - }; + readonly action: "labeled"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - readonly project: { - /** @description Body of the project */ - readonly body: string | null; - /** Format: uri */ - readonly columns_url: string; - /** Format: date-time */ - readonly created_at: string; + /** + * 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 creator: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -52482,49 +45586,11 @@ 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; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - /** @description Name of the project */ - readonly name: string; - readonly node_id: string; - readonly number: number; - /** Format: uri */ - readonly owner_url: string; - /** - * @description State of the project; either 'open' or 'closed' - * @enum {string} - */ - readonly state: "open" | "closed"; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** project reopened event */ - readonly "webhook-project-reopened": { - /** @enum {string} */ - readonly action: "reopened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - readonly project: { - /** @description Body of the project */ - readonly body: string | null; - /** Format: uri */ - readonly columns_url: string; - /** Format: date-time */ - readonly created_at: string; - /** User */ - readonly creator: { + readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -52556,300 +45622,360 @@ 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; + } | 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; - /** @description Name of the project */ - readonly name: string; + readonly labels?: { + /** @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; + /** + * 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; + } | 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?: ("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 */ + 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; + } | 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; + }; + /** 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 owner_url: string; + readonly repository_url: string; /** - * @description State of the project; either 'open' or 'closed' + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; + 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 */ + /** + * 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; + 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; + } | null; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Closed Event */ - readonly "webhook-projects-v2-project-closed": { - /** @enum {string} */ - readonly action: "closed"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** @description A project was created */ - readonly "webhook-projects-v2-project-created": { - /** @enum {string} */ - readonly action: "created"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Deleted Event */ - readonly "webhook-projects-v2-project-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Edited Event */ - readonly "webhook-projects-v2-project-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly description?: { - readonly from?: string | null; - readonly to?: string | null; - }; - readonly public?: { - readonly from?: boolean; - readonly to?: boolean; - }; - readonly short_description?: { - readonly from?: string | null; - readonly to?: string | null; - }; - readonly title?: { - readonly from?: string; - readonly to?: string; - }; - }; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Archived Event */ - readonly "webhook-projects-v2-item-archived": { - /** @enum {string} */ - readonly action: "archived"; - readonly changes: { - readonly archived_at?: { - /** Format: date-time */ - readonly from?: string | null; - /** Format: date-time */ - readonly to?: string | null; - }; - }; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Converted Event */ - readonly "webhook-projects-v2-item-converted": { - /** @enum {string} */ - readonly action: "converted"; - readonly changes: { - readonly content_type?: { - readonly from?: string | null; - readonly to?: string; - }; - }; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Created Event */ - readonly "webhook-projects-v2-item-created": { - /** @enum {string} */ - readonly action: "created"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Deleted Event */ - readonly "webhook-projects-v2-item-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Edited Event */ - readonly "webhook-projects-v2-item-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes?: { - readonly field_value: { - readonly field_node_id?: string; - readonly field_type?: string; - }; - } | { - readonly body: { - readonly from?: string | null; - readonly to?: string | null; - }; - }; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Reordered Event */ - readonly "webhook-projects-v2-item-reordered": { - /** @enum {string} */ - readonly action: "reordered"; - readonly changes: { - readonly previous_projects_v2_item_node_id?: { - readonly from?: string | null; - readonly to?: string | null; - }; - }; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Restored Event */ - readonly "webhook-projects-v2-item-restored": { - /** @enum {string} */ - readonly action: "restored"; - readonly changes: { - readonly archived_at?: { - /** Format: date-time */ - readonly from?: string | null; - /** Format: date-time */ - readonly to?: string | null; - }; - }; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Reopened Event */ - readonly "webhook-projects-v2-project-reopened": { - /** @enum {string} */ - readonly action: "reopened"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** public event */ - readonly "webhook-public": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + 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-webhooks"]; }; - /** pull_request assigned event */ - readonly "webhook-pull-request-assigned": { + /** issues locked event */ + readonly "webhook-issues-locked": { /** @enum {string} */ - readonly action: "assigned"; - /** 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 action: "locked"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - readonly pull_request: { - readonly _links: { - /** Link */ - readonly comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly commits: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly issue: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comment: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly statuses: { - /** Format: uri-template */ - readonly href: string; - }; - }; + /** + * 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; - readonly additions?: number; /** User */ - readonly assignee: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -52881,7 +46007,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; } | null; @@ -52917,7 +46043,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; } | null)[]; @@ -52927,345 +46053,53 @@ export type components = { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. - */ - readonly auto_merge: { - /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; - /** @description Title for the merge commit message. */ - readonly commit_title: string | null; - /** User */ - readonly enabled_by: { - /** 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; - /** - * @description The merge method to use. - * @enum {string} - */ - readonly merge_method: "merge" | "squash" | "rebase"; - } | null; - readonly base: { - readonly label: string; - readonly ref: string; + /** @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?: ({ + /** @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; /** - * Repository - * @description A git repository - */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; - /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: 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; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - }; - readonly sha: string; + * Format: uri + * @description URL for the label + */ + readonly url: string; + } | null)[]; + /** Format: uri-template */ + readonly labels_url: string; + /** @enum {boolean} */ + readonly locked: true; + /** + * 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 user: { + readonly creator: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -53301,311 +46135,53 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - }; - readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; - /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; - /** Format: uri */ - readonly commits_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; - /** Format: uri */ - readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + 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; /** - * Repository - * @description A git repository + * @description The state of the milestone. + * @enum {string} */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; - /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: 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; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - } | null; - readonly sha: 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?: ("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 */ + 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 user: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -53641,38 +46217,186 @@ export type components = { /** Format: uri */ readonly url?: 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"; + /** @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; + }; + /** 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 html_url: string; - readonly id: number; + 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 issue_url: string; - readonly labels: { - /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; + 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; 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 locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ - readonly merged_at: string | null; + 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 organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** 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 merged_by?: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -53708,6 +46432,82 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; + readonly assignees: ({ + /** 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?: ({ + /** @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. @@ -53780,300 +46580,188 @@ export type components = { readonly url: string; } | null; readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: (({ - /** 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; - } | null) | { - readonly deleted?: boolean; - /** @description Description of the team */ + /** + * 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?: ("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 team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ + /** @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; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; + /** User */ + readonly owner: { /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly events_url?: string; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - })[]; - readonly requested_teams: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; + 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; - /** @description Unique identifier of the team */ + 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 members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; + readonly url?: string; } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }[]; - /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; - /** Format: uri */ - readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - readonly state: "open" | "closed"; - /** Format: uri */ - readonly statuses_url: string; - /** @description The title of the pull request. */ - readonly title: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - 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; - 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; - } | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request auto_merge_disabled event */ - readonly "webhook-pull-request-auto-merge-disabled": { - /** @enum {string} */ - readonly action: "auto_merge_disabled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - readonly pull_request: { - readonly _links: { - /** Link */ - readonly comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly commits: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly issue: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comment: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly statuses: { - /** Format: uri-template */ - readonly href: string; + /** @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"; }; - }; - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; - /** 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; + /** @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 received_events_url?: string; + readonly diff_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; + readonly html_url?: string; + /** Format: date-time */ + readonly merged_at?: string | null; /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly patch_url?: string; /** Format: uri */ readonly url?: string; - } | null; - readonly assignees: ({ + }; + /** 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} + */ + 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; @@ -54108,24 +46796,27 @@ export type components = { 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"; + } | 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-webhooks"]; + }; + /** issues opened event */ + readonly "webhook-issues-opened": { + /** @enum {string} */ + readonly action: "opened"; + readonly changes?: { /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly auto_merge: { - /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; - /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + readonly old_issue: { + /** @enum {string|null} */ + readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly enabled_by: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -54161,299 +46852,7 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - /** - * @description The merge method to use. - * @enum {string} - */ - readonly merge_method: "merge" | "squash" | "rebase"; - } | null; - readonly base: { - readonly label: string; - readonly ref: string; - /** - * Repository - * @description A git repository - */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; - /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: 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; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - }; - readonly sha: string; - /** User */ - readonly user: { + readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -54485,205 +46884,142 @@ export type components = { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - } | null; - }; - readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; - /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; - /** Format: uri */ - readonly commits_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; - /** Format: uri */ - readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; - /** - * Repository - * @description A git repository - */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; + 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?: { + /** @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; /** - * @description Whether discussions are enabled. - * @default false + * Format: uri + * @description URL for the label */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; + readonly url: string; + }[]; + /** 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"; + /** Format: uri */ + readonly url?: string; + } | null; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + readonly labels_url: string; + readonly node_id: string; + /** @description The number of the milestone. */ + readonly number: number; + readonly open_issues: number; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @description The state of the milestone. * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + readonly state: "open" | "closed"; + /** @description The title of the milestone. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; + 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?: ("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 mirror_url: string | null; - /** @description The name of the repository. */ + 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; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; /** User */ readonly owner: { /** Format: uri */ @@ -54721,79 +47057,327 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; + /** @description The set of permissions for the GitHub app */ readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + /** @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"; + /** @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 Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + /** @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 stargazers_url: string; + 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; + 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} + */ + 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 statuses_url: string; + readonly events_url?: string; /** Format: uri */ - readonly subscribers_url: string; + 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 subscription_url: string; + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly svn_url: string; + readonly organizations_url?: string; /** Format: uri */ - readonly tags_url: string; + readonly received_events_url?: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; + readonly repos_url?: string; + readonly site_admin?: boolean; /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + } | null; + /** + * Repository + * @description A git repository + */ + readonly old_repository: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + readonly custom_properties?: { + readonly [key: string]: unknown; + }; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** @description Whether the repository has discussions enabled. */ + readonly has_discussions?: boolean; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; /** Format: uri */ - readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - }; - readonly sha: string; + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: string; /** User */ - readonly user: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -54829,13 +47413,160 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require commit signoff. */ + readonly web_commit_signoff_required?: boolean; }; + }; + 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: ({ + /** 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; - /** Format: uri */ - readonly issue_url: string; - readonly labels: { + readonly labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; @@ -54850,17 +47581,329 @@ export type components = { */ readonly url: string; }[]; - readonly locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | 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; + } | 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?: ("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 */ + 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; + } | 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; + }; + /** 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} + */ + 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 merged_at: string | null; + 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; + 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 organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues pinned event */ + readonly "webhook-issues-pinned": { + /** @enum {string} */ + readonly action: "pinned"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly issue: components["schemas"]["webhooks_issue_2"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues reopened event */ + readonly "webhook-issues-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + 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 merged_by?: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -54896,6 +47939,82 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; + readonly assignees: ({ + /** 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; + } | 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?: ({ + /** @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. @@ -54939,7 +48058,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; @@ -54968,165 +48087,185 @@ export type components = { readonly url: string; } | null; readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: (({ - /** 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; - } | null) | { - readonly deleted?: boolean; - /** @description Description of the team */ + /** + * 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?: ("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 */ readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ + /** @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; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; + /** User */ + readonly owner: { /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly events_url?: string; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - })[]; - readonly requested_teams: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; + 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; - /** @description Unique identifier of the team */ + 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 members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; + readonly url?: string; } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url?: string; + /** @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: uri - * @description URL for the team - */ + /** 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; - }[]; - /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: 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 review_comments_url: string; + readonly repository_url: string; /** - * @description State of this Pull Request. Either `open` or `closed`. + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ readonly state: "open" | "closed"; + readonly state_reason?: string | null; /** Format: uri */ - readonly statuses_url: string; - /** @description The title of the pull request. */ + readonly timeline_url?: string; + /** @description Title of the issue */ readonly title: string; /** Format: date-time */ readonly updated_at: string; - /** Format: uri */ + /** + * Format: uri + * @description URL for the issue + */ readonly url: string; /** User */ readonly user: { @@ -55160,161 +48299,30 @@ export type components = { readonly starred_url?: string; /** Format: uri */ readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ - readonly url?: string; - } | null; - }; - readonly reason: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request auto_merge_enabled event */ - readonly "webhook-pull-request-auto-merge-enabled": { - /** @enum {string} */ - readonly action: "auto_merge_enabled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - readonly pull_request: { - readonly _links: { - /** Link */ - readonly comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly commits: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly issue: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comment: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly statuses: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; - /** 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: ({ - /** 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"; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + readonly url?: string; + } | null; + }; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues transferred event */ + readonly "webhook-issues-transferred": { + /** @enum {string} */ + readonly action: "transferred"; + readonly changes: { /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly auto_merge: { - /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; - /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + readonly new_issue: { + /** @enum {string|null} */ + readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly enabled_by: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -55350,299 +48358,7 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - /** - * @description The merge method to use. - * @enum {string} - */ - readonly merge_method: "merge" | "squash" | "rebase"; - } | null; - readonly base: { - readonly label: string; - readonly ref: string; - /** - * Repository - * @description A git repository - */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; - /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: 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; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - }; - readonly sha: string; - /** User */ - readonly user: { + readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -55677,202 +48393,139 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; - } | null; - }; - readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; - /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; - /** Format: uri */ - readonly commits_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; - /** Format: uri */ - readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + } | null)[]; /** - * Repository - * @description A git repository + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: 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?: { + /** @description 6-character hex code, without the leading #, identifying the color */ + readonly color: string; + readonly default: boolean; readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; + readonly id: number; + /** @description The name of the label. */ + readonly name: string; + readonly node_id: string; /** - * @description Whether discussions are enabled. - * @default false + * Format: uri + * @description URL for the label */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; + readonly url: string; + }[]; + /** 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"; + /** Format: uri */ + readonly url?: string; + } | null; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + readonly labels_url: string; + readonly node_id: string; + /** @description The number of the milestone. */ + readonly number: number; + readonly open_issues: number; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @description The state of the milestone. * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + readonly state: "open" | "closed"; + /** @description The title of the milestone. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; + 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?: ("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 mirror_url: string | null; - /** @description The name of the repository. */ + 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; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; /** User */ readonly owner: { /** Format: uri */ @@ -55910,77 +48563,129 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; + /** @description The set of permissions for the GitHub app */ readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + /** @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"; + /** @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 Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; + /** @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 subscription_url: string; + readonly diff_url?: string; /** Format: uri */ - readonly svn_url: string; + readonly html_url?: string; + /** Format: date-time */ + readonly merged_at?: string | null; /** Format: uri */ - readonly tags_url: string; + readonly patch_url?: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; + readonly url?: string; + }; + /** 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; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; }; - readonly sha: string; + /** 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 */ @@ -56019,37 +48724,302 @@ export type components = { readonly url?: string; } | null; }; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - /** Format: uri */ - readonly issue_url: string; - readonly labels: { - /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; + /** + * Repository + * @description A git repository + */ + readonly new_repository: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + readonly custom_properties?: { + readonly [key: string]: unknown; + }; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ readonly id: number; - /** @description The name of the label. */ + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** - * Format: uri - * @description URL for the label - */ + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: 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; + } | null; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ readonly url: string; - }[]; - readonly locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ - readonly merged_at: string | null; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly issue: components["schemas"]["webhooks_issue_2"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues unassigned event */ + readonly "webhook-issues-unassigned": { + /** + * @description The action that was performed. + * @enum {string} + */ + readonly action: "unassigned"; + readonly assignee?: components["schemas"]["webhooks_user_mannequin"]; + 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-webhooks"]; + }; + /** issues unlabeled event */ + readonly "webhook-issues-unlabeled": { + /** @enum {string} */ + readonly action: "unlabeled"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly issue: components["schemas"]["webhooks_issue"]; + 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-webhooks"]; + }; + /** issues unlocked event */ + readonly "webhook-issues-unlocked": { + /** @enum {string} */ + readonly action: "unlocked"; + 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 merged_by?: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -56085,6 +49055,83 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; + readonly assignees: ({ + /** 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?: ({ + /** @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; + /** @enum {boolean} */ + readonly locked: false; /** * Milestone * @description A collection of related issues and pull requests. @@ -56128,7 +49175,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; } | null; @@ -56157,12 +49204,188 @@ export type components = { readonly url: string; } | null; readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ 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?: ("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 */ + 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; + } | 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"; + /** @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; + }; + /** 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 patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: (({ + 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; @@ -56194,387 +49417,567 @@ 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; - } | null) | { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ + } | null; + }; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues unpinned event */ + readonly "webhook-issues-unpinned": { + /** @enum {string} */ + readonly action: "unpinned"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly issue: components["schemas"]["webhooks_issue_2"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** label created event */ + readonly "webhook-label-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + 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-webhooks"]; + }; + /** label deleted event */ + readonly "webhook-label-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + 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-webhooks"]; + }; + /** label edited event */ + readonly "webhook-label-edited": { + /** @enum {string} */ + readonly action: "edited"; + /** @description The changes to the label if the action was `edited`. */ + readonly changes?: { + readonly color?: { + /** @description The previous version of the color if the action was `edited`. */ + readonly from: string; + }; + readonly description?: { + /** @description The previous version of the description if the action was `edited`. */ + readonly from: string; + }; + readonly name?: { + /** @description The previous version of the name if the action was `edited`. */ + readonly from: string; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + 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-webhooks"]; + }; + /** marketplace_purchase cancelled event */ + readonly "webhook-marketplace-purchase-cancelled": { + /** @enum {string} */ + readonly action: "cancelled"; + readonly effective_date: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase changed event */ + readonly "webhook-marketplace-purchase-changed": { + /** @enum {string} */ + readonly action: "changed"; + readonly effective_date: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** Marketplace Purchase */ + readonly previous_marketplace_purchase?: { + readonly account: { readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ + readonly login: string; + readonly node_id: string; + readonly organization_billing_email: string | null; + readonly type: string; + }; + readonly billing_cycle: string; + readonly free_trial_ends_on: string | null; + readonly next_billing_date?: string | null; + readonly on_free_trial: boolean | null; + readonly plan: { + readonly bullets: string[]; + readonly description: string; + readonly has_free_trial: boolean; + readonly id: number; + readonly monthly_price_in_cents: number; readonly name: string; + /** @enum {string} */ + readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + readonly unit_name: string | null; + readonly yearly_price_in_cents: number; + }; + readonly unit_count: number; + }; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase pending_change event */ + readonly "webhook-marketplace-purchase-pending-change": { + /** @enum {string} */ + readonly action: "pending_change"; + readonly effective_date: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** Marketplace Purchase */ + readonly previous_marketplace_purchase?: { + readonly account: { + readonly id: number; + readonly login: string; readonly node_id: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly organization_billing_email: string | null; + readonly type: string; + }; + readonly billing_cycle: string; + readonly free_trial_ends_on: string | null; + readonly next_billing_date?: string | null; + readonly on_free_trial: boolean; + readonly plan: { + readonly bullets: string[]; + readonly description: string; + readonly has_free_trial: boolean; + readonly id: number; + readonly monthly_price_in_cents: number; + readonly name: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - })[]; - readonly requested_teams: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ + readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + readonly unit_name: string | null; + readonly yearly_price_in_cents: number; + }; + readonly unit_count: number; + }; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase pending_change_cancelled event */ + readonly "webhook-marketplace-purchase-pending-change-cancelled": { + /** @enum {string} */ + readonly action: "pending_change_cancelled"; + readonly effective_date: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + /** Marketplace Purchase */ + readonly marketplace_purchase: { + readonly account: { readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ + readonly login: string; + readonly node_id: string; + readonly organization_billing_email: string | null; + readonly type: string; + }; + readonly billing_cycle: string; + readonly free_trial_ends_on: unknown; + readonly next_billing_date: string | null; + readonly on_free_trial: boolean; + readonly plan: { + readonly bullets: string[]; + readonly description: string; + readonly has_free_trial: boolean; + readonly id: number; + readonly monthly_price_in_cents: number; readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }[]; + readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + readonly unit_name: string | null; + readonly yearly_price_in_cents: number; + }; + readonly unit_count: number; + }; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase purchased event */ + readonly "webhook-marketplace-purchase-purchased": { + /** @enum {string} */ + readonly action: "purchased"; + readonly effective_date: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member added event */ + readonly "webhook-member-added": { + /** @enum {string} */ + readonly action: "added"; + readonly changes?: { + /** @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. */ + readonly permission?: { + /** @enum {string} */ + readonly to: "write" | "admin" | "read"; + }; + /** @description The role assigned to the collaborator. */ + readonly role_name?: { + readonly to: string; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly member: components["schemas"]["webhooks_user"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member edited event */ + readonly "webhook-member-edited": { + /** @enum {string} */ + readonly action: "edited"; + /** @description The changes to the collaborator permissions */ + readonly changes: { + readonly old_permission?: { + /** @description The previous permissions of the collaborator if the action was edited. */ + readonly from: string; + }; + readonly permission?: { + readonly from?: string | null; + readonly to?: string | null; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly member: components["schemas"]["webhooks_user"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member removed event */ + readonly "webhook-member-removed": { + /** @enum {string} */ + readonly action: "removed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly member: components["schemas"]["webhooks_user"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** membership added event */ + readonly "webhook-membership-added": { + /** @enum {string} */ + readonly action: "added"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly member: components["schemas"]["webhooks_user"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + /** + * @description The scope of the membership. Currently, can only be `team`. + * @enum {string} + */ + readonly scope: "team"; + /** User */ + readonly sender: { + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + readonly events_url?: string; /** Format: uri */ - readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - readonly state: "open" | "closed"; + 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 statuses_url: string; - /** @description The title of the pull request. */ - readonly title: string; - /** Format: date-time */ - readonly updated_at: string; + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - 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; - 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; + 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 team: components["schemas"]["webhooks_team"]; + }; + /** membership removed event */ + readonly "webhook-membership-removed": { + /** @enum {string} */ + readonly action: "removed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly member: components["schemas"]["webhooks_user"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + /** + * @description The scope of the membership. Currently, can only be `team`. + * @enum {string} + */ + readonly scope: "team" | "organization"; + /** User */ + readonly sender: { + /** 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 team: components["schemas"]["webhooks_team"]; + }; + readonly "webhook-merge-group-checks-requested": { + /** @enum {string} */ + readonly action: "checks_requested"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly merge_group: components["schemas"]["merge-group"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + readonly "webhook-merge-group-destroyed": { + /** @enum {string} */ + readonly action: "destroyed"; + /** + * @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated). + * @enum {string} + */ + readonly reason?: "merged" | "invalidated" | "dequeued"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly merge_group: components["schemas"]["merge-group"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** meta deleted event */ + readonly "webhook-meta-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ + readonly hook: { + readonly active: boolean; + readonly config: { /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly content_type: "json" | "form"; + readonly insecure_ssl: string; + readonly secret?: string; /** Format: uri */ - readonly url?: string; - } | null; + readonly url: string; + }; + readonly created_at: string; + readonly events: ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[]; + readonly id: number; + readonly name: string; + readonly type: string; + readonly updated_at: string; }; - readonly reason?: string; + /** @description The id of the modified webhook. */ + readonly hook_id: number; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["nullable-repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** milestone closed event */ + readonly "webhook-milestone-closed": { + /** @enum {string} */ + readonly action: "closed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + 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-webhooks"]; }; - /** pull_request closed event */ - readonly "webhook-pull-request-closed": { + /** milestone created event */ + readonly "webhook-milestone-created": { /** @enum {string} */ - readonly action: "closed"; + readonly action: "created"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; + readonly milestone: components["schemas"]["webhooks_milestone_3"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - readonly allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - }; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request converted_to_draft event */ - readonly "webhook-pull-request-converted-to-draft": { + /** milestone deleted event */ + readonly "webhook-milestone-deleted": { /** @enum {string} */ - readonly action: "converted_to_draft"; + readonly action: "deleted"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; + readonly milestone: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - readonly allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** milestone edited event */ + readonly "webhook-milestone-edited": { + /** @enum {string} */ + readonly action: "edited"; + /** @description The changes to the milestone if the action was `edited`. */ + readonly changes: { + readonly description?: { + /** @description The previous version of the description if the action was `edited`. */ + readonly from: string; + }; + readonly due_on?: { + /** @description The previous version of the due date if the action was `edited`. */ + readonly from: string; + }; + readonly title?: { + /** @description The previous version of the title if the action was `edited`. */ + readonly from: string; + }; }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + 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-webhooks"]; + }; + /** milestone opened event */ + readonly "webhook-milestone-opened": { + /** @enum {string} */ + readonly action: "opened"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly milestone: components["schemas"]["webhooks_milestone_3"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request demilestoned event */ - readonly "webhook-pull-request-demilestoned": { + /** org_block blocked event */ + readonly "webhook-org-block-blocked": { + /** @enum {string} */ + readonly action: "blocked"; + readonly blocked_user: components["schemas"]["webhooks_user"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** org_block unblocked event */ + readonly "webhook-org-block-unblocked": { /** @enum {string} */ - readonly action: "demilestoned"; + readonly action: "unblocked"; + readonly blocked_user: components["schemas"]["webhooks_user"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly milestone?: components["schemas"]["milestone"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - readonly pull_request: { - readonly _links: { - /** Link */ - readonly comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly commits: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly issue: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comment: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly statuses: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization deleted event */ + readonly "webhook-organization-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly membership?: components["schemas"]["webhooks_membership"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization member_added event */ + readonly "webhook-organization-member-added": { + /** @enum {string} */ + readonly action: "member_added"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly membership: components["schemas"]["webhooks_membership"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization member_invited event */ + readonly "webhook-organization-member-invited": { + /** @enum {string} */ + readonly action: "member_invited"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + /** @description The invitation for the user or email if the action is `member_invited`. */ + readonly invitation: { + /** Format: date-time */ + readonly created_at: string; + readonly email: string | null; + /** Format: date-time */ + readonly failed_at: string | null; + readonly failed_reason: string | null; + readonly id: number; + /** Format: uri */ + readonly invitation_teams_url: string; /** 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; - } | null; - readonly assignees: ({ + readonly inviter: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -56606,355 +50009,125 @@ 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; - } | 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"; - /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. - */ - readonly auto_merge: { - /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; - /** @description Title for the merge commit message. */ - readonly commit_title: string | null; - /** User */ - readonly enabled_by: { - /** 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; - /** - * @description The merge method to use. - * @enum {string} - */ - readonly merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; - /** - * Repository - * @description A git repository - */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; - /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: 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; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - }; - readonly sha: string; + readonly login: string | null; + readonly node_id: string; + readonly role: string; + readonly team_count: number; + readonly invitation_source?: string; + }; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly user?: components["schemas"]["webhooks_user"]; + }; + /** organization member_removed event */ + readonly "webhook-organization-member-removed": { + /** @enum {string} */ + readonly action: "member_removed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly membership: components["schemas"]["webhooks_membership"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization renamed event */ + readonly "webhook-organization-renamed": { + /** @enum {string} */ + readonly action: "renamed"; + readonly changes?: { + readonly login?: { + readonly from?: string; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly membership?: components["schemas"]["webhooks_membership"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Ruby Gems metadata */ + readonly "webhook-rubygems-metadata": { + readonly name?: string; + readonly description?: string; + readonly readme?: string; + readonly homepage?: string; + readonly version_info?: { + readonly version?: string; + }; + readonly platform?: string; + readonly metadata?: { + readonly [key: string]: string | undefined; + }; + readonly repo?: string; + readonly dependencies?: { + readonly [key: string]: string | undefined; + }[]; + readonly commit_oid?: string; + }; + /** package published event */ + readonly "webhook-package-published": { + /** @enum {string} */ + readonly action: "published"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description Information about the package. */ + readonly package: { + readonly created_at: string | null; + readonly description: string | null; + readonly ecosystem: string; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly name: string; + readonly namespace: 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; + } | null; + readonly package_type: string; + readonly package_version: { /** User */ - readonly user: { + readonly author?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -56990,203 +50163,99 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - }; - readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; - /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; - /** Format: uri */ - readonly commits_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; - /** Format: uri */ - readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; - /** - * Repository - * @description A git repository - */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; + readonly body?: string | Record; + readonly body_html?: string; + readonly container_metadata?: { + readonly labels?: Record; + readonly manifest?: Record; + readonly tag?: { + readonly digest?: string; + readonly name?: string; + }; + } | null; + readonly created_at?: string; + readonly description: string; + readonly docker_metadata?: { + readonly tags?: string[]; + }[]; + readonly draft?: boolean; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly installation_command: string; + readonly manifest?: string; + readonly metadata: { + readonly [key: string]: unknown; + }[]; + readonly name: string; + readonly npm_metadata?: { + readonly name?: string; + readonly version?: string; + readonly npm_user?: string; + readonly author?: Record; + readonly bugs?: Record; + readonly dependencies?: Record; + readonly dev_dependencies?: Record; + readonly peer_dependencies?: Record; + readonly optional_dependencies?: Record; + readonly description?: string; + readonly dist?: Record; + readonly git_head?: string; + readonly homepage?: string; + readonly license?: string; + readonly main?: string; + readonly repository?: Record; + readonly scripts?: Record; + readonly id?: string; + readonly node_version?: string; + readonly npm_version?: string; + readonly has_shrinkwrap?: boolean; + readonly maintainers?: Record[]; + readonly contributors?: Record[]; + readonly engines?: Record; + readonly keywords?: string[]; + readonly files?: string[]; + readonly bin?: Record; + readonly man?: Record; + readonly directories?: Record; + readonly os?: string[]; + readonly cpu?: string[]; + readonly readme?: string; + readonly installation_command?: string; + readonly release_id?: number; + readonly commit_oid?: string; + readonly published_via_actions?: boolean; + readonly deleted_by_id?: number; + } | null; + readonly nuget_metadata?: { + readonly id?: number | string; + readonly name?: string; + readonly value?: boolean | string | number | { + readonly url?: string; + readonly branch?: string; + readonly commit?: string; + readonly type?: string; + }; + }[] | null; + readonly package_files: { + readonly content_type: string; + readonly created_at: string; /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ + readonly download_url: string; readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; - /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ + readonly md5: string | null; readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + readonly sha1: string | null; + readonly sha256: string | null; + readonly size: number; + readonly state: string | null; + readonly updated_at: string; + }[]; + readonly package_url?: string; + readonly prerelease?: boolean; + readonly release?: { /** User */ - readonly owner: { + readonly author: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -57222,146 +50291,61 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; + readonly created_at: string; + readonly draft: boolean; /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; + readonly html_url: string; + readonly id: number; + readonly name: string | null; + readonly prerelease: boolean; + readonly published_at: string; + readonly tag_name: string; + readonly target_commitish: string; /** Format: uri */ readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; }; - readonly sha: 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; - 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 rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + readonly source_url?: string; + readonly summary: string; + readonly tag_name?: string; + readonly target_commitish?: string; + readonly target_oid?: string; + readonly updated_at?: string; + readonly version: string; + } | null; + readonly registry: { + /** Format: uri */ + readonly about_url: string; + readonly name: string; + readonly type: string; + /** Format: uri */ + readonly url: string; + readonly vendor: string; + } | null; + readonly updated_at: string | null; + }; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** package updated event */ + readonly "webhook-package-updated": { + /** @enum {string} */ + readonly action: "updated"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description Information about the package. */ + readonly package: { + readonly created_at: string; + readonly description: string | null; + readonly ecosystem: string; /** Format: uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ - readonly issue_url: string; - readonly labels: { - /** @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 locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ - readonly merged_at: string | null; + readonly name: string; + readonly namespace: string; /** User */ - readonly merged_by?: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -57393,22 +50377,14 @@ 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; } | null; - /** - * 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; + readonly package_type: string; + readonly package_version: { /** User */ - readonly creator: { + readonly author: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -57440,41 +50416,130 @@ 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; } | null; - readonly description: string | null; - /** Format: date-time */ - readonly due_on: string | null; + readonly body: string; + readonly body_html: string; + readonly created_at: string; + readonly description: string; + readonly docker_metadata?: { + readonly tags?: string[]; + }[]; + readonly draft?: boolean; /** Format: uri */ readonly html_url: string; readonly id: number; + readonly installation_command: string; + readonly manifest?: string; + readonly metadata: { + readonly [key: string]: unknown; + }[]; + readonly name: string; + readonly package_files: { + readonly content_type: string; + readonly created_at: string; + /** Format: uri */ + readonly download_url: string; + readonly id: number; + readonly md5: string | null; + readonly name: string; + readonly sha1: string | null; + readonly sha256: string; + readonly size: number; + readonly state: string; + readonly updated_at: string; + }[]; + readonly package_url?: string; + readonly prerelease?: boolean; + readonly release?: { + /** User */ + readonly author: { + /** 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 created_at: string; + readonly draft: boolean; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly name: string; + readonly prerelease: boolean; + readonly published_at: string; + readonly tag_name: string; + readonly target_commitish: string; + /** Format: uri */ + readonly url: string; + }; + readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; /** 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 source_url?: string; + readonly summary: string; + readonly tag_name?: string; + readonly target_commitish: string; + readonly target_oid: string; readonly updated_at: string; + readonly version: string; + }; + readonly registry: { + /** Format: uri */ + readonly about_url: string; + readonly name: string; + readonly type: string; /** Format: uri */ readonly url: string; + readonly vendor: string; } | null; - readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; - /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: (({ + readonly updated_at: string; + }; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** page_build event */ + readonly "webhook-page-build": { + /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ + readonly build: { + readonly commit: string | null; + readonly created_at: string; + readonly duration: number; + readonly error: { + readonly message: string | null; + }; + /** User */ + readonly pusher: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -57509,128 +50574,246 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; - } | null) | { + } | null; + readonly status: string; + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly id: number; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** personal_access_token_request approved event */ + readonly "webhook-personal-access-token-request-approved": { + /** @enum {string} */ + readonly action: "approved"; + readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly installation: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request cancelled event */ + readonly "webhook-personal-access-token-request-cancelled": { + /** @enum {string} */ + readonly action: "cancelled"; + readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly installation: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request created event */ + readonly "webhook-personal-access-token-request-created": { + /** @enum {string} */ + readonly action: "created"; + readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly installation: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request denied event */ + readonly "webhook-personal-access-token-request-denied": { + /** @enum {string} */ + readonly action: "denied"; + readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly installation: components["schemas"]["simple-installation"]; + }; + readonly "webhook-ping": { + /** + * Webhook + * @description The webhook that is being pinged + */ + readonly hook?: { + /** @description Determines whether the hook is actually triggered for the events it subscribes to. */ + readonly active: boolean; + /** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */ + readonly app_id?: number; + readonly config: { + readonly content_type?: components["schemas"]["webhook-config-content-type"]; + readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + readonly secret?: components["schemas"]["webhook-config-secret"]; + readonly url?: components["schemas"]["webhook-config-url"]; + }; + /** Format: date-time */ + readonly created_at: string; + /** Format: uri */ + readonly deliveries_url?: string; + /** @description Determines what events the hook is triggered for. Default: ['push']. */ + readonly events: string[]; + /** @description Unique identifier of the webhook. */ + readonly id: number; + readonly last_response?: components["schemas"]["hook-response"]; + /** + * @description The type of webhook. The only valid value is 'web'. + * @enum {string} + */ + readonly name: "web"; + /** Format: uri */ + readonly ping_url?: string; + /** Format: uri */ + readonly test_url?: string; + readonly type: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url?: string; + }; + /** @description The ID of the webhook that triggered the ping. */ + readonly hook_id?: number; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + /** @description Random string of GitHub zen. */ + readonly zen?: string; + }; + /** @description The webhooks ping payload encoded with URL encoding. */ + readonly "webhook-ping-form-encoded": { + /** @description A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. */ + readonly payload: string; + }; + /** project_card converted event */ + readonly "webhook-project-card-converted": { + /** @enum {string} */ + readonly action: "converted"; + readonly changes: { + readonly note: { + readonly from: string; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_card: components["schemas"]["webhooks_project_card"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card created event */ + readonly "webhook-project-card-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_card: components["schemas"]["webhooks_project_card"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card deleted event */ + readonly "webhook-project-card-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** Project Card */ + readonly project_card: { + readonly after_id?: number | null; + /** @description Whether or not the card is archived */ + readonly archived: boolean; + readonly column_id: number | null; + /** Format: uri */ + readonly column_url: string; + /** Format: uri */ + readonly content_url?: string; + /** Format: date-time */ + readonly created_at: string; + /** User */ + readonly creator: { + /** Format: uri */ + readonly avatar_url?: string; readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; + 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; - /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; + readonly login: string; + readonly name?: string; readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - })[]; - readonly requested_teams: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; + readonly organizations_url?: string; /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ readonly url?: string; - }[]; - /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; - /** Format: uri */ - readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - readonly state: "open" | "closed"; + } | null; + /** @description The project card's ID */ + readonly id: number; + readonly node_id: string; + readonly note: string | null; /** Format: uri */ - readonly statuses_url: string; - /** @description The title of the pull request. */ - readonly title: string; + readonly project_url: string; /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; + }; + readonly repository?: components["schemas"]["nullable-repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card edited event */ + readonly "webhook-project-card-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes: { + readonly note: { + readonly from: string | null; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_card: components["schemas"]["webhooks_project_card"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card moved event */ + readonly "webhook-project-card-moved": { + /** @enum {string} */ + readonly action: "moved"; + readonly changes?: { + readonly column_id: { + readonly from: number; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_card: { + readonly after_id?: number | null; + /** @description Whether or not the card is archived */ + readonly archived: boolean; + readonly column_id: number; + /** Format: uri */ + readonly column_url: string; + /** Format: uri */ + readonly content_url?: string; + /** Format: date-time */ + readonly created_at: string; /** User */ - readonly user: { + readonly creator: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -57666,17 +50849,334 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; + /** @description The project card's ID */ + readonly id: number; + readonly node_id: string; + readonly note: string | null; + /** Format: uri */ + readonly project_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + } & { + readonly after_id: number | null; + readonly archived?: boolean; + readonly column_id?: number; + readonly column_url?: string; + readonly created_at?: string; + readonly creator?: { + 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; + 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; + } | null; + readonly id?: number; + readonly node_id?: string; + readonly note?: string | null; + readonly project_url?: string; + readonly updated_at?: string; + readonly url?: string; }; - readonly repository: components["schemas"]["repository-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project closed event */ + readonly "webhook-project-closed": { + /** @enum {string} */ + readonly action: "closed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project: components["schemas"]["webhooks_project"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_column created event */ + readonly "webhook-project-column-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_column: components["schemas"]["webhooks_project_column"]; + readonly repository?: components["schemas"]["repository-webhooks"]; readonly sender?: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request dequeued event */ - readonly "webhook-pull-request-dequeued": { + /** project_column deleted event */ + readonly "webhook-project-column-deleted": { /** @enum {string} */ - readonly action: "dequeued"; + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_column: components["schemas"]["webhooks_project_column"]; + readonly repository?: components["schemas"]["nullable-repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project_column edited event */ + readonly "webhook-project-column-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes: { + readonly name?: { + readonly from: string; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_column: components["schemas"]["webhooks_project_column"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project_column moved event */ + readonly "webhook-project-column-moved": { + /** @enum {string} */ + readonly action: "moved"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_column: components["schemas"]["webhooks_project_column"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project created event */ + readonly "webhook-project-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project: components["schemas"]["webhooks_project"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project deleted event */ + readonly "webhook-project-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project: components["schemas"]["webhooks_project"]; + readonly repository?: components["schemas"]["nullable-repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project edited event */ + readonly "webhook-project-edited": { + /** @enum {string} */ + readonly action: "edited"; + /** @description The changes to the project if the action was `edited`. */ + readonly changes?: { + readonly body?: { + /** @description The previous version of the body if the action was `edited`. */ + readonly from: string; + }; + readonly name?: { + /** @description The changes to the project if the action was `edited`. */ + readonly from: string; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project: components["schemas"]["webhooks_project"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project reopened event */ + readonly "webhook-project-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project: components["schemas"]["webhooks_project"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Closed Event */ + readonly "webhook-projects-v2-project-closed": { + /** @enum {string} */ + readonly action: "closed"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2: components["schemas"]["projects-v2"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** @description A project was created */ + readonly "webhook-projects-v2-project-created": { + /** @enum {string} */ + readonly action: "created"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2: components["schemas"]["projects-v2"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Deleted Event */ + readonly "webhook-projects-v2-project-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2: components["schemas"]["projects-v2"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Edited Event */ + readonly "webhook-projects-v2-project-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes: { + readonly description?: { + readonly from?: string | null; + readonly to?: string | null; + }; + readonly public?: { + readonly from?: boolean; + readonly to?: boolean; + }; + readonly short_description?: { + readonly from?: string | null; + readonly to?: string | null; + }; + readonly title?: { + readonly from?: string; + readonly to?: string; + }; + }; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2: components["schemas"]["projects-v2"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Archived Event */ + readonly "webhook-projects-v2-item-archived": { + /** @enum {string} */ + readonly action: "archived"; + readonly changes: components["schemas"]["webhooks_project_changes"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_item: components["schemas"]["projects-v2-item"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Converted Event */ + readonly "webhook-projects-v2-item-converted": { + /** @enum {string} */ + readonly action: "converted"; + readonly changes: { + readonly content_type?: { + readonly from?: string | null; + readonly to?: string; + }; + }; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_item: components["schemas"]["projects-v2-item"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Created Event */ + readonly "webhook-projects-v2-item-created": { + /** @enum {string} */ + readonly action: "created"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_item: components["schemas"]["projects-v2-item"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Deleted Event */ + readonly "webhook-projects-v2-item-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_item: components["schemas"]["projects-v2-item"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Edited Event */ + readonly "webhook-projects-v2-item-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes?: { + readonly field_value: { + readonly field_node_id?: string; + readonly field_type?: string; + }; + } | { + readonly body: { + readonly from?: string | null; + readonly to?: string | null; + }; + }; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_item: components["schemas"]["projects-v2-item"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Reordered Event */ + readonly "webhook-projects-v2-item-reordered": { + /** @enum {string} */ + readonly action: "reordered"; + readonly changes: { + readonly previous_projects_v2_item_node_id?: { + readonly from?: string | null; + readonly to?: string | null; + }; + }; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_item: components["schemas"]["projects-v2-item"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Restored Event */ + readonly "webhook-projects-v2-item-restored": { + /** @enum {string} */ + readonly action: "restored"; + readonly changes: components["schemas"]["webhooks_project_changes"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_item: components["schemas"]["projects-v2-item"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Reopened Event */ + readonly "webhook-projects-v2-project-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2: components["schemas"]["projects-v2"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** public event */ + readonly "webhook-public": { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly number: number; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request assigned event */ + readonly "webhook-pull-request-assigned": { + /** @enum {string} */ + readonly action: "assigned"; + readonly assignee: components["schemas"]["webhooks_user"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ readonly pull_request: { @@ -57758,7 +51258,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; @@ -57794,7 +51294,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)[]; @@ -58197,7 +51697,7 @@ export type components = { /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string; + readonly label: string | null; readonly ref: string; /** * Repository @@ -58479,7 +51979,7 @@ export type components = { readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - }; + } | null; readonly sha: string; /** User */ readonly user: { @@ -58694,22 +52194,22 @@ 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) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -58736,17 +52236,17 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -58855,94 +52355,13 @@ export type components = { readonly url?: string; } | null; }; - readonly reason: string; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request edited event */ - readonly "webhook-pull-request-edited": { - /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the comment if the action was `edited`. */ - readonly changes: { - readonly base?: { - readonly ref: { - readonly from: string; - }; - readonly sha: { - readonly from: string; - }; - }; - readonly body?: { - /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; - }; - readonly title?: { - /** @description The previous version of the title if the action was `edited`. */ - readonly from: string; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - readonly allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request enqueued event */ - readonly "webhook-pull-request-enqueued": { + /** pull_request auto_merge_disabled event */ + readonly "webhook-pull-request-auto-merge-disabled": { /** @enum {string} */ - readonly action: "enqueued"; + readonly action: "auto_merge_disabled"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly number: number; @@ -59224,6 +52643,11 @@ export type components = { * @default true */ readonly has_issues: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; readonly has_pages: boolean; /** * @description Whether projects are enabled. @@ -59235,11 +52659,6 @@ export type components = { * @default true */ readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; readonly homepage: string | null; /** Format: uri */ readonly hooks_url: string; @@ -59897,7 +53316,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; } | null; @@ -59963,22 +53382,22 @@ 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) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -60005,17 +53424,17 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -60124,32 +53543,16 @@ export type components = { readonly url?: string; } | null; }; + readonly reason: string; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request labeled event */ - readonly "webhook-pull-request-labeled": { + /** pull_request auto_merge_enabled event */ + readonly "webhook-pull-request-auto-merge-enabled": { /** @enum {string} */ - readonly action: "labeled"; + readonly action: "auto_merge_enabled"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** Label */ - readonly label?: { - /** @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; - }; - /** @description The pull request number. */ readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ @@ -60232,7 +53635,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; } | null; @@ -60268,7 +53671,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; } | null)[]; @@ -60671,7 +54074,7 @@ export type components = { /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string | null; + readonly label: string; readonly ref: string; /** * Repository @@ -60953,7 +54356,7 @@ export type components = { readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - } | null; + }; readonly sha: string; /** User */ readonly user: { @@ -61055,7 +54458,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; } | null; @@ -61329,16 +54732,52 @@ export type components = { readonly url?: string; } | null; }; + readonly reason?: string; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request locked event */ - readonly "webhook-pull-request-locked": { + /** pull_request closed event */ + readonly "webhook-pull-request-closed": { /** @enum {string} */ - readonly action: "locked"; + readonly action: "closed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["pull-request-webhook"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request converted_to_draft event */ + readonly "webhook-pull-request-converted-to-draft": { + /** @enum {string} */ + readonly action: "converted_to_draft"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["pull-request-webhook"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request demilestoned event */ + readonly "webhook-pull-request-demilestoned": { + /** @enum {string} */ + readonly action: "demilestoned"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly milestone?: components["schemas"]["milestone"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["webhooks_pull_request_5"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request dequeued event */ + readonly "webhook-pull-request-dequeued": { + /** @enum {string} */ + readonly action: "dequeued"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ @@ -61457,7 +54896,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; } | null)[]; @@ -61860,7 +55299,7 @@ export type components = { /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string | null; + readonly label: string; readonly ref: string; /** * Repository @@ -62142,7 +55581,7 @@ export type components = { readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - } | null; + }; readonly sha: string; /** User */ readonly user: { @@ -62244,7 +55683,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; } | null; @@ -62291,7 +55730,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; @@ -62357,22 +55796,22 @@ 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; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + readonly description?: string | null; /** Format: uri */ - readonly html_url: string; + readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url: string; + readonly members_url?: string; /** @description Name of the team */ readonly name: string; - readonly node_id: string; + readonly node_id?: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -62399,17 +55838,17 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly permission?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + readonly repositories_url?: string; + readonly slug?: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + readonly url?: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -62518,16 +55957,47 @@ export type components = { readonly url?: string; } | null; }; + readonly reason: string; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request milestoned event */ - readonly "webhook-pull-request-milestoned": { + /** pull_request edited event */ + readonly "webhook-pull-request-edited": { /** @enum {string} */ - readonly action: "milestoned"; + readonly action: "edited"; + /** @description The changes to the comment if the action was `edited`. */ + readonly changes: { + readonly base?: { + readonly ref: { + readonly from: string; + }; + readonly sha: { + readonly from: string; + }; + }; + readonly body?: { + /** @description The previous version of the body if the action was `edited`. */ + readonly from: string; + }; + readonly title?: { + /** @description The previous version of the title if the action was `edited`. */ + readonly from: string; + }; + }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly milestone?: components["schemas"]["milestone"]; - /** @description The pull request number. */ + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["pull-request-webhook"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request enqueued event */ + readonly "webhook-pull-request-enqueued": { + /** @enum {string} */ + readonly action: "enqueued"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ @@ -62610,7 +56080,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; } | null; @@ -62646,7 +56116,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; } | null)[]; @@ -62981,7 +56451,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -63321,7 +56791,7 @@ export type components = { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -63433,7 +56903,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; } | null; @@ -63549,502 +57019,177 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; - } | null) | { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - })[]; - readonly requested_teams: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }[]; - /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; - /** Format: uri */ - readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - readonly state: "open" | "closed"; - /** Format: uri */ - readonly statuses_url: string; - /** @description The title of the pull request. */ - readonly title: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - 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; - 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; - } | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request opened event */ - readonly "webhook-pull-request-opened": { - /** @enum {string} */ - readonly action: "opened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - readonly allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request ready_for_review event */ - readonly "webhook-pull-request-ready-for-review": { - /** @enum {string} */ - readonly action: "ready_for_review"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - readonly allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request reopened event */ - readonly "webhook-pull-request-reopened": { - /** @enum {string} */ - readonly action: "reopened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - readonly allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request_review_comment created event */ - readonly "webhook-pull-request-review-comment-created": { - /** @enum {string} */ - readonly action: "created"; - /** - * Pull Request Review Comment - * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. - */ - readonly comment: { - readonly _links: { - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly pull_request: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** - * 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 The text of the comment. */ - readonly body: string; - /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ - readonly html_url: string; - /** @description The ID of the pull request review comment. */ - readonly id: number; - /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; - /** @description The node ID of the pull request review comment. */ - readonly node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number | null; - /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - readonly path: string; - /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - readonly pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - readonly start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - readonly subject_type?: "line" | "file"; - /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL for the pull request review 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; - 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 deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; + })[]; + readonly requested_teams: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; + }[]; + /** Format: uri-template */ + readonly review_comment_url: string; + readonly review_comments?: number; + /** Format: uri */ + readonly review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + readonly state: "open" | "closed"; + /** Format: uri */ + readonly statuses_url: string; + /** @description The title of the pull request. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + 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; + 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; } | null; }; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request labeled event */ + readonly "webhook-pull-request-labeled": { + /** @enum {string} */ + readonly action: "labeled"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; + readonly label?: components["schemas"]["webhooks_label"]; + readonly number: components["schemas"]["webhooks_number"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -64090,6 +57235,7 @@ export type components = { }; /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; /** User */ readonly assignee: { /** Format: uri */ @@ -64173,7 +57319,7 @@ export type components = { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge?: { + readonly auto_merge: { /** @description Commit message for the merge commit. */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ @@ -64545,17 +57691,24 @@ export type components = { } | null; }; readonly body: string | null; + readonly changed_files?: number; + /** Format: date-time */ readonly closed_at: string | null; + readonly comments?: number; /** Format: uri */ readonly comments_url: string; + readonly commits?: number; /** Format: uri */ readonly commits_url: string; + /** Format: date-time */ readonly created_at: string; + readonly deletions?: number; /** Format: uri */ readonly diff_url: string; - readonly draft?: boolean; + /** @description Indicates whether or not the pull request is a draft. */ + readonly draft: boolean; readonly head: { - readonly label: string; + readonly label: string | null; readonly ref: string; /** * Repository @@ -64898,8 +58051,51 @@ export type components = { readonly url: string; }[]; readonly locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ readonly merged_at: string | null; + /** User */ + readonly merged_by?: { + /** 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; + } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -64972,9 +58168,11 @@ export type components = { readonly url: string; } | null; readonly node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; + readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -65114,13 +58312,19 @@ export type components = { }[]; /** Format: uri-template */ readonly review_comment_url: string; + readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; + /** @description The title of the pull request. */ readonly title: string; + /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -65165,158 +58369,15 @@ export type components = { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review_comment deleted event */ - readonly "webhook-pull-request-review-comment-deleted": { + /** pull_request locked event */ + readonly "webhook-pull-request-locked": { /** @enum {string} */ - readonly action: "deleted"; - /** - * Pull Request Review Comment - * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. - */ - readonly comment: { - readonly _links: { - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly pull_request: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** - * 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 The text of the comment. */ - readonly body: string; - /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ - readonly html_url: string; - /** @description The ID of the pull request review comment. */ - readonly id: number; - /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; - /** @description The node ID of the pull request review comment. */ - readonly node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number; - /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - readonly path: string; - /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - readonly pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - readonly start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - readonly subject_type?: "line" | "file"; - /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL for the pull request review 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; - 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 action: "locked"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -65362,6 +58423,7 @@ export type components = { }; /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; /** User */ readonly assignee: { /** Format: uri */ @@ -65431,7 +58493,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)[]; @@ -65445,7 +58507,7 @@ export type components = { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge?: { + readonly auto_merge: { /** @description Commit message for the merge commit. */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ @@ -65817,17 +58879,24 @@ export type components = { } | null; }; readonly body: string | null; + readonly changed_files?: number; + /** Format: date-time */ readonly closed_at: string | null; + readonly comments?: number; /** Format: uri */ readonly comments_url: string; + readonly commits?: number; /** Format: uri */ readonly commits_url: string; + /** Format: date-time */ readonly created_at: string; + readonly deletions?: number; /** Format: uri */ readonly diff_url: string; - readonly draft?: boolean; + /** @description Indicates whether or not the pull request is a draft. */ + readonly draft: boolean; readonly head: { - readonly label: string; + readonly label: string | null; readonly ref: string; /** * Repository @@ -66170,8 +59239,51 @@ export type components = { readonly url: string; }[]; readonly locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ readonly merged_at: string | null; + /** User */ + readonly merged_by?: { + /** 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; + } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -66244,9 +59356,11 @@ export type components = { readonly url: string; } | null; readonly node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; + readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -66279,22 +59393,22 @@ 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) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -66321,17 +59435,17 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -66386,13 +59500,19 @@ export type components = { }[]; /** Format: uri-template */ readonly review_comment_url: string; + readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; + /** @description The title of the pull request. */ readonly title: string; + /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -66437,17 +59557,58 @@ export type components = { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review_comment edited event */ - readonly "webhook-pull-request-review-comment-edited": { + /** pull_request milestoned event */ + readonly "webhook-pull-request-milestoned": { /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the comment. */ - readonly changes: { - readonly body?: { - /** @description The previous version of the body. */ - readonly from: string; - }; - }; + readonly action: "milestoned"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly milestone?: components["schemas"]["milestone"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["webhooks_pull_request_5"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request opened event */ + readonly "webhook-pull-request-opened": { + /** @enum {string} */ + readonly action: "opened"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["pull-request-webhook"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request ready_for_review event */ + readonly "webhook-pull-request-ready-for-review": { + /** @enum {string} */ + readonly action: "ready_for_review"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["pull-request-webhook"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request reopened event */ + readonly "webhook-pull-request-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["pull-request-webhook"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request_review_comment created event */ + readonly "webhook-pull-request-review-comment-created": { + /** @enum {string} */ + readonly action: "created"; /** * Pull Request Review Comment * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -66500,7 +59661,7 @@ export type components = { /** @description The SHA of the original commit to which the comment applies. */ readonly original_commit_id: string; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number; + readonly original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ readonly original_position: number; /** @description The first line of the range for a multi-line comment. */ @@ -66674,7 +59835,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; @@ -66710,7 +59871,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)[]; @@ -67558,22 +60719,22 @@ 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) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -67600,17 +60761,17 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -67712,100 +60873,100 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request_review dismissed event */ - readonly "webhook-pull-request-review-dismissed": { - /** @enum {string} */ - readonly action: "dismissed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ - readonly pull_request: { - readonly _links: { - /** Link */ - readonly comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly commits: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly issue: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comment: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly statuses: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** @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; - } | null; + }; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request_review_comment deleted event */ + readonly "webhook-pull-request-review-comment-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly comment: components["schemas"]["webhooks_review_comment"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: { + readonly _links: { + /** Link */ + readonly comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly commits: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly html: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly issue: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comment: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly statuses: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** @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: ({ /** Format: uri */ readonly avatar_url?: string; @@ -67838,7 +60999,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; } | null)[]; @@ -67852,7 +61013,7 @@ export type components = { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + readonly auto_merge?: { /** @description Commit message for the merge commit. */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ @@ -68232,7 +61393,7 @@ export type components = { readonly created_at: string; /** Format: uri */ readonly diff_url: string; - readonly draft: boolean; + readonly draft?: boolean; readonly head: { readonly label: string; readonly ref: string; @@ -68686,22 +61847,22 @@ 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; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + readonly description?: string | null; /** Format: uri */ - readonly html_url: string; + readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url: string; + readonly members_url?: string; /** @description Name of the team */ readonly name: string; - readonly node_id: string; + readonly node_id?: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -68728,17 +61889,17 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly permission?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + readonly repositories_url?: string; + readonly slug?: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + readonly url?: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -68842,95 +62003,17 @@ export type components = { } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - /** @description The review that was affected. */ - readonly review: { - readonly _links: { - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly pull_request: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** - * 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 The text of the review. */ - readonly body: string | null; - /** @description A commit SHA for the review. */ - readonly commit_id: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the review */ - readonly id: number; - readonly node_id: string; - /** Format: uri */ - readonly pull_request_url: string; - /** @enum {string} */ - readonly state: "dismissed" | "approved" | "changes_requested"; - /** Format: date-time */ - readonly submitted_at: 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; - 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; - } | null; - }; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review edited event */ - readonly "webhook-pull-request-review-edited": { + /** pull_request_review_comment edited event */ + readonly "webhook-pull-request-review-comment-edited": { /** @enum {string} */ readonly action: "edited"; - readonly changes: { - readonly body?: { - /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; - }; - }; + readonly changes: components["schemas"]["webhooks_changes"]; + readonly comment: components["schemas"]["webhooks_review_comment"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -69009,7 +62092,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; } | null; @@ -69045,7 +62128,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; } | null)[]; @@ -69059,7 +62142,7 @@ export type components = { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + readonly auto_merge?: { /** @description Commit message for the merge commit. */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ @@ -69217,6 +62300,11 @@ export type components = { * @default true */ readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; readonly homepage: string | null; /** Format: uri */ readonly hooks_url: string; @@ -69248,6 +62336,23 @@ export type components = { readonly url: string | null; } | null; readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -69316,6 +62421,23 @@ export type components = { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -69340,10 +62462,17 @@ export type components = { readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; }; readonly sha: string; /** User */ @@ -69393,7 +62522,7 @@ export type components = { readonly created_at: string; /** Format: uri */ readonly diff_url: string; - readonly draft: boolean; + readonly draft?: boolean; readonly head: { readonly label: string; readonly ref: string; @@ -69504,6 +62633,11 @@ export type components = { * @default true */ readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; readonly homepage: string | null; /** Format: uri */ readonly hooks_url: string; @@ -69535,6 +62669,23 @@ export type components = { readonly url: string | null; } | null; readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -69603,6 +62754,23 @@ export type components = { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -69627,10 +62795,17 @@ export type components = { readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; /** User */ @@ -69801,22 +62976,22 @@ 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; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + readonly description?: string | null; /** Format: uri */ - readonly html_url: string; + readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url: string; + readonly members_url?: string; /** @description Name of the team */ readonly name: string; - readonly node_id: string; + readonly node_id?: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -69843,17 +63018,17 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly permission?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + readonly repositories_url?: string; + readonly slug?: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + readonly url?: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -69957,90 +63132,16 @@ export type components = { } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - /** @description The review that was affected. */ - readonly review: { - readonly _links: { - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly pull_request: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** - * 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 The text of the review. */ - readonly body: string | null; - /** @description A commit SHA for the review. */ - readonly commit_id: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the review */ - readonly id: number; - readonly node_id: string; - /** Format: uri */ - readonly pull_request_url: string; - readonly state: string; - /** Format: date-time */ - readonly submitted_at: string | null; - /** 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; - 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 sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request review_request_removed event */ - readonly "webhook-pull-request-review-request-removed": { + /** pull_request_review dismissed event */ + readonly "webhook-pull-request-review-dismissed": { /** @enum {string} */ - readonly action: "review_request_removed"; + readonly action: "dismissed"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ + /** Simple Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -70086,7 +63187,6 @@ export type components = { }; /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; /** User */ readonly assignee: { /** Format: uri */ @@ -70120,7 +63220,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; @@ -70156,7 +63256,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)[]; @@ -70450,12 +63550,19 @@ export type components = { readonly role_name?: string | null; readonly size: number; /** - * @description The default value for a squash merge commit message. + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a squash merge commit title. + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -70535,21 +63642,14 @@ export type components = { } | null; }; readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ readonly closed_at: string | null; - readonly comments?: number; /** Format: uri */ readonly comments_url: string; - readonly commits?: number; /** Format: uri */ readonly commits_url: string; - /** Format: date-time */ readonly created_at: string; - readonly deletions?: number; /** Format: uri */ readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { readonly label: string; @@ -70834,7 +63934,7 @@ export type components = { readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - }; + } | null; readonly sha: string; /** User */ readonly user: { @@ -70895,51 +63995,8 @@ export type components = { readonly url: string; }[]; readonly locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ readonly merged_at: string | null; - /** User */ - readonly merged_by?: { - /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -71012,11 +64069,9 @@ export type components = { readonly url: string; } | null; readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; - readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -71049,7 +64104,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) | { @@ -71102,73 +64157,67 @@ export type components = { * @description URL for the team */ readonly url: string; - })[]; - readonly requested_teams: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; + })[]; + readonly requested_teams: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; }[]; /** Format: uri-template */ readonly review_comment_url: string; - readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; - /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -71205,59 +64254,101 @@ 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; }; readonly repository: components["schemas"]["repository-webhooks"]; - /** User */ - readonly requested_reviewer: { - /** 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; + /** @description The review that was affected. */ + readonly review: { + readonly _links: { + /** Link */ + readonly html: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly pull_request: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** + * 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 The text of the review. */ + readonly body: string | null; + /** @description A commit SHA for the review. */ + readonly commit_id: string; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; + /** @description Unique identifier of the review */ 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; + readonly node_id: string; /** Format: uri */ - readonly subscriptions_url?: string; + readonly pull_request_url: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - } | null; + readonly state: "dismissed" | "approved" | "changes_requested"; + /** Format: date-time */ + readonly submitted_at: 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; + 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; + } | null; + }; readonly sender: components["schemas"]["simple-user-webhooks"]; - } | { + }; + /** pull_request_review edited event */ + readonly "webhook-pull-request-review-edited": { /** @enum {string} */ - readonly action: "review_request_removed"; + readonly action: "edited"; + readonly changes: { + readonly body?: { + /** @description The previous version of the body if the action was `edited`. */ + readonly from: string; + }; + }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ + /** Simple Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -71303,7 +64394,6 @@ export type components = { }; /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; /** User */ readonly assignee: { /** Format: uri */ @@ -71337,7 +64427,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; @@ -71373,7 +64463,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)[]; @@ -71545,11 +64635,6 @@ export type components = { * @default true */ readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; readonly homepage: string | null; /** Format: uri */ readonly hooks_url: string; @@ -71581,23 +64666,6 @@ export type components = { readonly url: string | null; } | null; readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -71666,23 +64734,6 @@ export type components = { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -71707,17 +64758,10 @@ export type components = { readonly updated_at: string; /** Format: uri */ readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; }; readonly sha: string; /** User */ @@ -71759,21 +64803,14 @@ export type components = { } | null; }; readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ readonly closed_at: string | null; - readonly comments?: number; /** Format: uri */ readonly comments_url: string; - readonly commits?: number; /** Format: uri */ readonly commits_url: string; - /** Format: date-time */ readonly created_at: string; - readonly deletions?: number; /** Format: uri */ readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { readonly label: string; @@ -71885,11 +64922,6 @@ export type components = { * @default true */ readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; readonly homepage: string | null; /** Format: uri */ readonly hooks_url: string; @@ -71921,23 +64953,6 @@ export type components = { readonly url: string | null; } | null; readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -72006,23 +65021,6 @@ export type components = { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -72047,18 +65045,11 @@ export type components = { readonly updated_at: string; /** Format: uri */ readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - }; + } | null; readonly sha: string; /** User */ readonly user: { @@ -72119,51 +65110,8 @@ export type components = { readonly url: string; }[]; readonly locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ readonly merged_at: string | null; - /** User */ - readonly merged_by?: { - /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -72207,7 +65155,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; @@ -72236,11 +65184,9 @@ export type components = { readonly url: string; } | null; readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; - readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -72273,7 +65219,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) | { @@ -72330,16 +65276,16 @@ export type components = { readonly requested_teams: { readonly deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + readonly description?: string | null; /** Format: uri */ - readonly html_url: string; + readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url: string; + readonly members_url?: string; /** @description Name of the team */ readonly name: string; - readonly node_id: string; + readonly node_id?: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -72366,33 +65312,27 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly permission?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + readonly repositories_url?: string; + readonly slug?: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + readonly url?: string; }[]; /** Format: uri-template */ readonly review_comment_url: string; - readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; - /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -72429,73 +65369,19 @@ 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; }; readonly repository: components["schemas"]["repository-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly requested_team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - }; + readonly review: components["schemas"]["webhooks_review"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request review_requested event */ - readonly "webhook-pull-request-review-requested": { + /** pull_request review_request_removed event */ + readonly "webhook-pull-request-review-request-removed": { /** @enum {string} */ - readonly action: "review_requested"; + readonly action: "review_request_removed"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ @@ -72581,7 +65467,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; } | null; @@ -72617,7 +65503,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; } | null)[]; @@ -72911,19 +65797,12 @@ export type components = { readonly role_name?: string | null; readonly size: number; /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * @description The default value for a squash merge commit message. * @enum {string} */ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @description The default value for a squash merge commit title. * @enum {string} */ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -73451,7 +66330,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; } | null; @@ -73574,16 +66453,16 @@ export type components = { readonly requested_teams: { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -73610,17 +66489,17 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; }[]; /** Format: uri-template */ readonly review_comment_url: string; @@ -73673,7 +66552,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; } | null; @@ -73712,14 +66591,14 @@ 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; } | null; readonly sender: components["schemas"]["simple-user-webhooks"]; } | { /** @enum {string} */ - readonly action: "review_requested"; + readonly action: "review_request_removed"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ @@ -73805,7 +66684,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; } | null; @@ -73841,7 +66720,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; } | null)[]; @@ -74675,7 +67554,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; } | null; @@ -74747,16 +67626,16 @@ export type components = { } | null) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -74783,31 +67662,31 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; })[]; readonly requested_teams: { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -74834,17 +67713,17 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; }[]; /** Format: uri-template */ readonly review_comment_url: string; @@ -74897,7 +67776,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; } | null; @@ -74910,16 +67789,16 @@ export type components = { readonly requested_team: { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -74946,28 +67825,30 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; }; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review submitted event */ - readonly "webhook-pull-request-review-submitted": { + /** pull_request review_requested event */ + readonly "webhook-pull-request-review-requested": { /** @enum {string} */ - readonly action: "submitted"; + readonly action: "review_requested"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; + /** @description The pull request number. */ + readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ + /** Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -75013,6 +67894,7 @@ export type components = { }; /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; /** User */ readonly assignee: { /** Format: uri */ @@ -75468,17 +68350,24 @@ export type components = { } | null; }; readonly body: string | null; + readonly changed_files?: number; + /** Format: date-time */ readonly closed_at: string | null; + readonly comments?: number; /** Format: uri */ readonly comments_url: string; + readonly commits?: number; /** Format: uri */ readonly commits_url: string; + /** Format: date-time */ readonly created_at: string; + readonly deletions?: number; /** Format: uri */ readonly diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string | null; + readonly label: string; readonly ref: string; /** * Repository @@ -75760,7 +68649,7 @@ export type components = { readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - } | null; + }; readonly sha: string; /** User */ readonly user: { @@ -75821,8 +68710,51 @@ export type components = { readonly url: string; }[]; readonly locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ readonly merged_at: string | null; + /** User */ + readonly merged_by?: { + /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -75895,9 +68827,11 @@ export type components = { readonly url: string; } | null; readonly node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; + readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -75930,7 +68864,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; } | null) | { @@ -76037,13 +68971,19 @@ export type components = { }[]; /** Format: uri-template */ readonly review_comment_url: string; + readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; + /** @description The title of the pull request. */ readonly title: string; + /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -76086,88 +69026,53 @@ export type components = { } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - /** @description The review that was affected. */ - readonly review: { - readonly _links: { - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly pull_request: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** - * 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 The text of the review. */ - readonly body: string | null; - /** @description A commit SHA for the review. */ - readonly commit_id: string; + /** User */ + readonly requested_reviewer: { /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the review */ + 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 node_id: string; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly pull_request_url: string; - readonly state: string; - /** Format: date-time */ - readonly submitted_at: string | null; - /** 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; - 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 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; + } | null; readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request_review_thread resolved event */ - readonly "webhook-pull-request-review-thread-resolved": { + } | { /** @enum {string} */ - readonly action: "resolved"; + readonly action: "review_requested"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; + /** @description The pull request number. */ + readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ + /** Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -76213,6 +69118,7 @@ export type components = { }; /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; /** User */ readonly assignee: { /** Format: uri */ @@ -76246,7 +69152,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; @@ -76282,7 +69188,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)[]; @@ -76490,6 +69396,23 @@ export type components = { readonly url: string | null; } | null; readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -76558,6 +69481,23 @@ export type components = { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -76582,6 +69522,11 @@ export type components = { readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; @@ -76629,17 +69574,24 @@ export type components = { } | null; }; readonly body: string | null; + readonly changed_files?: number; + /** Format: date-time */ readonly closed_at: string | null; + readonly comments?: number; /** Format: uri */ readonly comments_url: string; + readonly commits?: number; /** Format: uri */ readonly commits_url: string; + /** Format: date-time */ readonly created_at: string; + readonly deletions?: number; /** Format: uri */ readonly diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string | null; + readonly label: string; readonly ref: string; /** * Repository @@ -76784,6 +69736,23 @@ export type components = { readonly url: string | null; } | null; readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -76852,6 +69821,23 @@ export type components = { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -76876,13 +69862,18 @@ export type components = { readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - } | null; + }; readonly sha: string; /** User */ readonly user: { @@ -76943,8 +69934,51 @@ export type components = { readonly url: string; }[]; readonly locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ readonly merged_at: string | null; + /** User */ + readonly merged_by?: { + /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -76988,7 +70022,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; @@ -77017,9 +70051,11 @@ export type components = { readonly url: string; } | null; readonly node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; + readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -77052,22 +70088,22 @@ 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; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + readonly description?: string | null; /** Format: uri */ - readonly html_url: string; + readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url: string; + readonly members_url?: string; /** @description Name of the team */ readonly name: string; - readonly node_id: string; + readonly node_id?: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -77094,17 +70130,17 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly permission?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + readonly repositories_url?: string; + readonly slug?: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + readonly url?: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -77159,13 +70195,19 @@ export type components = { }[]; /** Format: uri-template */ readonly review_comment_url: string; + readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; + /** @description The title of the pull request. */ readonly title: string; + /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -77208,156 +70250,67 @@ export type components = { } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - readonly thread: { - readonly comments: { - readonly _links: { - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly pull_request: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** - * 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 The text of the comment. */ - readonly body: string; - /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + readonly requested_team: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ readonly html_url: string; - /** @description The ID of the pull request review comment. */ + /** @description Unique identifier of the team */ readonly id: number; - /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; - /** @description The node ID of the pull request review comment. */ + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; readonly node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number | null; - /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - readonly path: string; - /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - readonly pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - readonly start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - readonly subject_type?: "line" | "file"; - /** Format: date-time */ - readonly updated_at: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; /** * Format: uri - * @description URL for the pull request review comment + * @description URL for the team */ 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; - 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; - } | null; - }[]; - readonly node_id: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; }; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review_thread unresolved event */ - readonly "webhook-pull-request-review-thread-unresolved": { + /** pull_request_review submitted event */ + readonly "webhook-pull-request-review-submitted": { /** @enum {string} */ - readonly action: "unresolved"; + readonly action: "submitted"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; @@ -77440,7 +70393,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; @@ -77476,7 +70429,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)[]; @@ -77494,7 +70447,7 @@ export type components = { /** @description Commit message for the merge commit. */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string; + readonly commit_title: string | null; /** User */ readonly enabled_by: { /** Format: uri */ @@ -77684,6 +70637,23 @@ export type components = { readonly url: string | null; } | null; readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -77752,6 +70722,23 @@ export type components = { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -77776,6 +70763,11 @@ export type components = { readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; @@ -77833,7 +70825,7 @@ export type components = { readonly diff_url: string; readonly draft: boolean; readonly head: { - readonly label: string; + readonly label: string | null; readonly ref: string; /** * Repository @@ -77978,6 +70970,23 @@ export type components = { readonly url: string | null; } | null; readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -78046,6 +71055,23 @@ export type components = { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -78070,13 +71096,18 @@ export type components = { readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - }; + } | null; readonly sha: string; /** User */ readonly user: { @@ -78182,7 +71213,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; @@ -78246,22 +71277,22 @@ 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) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -78288,17 +71319,17 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -78365,285 +71396,6 @@ export type components = { 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; - 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 repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - readonly thread: { - readonly comments: { - readonly _links: { - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly pull_request: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** - * 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 The text of the comment. */ - readonly body: string; - /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ - readonly html_url: string; - /** @description The ID of the pull request review comment. */ - readonly id: number; - /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; - /** @description The node ID of the pull request review comment. */ - readonly node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number; - /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - readonly path: string; - /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - readonly pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - readonly start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - readonly subject_type?: "line" | "file"; - /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL for the pull request review 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; - 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 node_id: string; - }; - }; - /** pull_request synchronize event */ - readonly "webhook-pull-request-synchronize": { - /** @enum {string} */ - readonly action: "synchronize"; - readonly after: string; - readonly before: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - readonly pull_request: { - readonly _links: { - /** Link */ - readonly comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly commits: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly issue: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comment: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly statuses: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; - /** 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; - } | null; - readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -78678,6 +71430,137 @@ export type components = { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + } | null; + }; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly review: components["schemas"]["webhooks_review"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request_review_thread resolved event */ + readonly "webhook-pull-request-review-thread-resolved": { + /** @enum {string} */ + readonly action: "resolved"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** Simple Pull Request */ + readonly pull_request: { + readonly _links: { + /** Link */ + readonly comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly commits: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly html: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly issue: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comment: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly statuses: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** @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: ({ + /** 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 @@ -78883,23 +71766,6 @@ export type components = { readonly url: string | null; } | null; readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -78968,23 +71834,6 @@ export type components = { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -79009,11 +71858,6 @@ export type components = { readonly updated_at: string; /** Format: uri */ readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; @@ -79061,24 +71905,17 @@ export type components = { } | null; }; readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ readonly closed_at: string | null; - readonly comments?: number; /** Format: uri */ readonly comments_url: string; - readonly commits?: number; /** Format: uri */ readonly commits_url: string; - /** Format: date-time */ readonly created_at: string; - readonly deletions?: number; /** Format: uri */ readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string; + readonly label: string | null; readonly ref: string; /** * Repository @@ -79223,16 +72060,6 @@ export type components = { readonly url: string | null; } | null; readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit message title. - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -79301,23 +72128,6 @@ export type components = { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -79342,18 +72152,13 @@ export type components = { readonly updated_at: string; /** Format: uri */ readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - }; + } | null; readonly sha: string; /** User */ readonly user: { @@ -79414,51 +72219,8 @@ export type components = { readonly url: string; }[]; readonly locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ readonly merged_at: string | null; - /** User */ - readonly merged_by?: { - /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -79502,7 +72264,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; } | null; @@ -79531,11 +72293,9 @@ export type components = { readonly url: string; } | null; readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; - readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -79675,19 +72435,13 @@ export type components = { }[]; /** Format: uri-template */ readonly review_comment_url: string; - readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; - /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -79730,55 +72484,160 @@ export type components = { } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly thread: { + readonly comments: { + readonly _links: { + /** Link */ + readonly html: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly pull_request: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** + * 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 The text of the comment. */ + readonly body: string; + /** @description The SHA of the commit to which the comment applies. */ + readonly commit_id: string; + /** Format: date-time */ + readonly created_at: string; + /** @description The diff of the line that the comment refers to. */ + readonly diff_hunk: string; + /** + * Format: uri + * @description HTML URL for the pull request review comment. + */ + readonly html_url: string; + /** @description The ID of the pull request review comment. */ + readonly id: number; + /** @description The comment ID to reply to. */ + readonly in_reply_to_id?: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + readonly line: number | null; + /** @description The node ID of the pull request review comment. */ + readonly node_id: string; + /** @description The SHA of the original commit to which the comment applies. */ + readonly original_commit_id: string; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + readonly original_line: number | null; + /** @description The index of the original line in the diff to which the comment applies. */ + readonly original_position: number; + /** @description The first line of the range for a multi-line comment. */ + readonly original_start_line: number | null; + /** @description The relative path of the file to which the comment applies. */ + readonly path: string; + /** @description The line index in the diff to which the comment applies. */ + readonly position: number | null; + /** @description The ID of the pull request review to which the comment belongs. */ + readonly pull_request_review_id: number | null; + /** + * Format: uri + * @description URL for the pull request that the review comment belongs to. + */ + readonly pull_request_url: string; + /** 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; + }; + /** + * @description The side of the first line of the range for a multi-line comment. + * @enum {string} + */ + readonly side: "LEFT" | "RIGHT"; + /** @description The first line of the range for a multi-line comment. */ + readonly start_line: number | null; + /** + * @description The side of the first line of the range for a multi-line comment. + * @default RIGHT + * @enum {string|null} + */ + readonly start_side: "LEFT" | "RIGHT" | null; + /** + * @description The level at which the comment is targeted, can be a diff line or a file. + * @enum {string} + */ + readonly subject_type?: "line" | "file"; + /** Format: date-time */ + readonly updated_at: string; + /** + * Format: uri + * @description URL for the pull request review 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; + 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; + } | null; + }[]; + readonly node_id: string; + }; }; - /** pull_request unassigned event */ - readonly "webhook-pull-request-unassigned": { + /** pull_request_review_thread unresolved event */ + readonly "webhook-pull-request-review-thread-unresolved": { /** @enum {string} */ - readonly action: "unassigned"; - /** 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; - } | null; + readonly action: "unresolved"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ + /** Simple Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -79824,7 +72683,6 @@ export type components = { }; /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; /** User */ readonly assignee: { /** Format: uri */ @@ -79858,7 +72716,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; } | null; @@ -79894,7 +72752,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; } | null)[]; @@ -79912,7 +72770,7 @@ export type components = { /** @description Commit message for the merge commit. */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + readonly commit_title: string; /** User */ readonly enabled_by: { /** Format: uri */ @@ -79957,7 +72815,7 @@ export type components = { readonly merge_method: "merge" | "squash" | "rebase"; } | null; readonly base: { - readonly label: string | null; + readonly label: string; readonly ref: string; /** * Repository @@ -80102,23 +72960,6 @@ export type components = { readonly url: string | null; } | null; readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -80187,23 +73028,6 @@ export type components = { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -80228,11 +73052,6 @@ export type components = { readonly updated_at: string; /** Format: uri */ readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; @@ -80280,24 +73099,17 @@ export type components = { } | null; }; readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ readonly closed_at: string | null; - readonly comments?: number; /** Format: uri */ readonly comments_url: string; - readonly commits?: number; /** Format: uri */ readonly commits_url: string; - /** Format: date-time */ readonly created_at: string; - readonly deletions?: number; /** Format: uri */ readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string | null; + readonly label: string; readonly ref: string; /** * Repository @@ -80442,23 +73254,6 @@ export type components = { readonly url: string | null; } | null; readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -80527,23 +73322,6 @@ export type components = { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -80568,18 +73346,13 @@ export type components = { readonly updated_at: string; /** Format: uri */ readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - } | null; + }; readonly sha: string; /** User */ readonly user: { @@ -80640,51 +73413,8 @@ export type components = { readonly url: string; }[]; readonly locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ readonly merged_at: string | null; - /** User */ - readonly merged_by?: { - /** 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; - } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -80728,7 +73458,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; } | null; @@ -80757,11 +73487,9 @@ export type components = { readonly url: string; } | null; readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; - readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -80794,22 +73522,22 @@ 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; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + readonly description?: string | null; /** Format: uri */ - readonly html_url: string; + readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url: string; + readonly members_url?: string; /** @description Name of the team */ readonly name: string; - readonly node_id: string; + readonly node_id?: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -80836,17 +73564,17 @@ export type components = { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly permission?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + readonly repositories_url?: string; + readonly slug?: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + readonly url?: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -80901,19 +73629,13 @@ export type components = { }[]; /** Format: uri-template */ readonly review_comment_url: string; - readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; - /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -80950,38 +73672,167 @@ 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; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly thread: { + readonly comments: { + readonly _links: { + /** Link */ + readonly html: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly pull_request: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** + * 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 The text of the comment. */ + readonly body: string; + /** @description The SHA of the commit to which the comment applies. */ + readonly commit_id: string; + /** Format: date-time */ + readonly created_at: string; + /** @description The diff of the line that the comment refers to. */ + readonly diff_hunk: string; + /** + * Format: uri + * @description HTML URL for the pull request review comment. + */ + readonly html_url: string; + /** @description The ID of the pull request review comment. */ + readonly id: number; + /** @description The comment ID to reply to. */ + readonly in_reply_to_id?: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + readonly line: number | null; + /** @description The node ID of the pull request review comment. */ + readonly node_id: string; + /** @description The SHA of the original commit to which the comment applies. */ + readonly original_commit_id: string; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + readonly original_line: number; + /** @description The index of the original line in the diff to which the comment applies. */ + readonly original_position: number; + /** @description The first line of the range for a multi-line comment. */ + readonly original_start_line: number | null; + /** @description The relative path of the file to which the comment applies. */ + readonly path: string; + /** @description The line index in the diff to which the comment applies. */ + readonly position: number | null; + /** @description The ID of the pull request review to which the comment belongs. */ + readonly pull_request_review_id: number | null; + /** + * Format: uri + * @description URL for the pull request that the review comment belongs to. + */ + readonly pull_request_url: string; + /** 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; + }; + /** + * @description The side of the first line of the range for a multi-line comment. + * @enum {string} + */ + readonly side: "LEFT" | "RIGHT"; + /** @description The first line of the range for a multi-line comment. */ + readonly start_line: number | null; + /** + * @description The side of the first line of the range for a multi-line comment. + * @default RIGHT + * @enum {string|null} + */ + readonly start_side: "LEFT" | "RIGHT" | null; + /** + * @description The level at which the comment is targeted, can be a diff line or a file. + * @enum {string} + */ + readonly subject_type?: "line" | "file"; + /** Format: date-time */ + readonly updated_at: string; + /** + * Format: uri + * @description URL for the pull request review 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; + 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 node_id: string; + }; }; - /** pull_request unlabeled event */ - readonly "webhook-pull-request-unlabeled": { + /** pull_request synchronize event */ + readonly "webhook-pull-request-synchronize": { /** @enum {string} */ - readonly action: "unlabeled"; + readonly action: "synchronize"; + readonly after: string; + readonly before: string; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** Label */ - readonly label?: { - /** @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; - }; - /** @description The pull request number. */ - readonly number: number; + readonly number: components["schemas"]["webhooks_number"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ readonly pull_request: { @@ -81502,7 +74353,7 @@ export type components = { /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string | null; + readonly label: string; readonly ref: string; /** * Repository @@ -81777,7 +74628,7 @@ export type components = { readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - } | null; + }; readonly sha: string; /** User */ readonly user: { @@ -82152,103 +75003,103 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request unlocked event */ - readonly "webhook-pull-request-unlocked": { - /** @enum {string} */ - readonly action: "unlocked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - readonly pull_request: { - readonly _links: { - /** Link */ - readonly comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly commits: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly issue: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comment: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly statuses: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; - /** 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 repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request unassigned event */ + readonly "webhook-pull-request-unassigned": { + /** @enum {string} */ + readonly action: "unassigned"; + readonly assignee?: components["schemas"]["webhooks_user_mannequin"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** Pull Request */ + readonly pull_request: { + readonly _links: { + /** Link */ + readonly comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly commits: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly html: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly issue: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comment: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly statuses: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** @enum {string|null} */ + readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; + /** 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; + } | null; readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; @@ -82281,7 +75132,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)[]; @@ -82299,7 +75150,7 @@ export type components = { /** @description Commit message for the merge commit. */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string; + readonly commit_title: string | null; /** User */ readonly enabled_by: { /** Format: uri */ @@ -82344,7 +75195,7 @@ export type components = { readonly merge_method: "merge" | "squash" | "rebase"; } | null; readonly base: { - readonly label: string; + readonly label: string | null; readonly ref: string; /** * Repository @@ -82684,7 +75535,7 @@ export type components = { /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string; + readonly label: string | null; readonly ref: string; /** * Repository @@ -82935,714 +75786,108 @@ export type components = { readonly stargazers?: number; readonly stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - } | null; - readonly sha: 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; - 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; - }; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - /** Format: uri */ - readonly issue_url: string; - readonly labels: { - /** @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 locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ - readonly merged_at: string | null; - /** User */ - readonly merged_by?: { - /** 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; - /** - * 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; + readonly stargazers_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; + readonly statuses_url: string; /** Format: uri */ - readonly received_events_url?: string; + readonly subscribers_url: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; + readonly subscription_url: string; /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly svn_url: string; /** Format: uri */ - readonly url?: 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; - /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; - /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: (({ - /** 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 deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; + readonly tags_url: string; /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; + readonly teams_url: string; + readonly topics: string[]; /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - })[]; - readonly requested_teams: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; /** - * Format: uri - * @description URL for the team + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }[]; - /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; - /** Format: uri */ - readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - readonly state: "open" | "closed"; - /** Format: uri */ - readonly statuses_url: string; - /** @description The title of the pull request. */ - readonly title: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - 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; - 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 repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** push event */ - readonly "webhook-push": { - /** @description The SHA of the most recent commit on `ref` after the push. */ - readonly after: string; - readonly base_ref: string | null; - /** @description The SHA of the most recent commit on `ref` before the push. */ - readonly before: string; - /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */ - readonly commits: { - /** @description An array of files added in the commit. */ - readonly added?: string[]; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly author: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly committer: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** @description Whether this commit is distinct from any that have been pushed before. */ - readonly distinct: boolean; - readonly id: string; - /** @description The commit message. */ - readonly message: string; - /** @description An array of files modified by the commit. */ - readonly modified?: string[]; - /** @description An array of files removed in the commit. */ - readonly removed?: string[]; - /** - * Format: date-time - * @description The ISO 8601 timestamp of the commit. - */ - readonly timestamp: string; - readonly tree_id: string; - /** - * Format: uri - * @description URL that points to the commit API resource. - */ - readonly url: string; - }[]; - /** @description URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. */ - readonly compare: string; - /** @description Whether this push created the `ref`. */ - readonly created: boolean; - /** @description Whether this push deleted the `ref`. */ - readonly deleted: boolean; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description Whether this push was a force push of the `ref`. */ - readonly forced: boolean; - /** Commit */ - readonly head_commit: { - /** @description An array of files added in the commit. */ - readonly added?: string[]; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly author: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly committer: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** @description Whether this commit is distinct from any that have been pushed before. */ - readonly distinct: boolean; - readonly id: string; - /** @description The commit message. */ - readonly message: string; - /** @description An array of files modified by the commit. */ - readonly modified?: string[]; - /** @description An array of files removed in the commit. */ - readonly removed?: string[]; - /** - * Format: date-time - * @description The ISO 8601 timestamp of the commit. - */ - readonly timestamp: string; - readonly tree_id: string; - /** - * Format: uri - * @description URL that points to the commit API resource. - */ - readonly url: string; - } | null; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly pusher: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email?: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** @description The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. */ - readonly ref: string; - /** - * Repository - * @description A git repository - */ - readonly repository: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; + readonly use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; + } | null; + readonly sha: 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; + 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; + }; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; + readonly issue_url: string; + readonly labels: { + /** @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; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + /** + * Format: uri + * @description URL for the label + */ + readonly url: string; + }[]; + readonly locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; + readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ + readonly merged_at: string | null; /** User */ - readonly owner: { + readonly merged_by?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -83674,423 +75919,757 @@ 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; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - readonly "webhook-registry-package-published": { - /** @enum {string} */ - readonly action: "published"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly registry_package: { - readonly created_at: string | null; - readonly description: string | null; - readonly ecosystem: string; - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; - readonly owner: { - readonly avatar_url: string; - readonly events_url: string; - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string; + /** + * 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; + } | null; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; + /** Format: uri */ readonly html_url: string; readonly id: number; - readonly login: string; + /** Format: uri */ + readonly labels_url: 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; + /** @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; - }; - readonly package_type: string; - readonly package_version: { - readonly author?: { - readonly avatar_url: string; - readonly events_url: string; - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string; + } | null; + readonly node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ + readonly number: number; + /** Format: uri */ + readonly patch_url: string; + readonly rebaseable?: boolean | null; + readonly requested_reviewers: (({ + /** 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; + } | null) | { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ readonly html_url: string; + /** @description Unique identifier of the team */ readonly id: number; - readonly login: string; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: 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; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ readonly url: string; - }; - readonly body?: string | Record; - readonly body_html?: string; - readonly container_metadata?: { - readonly labels?: Record; - readonly manifest?: Record; - readonly tag?: { - readonly digest?: string; - readonly name?: string; - }; - }; - readonly created_at?: string; - readonly description: string; - readonly docker_metadata?: { - readonly tags?: string[]; - }[]; - readonly draft?: boolean; - readonly html_url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + })[]; + readonly requested_teams: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: { - readonly [key: string]: unknown; - }[]; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ readonly name: string; - readonly npm_metadata?: { - readonly name?: string; - readonly version?: string; - readonly npm_user?: string; - readonly author?: (string | Record) | null; - readonly bugs?: (string | Record) | null; - readonly dependencies?: Record; - readonly dev_dependencies?: Record; - readonly peer_dependencies?: Record; - readonly optional_dependencies?: Record; - readonly description?: string; - readonly dist?: (string | Record) | null; - readonly git_head?: string; - readonly homepage?: string; - readonly license?: string; - readonly main?: string; - readonly repository?: (string | Record) | null; - readonly scripts?: Record; - readonly id?: string; - readonly node_version?: string; - readonly npm_version?: string; - readonly has_shrinkwrap?: boolean; - readonly maintainers?: string[]; - readonly contributors?: string[]; - readonly engines?: Record; - readonly keywords?: string[]; - readonly files?: string[]; - readonly bin?: Record; - readonly man?: Record; - readonly directories?: (string | Record) | null; - readonly os?: string[]; - readonly cpu?: string[]; - readonly readme?: string; - readonly installation_command?: string; - readonly release_id?: number; - readonly commit_oid?: string; - readonly published_via_actions?: boolean; - readonly deleted_by_id?: number; - } | null; - readonly nuget_metadata?: { - readonly id?: (string | Record | number) | null; - readonly name?: string; - readonly value?: boolean | string | number | { - readonly url?: string; - readonly branch?: string; - readonly commit?: string; - readonly type?: string; - }; - }[] | null; - readonly package_files: { - readonly content_type: string; - readonly created_at: string; - readonly download_url: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ readonly id: number; - readonly md5: string | null; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ readonly name: string; - readonly sha1: string | null; - readonly sha256: string | null; - readonly size: number; - readonly state: string | null; - readonly updated_at: string; - }[]; - readonly package_url: string; - readonly prerelease?: boolean; - readonly release?: { - readonly author?: { - 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; - 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 created_at?: string; - readonly draft?: boolean; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly prerelease?: boolean; - readonly published_at?: string; - readonly tag_name?: string; - readonly target_commitish?: string; - readonly url?: string; - }; - readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish?: string; - readonly target_oid?: string; - readonly updated_at?: string; - readonly version: string; - } | null; - readonly registry: { - readonly about_url?: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; + }[]; + /** Format: uri-template */ + readonly review_comment_url: string; + readonly review_comments?: number; + /** Format: uri */ + readonly review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + readonly state: "open" | "closed"; + /** Format: uri */ + readonly statuses_url: string; + /** @description The title of the pull request. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + 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; + readonly id: number; + readonly login: string; readonly name?: string; - readonly type?: 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 vendor?: string; } | null; - readonly updated_at: string | null; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; }; - readonly "webhook-registry-package-updated": { + /** pull_request unlabeled event */ + readonly "webhook-pull-request-unlabeled": { /** @enum {string} */ - readonly action: "updated"; + readonly action: "unlabeled"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; + readonly label?: components["schemas"]["webhooks_label"]; + readonly number: components["schemas"]["webhooks_number"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly registry_package: { - readonly created_at: string; - readonly description: unknown; - readonly ecosystem: string; - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; - readonly owner: { - 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; + /** Pull Request */ + readonly pull_request: { + readonly _links: { + /** Link */ + readonly comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly commits: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly html: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly issue: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comment: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly statuses: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** @enum {string|null} */ + readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; + /** 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 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 package_type: string; - readonly package_version: { - readonly author: { - 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; + 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; + } | null; + readonly assignees: ({ + /** 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; + } | 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"; + /** + * PullRequestAutoMerge + * @description The status of auto merging a pull request. + */ + readonly auto_merge: { + /** @description Commit message for the merge commit. */ + readonly commit_message: string | null; + /** @description Title for the merge commit message. */ + readonly commit_title: string | null; + /** User */ + readonly enabled_by: { + /** 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 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 body: string; - readonly body_html: string; - readonly created_at: string; - readonly description: string; - readonly docker_metadata?: ({ - readonly tags?: string[]; - } | null)[]; - readonly draft?: boolean; - readonly html_url: string; - readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: { - readonly [key: string]: unknown; - }[]; - readonly name: string; - readonly package_files: { - readonly content_type?: string; - readonly created_at?: string; - readonly download_url?: string; - readonly id?: number; - readonly md5?: string | null; readonly name?: string; - readonly sha1?: string | null; - readonly sha256?: string; - readonly size?: number; - readonly state?: string; - readonly updated_at?: string; - }[]; - readonly package_url: string; - readonly prerelease?: boolean; - readonly release?: { - readonly author: { - 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; + 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; + /** + * @description The merge method to use. + * @enum {string} + */ + readonly merge_method: "merge" | "squash" | "rebase"; + } | null; + readonly base: { + readonly label: string; + readonly ref: string; + /** + * Repository + * @description A git repository + */ + readonly repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: 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 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 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 permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; }; - readonly created_at: string; - readonly draft: boolean; - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly prerelease: boolean; - readonly published_at: string; - readonly tag_name: string; - readonly target_commitish: string; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; }; - readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish: string; - readonly target_oid: string; - readonly updated_at: string; - readonly version: string; - }; - readonly registry: Record; - readonly updated_at: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** release created event */ - readonly "webhook-release-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - readonly release: { - readonly assets: { - /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; - /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; - /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - readonly state: "uploaded"; - /** Format: date-time */ - readonly updated_at: string; + readonly sha: string; /** User */ - readonly uploader?: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84126,128 +76705,304 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - /** Format: uri */ - readonly url: string; - }[]; - /** Format: uri */ - readonly assets_url: string; - /** User */ - readonly author: { - /** 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 body: string | null; + readonly changed_files?: number; /** Format: date-time */ - readonly created_at: string | null; + readonly closed_at: string | null; + readonly comments?: number; /** Format: uri */ - readonly discussion_url?: string; - /** @description Whether the release is a draft or published */ - readonly draft: boolean; + readonly comments_url: string; + readonly commits?: number; /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; + readonly commits_url: string; /** Format: date-time */ - readonly published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - readonly tag_name: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; - /** Format: uri-template */ - readonly upload_url: string; - /** Format: uri */ - readonly url: string; + readonly created_at: string; + readonly deletions?: number; /** Format: uri */ - readonly zipball_url: string | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** release deleted event */ - readonly "webhook-release-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - readonly release: { - readonly assets: { - /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; - /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; + readonly diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ + readonly draft: boolean; + readonly head: { readonly label: string | null; - /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; + readonly ref: string; /** - * @description State of the release asset. - * @enum {string} + * Repository + * @description A git repository */ - readonly state: "uploaded"; - /** Format: date-time */ - readonly updated_at: string; + readonly repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit message title. + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: 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; + } | null; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; + } | null; + readonly sha: string; /** User */ - readonly uploader?: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84283,13 +77038,38 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - /** Format: uri */ + }; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + /** Format: uri */ + readonly issue_url: string; + readonly labels: { + /** @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 */ - readonly assets_url: string; + readonly locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; + readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ + readonly merged_at: string | null; /** User */ - readonly author: { + readonly merged_by?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84325,100 +77105,18 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - readonly body: string | null; - /** Format: date-time */ - readonly created_at: string | null; - /** Format: uri */ - readonly discussion_url?: string; - /** @description Whether the release is a draft or published */ - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; - /** Format: date-time */ - readonly published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - readonly tag_name: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; - /** Format: uri-template */ - readonly upload_url: string; - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly zipball_url: string | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** release edited event */ - readonly "webhook-release-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly body?: { - /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; - }; - readonly name?: { - /** @description The previous version of the name if the action was `edited`. */ - readonly from: string; - }; - readonly make_latest?: { - /** @description Whether this release was explicitly `edited` to be the latest. */ - readonly to: boolean; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - readonly release: { - readonly assets: { - /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + readonly milestone: { /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; - /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - readonly state: "uploaded"; + readonly closed_at: string | null; + readonly closed_issues: number; /** Format: date-time */ - readonly updated_at: string; + readonly created_at: string; /** User */ - readonly uploader?: { + readonly creator: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84450,17 +77148,41 @@ 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; + 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; + /** @description Number uniquely identifying the pull request within its repository. */ + readonly number: number; /** Format: uri */ - readonly assets_url: string; - /** User */ - readonly author: { + readonly patch_url: string; + readonly rebaseable?: boolean | null; + readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84492,128 +77214,131 @@ 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; - readonly body: string | null; - /** Format: date-time */ - readonly created_at: string | null; - /** Format: uri */ - readonly discussion_url?: string; - /** @description Whether the release is a draft or published */ - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; - /** Format: date-time */ - readonly published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - readonly tag_name: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; - /** Format: uri-template */ - readonly upload_url: string; - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly zipball_url: string | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** release prereleased event */ - readonly "webhook-release-prereleased": { - /** @enum {string} */ - readonly action: "prereleased"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly release: { - readonly assets: { + } | null) | { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description: string | null; /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; - /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; + readonly html_url: string; + /** @description Unique identifier of the team */ readonly id: number; - readonly label: string | null; - /** @description The file name of the asset. */ + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ readonly name: string; readonly node_id: string; - readonly size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - readonly state: "uploaded"; - /** Format: date-time */ - readonly updated_at: string; - /** User */ - readonly uploader?: { + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; /** Format: uri-template */ - readonly events_url?: string; + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + })[]; + readonly requested_teams: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; + /** @description Unique identifier of the team */ 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; + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly url?: string; + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly url: string; + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; }[]; + /** Format: uri-template */ + readonly review_comment_url: string; + readonly review_comments?: number; /** Format: uri */ - readonly assets_url: string; + readonly review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + readonly state: "open" | "closed"; + /** Format: uri */ + readonly statuses_url: string; + /** @description The title of the pull request. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; /** User */ - readonly author: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84645,170 +77370,71 @@ 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; - readonly body: string | null; - /** Format: date-time */ - readonly created_at: string | null; - /** Format: uri */ - readonly discussion_url?: string; - /** @description Whether the release is a draft or published */ - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; - /** Format: date-time */ - readonly published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - readonly tag_name: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; - /** Format: uri-template */ - readonly upload_url: string; - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly zipball_url: string | null; - } & { - readonly assets?: Record[]; - readonly assets_url?: string; - readonly author?: { - 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; - 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 body?: string | null; - readonly created_at?: string; - readonly draft?: boolean; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly node_id?: string; - /** - * @description Whether the release is identified as a prerelease or a full release. - * @enum {boolean} - */ - readonly prerelease: true; - readonly published_at?: string | null; - readonly tag_name?: string; - readonly tarball_url?: string | null; - readonly target_commitish?: string; - readonly upload_url?: string; - readonly url?: string; - readonly zipball_url?: string | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** release published event */ - readonly "webhook-release-published": { + /** pull_request unlocked event */ + readonly "webhook-pull-request-unlocked": { /** @enum {string} */ - readonly action: "published"; + readonly action: "unlocked"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly release: { - readonly assets: { - /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; - /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; - /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - readonly state: "uploaded"; - /** Format: date-time */ - readonly updated_at: string; - /** User */ - readonly uploader?: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + /** Pull Request */ + readonly pull_request: { + readonly _links: { + /** Link */ + readonly comments: { /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; + readonly href: string; + }; + /** Link */ + readonly commits: { /** Format: uri-template */ - readonly following_url?: string; + readonly href: string; + }; + /** Link */ + readonly html: { /** 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; + readonly href: string; + }; + /** Link */ + readonly issue: { /** 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; - /** Format: uri */ - readonly url: string; - }[]; - /** Format: uri */ - readonly assets_url: string; + readonly href: string; + }; + /** Link */ + readonly review_comment: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly statuses: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** @enum {string|null} */ + readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; /** User */ - readonly author: { + readonly assignee: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84844,125 +77470,59 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - readonly body: string | null; - /** Format: date-time */ - readonly created_at: string | null; - /** Format: uri */ - readonly discussion_url?: string; - /** @description Whether the release is a draft or published */ - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; - /** Format: date-time */ - readonly published_at: string | null; - /** 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; + readonly assignees: ({ /** Format: uri */ - readonly url: string; - }; - /** @description The name of the tag. */ - readonly tag_name: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; - /** Format: uri-template */ - readonly upload_url: string; - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly zipball_url: string | null; - } & { - readonly assets?: Record[]; - readonly assets_url?: string; - readonly author?: { 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 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; - readonly type?: string; - readonly url?: string; - }; - readonly body?: string | null; - readonly created_at?: string; - readonly draft?: boolean; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly node_id?: string; - readonly prerelease?: boolean; - /** Format: date-time */ - readonly published_at: string | null; - readonly tag_name?: string; - readonly tarball_url?: string | null; - readonly target_commitish?: string; - readonly upload_url?: string; - readonly url?: string; - readonly zipball_url?: string | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** release released event */ - readonly "webhook-release-released": { - /** @enum {string} */ - readonly action: "released"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - readonly release: { - readonly assets: { + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; - /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; - /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - readonly state: "uploaded"; - /** Format: date-time */ - readonly updated_at: string; + 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"; + /** + * PullRequestAutoMerge + * @description The status of auto merging a pull request. + */ + readonly auto_merge: { + /** @description Commit message for the merge commit. */ + readonly commit_message: string | null; + /** @description Title for the merge commit message. */ + readonly commit_title: string; /** User */ - readonly uploader?: { + readonly enabled_by: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84992,130 +77552,305 @@ export type components = { /** Format: uri-template */ readonly starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + /** + * @description The merge method to use. + * @enum {string} + */ + readonly merge_method: "merge" | "squash" | "rebase"; + } | null; + readonly base: { + readonly label: string; + readonly ref: string; + /** + * Repository + * @description A git repository + */ + readonly repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: 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; + } | null; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - } | null; - /** Format: uri */ - readonly url: string; - }[]; - /** Format: uri */ - readonly assets_url: string; - /** User */ - readonly author: { - /** 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 body: string | null; - /** Format: date-time */ - readonly created_at: string | null; - /** Format: uri */ - readonly discussion_url?: string; - /** @description Whether the release is a draft or published */ - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; - /** Format: date-time */ - readonly published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - readonly tag_name: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; - /** Format: uri-template */ - readonly upload_url: string; - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly zipball_url: string | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** release unpublished event */ - readonly "webhook-release-unpublished": { - /** @enum {string} */ - readonly action: "unpublished"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly release: { - readonly assets: { - /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; - /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; - /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - readonly state: "uploaded"; - /** Format: date-time */ - readonly updated_at: string; + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; + }; + readonly sha: string; /** User */ - readonly uploader?: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -85131,403 +77866,223 @@ export type components = { 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; - /** Format: uri */ - readonly url: string; - }[]; - /** Format: uri */ - readonly assets_url: string; - /** User */ - readonly author: { - /** 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 body: string | null; - /** Format: date-time */ - readonly created_at: string | null; - /** Format: uri */ - readonly discussion_url?: string; - /** @description Whether the release is a draft or published */ - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; - /** Format: date-time */ - readonly published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - readonly tag_name: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; - /** Format: uri-template */ - readonly upload_url: string; - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly zipball_url: string | null; - } & { - readonly assets?: Record[]; - readonly assets_url?: string; - readonly author?: { - 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; - 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 body?: string | null; - readonly created_at?: string; - readonly draft?: boolean; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly node_id?: string; - readonly prerelease?: boolean; - readonly published_at: string | null; - readonly tag_name?: string; - readonly tarball_url?: string | null; - readonly target_commitish?: string; - readonly upload_url?: string; - readonly url?: string; - readonly zipball_url?: string | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** Repository advisory published event */ - readonly "webhook-repository-advisory-published": { - /** @enum {string} */ - readonly action: "published"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly repository_advisory: components["schemas"]["repository-advisory"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** Repository advisory reported event */ - readonly "webhook-repository-advisory-reported": { - /** @enum {string} */ - readonly action: "reported"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly repository_advisory: components["schemas"]["repository-advisory"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** repository archived event */ - readonly "webhook-repository-archived": { - /** @enum {string} */ - readonly action: "archived"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository created event */ - readonly "webhook-repository-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository deleted event */ - readonly "webhook-repository-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_dispatch event */ - readonly "webhook-repository-dispatch-sample": { - /** @enum {string} */ - readonly action: "sample.collected"; - readonly branch: string; - readonly client_payload: { - readonly [key: string]: unknown; - } | null; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository edited event */ - readonly "webhook-repository-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly default_branch?: { - readonly from: string; - }; - readonly description?: { - readonly from: string | null; - }; - readonly homepage?: { - readonly from: string | null; - }; - readonly topics?: { - readonly from?: string[] | null; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_import event */ - readonly "webhook-repository-import": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - /** @enum {string} */ - readonly status: "success" | "cancelled" | "failure"; - }; - /** repository privatized event */ - readonly "webhook-repository-privatized": { - /** @enum {string} */ - readonly action: "privatized"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository publicized event */ - readonly "webhook-repository-publicized": { - /** @enum {string} */ - readonly action: "publicized"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository renamed event */ - readonly "webhook-repository-renamed": { - /** @enum {string} */ - readonly action: "renamed"; - readonly changes: { - readonly repository: { - readonly name: { - readonly from: string; - }; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository ruleset created event */ - readonly "webhook-repository-ruleset-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository ruleset deleted event */ - readonly "webhook-repository-ruleset-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository ruleset edited event */ - readonly "webhook-repository-ruleset-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly changes?: { - readonly name?: { - readonly from?: string; - }; - readonly enforcement?: { - readonly from?: string; - }; - readonly conditions?: { - readonly added?: components["schemas"]["repository-ruleset-conditions"][]; - readonly deleted?: components["schemas"]["repository-ruleset-conditions"][]; - readonly updated?: { - readonly condition?: components["schemas"]["repository-ruleset-conditions"]; - readonly changes?: { - readonly condition_type?: { - readonly from?: string; - }; - readonly target?: { - readonly from?: string; - }; - readonly include?: { - readonly from?: string[]; - }; - readonly exclude?: { - readonly from?: string[]; - }; - }; - }[]; - }; - readonly rules?: { - readonly added?: components["schemas"]["repository-rule"][]; - readonly deleted?: components["schemas"]["repository-rule"][]; - readonly updated?: { - readonly rule?: components["schemas"]["repository-rule"]; - readonly changes?: { - readonly configuration?: { - readonly from?: string; - }; - readonly rule_type?: { - readonly from?: string; - }; - readonly pattern?: { - readonly from?: string; - }; - }; - }[]; - }; - }; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository transferred event */ - readonly "webhook-repository-transferred": { - /** @enum {string} */ - readonly action: "transferred"; - readonly changes: { - readonly owner: { - readonly from: { - /** Organization */ - readonly organization?: { - /** Format: uri */ - readonly avatar_url: string; - readonly description: string | null; - /** Format: uri */ - readonly events_url: string; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url?: string; - readonly id: number; - /** Format: uri */ - readonly issues_url: string; - readonly login: string; - /** Format: uri-template */ - readonly members_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 body: string | null; + readonly changed_files?: number; + /** Format: date-time */ + readonly closed_at: string | null; + readonly comments?: number; + /** Format: uri */ + readonly comments_url: string; + readonly commits?: number; + /** Format: uri */ + readonly commits_url: string; + /** Format: date-time */ + readonly created_at: string; + readonly deletions?: number; + /** Format: uri */ + readonly diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ + readonly draft: boolean; + readonly head: { + readonly label: string; + readonly ref: string; + /** + * Repository + * @description A git repository + */ + readonly repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; readonly node_id: string; - /** Format: uri-template */ - readonly public_members_url: string; - /** Format: uri */ - readonly repos_url: string; + readonly spdx_id: string; /** Format: uri */ - readonly url: string; - }; + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: string; /** User */ - readonly user?: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -85563,324 +78118,146 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - }; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository unarchived event */ - readonly "webhook-repository-unarchived": { - /** @enum {string} */ - readonly action: "unarchived"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert create event */ - readonly "webhook-repository-vulnerability-alert-create": { - /** @enum {string} */ - readonly action: "create"; - readonly alert: { - readonly affected_package_name: string; - readonly affected_range: string; - readonly created_at: string; - readonly dismiss_reason?: string; - readonly dismissed_at?: string; - /** User */ - readonly dismisser?: { - /** 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 external_identifier: string; - /** Format: uri */ - readonly external_reference: string | null; - readonly fix_reason?: string; - /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id: string; - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly severity: string; - /** @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; - } & { - readonly affected_package_name?: string; - readonly affected_range?: string; - readonly created_at?: string; - readonly external_identifier?: string; - readonly external_reference?: string | null; - readonly fixed_in?: string; - readonly ghsa_id?: string; - readonly id?: number; - readonly node_id?: string; - readonly number?: number; - readonly severity?: string; - /** @enum {string} */ - readonly state: "open"; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert dismiss event */ - readonly "webhook-repository-vulnerability-alert-dismiss": { - /** @enum {string} */ - readonly action: "dismiss"; - readonly alert: { - readonly affected_package_name: string; - readonly affected_range: string; - readonly created_at: string; - readonly dismiss_comment?: string | null; - readonly dismiss_reason?: string; - readonly dismissed_at?: string; - /** User */ - readonly dismisser?: { - /** 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 external_identifier: string; - /** Format: uri */ - readonly external_reference: string | null; - readonly fix_reason?: string; - /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id: string; - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly severity: string; - /** @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; - } & { - readonly affected_package_name?: string; - readonly affected_range?: string; - readonly created_at?: string; - readonly dismiss_comment?: string | null; - readonly dismiss_reason: string; - readonly dismissed_at: string; - /** User */ - readonly dismisser: { - /** 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 external_identifier?: string; - readonly external_reference?: string | null; - readonly fixed_in?: string; - readonly ghsa_id?: string; - readonly id?: number; - readonly node_id?: string; - readonly number?: number; - readonly severity?: string; - /** @enum {string} */ - readonly state: "dismissed"; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert reopen event */ - readonly "webhook-repository-vulnerability-alert-reopen": { - /** @enum {string} */ - readonly action: "reopen"; - readonly alert: { - readonly affected_package_name: string; - readonly affected_range: string; - readonly created_at: string; - readonly dismiss_reason?: string; - readonly dismissed_at?: string; - /** User */ - readonly dismisser?: { - /** 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 external_identifier: string; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; + } | null; + readonly sha: 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; + 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; + }; /** Format: uri */ - readonly external_reference: string | null; - readonly fix_reason?: string; - /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id: string; + readonly html_url: string; readonly id: number; - readonly node_id: string; - readonly number: number; - readonly severity: string; - /** @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; - } & { - readonly affected_package_name?: string; - readonly affected_range?: string; - readonly created_at?: string; - readonly external_identifier?: string; - readonly external_reference?: string | null; - readonly fixed_in?: string; - readonly ghsa_id?: string; - readonly id?: number; - readonly node_id?: string; - readonly number?: number; - readonly severity?: string; - /** @enum {string} */ - readonly state: "open"; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert resolve event */ - readonly "webhook-repository-vulnerability-alert-resolve": { - /** @enum {string} */ - readonly action: "resolve"; - readonly alert: { - readonly affected_package_name: string; - readonly affected_range: string; - readonly created_at: string; - readonly dismiss_reason?: string; - readonly dismissed_at?: string; + /** Format: uri */ + readonly issue_url: string; + readonly labels: { + /** @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 locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; + readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ + readonly merged_at: string | null; /** User */ - readonly dismisser?: { + readonly merged_by?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -85916,330 +78293,84 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - readonly external_identifier: string; - /** Format: uri */ - readonly external_reference: string | null; - readonly fix_reason?: string; - /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id: string; - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly severity: string; - /** @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; - } & { - readonly affected_package_name?: string; - readonly affected_range?: string; - readonly created_at?: string; - readonly external_identifier?: string; - readonly external_reference?: string | null; - readonly fix_reason?: string; - /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id?: string; - readonly id?: number; - readonly node_id?: string; - readonly number?: number; - readonly severity?: string; - /** @enum {string} */ - readonly state: "fixed" | "open"; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** secret_scanning_alert created event */ - readonly "webhook-secret-scanning-alert-created": { - /** @enum {string} */ - readonly action: "created"; - readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** Secret Scanning Alert Location Created Event */ - readonly "webhook-secret-scanning-alert-location-created": { - /** @enum {string} */ - readonly action?: "created"; - readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly location: components["schemas"]["secret-scanning-location"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Secret Scanning Alert Location Created Event */ - readonly "webhook-secret-scanning-alert-location-created-form-encoded": { - /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; - }; - /** secret_scanning_alert reopened event */ - readonly "webhook-secret-scanning-alert-reopened": { - /** @enum {string} */ - readonly action: "reopened"; - readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** secret_scanning_alert resolved event */ - readonly "webhook-secret-scanning-alert-resolved": { - /** @enum {string} */ - readonly action: "resolved"; - readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** secret_scanning_alert revoked event */ - readonly "webhook-secret-scanning-alert-revoked": { - /** @enum {string} */ - readonly action: "revoked"; - readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_advisory published event */ - readonly "webhook-security-advisory-published": { - /** @enum {string} */ - readonly action: "published"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - /** @description The details of the security advisory, including summary, description, and severity. */ - readonly security_advisory: { - readonly cvss: { - readonly score: number; - readonly vector_string: string | null; - }; - readonly cwes: { - readonly cwe_id: string; - readonly name: string; - }[]; - readonly description: string; - readonly ghsa_id: string; - readonly identifiers: { - readonly type: string; - readonly value: string; - }[]; - readonly published_at: string; - readonly references: { - /** Format: uri */ - readonly url: string; - }[]; - readonly severity: string; - readonly summary: string; - readonly updated_at: string; - readonly vulnerabilities: { - readonly first_patched_version: { - readonly identifier: string; - } | null; - readonly package: { - readonly ecosystem: string; - readonly name: string; - }; - readonly severity: string; - readonly vulnerable_version_range: string; - }[]; - readonly withdrawn_at: string | null; - }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_advisory updated event */ - readonly "webhook-security-advisory-updated": { - /** @enum {string} */ - readonly action: "updated"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - /** @description The details of the security advisory, including summary, description, and severity. */ - readonly security_advisory: { - readonly cvss: { - readonly score: number; - readonly vector_string: string | null; - }; - readonly cwes: { - readonly cwe_id: string; - readonly name: string; - }[]; - readonly description: string; - readonly ghsa_id: string; - readonly identifiers: { - readonly type: string; - readonly value: string; - }[]; - readonly published_at: string; - readonly references: { - /** Format: uri */ - readonly url: string; - }[]; - readonly severity: string; - readonly summary: string; - readonly updated_at: string; - readonly vulnerabilities: { - readonly first_patched_version: { - readonly identifier: string; - } | null; - readonly package: { - readonly ecosystem: string; - readonly name: string; - }; - readonly severity: string; - readonly vulnerable_version_range: string; - }[]; - readonly withdrawn_at: string | null; - }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_advisory withdrawn event */ - readonly "webhook-security-advisory-withdrawn": { - /** @enum {string} */ - readonly action: "withdrawn"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - /** @description The details of the security advisory, including summary, description, and severity. */ - readonly security_advisory: { - readonly cvss: { - readonly score: number; - readonly vector_string: string | null; - }; - readonly cwes: { - readonly cwe_id: string; - readonly name: string; - }[]; - readonly description: string; - readonly ghsa_id: string; - readonly identifiers: { - readonly type: string; - readonly value: string; - }[]; - readonly published_at: string; - readonly references: { - /** Format: uri */ - readonly url: string; - }[]; - readonly severity: string; - readonly summary: string; - readonly updated_at: string; - readonly vulnerabilities: { - readonly first_patched_version: { - readonly identifier: string; + /** + * 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"; + /** Format: uri */ + readonly url?: string; } | null; - readonly package: { - readonly ecosystem: string; - readonly name: string; - }; - readonly severity: string; - readonly vulnerable_version_range: string; - }[]; - readonly withdrawn_at: string; - }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_and_analysis event */ - readonly "webhook-security-and-analysis": { - readonly changes: { - readonly from?: { - readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["full-repository"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** sponsorship cancelled event */ - readonly "webhook-sponsorship-cancelled": { - /** @enum {string} */ - readonly action: "cancelled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly sponsorship: { - readonly created_at: string; - readonly maintainer?: { - 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; - 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 node_id: string; - readonly privacy_level: string; - /** User */ - readonly sponsor: { - /** 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; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; /** Format: uri */ - readonly html_url?: string; + 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"; + 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; + readonly url: string; } | null; - /** User */ - readonly sponsorable: { + readonly node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ + readonly number: number; + /** Format: uri */ + readonly patch_url: string; + readonly rebaseable?: boolean | null; + readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -86274,96 +78405,128 @@ export type components = { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; - } | null; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - readonly tier: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; - readonly name: string; - readonly node_id: string; - }; - }; - }; - /** sponsorship created event */ - readonly "webhook-sponsorship-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly sponsorship: { - readonly created_at: string; - readonly maintainer?: { - 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; - 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 node_id: string; - readonly privacy_level: string; - /** User */ - readonly sponsor: { - /** Format: uri */ - readonly avatar_url?: string; + } | null) | { 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; + /** @description Description of the team */ + readonly description?: string | null; /** Format: uri */ readonly html_url?: string; + /** @description Unique identifier of the team */ readonly id: number; - readonly login: string; - readonly name?: string; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; + })[]; + readonly requested_teams: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ readonly url?: string; - } | null; + }[]; + /** Format: uri-template */ + readonly review_comment_url: string; + readonly review_comments?: number; + /** Format: uri */ + readonly review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + readonly state: "open" | "closed"; + /** Format: uri */ + readonly statuses_url: string; + /** @description The title of the pull request. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; /** User */ - readonly sponsorable: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -86399,64 +78562,308 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; + }; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** push event */ + readonly "webhook-push": { + /** @description The SHA of the most recent commit on `ref` after the push. */ + readonly after: string; + readonly base_ref: components["schemas"]["webhooks_nullable_string"]; + /** @description The SHA of the most recent commit on `ref` before the push. */ + readonly before: string; + /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. */ + readonly commits: { + /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ + readonly added?: string[]; /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. + * Committer + * @description Metaproperties for Git author/committer information. */ - readonly tier: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; + readonly author: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ readonly name: string; - readonly node_id: string; + readonly username?: string; }; - }; - }; - /** sponsorship edited event */ - readonly "webhook-sponsorship-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly privacy_level?: { - /** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */ - readonly from: string; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly committer: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; }; - }; + /** @description Whether this commit is distinct from any that have been pushed before. */ + readonly distinct: boolean; + readonly id: string; + /** @description The commit message. */ + readonly message: string; + /** @description An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit. */ + readonly modified?: string[]; + /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */ + readonly removed?: string[]; + /** + * Format: date-time + * @description The ISO 8601 timestamp of the commit. + */ + readonly timestamp: string; + readonly tree_id: string; + /** + * Format: uri + * @description URL that points to the commit API resource. + */ + readonly url: string; + }[]; + /** @description URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. */ + readonly compare: string; + /** @description Whether this push created the `ref`. */ + readonly created: boolean; + /** @description Whether this push deleted the `ref`. */ + readonly deleted: boolean; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @description Whether this push was a force push of the `ref`. */ + readonly forced: boolean; + /** Commit */ + readonly head_commit: { + /** @description An array of files added in the commit. */ + readonly added?: string[]; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly author: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly committer: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + /** @description Whether this commit is distinct from any that have been pushed before. */ + readonly distinct: boolean; + readonly id: string; + /** @description The commit message. */ + readonly message: string; + /** @description An array of files modified by the commit. */ + readonly modified?: string[]; + /** @description An array of files removed in the commit. */ + readonly removed?: string[]; + /** + * Format: date-time + * @description The ISO 8601 timestamp of the commit. + */ + readonly timestamp: string; + readonly tree_id: string; + /** + * Format: uri + * @description URL that points to the commit API resource. + */ + readonly url: string; + } | null; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly sponsorship: { - readonly created_at: string; - readonly maintainer?: { - 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; - 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; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly pusher: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email?: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + /** @description The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. */ + readonly ref: string; + /** + * Repository + * @description A git repository + */ + readonly repository: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + readonly custom_properties?: { + readonly [key: string]: unknown; }; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; readonly node_id: string; - readonly privacy_level: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: string; /** User */ - readonly sponsor: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -86492,134 +78899,508 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - /** User */ - readonly sponsorable: { - /** 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 permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; + }; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + readonly "webhook-registry-package-published": { + /** @enum {string} */ + readonly action: "published"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly registry_package: { + readonly created_at: string | null; + readonly description: string | null; + readonly ecosystem: string; + readonly html_url: string; + readonly id: number; + readonly name: string; + readonly namespace: string; + readonly owner: { + 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; 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 package_type: string; + readonly package_version: { + readonly author?: { + 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; + 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 body?: string | Record; + readonly body_html?: string; + readonly container_metadata?: { + readonly labels?: Record; + readonly manifest?: Record; + readonly tag?: { + readonly digest?: string; + readonly name?: string; + }; + }; + readonly created_at?: string; + readonly description: string; + readonly docker_metadata?: { + readonly tags?: string[]; + }[]; + readonly draft?: boolean; + readonly html_url: string; + readonly id: number; + readonly installation_command: string; + readonly manifest?: string; + readonly metadata: { + readonly [key: string]: unknown; + }[]; + readonly name: string; + readonly npm_metadata?: { + readonly name?: string; + readonly version?: string; + readonly npm_user?: string; + readonly author?: (string | Record) | null; + readonly bugs?: (string | Record) | null; + readonly dependencies?: Record; + readonly dev_dependencies?: Record; + readonly peer_dependencies?: Record; + readonly optional_dependencies?: Record; + readonly description?: string; + readonly dist?: (string | Record) | null; + readonly git_head?: string; + readonly homepage?: string; + readonly license?: string; + readonly main?: string; + readonly repository?: (string | Record) | null; + readonly scripts?: Record; + readonly id?: string; + readonly node_version?: string; + readonly npm_version?: string; + readonly has_shrinkwrap?: boolean; + readonly maintainers?: string[]; + readonly contributors?: string[]; + readonly engines?: Record; + readonly keywords?: string[]; + readonly files?: string[]; + readonly bin?: Record; + readonly man?: Record; + readonly directories?: (string | Record) | null; + readonly os?: string[]; + readonly cpu?: string[]; + readonly readme?: string; + readonly installation_command?: string; + readonly release_id?: number; + readonly commit_oid?: string; + readonly published_via_actions?: boolean; + readonly deleted_by_id?: number; + } | null; + readonly nuget_metadata?: { + readonly id?: (string | Record | number) | null; + readonly name?: string; + readonly value?: boolean | string | number | { + readonly url?: string; + readonly branch?: string; + readonly commit?: string; + readonly type?: string; + }; + }[] | null; + readonly package_files: { + readonly content_type: string; + readonly created_at: string; + readonly download_url: string; + readonly id: number; + readonly md5: string | null; + readonly name: string; + readonly sha1: string | null; + readonly sha256: string | null; + readonly size: number; + readonly state: string | null; + readonly updated_at: string; + }[]; + readonly package_url: string; + readonly prerelease?: boolean; + readonly release?: { + readonly author?: { + 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; + 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 created_at?: string; + readonly draft?: boolean; + readonly html_url?: string; + readonly id?: number; + readonly name?: string | null; + readonly prerelease?: boolean; + readonly published_at?: string; + readonly tag_name?: string; + readonly target_commitish?: string; + readonly url?: string; + }; + readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + readonly summary: string; + readonly tag_name?: string; + readonly target_commitish?: string; + readonly target_oid?: string; + readonly updated_at?: string; + readonly version: string; + } | null; + readonly registry: { + readonly about_url?: 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 type?: string; readonly url?: string; + readonly vendor?: string; } | null; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - readonly tier: { + readonly updated_at: string | null; + }; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + readonly "webhook-registry-package-updated": { + /** @enum {string} */ + readonly action: "updated"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly registry_package: { + readonly created_at: string; + readonly description: unknown; + readonly ecosystem: string; + readonly html_url: string; + readonly id: number; + readonly name: string; + readonly namespace: string; + readonly owner: { + 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; + 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 package_type: string; + readonly package_version: { + readonly author: { + 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; + 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 body: string; + readonly body_html: string; readonly created_at: string; readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; + readonly docker_metadata?: ({ + readonly tags?: string[]; + } | null)[]; + readonly draft?: boolean; + readonly html_url: string; + readonly id: number; + readonly installation_command: string; + readonly manifest?: string; + readonly metadata: { + readonly [key: string]: unknown; + }[]; readonly name: string; - readonly node_id: string; + readonly package_files: { + readonly content_type?: string; + readonly created_at?: string; + readonly download_url?: string; + readonly id?: number; + readonly md5?: string | null; + readonly name?: string; + readonly sha1?: string | null; + readonly sha256?: string; + readonly size?: number; + readonly state?: string; + readonly updated_at?: string; + }[]; + readonly package_url: string; + readonly prerelease?: boolean; + readonly release?: { + readonly author: { + 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; + 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 created_at: string; + readonly draft: boolean; + readonly html_url: string; + readonly id: number; + readonly name: string; + readonly prerelease: boolean; + readonly published_at: string; + readonly tag_name: string; + readonly target_commitish: string; + readonly url: string; + }; + readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + readonly summary: string; + readonly tag_name?: string; + readonly target_commitish: string; + readonly target_oid: string; + readonly updated_at: string; + readonly version: string; }; + readonly registry: Record; + readonly updated_at: string; }; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** sponsorship pending_cancellation event */ - readonly "webhook-sponsorship-pending-cancellation": { + /** release created event */ + readonly "webhook-release-created": { /** @enum {string} */ - readonly action: "pending_cancellation"; - /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ - readonly effective_date?: string; + readonly action: "created"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly release: components["schemas"]["webhooks_release"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly sponsorship: { - readonly created_at: string; - readonly maintainer?: { - 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; - 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; + }; + /** release deleted event */ + readonly "webhook-release-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly release: components["schemas"]["webhooks_release"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** release edited event */ + readonly "webhook-release-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes: { + readonly body?: { + /** @description The previous version of the body if the action was `edited`. */ + readonly from: string; }; - readonly node_id: string; - readonly privacy_level: string; - /** User */ - readonly sponsor: { - /** 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; + readonly name?: { + /** @description The previous version of the name if the action was `edited`. */ + readonly from: string; + }; + readonly make_latest?: { + /** @description Whether this release was explicitly `edited` to be the latest. */ + readonly to: boolean; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly release: components["schemas"]["webhooks_release"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** release prereleased event */ + readonly "webhook-release-prereleased": { + /** @enum {string} */ + readonly action: "prereleased"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** + * Release + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. + */ + readonly release: { + readonly assets: ({ /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly browser_download_url: string; + readonly content_type: string; + /** Format: date-time */ + readonly created_at: string; + readonly download_count: number; + readonly id: number; + readonly label: string | null; + /** @description The file name of the asset. */ + readonly name: string; + readonly node_id: string; + readonly size: number; + /** + * @description State of the release asset. + * @enum {string} + */ + readonly state: "uploaded"; + /** Format: date-time */ + readonly updated_at: string; + /** User */ + readonly uploader?: { + /** 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; /** Format: uri */ - readonly url?: string; - } | null; + readonly url: string; + } | null)[]; + /** Format: uri */ + readonly assets_url: string; /** User */ - readonly sponsorable: { + readonly author: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -86655,222 +79436,422 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; + readonly body: string | null; + /** Format: date-time */ + readonly created_at: string | null; + /** Format: uri */ + readonly discussion_url?: string; + /** @description Whether the release is a draft or published */ + readonly draft: boolean; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly name: string | null; + readonly node_id: string; /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. + * @description Whether the release is identified as a prerelease or a full release. + * @enum {boolean} */ - readonly tier: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; - readonly name: string; - readonly node_id: string; + readonly prerelease: true; + /** Format: date-time */ + readonly published_at: string | null; + /** 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; }; + /** @description The name of the tag. */ + readonly tag_name: string; + /** Format: uri */ + readonly tarball_url: string | null; + /** @description Specifies the commitish value that determines where the Git tag is created from. */ + readonly target_commitish: string; + /** Format: uri-template */ + readonly upload_url: string; + /** Format: uri */ + readonly url: string; + /** Format: uri */ + readonly zipball_url: string | null; }; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; }; - /** sponsorship pending_tier_change event */ - readonly "webhook-sponsorship-pending-tier-change": { + /** release published event */ + readonly "webhook-release-published": { /** @enum {string} */ - readonly action: "pending_tier_change"; + readonly action: "published"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly release: components["schemas"]["webhooks_release_1"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** release released event */ + readonly "webhook-release-released": { + /** @enum {string} */ + readonly action: "released"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly release: components["schemas"]["webhooks_release"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** release unpublished event */ + readonly "webhook-release-unpublished": { + /** @enum {string} */ + readonly action: "unpublished"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly release: components["schemas"]["webhooks_release_1"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Repository advisory published event */ + readonly "webhook-repository-advisory-published": { + /** @enum {string} */ + readonly action: "published"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly repository_advisory: components["schemas"]["repository-advisory"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Repository advisory reported event */ + readonly "webhook-repository-advisory-reported": { + /** @enum {string} */ + readonly action: "reported"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly repository_advisory: components["schemas"]["repository-advisory"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** repository archived event */ + readonly "webhook-repository-archived": { + /** @enum {string} */ + readonly action: "archived"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository created event */ + readonly "webhook-repository-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository deleted event */ + readonly "webhook-repository-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_dispatch event */ + readonly "webhook-repository-dispatch-sample": { + /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + readonly action: string; + readonly branch: string; + /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + readonly client_payload: { + readonly [key: string]: unknown; + } | null; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository edited event */ + readonly "webhook-repository-edited": { + /** @enum {string} */ + readonly action: "edited"; readonly changes: { - readonly tier: { - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - readonly from: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; - readonly name: string; - readonly node_id: string; + readonly default_branch?: { + readonly from: string; + }; + readonly description?: { + readonly from: string | null; + }; + readonly homepage?: { + readonly from: string | null; + }; + readonly topics?: { + readonly from?: string[] | null; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_import event */ + readonly "webhook-repository-import": { + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + /** @enum {string} */ + readonly status: "success" | "cancelled" | "failure"; + }; + /** repository privatized event */ + readonly "webhook-repository-privatized": { + /** @enum {string} */ + readonly action: "privatized"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository publicized event */ + readonly "webhook-repository-publicized": { + /** @enum {string} */ + readonly action: "publicized"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository renamed event */ + readonly "webhook-repository-renamed": { + /** @enum {string} */ + readonly action: "renamed"; + readonly changes: { + readonly repository: { + readonly name: { + readonly from: string; }; }; }; - /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ - readonly effective_date?: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository ruleset created event */ + readonly "webhook-repository-ruleset-created": { + /** @enum {string} */ + readonly action: "created"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository_ruleset: components["schemas"]["repository-ruleset"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly sponsorship: { - readonly created_at: string; - readonly maintainer?: { - 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; - 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; + }; + /** repository ruleset deleted event */ + readonly "webhook-repository-ruleset-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository_ruleset: components["schemas"]["repository-ruleset"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository ruleset edited event */ + readonly "webhook-repository-ruleset-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository_ruleset: components["schemas"]["repository-ruleset"]; + readonly changes?: { + readonly name?: { + readonly from?: string; }; - readonly node_id: string; - readonly privacy_level: string; - /** User */ - readonly sponsor: { - /** 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; - /** User */ - readonly sponsorable: { - /** 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; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - readonly tier: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; - readonly name: string; - readonly node_id: string; + readonly enforcement?: { + readonly from?: string; + }; + readonly conditions?: { + readonly added?: components["schemas"]["repository-ruleset-conditions"][]; + readonly deleted?: components["schemas"]["repository-ruleset-conditions"][]; + readonly updated?: { + readonly condition?: components["schemas"]["repository-ruleset-conditions"]; + readonly changes?: { + readonly condition_type?: { + readonly from?: string; + }; + readonly target?: { + readonly from?: string; + }; + readonly include?: { + readonly from?: string[]; + }; + readonly exclude?: { + readonly from?: string[]; + }; + }; + }[]; + }; + readonly rules?: { + readonly added?: components["schemas"]["repository-rule"][]; + readonly deleted?: components["schemas"]["repository-rule"][]; + readonly updated?: { + readonly rule?: components["schemas"]["repository-rule"]; + readonly changes?: { + readonly configuration?: { + readonly from?: string; + }; + readonly rule_type?: { + readonly from?: string; + }; + readonly pattern?: { + readonly from?: string; + }; + }; + }[]; + }; + }; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository transferred event */ + readonly "webhook-repository-transferred": { + /** @enum {string} */ + readonly action: "transferred"; + readonly changes: { + readonly owner: { + readonly from: { + /** Organization */ + readonly organization?: { + /** Format: uri */ + readonly avatar_url: string; + readonly description: string | null; + /** Format: uri */ + readonly events_url: string; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url?: string; + readonly id: number; + /** Format: uri */ + readonly issues_url: string; + readonly login: string; + /** Format: uri-template */ + readonly members_url: string; + readonly node_id: string; + /** Format: uri-template */ + readonly public_members_url: string; + /** Format: uri */ + readonly repos_url: string; + /** Format: uri */ + 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; + 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 enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** sponsorship tier_changed event */ - readonly "webhook-sponsorship-tier-changed": { + /** repository unarchived event */ + readonly "webhook-repository-unarchived": { /** @enum {string} */ - readonly action: "tier_changed"; - readonly changes: { - readonly tier: { - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - readonly from: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; - readonly name: string; - readonly node_id: string; - }; - }; - }; + readonly action: "unarchived"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_vulnerability_alert create event */ + readonly "webhook-repository-vulnerability-alert-create": { + /** @enum {string} */ + readonly action: "create"; + readonly alert: components["schemas"]["webhooks_alert"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly sponsorship: { + }; + /** repository_vulnerability_alert dismiss event */ + readonly "webhook-repository-vulnerability-alert-dismiss": { + /** @enum {string} */ + readonly action: "dismiss"; + /** + * Repository Vulnerability Alert Alert + * @description The security alert of the vulnerable dependency. + */ + readonly alert: { + readonly affected_package_name: string; + readonly affected_range: string; readonly created_at: string; - readonly maintainer?: { - 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; - 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 node_id: string; - readonly privacy_level: string; + readonly dismiss_comment?: string | null; + readonly dismiss_reason: string; + readonly dismissed_at: string; /** User */ - readonly sponsor: { + readonly dismisser: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -86906,8 +79887,54 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; + readonly external_identifier: string; + /** Format: uri */ + readonly external_reference: string | null; + readonly fix_reason?: string; + /** Format: date-time */ + readonly fixed_at?: string; + readonly fixed_in?: string; + readonly ghsa_id: string; + readonly id: number; + readonly node_id: string; + readonly number: number; + readonly severity: string; + /** @enum {string} */ + readonly state: "dismissed"; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_vulnerability_alert reopen event */ + readonly "webhook-repository-vulnerability-alert-reopen": { + /** @enum {string} */ + readonly action: "reopen"; + readonly alert: components["schemas"]["webhooks_alert"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_vulnerability_alert resolve event */ + readonly "webhook-repository-vulnerability-alert-resolve": { + /** @enum {string} */ + readonly action: "resolve"; + /** + * Repository Vulnerability Alert Alert + * @description The security alert of the vulnerable dependency. + */ + readonly alert: { + readonly affected_package_name: string; + readonly affected_range: string; + readonly created_at: string; + readonly dismiss_reason?: string; + readonly dismissed_at?: string; /** User */ - readonly sponsorable: { + readonly dismisser?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -86943,22 +79970,255 @@ export type components = { /** Format: uri */ readonly url?: string; } | null; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - readonly tier: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; + readonly external_identifier: string; + /** Format: uri */ + readonly external_reference: string | null; + readonly fix_reason?: string; + /** Format: date-time */ + readonly fixed_at?: string; + readonly fixed_in?: string; + readonly ghsa_id: string; + readonly id: number; + readonly node_id: string; + readonly number: number; + readonly severity: string; + /** @enum {string} */ + readonly state: "fixed" | "open"; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert created event */ + readonly "webhook-secret-scanning-alert-created": { + /** @enum {string} */ + readonly action: "created"; + readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Secret Scanning Alert Location Created Event */ + readonly "webhook-secret-scanning-alert-location-created": { + /** @enum {string} */ + readonly action?: "created"; + readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly location: components["schemas"]["secret-scanning-location"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Secret Scanning Alert Location Created Event */ + readonly "webhook-secret-scanning-alert-location-created-form-encoded": { + /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ + readonly payload: string; + }; + /** secret_scanning_alert reopened event */ + readonly "webhook-secret-scanning-alert-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert resolved event */ + readonly "webhook-secret-scanning-alert-resolved": { + /** @enum {string} */ + readonly action: "resolved"; + readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert revoked event */ + readonly "webhook-secret-scanning-alert-revoked": { + /** @enum {string} */ + readonly action: "revoked"; + readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert validated event */ + readonly "webhook-secret-scanning-alert-validated": { + /** @enum {string} */ + readonly action: "validated"; + readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_advisory published event */ + readonly "webhook-security-advisory-published": { + /** @enum {string} */ + readonly action: "published"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly security_advisory: components["schemas"]["webhooks_security_advisory"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_advisory updated event */ + readonly "webhook-security-advisory-updated": { + /** @enum {string} */ + readonly action: "updated"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly security_advisory: components["schemas"]["webhooks_security_advisory"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_advisory withdrawn event */ + readonly "webhook-security-advisory-withdrawn": { + /** @enum {string} */ + readonly action: "withdrawn"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + /** @description The details of the security advisory, including summary, description, and severity. */ + readonly security_advisory: { + readonly cvss: { + readonly score: number; + readonly vector_string: string | null; + }; + readonly cwes: { + readonly cwe_id: string; readonly name: string; - readonly node_id: string; + }[]; + readonly description: string; + readonly ghsa_id: string; + readonly identifiers: { + readonly type: string; + readonly value: string; + }[]; + readonly published_at: string; + readonly references: { + /** Format: uri */ + readonly url: string; + }[]; + readonly severity: string; + readonly summary: string; + readonly updated_at: string; + readonly vulnerabilities: { + readonly first_patched_version: { + readonly identifier: string; + } | null; + readonly package: { + readonly ecosystem: string; + readonly name: string; + }; + readonly severity: string; + readonly vulnerable_version_range: string; + }[]; + readonly withdrawn_at: string; + }; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_and_analysis event */ + readonly "webhook-security-and-analysis": { + readonly changes: { + readonly from?: { + readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["full-repository"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sponsorship cancelled event */ + readonly "webhook-sponsorship-cancelled": { + /** @enum {string} */ + readonly action: "cancelled"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship created event */ + readonly "webhook-sponsorship-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship edited event */ + readonly "webhook-sponsorship-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes: { + readonly privacy_level?: { + /** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */ + readonly from: string; }; }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship pending_cancellation event */ + readonly "webhook-sponsorship-pending-cancellation": { + /** @enum {string} */ + readonly action: "pending_cancellation"; + readonly effective_date?: components["schemas"]["webhooks_effective_date"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship pending_tier_change event */ + readonly "webhook-sponsorship-pending-tier-change": { + /** @enum {string} */ + readonly action: "pending_tier_change"; + readonly changes: components["schemas"]["webhooks_changes_8"]; + readonly effective_date?: components["schemas"]["webhooks_effective_date"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship tier_changed event */ + readonly "webhook-sponsorship-tier-changed": { + /** @enum {string} */ + readonly action: "tier_changed"; + readonly changes: components["schemas"]["webhooks_changes_8"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ readonly "webhook-star-created": { @@ -87163,71 +80423,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }; + readonly team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ readonly "webhook-team-added-to-repository": { @@ -87476,71 +80672,7 @@ export type components = { readonly watchers_count: number; }; readonly sender?: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }; + readonly team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ readonly "webhook-team-created": { @@ -87789,71 +80921,7 @@ export type components = { readonly watchers_count: number; }; readonly sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }; + readonly team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ readonly "webhook-team-deleted": { @@ -88102,71 +81170,7 @@ export type components = { readonly watchers_count: number; }; readonly sender?: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }; + readonly team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ readonly "webhook-team-edited": { @@ -88446,71 +81450,7 @@ export type components = { readonly watchers_count: number; }; readonly sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }; + readonly team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ readonly "webhook-team-removed-from-repository": { @@ -88759,71 +81699,7 @@ export type components = { readonly watchers_count: number; }; readonly sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }; + readonly team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ readonly "webhook-watch-started": { @@ -89069,66 +81945,12 @@ export type components = { readonly runner_name: string | null; /** Format: date-time */ readonly started_at: string; - /** @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ - readonly head_branch: string | null; - /** @description The name of the workflow. */ - readonly workflow_name: string | null; - readonly steps: { - readonly completed_at: string | null; - /** @enum {string|null} */ - readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; - readonly name: string; - readonly number: number; - readonly started_at: string | null; - /** @enum {string} */ - readonly status: "completed" | "in_progress" | "queued" | "pending"; - }[]; - /** Format: uri */ - readonly url: string; - }; - readonly deployment?: components["schemas"]["deployment"]; - }; - /** workflow_job waiting event */ - readonly "webhook-workflow-job-waiting": { - /** @enum {string} */ - readonly action: "waiting"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly workflow_job: { - /** Format: uri */ - readonly check_run_url: string; - readonly completed_at: string | null; - readonly conclusion: string | null; - /** @description The time that the job created. */ - readonly created_at: string; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly labels: string[]; - readonly name: string; - readonly node_id: string; - readonly run_attempt: number; - readonly run_id: number; - /** Format: uri */ - readonly run_url: string; - readonly runner_group_id: number | null; - readonly runner_group_name: string | null; - readonly runner_id: number | null; - readonly runner_name: string | null; - /** Format: date-time */ - readonly started_at: string; + /** @enum {string} */ + readonly status: "queued" | "in_progress" | "completed" | "waiting"; /** @description The name of the current branch. */ readonly head_branch: string | null; /** @description The name of the workflow. */ readonly workflow_name: string | null; - /** @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting"; readonly steps: { readonly completed_at: string | null; /** @enum {string|null} */ @@ -89137,40 +81959,78 @@ export type components = { readonly number: number; readonly started_at: string | null; /** @enum {string} */ - readonly status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; + readonly status: "completed" | "in_progress" | "queued" | "pending"; }[]; /** Format: uri */ readonly url: string; }; readonly deployment?: components["schemas"]["deployment"]; }; - /** workflow_run completed event */ - readonly "webhook-workflow-run-completed": { + /** workflow_job waiting event */ + readonly "webhook-workflow-job-waiting": { /** @enum {string} */ - readonly action: "completed"; + readonly action: "waiting"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - readonly workflow: { + readonly workflow_job: { /** Format: uri */ - readonly badge_url: string; - /** Format: date-time */ + readonly check_run_url: string; + readonly completed_at: string | null; + readonly conclusion: string | null; + /** @description The time that the job created. */ readonly created_at: string; + readonly head_sha: string; /** Format: uri */ readonly html_url: string; readonly id: number; + readonly labels: string[]; readonly name: string; readonly node_id: string; - readonly path: string; - readonly state: string; + readonly run_attempt: number; + readonly run_id: number; + /** Format: uri */ + readonly run_url: string; + readonly runner_group_id: number | null; + readonly runner_group_name: string | null; + readonly runner_id: number | null; + readonly runner_name: string | null; /** Format: date-time */ - readonly updated_at: string; + readonly started_at: string; + /** @description The name of the current branch. */ + readonly head_branch: string | null; + /** @description The name of the workflow. */ + readonly workflow_name: string | null; + /** @enum {string} */ + readonly status: "queued" | "in_progress" | "completed" | "waiting"; + readonly steps: { + readonly completed_at: string | null; + /** @enum {string|null} */ + readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; + readonly name: string; + readonly number: number; + readonly started_at: string | null; + /** @enum {string} */ + readonly status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; + }[]; /** Format: uri */ readonly url: string; - } | null; + }; + readonly deployment?: components["schemas"]["deployment"]; + }; + /** workflow_run completed event */ + readonly "webhook-workflow-run-completed": { + /** @enum {string} */ + readonly action: "completed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly workflow: components["schemas"]["webhooks_workflow"]; + /** Workflow Run */ readonly workflow_run: { /** User */ readonly actor: { @@ -89218,7 +82078,7 @@ export type components = { /** Format: uri */ readonly check_suite_url: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; + readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out"; /** Format: date-time */ readonly created_at: string; readonly event: string; @@ -89395,7 +82255,7 @@ export type components = { readonly path: string; /** Format: uri */ readonly previous_attempt_url: string | null; - readonly pull_requests: { + readonly pull_requests: ({ readonly base: { readonly ref: string; /** Repo Ref */ @@ -89422,7 +82282,7 @@ export type components = { readonly number: number; /** Format: uri */ readonly url: string; - }[]; + } | null)[]; readonly referenced_workflows?: { readonly path: string; readonly ref?: string; @@ -89606,229 +82466,11 @@ export type components = { readonly workflow_id: number; /** Format: uri */ readonly workflow_url: string; - } & { - readonly actor?: { - 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; - 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 artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id?: number; - readonly check_suite_node_id?: string; - readonly check_suite_url?: string; - /** @enum {string} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped"; - readonly created_at?: string; - readonly event?: string; - readonly head_branch?: string | null; - readonly head_commit?: { - readonly author?: { - readonly email?: string; - readonly name?: string; - }; - readonly committer?: { - readonly email?: string; - readonly name?: string; - }; - readonly id?: string; - readonly message?: string; - readonly timestamp?: string; - readonly tree_id?: string; - }; - readonly head_repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha?: string; - readonly html_url?: string; - readonly id?: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name?: string | null; - readonly node_id?: string; - readonly path?: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests?: Record[]; - readonly referenced_workflows?: { - readonly path: string; - readonly ref?: string; - readonly sha: string; - }[] | null; - readonly repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt?: number; - readonly run_number?: number; - readonly run_started_at?: string; - readonly status?: string; - readonly triggering_actor?: { - 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; - 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; - } | null; - readonly updated_at?: string; - readonly url?: string; - readonly workflow_id?: number; - readonly workflow_url?: string; + /** + * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. + * @example Simple Workflow + */ + readonly display_title?: string; }; }; /** workflow_run in_progress event */ @@ -89840,24 +82482,8 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - readonly workflow: { - /** Format: uri */ - readonly badge_url: string; - /** Format: date-time */ - readonly created_at: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly state: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - } | null; + readonly workflow: components["schemas"]["webhooks_workflow"]; + /** Workflow Run */ readonly workflow_run: { /** User */ readonly actor: { @@ -89905,7 +82531,7 @@ export type components = { /** Format: uri */ readonly check_suite_url: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; + readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out"; /** Format: date-time */ readonly created_at: string; readonly event: string; @@ -90005,7 +82631,7 @@ export type components = { /** Format: uri-template */ readonly milestones_url: string; /** @description The name of the repository. */ - readonly name: string; + readonly name: string | null; readonly node_id: string; /** Format: uri-template */ readonly notifications_url: string; @@ -90082,7 +82708,7 @@ export type components = { readonly path: string; /** Format: uri */ readonly previous_attempt_url: string | null; - readonly pull_requests: { + readonly pull_requests: ({ readonly base: { readonly ref: string; /** Repo Ref */ @@ -90109,7 +82735,7 @@ export type components = { readonly number: number; /** Format: uri */ readonly url: string; - }[]; + } | null)[]; readonly referenced_workflows?: { readonly path: string; readonly ref?: string; @@ -90293,229 +82919,6 @@ export type components = { readonly workflow_id: number; /** Format: uri */ readonly workflow_url: string; - } & { - readonly actor?: { - 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; - 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 artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id?: number; - readonly check_suite_node_id?: string; - readonly check_suite_url?: string; - /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "skipped" | "stale"; - readonly created_at?: string; - readonly event?: string; - readonly head_branch?: string | null; - readonly head_commit?: { - readonly author?: { - readonly email?: string; - readonly name?: string; - }; - readonly committer?: { - readonly email?: string; - readonly name?: string; - }; - readonly id?: string; - readonly message?: string; - readonly timestamp?: string; - readonly tree_id?: string; - }; - readonly head_repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string | null; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha?: string; - readonly html_url?: string; - readonly id?: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name?: string | null; - readonly node_id?: string; - readonly path?: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests?: Record[]; - readonly referenced_workflows?: { - readonly path: string; - readonly ref?: string; - readonly sha: string; - }[] | null; - readonly repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt?: number; - readonly run_number?: number; - readonly run_started_at?: string; - readonly status?: string; - readonly triggering_actor?: { - 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; - 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 updated_at?: string; - readonly url?: string; - readonly workflow_id?: number; - readonly workflow_url?: string; }; }; /** workflow_run requested event */ @@ -90527,24 +82930,7 @@ export type components = { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - readonly workflow: { - /** Format: uri */ - readonly badge_url: string; - /** Format: date-time */ - readonly created_at: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly state: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - } | null; + readonly workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ readonly workflow_run: { /** User */ @@ -91057,6 +83443,15 @@ export type components = { readonly "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Internal Error */ + readonly internal_error: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Service unavailable */ readonly service_unavailable: { headers: { @@ -91142,15 +83537,6 @@ export type components = { }; }; }; - /** @description Internal Error */ - readonly internal_error: { - headers: { - readonly [name: string]: unknown; - }; - 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: { headers: { @@ -91235,22 +83621,31 @@ export type components = { readonly "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Unacceptable */ + readonly unacceptable: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["basic-error"]; + }; + }; }; parameters: { - /** @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. */ + /** @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 "pagination-before": string; - /** @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. */ + /** @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 "pagination-after": string; /** @description The direction to sort the results by. */ readonly direction: "asc" | "desc"; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ readonly ghsa_id: string; - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ readonly cursor: string; readonly "delivery-id": number; - /** @description Page number of the results to fetch. */ + /** @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: number; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since: string; @@ -91341,7 +83736,7 @@ export type components = { readonly "runner-label-name": string; /** @description The name of the secret. */ readonly "secret-name": string; - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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 "variables-per-page": number; /** @description The name of the variable. */ readonly "variable-name": string; @@ -91452,7 +83847,7 @@ export type components = { readonly "workflow-run-branch": string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ readonly event: string; - /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ + /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ readonly "workflow-run-status": "completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting" | "pending"; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ readonly created: string; @@ -91499,12 +83894,17 @@ export type components = { readonly "manifest-path": string; /** @description deployment_id parameter */ readonly "deployment-id": number; - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly "environment-name": string; /** @description The unique identifier of the branch policy. */ readonly "branch-policy-id": number; /** @description The unique identifier of the protection rule. */ readonly "protection-rule-id": number; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + readonly "git-ref-only": string; /** @description A user ID. Only return users with an ID greater than this ID. */ readonly "since-user": number; /** @description The number that identifies the issue. */ @@ -91513,6 +83913,8 @@ export type components = { readonly "key-id": number; /** @description The number that identifies the milestone. */ readonly "milestone-number": number; + /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + readonly "pages-deployment-id": number | string; /** @description The number that identifies the pull request. */ readonly "pull-number": number; /** @description The unique identifier of the review. */ @@ -91599,7 +84001,7 @@ export interface operations { /** @description If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned. */ readonly cve_id?: string; /** @description If specified, only advisories for these ecosystems will be returned. */ - readonly ecosystem?: "actions" | "composer" | "erlang" | "go" | "maven" | "npm" | "nuget" | "other" | "pip" | "pub" | "rubygems" | "rust"; + readonly ecosystem?: components["schemas"]["security-advisory-ecosystems"]; /** @description If specified, only advisories with these severities will be returned. */ readonly severity?: "unknown" | "low" | "medium" | "high" | "critical"; /** @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. @@ -91625,13 +84027,13 @@ export interface operations { * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ readonly modified?: string; - /** @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. */ + /** @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. */ + /** @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 The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 The property to sort the results by. */ readonly sort?: "updated" | "published"; @@ -91789,7 +84191,7 @@ export interface operations { readonly "apps/list-webhook-deliveries": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ readonly cursor?: components["parameters"]["cursor"]; @@ -91857,9 +84259,9 @@ export interface operations { readonly "apps/list-installation-requests-for-authenticated-app": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -91884,9 +84286,9 @@ export interface operations { readonly "apps/list-installations": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; @@ -92271,9 +84673,9 @@ export interface operations { readonly "classroom/list-accepted-assigments-for-an-assignment": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -92323,9 +84725,9 @@ export interface operations { readonly "classroom/list-classrooms": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -92372,9 +84774,9 @@ export interface operations { readonly "classroom/list-assignments-for-a-classroom": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -92465,6 +84867,42 @@ export interface operations { readonly 304: components["responses"]["not_modified"]; }; }; + readonly "copilot/usage-metrics-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 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"]["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 "dependabot/list-alerts-for-enterprise": { readonly parameters: { readonly query?: { @@ -92490,9 +84928,9 @@ export interface operations { readonly sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @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. */ + /** @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. */ + /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. @@ -92502,7 +84940,7 @@ export interface operations { * This parameter must not be used in combination with `first`. * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ readonly last?: components["parameters"]["pagination-last"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; readonly header?: never; @@ -92544,11 +84982,11 @@ export interface operations { readonly sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 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. */ + /** @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. */ + /** @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 validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ readonly validity?: components["parameters"]["secret-scanning-alert-validity"]; @@ -92579,9 +85017,9 @@ export interface operations { readonly "activity/list-public-events": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92629,9 +85067,9 @@ export interface operations { readonly query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92710,9 +85148,9 @@ export interface operations { readonly query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92741,9 +85179,9 @@ export interface operations { readonly query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92876,9 +85314,9 @@ export interface operations { readonly "gists/list-comments": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93036,9 +85474,9 @@ export interface operations { readonly "gists/list-commits": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93069,9 +85507,9 @@ export interface operations { readonly "gists/list-forks": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93281,9 +85719,9 @@ export interface operations { readonly "apps/list-repos-accessible-to-installation": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93349,9 +85787,9 @@ export interface operations { readonly orgs?: boolean; readonly owned?: boolean; readonly pulls?: boolean; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93379,9 +85817,9 @@ export interface operations { readonly parameters: { readonly query?: { readonly featured?: boolean; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93531,9 +85969,9 @@ export interface operations { readonly "apps/list-plans": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93563,9 +86001,9 @@ export interface operations { readonly sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ readonly direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93626,9 +86064,9 @@ export interface operations { readonly "apps/list-plans-stubbed": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93657,9 +86095,9 @@ export interface operations { readonly sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ readonly direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93708,9 +86146,9 @@ export interface operations { readonly "activity/list-public-events-for-repo-network": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93750,9 +86188,9 @@ export interface operations { readonly since?: components["parameters"]["since"]; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly before?: components["parameters"]["before"]; - /** @description Page number of the results to fetch. */ + /** @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 50). */ + /** @description The number of results per page (max 50). 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; @@ -93847,6 +86285,27 @@ export interface operations { readonly 403: components["responses"]["forbidden"]; }; }; + readonly "activity/mark-thread-as-done": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ + readonly thread_id: components["parameters"]["thread-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description No content */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; readonly "activity/mark-thread-as-read": { readonly parameters: { readonly query?: never; @@ -93984,7 +86443,7 @@ export interface operations { readonly query?: { /** @description An organization ID. Only return organizations with an ID greater than this ID. */ readonly since?: components["parameters"]["since-org"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; readonly header?: never; @@ -94073,7 +86532,7 @@ export interface operations { readonly location?: string; /** @description The shorthand name of the company. */ readonly name?: string; - /** @description The description of the company. */ + /** @description The description of the company. The maximum size is 160 characters. */ readonly description?: string; /** @description Whether an organization can use organization projects. */ readonly has_organization_projects?: boolean; @@ -94221,9 +86680,9 @@ export interface operations { readonly "actions/get-actions-cache-usage-by-repo-for-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -94356,9 +86815,9 @@ export interface operations { readonly "actions/list-selected-repositories-enabled-github-actions-organization": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -94559,9 +87018,9 @@ export interface operations { readonly query?: { /** @description The name of a self-hosted runner. */ readonly name?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -94850,9 +87309,9 @@ export interface operations { readonly "actions/list-org-secrets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95001,9 +87460,9 @@ export interface operations { readonly "actions/list-selected-repos-for-org-secret": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -95126,9 +87585,9 @@ export interface operations { readonly "actions/list-org-variables": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ + /** @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; @@ -95284,9 +87743,9 @@ export interface operations { readonly "actions/list-selected-repos-for-org-variable": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -95423,9 +87882,9 @@ export interface operations { readonly "orgs/list-blocked-users": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95534,13 +87993,13 @@ export interface operations { readonly tool_name?: components["parameters"]["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["parameters"]["tool-guid"]; - /** @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. */ + /** @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. */ + /** @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 Page number of the results to fetch. */ + /** @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). */ + /** @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 direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; @@ -95577,9 +88036,9 @@ export interface operations { readonly "codespaces/list-in-organization": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95735,9 +88194,9 @@ export interface operations { readonly "codespaces/list-org-secrets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95890,9 +88349,9 @@ export interface operations { readonly "codespaces/list-selected-repos-for-org-secret": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -96049,15 +88508,22 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; + /** @description There is a problem with your account's associated payment method. */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; readonly 500: components["responses"]["internal_error"]; }; }; readonly "copilot/list-copilot-seats": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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; }; readonly header?: never; @@ -96077,7 +88543,7 @@ export interface operations { }; content: { readonly "application/json": { - /** @description Total number of Copilot For Business seats for the organization currently being billed. */ + /** @description Total number of Copilot seats for the organization currently being billed. */ readonly total_seats?: number; readonly seats?: components["schemas"]["copilot-seat-details"][]; }; @@ -96089,7 +88555,7 @@ export interface operations { readonly 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/add-copilot-for-business-seats-for-teams": { + readonly "copilot/add-copilot-seats-for-teams": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -96122,7 +88588,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -96165,7 +88631,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -96175,7 +88641,7 @@ export interface operations { readonly 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/add-copilot-for-business-seats-for-users": { + readonly "copilot/add-copilot-seats-for-users": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -96208,7 +88674,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -96251,7 +88717,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -96261,6 +88727,42 @@ export interface operations { readonly 500: components["responses"]["internal_error"]; }; }; + readonly "copilot/usage-metrics-for-org": { + 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 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 [name: string]: unknown; + }; + content: { + readonly "application/json": 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 "dependabot/list-alerts-for-org": { readonly parameters: { readonly query?: { @@ -96286,9 +88788,9 @@ export interface operations { readonly sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @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. */ + /** @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. */ + /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. @@ -96298,7 +88800,7 @@ export interface operations { * This parameter must not be used in combination with `first`. * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ readonly last?: components["parameters"]["pagination-last"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; readonly header?: never; @@ -96329,9 +88831,9 @@ export interface operations { readonly "dependabot/list-org-secrets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96480,9 +88982,9 @@ export interface operations { readonly "dependabot/list-selected-repos-for-org-secret": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -96630,9 +89132,9 @@ export interface operations { readonly "activity/list-public-org-events": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96658,9 +89160,9 @@ export interface operations { readonly "orgs/list-failed-invitations": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96688,9 +89190,9 @@ export interface operations { readonly "orgs/list-webhooks": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96937,7 +89439,7 @@ export interface operations { readonly "orgs/list-webhook-deliveries": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ readonly cursor?: components["parameters"]["cursor"]; @@ -97065,9 +89567,9 @@ export interface operations { readonly "orgs/list-app-installations": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97169,9 +89671,9 @@ export interface operations { readonly "orgs/list-pending-invitations": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Filter invitations by their member role. */ readonly role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager"; @@ -97222,10 +89724,11 @@ export interface operations { * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. * @default direct_member * @enum {string} */ - readonly role: "admin" | "direct_member" | "billing_manager"; + readonly role: "admin" | "direct_member" | "billing_manager" | "reinstate"; /** @description Specify IDs for the teams you want to invite new members to. */ readonly team_ids?: number[]; }; @@ -97273,9 +89776,9 @@ export interface operations { readonly "orgs/list-invitation-teams": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97317,9 +89820,9 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97351,9 +89854,9 @@ export interface operations { readonly filter?: "2fa_disabled" | "all"; /** @description Filter members returned by their role. */ readonly role?: "all" | "admin" | "member"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97444,9 +89947,9 @@ export interface operations { readonly "codespaces/get-codespaces-for-user-in-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97561,7 +90064,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization or the user has a pending organization invitation. */ + /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -97666,9 +90169,9 @@ export interface operations { readonly "migrations/list-for-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Exclude attributes from the API response to improve performance */ readonly exclude?: "repositories"[]; @@ -97877,9 +90380,9 @@ export interface operations { readonly "migrations/list-repos-for-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98264,9 +90767,9 @@ export interface operations { readonly "orgs/list-org-role-teams": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98309,9 +90812,9 @@ export interface operations { readonly "orgs/list-org-role-users": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98356,9 +90859,9 @@ export interface operations { readonly query?: { /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ readonly filter?: "2fa_disabled" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98477,9 +90980,9 @@ export interface operations { * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ readonly visibility?: components["parameters"]["package-visibility"]; - /** @description Page number of the results to fetch. */ + /** @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?: number; - /** @description The number of results per page (max 100). */ + /** @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; }; readonly header?: never; @@ -98594,9 +91097,9 @@ export interface operations { readonly "packages/get-all-package-versions-for-package-owned-by-org": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 state of the package, either active or deleted. */ readonly state?: "active" | "deleted"; @@ -98720,9 +91223,9 @@ export interface operations { readonly "orgs/list-pat-grant-requests": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 property by which to sort the results. */ readonly sort?: components["parameters"]["personal-access-token-sort"]; @@ -98833,9 +91336,9 @@ export interface operations { readonly "orgs/list-pat-grant-request-repositories": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98867,9 +91370,9 @@ export interface operations { readonly "orgs/list-pat-grants": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 property by which to sort the results. */ readonly sort?: components["parameters"]["personal-access-token-sort"]; @@ -98976,9 +91479,9 @@ export interface operations { readonly "orgs/list-pat-grant-repositories": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99012,9 +91515,9 @@ export interface operations { readonly query?: { /** @description Indicates the state of the projects to return. */ readonly state?: "open" | "closed" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99184,10 +91687,11 @@ export interface operations { /** @description Whether the property is required. */ readonly required?: boolean; /** @description Default value of the property */ - readonly default_value?: string | null; + readonly default_value?: (string | string[]) | null; /** @description Short description of the property */ readonly description?: string | null; - /** @description Ordered list of allowed values of the property */ + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ readonly allowed_values?: string[] | null; }; }; @@ -99228,9 +91732,9 @@ export interface operations { readonly "orgs/list-custom-properties-values-for-repos": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ readonly repository_query?: string; @@ -99288,14 +91792,15 @@ export interface operations { }; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; }; }; readonly "orgs/list-public-members": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99405,9 +91910,9 @@ export interface operations { readonly sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ readonly direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99578,7 +92083,7 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository"]; + readonly "application/json": components["schemas"]["full-repository"]; }; }; readonly 403: components["responses"]["forbidden"]; @@ -99588,9 +92093,9 @@ export interface operations { readonly "repos/get-org-rulesets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99632,10 +92137,12 @@ export interface operations { /** @description The name of the ruleset. */ readonly name: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - readonly target?: "branch" | "tag"; + readonly target?: "branch" | "tag" | "push"; readonly enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -99672,9 +92179,9 @@ export interface operations { readonly actor_name?: components["parameters"]["actor-name-in-query"]; /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ readonly rule_suite_result?: components["parameters"]["rule-suite-result"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99775,10 +92282,12 @@ export interface operations { /** @description The name of the ruleset. */ readonly name?: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - readonly target?: "branch" | "tag"; + readonly target?: "branch" | "tag" | "push"; readonly enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -99842,9 +92351,9 @@ export interface operations { readonly sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ readonly before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; @@ -99883,11 +92392,11 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ readonly sort?: "created" | "updated" | "published"; - /** @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. */ + /** @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. */ + /** @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 The number of advisories to return per page. */ + /** @description The number of advisories to return per page. 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 Filter by the state of the repository advisories. Only advisories of this state will be returned. */ readonly state?: "triage" | "draft" | "published" | "closed"; @@ -100059,12 +92568,50 @@ export interface operations { }; }; }; + readonly "copilot/usage-metrics-for-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 organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @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": 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 "teams/list": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100280,9 +92827,9 @@ export interface operations { readonly query?: { /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Pinned discussions only filter */ readonly pinned?: string; @@ -100442,9 +92989,9 @@ export interface operations { readonly query?: { /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100603,9 +93150,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100717,9 +93264,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100823,9 +93370,9 @@ export interface operations { readonly "teams/list-pending-invitations-in-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100856,9 +93403,9 @@ export interface operations { readonly query?: { /** @description Filters members returned by their role in the team. */ readonly role?: "member" | "maintainer" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101005,9 +93552,9 @@ export interface operations { readonly "teams/list-projects-in-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101085,7 +93632,7 @@ export interface operations { readonly content: { readonly "application/json": { /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * @enum {string} */ readonly permission?: "read" | "write" | "admin"; @@ -101142,9 +93689,9 @@ export interface operations { readonly "teams/list-repos-in-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101280,9 +93827,9 @@ export interface operations { readonly "teams/list-child-in-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101629,9 +94176,9 @@ export interface operations { readonly query?: { /** @description Filters the project cards that are returned by the card's state. */ readonly archived_state?: "all" | "archived" | "not_archived"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101911,9 +94458,9 @@ export interface operations { readonly query?: { /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ readonly affiliation?: "outside" | "direct" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -102043,9 +94590,9 @@ export interface operations { readonly "projects/list-columns": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -102385,9 +94932,9 @@ export interface operations { readonly "actions/list-artifacts-for-repo": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 name field of an artifact. When specified, only artifacts with this name will be returned. */ readonly name?: components["parameters"]["artifact-name"]; @@ -102526,9 +95073,9 @@ export interface operations { readonly "actions/get-actions-cache-list": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ readonly ref?: components["parameters"]["actions-cache-git-ref-full"]; @@ -102776,9 +95323,9 @@ export interface operations { readonly "actions/list-repo-organization-secrets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -102810,9 +95357,9 @@ export interface operations { readonly "actions/list-repo-organization-variables": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ + /** @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; @@ -103064,9 +95611,9 @@ export interface operations { readonly query?: { /** @description The name of a self-hosted runner. */ readonly name?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -103385,11 +95932,11 @@ export interface operations { readonly branch?: components["parameters"]["workflow-run-branch"]; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ readonly event?: components["parameters"]["event"]; - /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ + /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ readonly status?: components["parameters"]["workflow-run-status"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ readonly created?: components["parameters"]["created"]; @@ -103540,9 +96087,9 @@ export interface operations { readonly "actions/list-workflow-run-artifacts": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 name field of an artifact. When specified, only artifacts with this name will be returned. */ readonly name?: components["parameters"]["artifact-name"]; @@ -103610,9 +96157,9 @@ export interface operations { readonly "actions/list-jobs-for-workflow-run-attempt": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -103765,9 +96312,9 @@ export interface operations { readonly query?: { /** @description Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run. */ readonly filter?: "latest" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104034,9 +96581,9 @@ export interface operations { readonly "actions/list-repo-secrets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104188,9 +96735,9 @@ export interface operations { readonly "actions/list-repo-variables": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ + /** @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; @@ -104342,9 +96889,9 @@ export interface operations { readonly "actions/list-repo-workflows": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104495,11 +97042,11 @@ export interface operations { readonly branch?: components["parameters"]["workflow-run-branch"]; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ readonly event?: components["parameters"]["event"]; - /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ + /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ readonly status?: components["parameters"]["workflow-run-status"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ readonly created?: components["parameters"]["created"]; @@ -104570,11 +97117,11 @@ export interface operations { readonly query?: { /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 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. */ + /** @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. */ + /** @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 The Git reference for the activities you want to list. * @@ -104618,9 +97165,9 @@ export interface operations { readonly "issues/list-assignees": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104682,10 +97229,7 @@ export interface operations { }; readonly "repos/list-autolinks": { readonly parameters: { - readonly query?: { - /** @description Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; + readonly query?: never; readonly header?: never; readonly path: { /** @description The account owner of the repository. The name is not case sensitive. */ @@ -104887,9 +97431,9 @@ export interface operations { readonly query?: { /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ readonly protected?: boolean; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -106144,11 +98688,11 @@ export interface operations { /** @description A reference for the run on the integrator's system. */ readonly external_id?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @default queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed"; + readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. @@ -106295,10 +98839,10 @@ export interface operations { */ readonly started_at?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - readonly status?: "queued" | "in_progress" | "completed"; + readonly status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. @@ -106387,9 +98931,9 @@ export interface operations { readonly "checks/list-annotations": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -106580,9 +99124,9 @@ export interface operations { readonly status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ readonly filter?: "latest" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -106647,9 +99191,9 @@ export interface operations { readonly tool_name?: components["parameters"]["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["parameters"]["tool-guid"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ readonly ref?: components["parameters"]["git-ref"]; @@ -106760,9 +99304,9 @@ export interface operations { readonly "code-scanning/list-alert-instances": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ readonly ref?: components["parameters"]["git-ref"]; @@ -106801,9 +99345,9 @@ export interface operations { readonly tool_name?: components["parameters"]["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["parameters"]["tool-guid"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ readonly ref?: components["schemas"]["code-scanning-ref"]; @@ -107176,9 +99720,9 @@ export interface operations { readonly "codespaces/list-in-repository-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107282,9 +99826,9 @@ export interface operations { readonly "codespaces/list-devcontainers-in-repository-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107438,9 +99982,9 @@ export interface operations { readonly "codespaces/list-repo-secrets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107596,9 +100140,9 @@ export interface operations { readonly affiliation?: "outside" | "direct" | "all"; /** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */ readonly permission?: "pull" | "triage" | "push" | "maintain" | "admin"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107764,9 +100308,9 @@ export interface operations { readonly "repos/list-commit-comments-for-repo": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107886,9 +100430,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108006,9 +100550,9 @@ export interface operations { readonly since?: components["parameters"]["since"]; /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly until?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108063,15 +100607,16 @@ export interface operations { readonly "application/json": components["schemas"]["branch-short"][]; }; }; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; readonly "repos/list-comments-for-commit": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108146,9 +100691,9 @@ export interface operations { readonly "repos/list-pull-requests-associated-with-commit": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108174,14 +100719,15 @@ export interface operations { readonly "application/json": components["schemas"]["pull-request-simple"][]; }; }; + readonly 409: components["responses"]["conflict"]; }; }; readonly "repos/get-commit": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -108207,6 +100753,7 @@ export interface operations { }; }; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; readonly 500: components["responses"]["internal_error"]; readonly 503: components["responses"]["service_unavailable"]; @@ -108221,9 +100768,9 @@ export interface operations { readonly status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ readonly filter?: "latest" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 app_id?: number; }; @@ -108265,9 +100812,9 @@ export interface operations { readonly app_id?: number; /** @description Returns check runs with the specified `name`. */ readonly check_name?: components["parameters"]["check-name"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108301,9 +100848,9 @@ export interface operations { readonly "repos/get-combined-status-for-ref": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108334,9 +100881,9 @@ export interface operations { readonly "repos/list-commit-statuses-for-ref": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108393,9 +100940,9 @@ export interface operations { readonly "repos/compare-commits": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -108590,9 +101137,9 @@ export interface operations { readonly query?: { /** @description Set to `1` or `true` to include anonymous contributors in results. */ readonly anon?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108661,12 +101208,12 @@ export interface operations { readonly page?: number; /** * @deprecated - * @description The number of results per page (max 100). + * @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. */ + /** @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. */ + /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. @@ -108793,9 +101340,9 @@ export interface operations { readonly "dependabot/list-repo-secrets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109054,9 +101601,9 @@ export interface operations { readonly task?: string; /** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */ readonly environment?: string | null; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109223,9 +101770,9 @@ export interface operations { readonly "repos/list-deployment-statuses": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109379,15 +101926,16 @@ export interface operations { }; content?: never; }; + readonly 404: components["responses"]["not_found"]; readonly 422: components["responses"]["validation_failed"]; }; }; readonly "repos/get-all-environments": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109428,7 +101976,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; }; readonly cookie?: never; @@ -109455,7 +102003,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; }; readonly cookie?: never; @@ -109508,7 +102056,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; }; readonly cookie?: never; @@ -109527,9 +102075,9 @@ export interface operations { readonly "repos/list-deployment-branch-policies": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109538,7 +102086,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; }; readonly cookie?: never; @@ -109572,7 +102120,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; }; readonly cookie?: never; @@ -109617,7 +102165,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ readonly branch_policy_id: components["parameters"]["branch-policy-id"]; @@ -109646,7 +102194,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ readonly branch_policy_id: components["parameters"]["branch-policy-id"]; @@ -109679,7 +102227,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ readonly branch_policy_id: components["parameters"]["branch-policy-id"]; @@ -109702,7 +102250,7 @@ export interface operations { readonly query?: never; readonly header?: never; readonly path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ readonly repo: components["parameters"]["repo"]; @@ -109736,7 +102284,7 @@ export interface operations { readonly query?: never; readonly header?: never; readonly path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ readonly repo: components["parameters"]["repo"]; @@ -109768,14 +102316,14 @@ export interface operations { readonly "repos/list-custom-deployment-rule-integrations": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; readonly path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ readonly repo: components["parameters"]["repo"]; @@ -109813,7 +102361,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the protection rule. */ readonly protection_rule_id: components["parameters"]["protection-rule-id"]; @@ -109838,7 +102386,7 @@ export interface operations { readonly query?: never; readonly header?: never; readonly path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ readonly repo: components["parameters"]["repo"]; @@ -109860,12 +102408,340 @@ export interface operations { }; }; }; + readonly "actions/list-environment-secrets": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + }; + 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 secrets: components["schemas"]["actions-secret"][]; + }; + }; + }; + }; + }; + readonly "actions/get-environment-public-key": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + readonly "actions/get-environment-secret": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ + readonly secret_name: components["parameters"]["secret-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-secret"]; + }; + }; + }; + }; + readonly "actions/create-or-update-environment-secret": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ + readonly secret_name: components["parameters"]["secret-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + readonly encrypted_value: string; + /** @description ID of the key you used to encrypt the secret. */ + readonly key_id: string; + }; + }; + }; + readonly responses: { + /** @description Response when creating a secret */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response when updating a secret */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/delete-environment-secret": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ + readonly secret_name: components["parameters"]["secret-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Default response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/list-environment-variables": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 30). 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"]["variables-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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + }; + 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 variables: components["schemas"]["actions-variable"][]; + }; + }; + }; + }; + }; + readonly "actions/create-environment-variable": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the variable. */ + readonly name: string; + /** @description The value of the variable. */ + readonly value: string; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["empty-object"]; + }; + }; + }; + }; + readonly "actions/get-environment-variable": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + /** @description The name of the variable. */ + readonly name: components["parameters"]["variable-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-variable"]; + }; + }; + }; + }; + readonly "actions/delete-environment-variable": { + 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 name of the variable. */ + readonly name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/update-environment-variable": { + 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 name of the variable. */ + readonly name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the variable. */ + readonly name?: string; + /** @description The value of the variable. */ + readonly value?: string; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; readonly "activity/list-repo-events": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109895,9 +102771,9 @@ export interface operations { readonly query?: { /** @description The sort order. `stargazers` will sort by star count. */ readonly sort?: "newest" | "oldest" | "stargazers" | "watchers"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -110033,6 +102909,7 @@ export interface operations { }; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -110099,6 +102976,7 @@ export interface operations { }; }; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -110128,6 +103006,7 @@ export interface operations { }; }; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; }; }; readonly "git/list-matching-refs": { @@ -110139,8 +103018,11 @@ export interface operations { 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 commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + readonly ref: components["parameters"]["git-ref-only"]; }; readonly cookie?: never; }; @@ -110156,6 +103038,7 @@ export interface operations { readonly "application/json": components["schemas"]["git-ref"][]; }; }; + readonly 409: components["responses"]["conflict"]; }; }; readonly "git/get-ref": { @@ -110167,8 +103050,11 @@ export interface operations { 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 commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + readonly ref: components["parameters"]["git-ref-only"]; }; readonly cookie?: never; }; @@ -110184,6 +103070,7 @@ export interface operations { }; }; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; }; }; readonly "git/create-ref": { @@ -110220,6 +103107,7 @@ export interface operations { readonly "application/json": components["schemas"]["git-ref"]; }; }; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -110232,8 +103120,11 @@ export interface operations { 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 commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + readonly ref: components["parameters"]["git-ref-only"]; }; readonly cookie?: never; }; @@ -110246,6 +103137,7 @@ export interface operations { }; content?: never; }; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -110259,10 +103151,10 @@ export interface operations { /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ readonly repo: components["parameters"]["repo"]; /** - * @description The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. - * @example heads/featureA + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a */ - readonly ref: string; + readonly ref: components["parameters"]["git-ref-only"]; }; readonly cookie?: never; }; @@ -110289,6 +103181,7 @@ export interface operations { readonly "application/json": components["schemas"]["git-ref"]; }; }; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -110345,6 +103238,7 @@ export interface operations { readonly "application/json": components["schemas"]["git-tag"]; }; }; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -110373,6 +103267,7 @@ export interface operations { }; }; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; }; }; readonly "git/create-tree": { @@ -110434,6 +103329,7 @@ export interface operations { }; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -110466,15 +103362,16 @@ export interface operations { }; }; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; readonly "repos/list-webhooks": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -110524,10 +103421,6 @@ export interface operations { readonly content_type?: components["schemas"]["webhook-config-content-type"]; readonly secret?: components["schemas"]["webhook-config-secret"]; readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - /** @example "abc" */ - readonly token?: string; - /** @example "sha256" */ - readonly digest?: string; }; /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. @@ -110632,17 +103525,7 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Key/value pairs to provide settings for this webhook. */ - readonly config?: { - readonly url: components["schemas"]["webhook-config-url"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - /** @example "bar@example.com" */ - readonly address?: string; - /** @example "The Serious Room" */ - readonly room?: string; - }; + readonly config?: components["schemas"]["webhook-config"]; /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ @@ -110742,7 +103625,7 @@ export interface operations { readonly "repos/list-webhook-deliveries": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ readonly cursor?: components["parameters"]["cursor"]; @@ -111275,9 +104158,9 @@ export interface operations { readonly "repos/list-invitations": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111386,9 +104269,9 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111480,9 +104363,9 @@ export interface operations { readonly direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111603,9 +104486,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111711,9 +104594,9 @@ export interface operations { readonly "issues/list-events-for-repo": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111973,9 +104856,9 @@ export interface operations { readonly query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112048,9 +104931,9 @@ export interface operations { readonly "issues/list-events": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112082,9 +104965,9 @@ export interface operations { readonly "issues/list-labels-on-issue": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112337,9 +105220,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112446,9 +105329,9 @@ export interface operations { readonly "issues/list-events-for-timeline": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112481,9 +105364,9 @@ export interface operations { readonly "repos/list-deploy-keys": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112606,9 +105489,9 @@ export interface operations { readonly "issues/list-labels-for-repo": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112790,7 +105673,10 @@ export interface operations { }; readonly "licenses/get-for-repo": { readonly parameters: { - readonly query?: never; + readonly query?: { + /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ + readonly ref?: components["parameters"]["git-ref"]; + }; readonly header?: never; readonly path: { /** @description The account owner of the repository. The name is not case sensitive. */ @@ -112928,9 +105814,9 @@ export interface operations { readonly sort?: "due_on" | "completeness"; /** @description The direction of the sort. Either `asc` or `desc`. */ readonly direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113110,9 +105996,9 @@ export interface operations { readonly "issues/list-labels-for-milestone": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113151,9 +106037,234 @@ export interface operations { readonly since?: components["parameters"]["since"]; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly before?: components["parameters"]["before"]; - /** @description The number of results per page (max 100). */ + /** @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"]; + }; + 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": components["schemas"]["thread"][]; + }; + }; + }; + }; + readonly "activity/mark-repo-notifications-as-read": { + 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?: { + readonly content: { + readonly "application/json": { + /** + * Format: date-time + * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + readonly last_read_at?: string; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 202: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly message?: string; + readonly url?: string; + }; + }; + }; + /** @description Reset Content */ + readonly 205: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "repos/get-pages": { + 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"]["page"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "repos/update-information-about-pages-site": { + 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: { + readonly content: { + readonly "application/json": { + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ + readonly cname?: string | null; + /** @description Specify whether HTTPS should be enforced for the repository. */ + readonly https_enforced?: boolean; + /** + * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch. + * @enum {string} + */ + readonly build_type?: "legacy" | "workflow"; + readonly source?: ("gh-pages" | "master" | "master /docs") | { + /** @description The repository branch used to publish your site's source files. */ + readonly branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. + * @enum {string} + */ + readonly path: "/" | "/docs"; + }; + } | unknown | unknown | unknown | unknown | unknown; + }; + }; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 400: components["responses"]["bad_request"]; + readonly 409: components["responses"]["conflict"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "repos/create-pages-site": { + 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: { + readonly content: { + readonly "application/json": ({ + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + readonly build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + readonly source?: { + /** @description The repository branch used to publish your site's source files. */ + readonly branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + readonly path: "/" | "/docs"; + }; + } | unknown | unknown) | null; + }; + }; + readonly responses: { + /** @description Response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["page"]; + }; + }; + readonly 409: components["responses"]["conflict"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "repos/delete-pages-site": { + 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 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "repos/list-pages-builds": { + 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 Page number of the results to fetch. */ + /** @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; @@ -113174,12 +106285,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["thread"][]; + readonly "application/json": components["schemas"]["page-build"][]; }; }; }; }; - readonly "activity/mark-repo-notifications-as-read": { + readonly "repos/request-pages-build": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -113191,40 +106302,20 @@ export interface operations { }; readonly cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** - * Format: date-time - * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. - */ - readonly last_read_at?: string; - }; - }; - }; + readonly requestBody?: never; readonly responses: { /** @description Response */ - readonly 202: { + readonly 201: { headers: { readonly [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; - readonly url?: string; - }; - }; - }; - /** @description Reset Content */ - readonly 205: { - headers: { - readonly [name: string]: unknown; + readonly "application/json": components["schemas"]["page-build-status"]; }; - content?: never; }; }; }; - readonly "repos/get-pages": { + readonly "repos/get-latest-pages-build": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -113244,13 +106335,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page"]; + readonly "application/json": components["schemas"]["page-build"]; }; }; - readonly 404: components["responses"]["not_found"]; }; }; - readonly "repos/update-information-about-pages-site": { + readonly "repos/get-pages-build": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -113259,47 +106349,24 @@ export interface operations { 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 build_id: number; }; readonly cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ - readonly cname?: string | null; - /** @description Specify whether HTTPS should be enforced for the repository. */ - readonly https_enforced?: boolean; - /** - * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch. - * @enum {string} - */ - readonly build_type?: "legacy" | "workflow"; - readonly source?: ("gh-pages" | "master" | "master /docs") | { - /** @description The repository branch used to publish your site's source files. */ - readonly branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. - * @enum {string} - */ - readonly path: "/" | "/docs"; - }; - } | unknown | unknown | unknown | unknown | unknown; - }; - }; + readonly requestBody?: never; readonly responses: { /** @description Response */ - readonly 204: { + readonly 200: { headers: { readonly [name: string]: unknown; }; - content?: never; + content: { + readonly "application/json": components["schemas"]["page-build"]; + }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/create-pages-site": { + readonly "repos/create-pages-deployment": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -113313,80 +106380,52 @@ export interface operations { }; readonly requestBody: { readonly content: { - readonly "application/json": ({ + readonly "application/json": { + /** @description The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */ + readonly artifact_id?: number; + /** @description The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */ + readonly artifact_url?: string; /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} + * @description The target environment for this GitHub Pages deployment. + * @default github-pages */ - readonly build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - readonly source?: { - /** @description The repository branch used to publish your site's source files. */ - readonly branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - readonly path: "/" | "/docs"; - }; - } | unknown | unknown) | null; + readonly environment: string; + /** + * @description A unique string that represents the version of the build for this deployment. + * @default GITHUB_SHA + */ + readonly pages_build_version: string; + /** @description The OIDC token issued by GitHub Actions certifying the origin of the deployment. */ + readonly oidc_token: string; + }; }; }; readonly responses: { /** @description Response */ - readonly 201: { + readonly 200: { headers: { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page"]; - }; - }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "repos/delete-pages-site": { - 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 204: { - headers: { - readonly [name: string]: unknown; + readonly "application/json": components["schemas"]["page-deployment"]; }; - content?: never; }; + readonly 400: components["responses"]["bad_request"]; readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-pages-builds": { + readonly "repos/get-pages-deployment": { readonly parameters: { - readonly query?: { - /** @description The number of results per page (max 100). */ - readonly per_page?: components["parameters"]["per-page"]; - /** @description Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; + 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 ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + readonly pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; readonly cookie?: never; }; @@ -113395,16 +106434,16 @@ export interface operations { /** @description Response */ readonly 200: { headers: { - readonly Link: components["headers"]["link"]; readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page-build"][]; + readonly "application/json": components["schemas"]["pages-deployment-status"]; }; }; + readonly 404: components["responses"]["not_found"]; }; }; - readonly "repos/request-pages-build": { + readonly "repos/cancel-pages-deployment": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -113413,23 +106452,18 @@ export interface operations { 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 ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + readonly pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["page-build-status"]; - }; - }; + readonly 204: components["responses"]["no_content"]; + readonly 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-latest-pages-build": { + readonly "repos/get-pages-health-check": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -113449,85 +106483,36 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page-build"]; + readonly "application/json": components["schemas"]["pages-health-check"]; }; }; - }; - }; - readonly "repos/get-pages-build": { - 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 build_id: number; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { + /** @description Empty response */ + readonly 202: { headers: { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page-build"]; + readonly "application/json": components["schemas"]["empty-object"]; }; }; - }; - }; - readonly "repos/create-pages-deployment": { - 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: { - readonly content: { - readonly "application/json": { - /** @description The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. */ - readonly artifact_url: string; - /** - * @description The target environment for this GitHub Pages deployment. - * @default github-pages - */ - readonly environment: string; - /** - * @description A unique string that represents the version of the build for this deployment. - * @default GITHUB_SHA - */ - readonly pages_build_version: string; - /** @description The OIDC token issued by GitHub Actions certifying the origin of the deployment. */ - readonly oidc_token: string; + /** @description Custom domains are not available for GitHub Pages */ + readonly 400: { + headers: { + readonly [name: string]: unknown; }; + content?: never; }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { + readonly 404: components["responses"]["not_found"]; + /** @description There isn't a CNAME for this page */ + readonly 422: { headers: { readonly [name: string]: unknown; }; - content: { - readonly "application/json": components["schemas"]["page-deployment"]; - }; + content?: never; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-pages-health-check": { + readonly "repos/check-private-vulnerability-reporting": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -113541,39 +106526,19 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description Response */ + /** @description Private vulnerability reporting status */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pages-health-check"]; - }; - }; - /** @description Empty response */ - readonly 202: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Custom domains are not available for GitHub Pages */ - readonly 400: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 404: components["responses"]["not_found"]; - /** @description There isn't a CNAME for this page */ - readonly 422: { - headers: { - readonly [name: string]: unknown; + readonly "application/json": { + /** @description Whether or not private vulnerability reporting is enabled for the repository. */ + readonly enabled: boolean; + }; }; - content?: never; }; + readonly 422: components["responses"]["bad_request"]; }; }; readonly "repos/enable-private-vulnerability-reporting": { @@ -113617,9 +106582,9 @@ export interface operations { readonly query?: { /** @description Indicates the state of the projects to return. */ readonly state?: "open" | "closed" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113716,6 +106681,39 @@ export interface operations { readonly 404: components["responses"]["not_found"]; }; }; + readonly "repos/create-or-update-custom-properties-values": { + 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: { + readonly content: { + readonly "application/json": { + /** @description A list of custom property names and associated values to apply to the repositories. */ + readonly properties: components["schemas"]["custom-property-value"][]; + }; + }; + }; + readonly responses: { + /** @description No Content when custom property values are successfully created or updated */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; readonly "pulls/list": { readonly parameters: { readonly query?: { @@ -113729,9 +106727,9 @@ export interface operations { readonly sort?: "created" | "updated" | "popularity" | "long-running"; /** @description The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ readonly direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113825,9 +106823,9 @@ export interface operations { readonly direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113946,9 +106944,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114078,6 +107076,7 @@ export interface operations { }; readonly 304: components["responses"]["not_modified"]; readonly 404: components["responses"]["not_found"]; + readonly 406: components["responses"]["unacceptable"]; readonly 500: components["responses"]["internal_error"]; readonly 503: components["responses"]["service_unavailable"]; }; @@ -114206,9 +107205,9 @@ export interface operations { readonly direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114261,7 +107260,7 @@ export interface operations { readonly path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. + * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ readonly position?: number; /** @@ -114349,9 +107348,9 @@ export interface operations { readonly "pulls/list-commits": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114382,9 +107381,9 @@ export interface operations { readonly "pulls/list-files": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114629,9 +107628,9 @@ export interface operations { readonly "pulls/list-reviews": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114689,7 +107688,7 @@ export interface operations { readonly comments?: { /** @description The relative path to the file that necessitates a review comment. */ readonly path: string; - /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below. */ + /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ readonly position?: number; /** @description Text of the review comment. */ readonly body: string; @@ -114820,9 +107819,9 @@ export interface operations { readonly "pulls/list-comments-for-review": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115044,9 +108043,9 @@ export interface operations { readonly "repos/list-releases": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115346,7 +108345,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ + /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -115453,9 +108452,9 @@ export interface operations { readonly "repos/list-release-assets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115529,9 +108528,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ readonly content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115637,9 +108636,9 @@ export interface operations { readonly "repos/get-branch-rules": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115669,9 +108668,9 @@ export interface operations { readonly "repos/get-repo-rulesets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Include rulesets configured at higher levels that apply to this repository */ readonly includes_parents?: boolean; @@ -115719,10 +108718,12 @@ export interface operations { /** @description The name of the ruleset. */ readonly name: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - readonly target?: "branch" | "tag"; + readonly target?: "branch" | "tag" | "push"; readonly enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -115759,9 +108760,9 @@ export interface operations { readonly actor_name?: components["parameters"]["actor-name-in-query"]; /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ readonly rule_suite_result?: components["parameters"]["rule-suite-result"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115873,10 +108874,12 @@ export interface operations { /** @description The name of the ruleset. */ readonly name?: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - readonly target?: "branch" | "tag"; + readonly target?: "branch" | "tag" | "push"; readonly enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -115942,9 +108945,9 @@ export interface operations { readonly sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ readonly before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; @@ -116079,9 +109082,9 @@ export interface operations { readonly "secret-scanning/list-locations-for-alert": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -116124,11 +109127,11 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ readonly sort?: "created" | "updated" | "published"; - /** @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. */ + /** @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. */ + /** @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 Number of advisories to return per page. */ + /** @description The number of advisories to return per page. 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 Filter by state of the repository advisories. Only advisories of this state will be returned. */ readonly state?: "triage" | "draft" | "published" | "closed"; @@ -116315,12 +109318,43 @@ export interface operations { readonly 422: components["responses"]["validation_failed"]; }; }; + readonly "security-advisories/create-fork": { + 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 GHSA (GitHub Security Advisory) identifier of the advisory. */ + readonly ghsa_id: components["parameters"]["ghsa_id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 202: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["full-repository"]; + }; + }; + readonly 400: components["responses"]["bad_request"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; readonly "activity/list-stargazers-for-repo": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116372,6 +109406,13 @@ export interface operations { }; readonly 202: components["responses"]["accepted"]; readonly 204: components["responses"]["no_content"]; + /** @description Repository contains more than 10,000 commits */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; }; }; readonly "repos/get-commit-activity-stats": { @@ -116532,9 +109573,9 @@ export interface operations { readonly "activity/list-watchers-for-repo": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116653,9 +109694,9 @@ export interface operations { readonly "repos/list-tags": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116798,9 +109839,9 @@ export interface operations { readonly "repos/list-teams": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116830,9 +109871,9 @@ export interface operations { readonly "repos/get-all-topics": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -117183,7 +110224,7 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository"]; + readonly "application/json": components["schemas"]["full-repository"]; }; }; }; @@ -117215,314 +110256,6 @@ export interface operations { readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "actions/list-environment-secrets": { - readonly parameters: { - readonly query?: { - /** @description The number of results per page (max 100). */ - readonly per_page?: components["parameters"]["per-page"]; - /** @description Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - 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 secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; - readonly "actions/get-environment-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; - readonly "actions/get-environment-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; - readonly "actions/create-or-update-environment-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ - readonly encrypted_value: string; - /** @description ID of the key you used to encrypt the secret. */ - readonly key_id: string; - }; - }; - }; - readonly responses: { - /** @description Response when creating a secret */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Response when updating a secret */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "actions/delete-environment-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Default response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "actions/list-environment-variables": { - readonly parameters: { - readonly query?: { - /** @description The number of results per page (max 30). */ - readonly per_page?: components["parameters"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - 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 variables: components["schemas"]["actions-variable"][]; - }; - }; - }; - }; - }; - readonly "actions/create-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the variable. */ - readonly name: string; - /** @description The value of the variable. */ - readonly value: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["empty-object"]; - }; - }; - }; - }; - readonly "actions/get-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["actions-variable"]; - }; - }; - }; - }; - readonly "actions/delete-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "actions/update-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the variable. */ - readonly name?: string; - /** @description The value of the variable. */ - readonly value?: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; readonly "search/code": { readonly parameters: { readonly query: { @@ -117538,9 +110271,9 @@ export interface operations { * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ readonly order?: "desc" | "asc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117577,9 +110310,9 @@ export interface operations { readonly sort?: "author-date" | "committer-date"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ readonly order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117613,9 +110346,9 @@ export interface operations { readonly sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ readonly order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117654,9 +110387,9 @@ export interface operations { readonly sort?: "created" | "updated"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ readonly order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117693,9 +110426,9 @@ export interface operations { readonly sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ readonly order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117727,9 +110460,9 @@ export interface operations { readonly query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */ readonly q: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117763,9 +110496,9 @@ export interface operations { readonly sort?: "followers" | "repositories" | "joined"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ readonly order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117913,9 +110646,9 @@ export interface operations { readonly query?: { /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118063,9 +110796,9 @@ export interface operations { readonly query?: { /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118214,9 +110947,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118286,9 +111019,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118352,9 +111085,9 @@ export interface operations { readonly "teams/list-pending-invitations-legacy": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118383,9 +111116,9 @@ export interface operations { readonly query?: { /** @description Filters members returned by their role in the team. */ readonly role?: "member" | "maintainer" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118618,9 +111351,9 @@ export interface operations { readonly "teams/list-projects-legacy": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118693,7 +111426,7 @@ export interface operations { readonly content: { readonly "application/json": { /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * @enum {string} */ readonly permission?: "read" | "write" | "admin"; @@ -118752,9 +111485,9 @@ export interface operations { readonly "teams/list-repos-legacy": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118885,9 +111618,9 @@ export interface operations { readonly "teams/list-child-legacy": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119004,9 +111737,9 @@ export interface operations { readonly "users/list-blocked-by-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119117,9 +111850,9 @@ export interface operations { readonly "codespaces/list-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 ID of the Repository to filter on */ readonly repository_id?: components["parameters"]["repository-id-in-query"]; @@ -119240,9 +111973,9 @@ export interface operations { readonly "codespaces/list-secrets-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119820,9 +112553,9 @@ export interface operations { readonly "users/list-emails-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119915,9 +112648,9 @@ export interface operations { readonly "users/list-followers-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119944,9 +112677,9 @@ export interface operations { readonly "users/list-followed-by-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120056,9 +112789,9 @@ export interface operations { readonly "users/list-gpg-keys-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120173,9 +112906,9 @@ export interface operations { readonly "apps/list-installations-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120205,9 +112938,9 @@ export interface operations { readonly "apps/list-installation-repos-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120382,9 +113115,9 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120410,9 +113143,9 @@ export interface operations { readonly "users/list-public-ssh-keys-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120529,9 +113262,9 @@ export interface operations { readonly "apps/list-subscriptions-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120558,9 +113291,9 @@ export interface operations { readonly "apps/list-subscriptions-for-authenticated-user-stubbed": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120588,9 +113321,9 @@ export interface operations { readonly query?: { /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ readonly state?: "active" | "pending"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120679,9 +113412,9 @@ export interface operations { readonly "migrations/list-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120886,9 +113619,9 @@ export interface operations { readonly "migrations/list-repos-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120916,9 +113649,9 @@ export interface operations { readonly "orgs/list-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120952,9 +113685,9 @@ export interface operations { * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ readonly visibility?: components["parameters"]["package-visibility"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -121058,9 +113791,9 @@ export interface operations { readonly "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 state of the package, either active or deleted. */ readonly state?: "active" | "deleted"; @@ -121215,9 +113948,9 @@ export interface operations { readonly "users/list-public-emails-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121258,9 +113991,9 @@ export interface operations { readonly sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ readonly direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since-repo-date"]; @@ -121441,7 +114174,7 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository"]; + readonly "application/json": components["schemas"]["full-repository"]; }; }; readonly 304: components["responses"]["not_modified"]; @@ -121455,9 +114188,9 @@ export interface operations { readonly "repos/list-invitations-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121535,9 +114268,9 @@ export interface operations { readonly "users/list-social-accounts-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121633,9 +114366,9 @@ export interface operations { readonly "users/list-ssh-signing-keys-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121756,9 +114489,9 @@ export interface operations { readonly sort?: components["parameters"]["sort-starred"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121875,9 +114608,9 @@ export interface operations { readonly "activity/list-watched-repos-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121904,9 +114637,9 @@ export interface operations { readonly "teams/list-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121935,7 +114668,7 @@ export interface operations { readonly query?: { /** @description A user ID. Only return users with an ID greater than this ID. */ readonly since?: components["parameters"]["since-user"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; readonly header?: never; @@ -122010,9 +114743,9 @@ export interface operations { readonly "activity/list-events-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122038,9 +114771,9 @@ export interface operations { readonly "activity/list-org-events-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122068,9 +114801,9 @@ export interface operations { readonly "activity/list-public-events-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122096,9 +114829,9 @@ export interface operations { readonly "users/list-followers-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122125,9 +114858,9 @@ export interface operations { readonly "users/list-following-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122185,9 +114918,9 @@ export interface operations { readonly query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122215,9 +114948,9 @@ export interface operations { readonly "users/list-gpg-keys-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122297,9 +115030,9 @@ export interface operations { readonly "users/list-public-keys-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122326,9 +115059,9 @@ export interface operations { readonly "orgs/list-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122362,9 +115095,9 @@ export interface operations { * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ readonly visibility?: components["parameters"]["package-visibility"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -122600,9 +115333,9 @@ export interface operations { readonly query?: { /** @description Indicates the state of the projects to return. */ readonly state?: "open" | "closed" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122630,9 +115363,9 @@ export interface operations { readonly "activity/list-received-events-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122658,9 +115391,9 @@ export interface operations { readonly "activity/list-received-public-events-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122692,9 +115425,9 @@ export interface operations { readonly sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ readonly direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122790,9 +115523,9 @@ export interface operations { readonly "users/list-social-accounts-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122819,9 +115552,9 @@ export interface operations { readonly "users/list-ssh-signing-keys-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122852,9 +115585,9 @@ export interface operations { readonly sort?: components["parameters"]["sort-starred"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122881,9 +115614,9 @@ export interface operations { readonly "activity/list-repos-watched-by-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122948,4 +115681,4 @@ export interface operations { }; }; }; -} \ No newline at end of file +} diff --git a/packages/openapi-typescript/examples/github-api-immutable.ts b/packages/openapi-typescript/examples/github-api-immutable.ts index de4eab409..1ec780f66 100644 --- a/packages/openapi-typescript/examples/github-api-immutable.ts +++ b/packages/openapi-typescript/examples/github-api-immutable.ts @@ -231,9 +231,9 @@ export interface paths { }; /** * List installations for the authenticated app - * @description 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. + * @description The permissions the installation has are included under the `permissions` key. * - * The permissions the installation has are included under the `permissions` key. + * 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 get: operations["apps/list-installations"]; readonly put?: never; @@ -283,7 +283,13 @@ export interface paths { readonly put?: never; /** * Create an installation access token for an app - * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. + * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. + * + * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. + * + * 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. */ @@ -382,7 +388,15 @@ export interface paths { readonly put?: never; /** * Create a scoped access token - * @description Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify + * which repositories the token can access and which permissions are granted to the + * token. + * + * Invalid tokens will return `404 NOT FOUND`. + * + * You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) + * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + * as the username and password. */ readonly post: operations["apps/scope-token"]; readonly delete?: never; @@ -401,8 +415,6 @@ export interface paths { /** * Get an app * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - * - * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ readonly get: operations["apps/get-by-slug"]; readonly put?: never; @@ -593,6 +605,39 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/enterprises/{enterprise}/copilot/usage": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a summary of Copilot usage for enterprise members + * @description **Note**: This endpoint is in beta 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 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 response contains metrics for the prior 28 days. 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. + * + * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage + * metrics for the enterprise. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + */ + readonly get: operations["copilot/usage-metrics-for-enterprise"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/enterprises/{enterprise}/dependabot/alerts": { readonly parameters: { readonly query?: never; @@ -603,9 +648,12 @@ export interface paths { /** * List Dependabot alerts for an enterprise * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. - * To use this endpoint, you must be a member of the enterprise, and you must use an - * access token with the `repo` scope or `security_events` scope. + * + * The authenticated user must be a member of the enterprise to use this endpoint. + * * 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 the `repo` or `security_events` scope to use this endpoint. */ readonly get: operations["dependabot/list-alerts-for-enterprise"]; readonly put?: never; @@ -626,7 +674,12 @@ export interface paths { /** * List secret scanning alerts for an enterprise * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are 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). + * + * 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). + * + * 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 the `repo` scope or `security_events` scope to use this endpoint. */ readonly get: operations["secret-scanning/list-alerts-for-enterprise"]; readonly put?: never; @@ -666,16 +719,18 @@ export interface paths { }; /** * Get feeds - * @description GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: + * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * * * **Timeline**: The GitHub global public timeline - * * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * * **Current user public**: The public timeline for the authenticated user * * **Current user**: The private timeline for the authenticated user * * **Current user actor**: The private timeline for activity created by the authenticated user * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. * + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ readonly get: operations["activity/get-feeds"]; @@ -762,7 +817,15 @@ export interface paths { readonly path?: never; readonly cookie?: never; }; - /** Get a gist */ + /** + * Get a gist + * @description Gets a specified gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ readonly get: operations["gists/get"]; readonly put?: never; readonly post?: never; @@ -772,8 +835,16 @@ export interface paths { readonly head?: never; /** * Update a gist - * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. + * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files + * from the previous version of the gist that aren't explicitly changed during an edit + * are unchanged. + * * At least one of `description` or `files` is required. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ readonly patch: operations["gists/update"]; readonly trace?: never; @@ -785,10 +856,26 @@ export interface paths { readonly path?: never; readonly cookie?: never; }; - /** List gist comments */ + /** + * List gist comments + * @description Lists the comments on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ readonly get: operations["gists/list-comments"]; readonly put?: never; - /** Create a gist comment */ + /** + * Create a gist comment + * @description Creates a comment on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ readonly post: operations["gists/create-comment"]; readonly delete?: never; readonly options?: never; @@ -803,7 +890,15 @@ export interface paths { readonly path?: never; readonly cookie?: never; }; - /** Get a gist comment */ + /** + * Get a gist comment + * @description Gets a comment on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ readonly get: operations["gists/get-comment"]; readonly put?: never; readonly post?: never; @@ -811,7 +906,15 @@ export interface paths { readonly delete: operations["gists/delete-comment"]; readonly options?: never; readonly head?: never; - /** Update a gist comment */ + /** + * Update a gist comment + * @description Updates a comment on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ readonly patch: operations["gists/update-comment"]; readonly trace?: never; }; @@ -861,7 +964,7 @@ export interface paths { readonly get: operations["gists/check-is-starred"]; /** * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ readonly put: operations["gists/star"]; readonly post?: never; @@ -879,7 +982,15 @@ export interface paths { readonly path?: never; readonly cookie?: never; }; - /** Get a gist revision */ + /** + * Get a gist revision + * @description Gets a specified gist revision. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ readonly get: operations["gists/get-revision"]; readonly put?: never; readonly post?: never; @@ -918,8 +1029,11 @@ export interface paths { }; /** * Get a gitignore template - * @description The API also allows fetching the source of a single template. - * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. + * @description Get the content of a gitignore template. + * + * 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 .gitignore contents. */ readonly get: operations["gitignore/get-template"]; readonly put?: never; @@ -940,8 +1054,6 @@ export interface paths { /** * List repositories accessible to the app installation * @description List repositories that an app installation can access. - * - * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ readonly get: operations["apps/list-repos-accessible-to-installation"]; readonly put?: never; @@ -967,8 +1079,6 @@ export interface paths { * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. - * - * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ readonly delete: operations["apps/revoke-installation-access-token"]; readonly options?: never; @@ -989,11 +1099,17 @@ export interface paths { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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"]; readonly put?: never; @@ -1294,7 +1410,11 @@ export interface paths { readonly get: operations["activity/get-thread"]; readonly put?: never; readonly post?: never; - readonly delete?: never; + /** + * Mark a thread as done + * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications. + */ + readonly delete: operations["activity/mark-thread-as-done"]; readonly options?: never; readonly head?: never; /** @@ -1367,7 +1487,7 @@ export interface paths { }; /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub. + * @description Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -1389,9 +1509,26 @@ export interface paths { }; /** * Get an organization - * @description To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * @description Gets information about an organization. + * + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * + * To see the full details about an organization, the authenticated user must be an organization owner. + * + * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: * - * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + * + * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. */ readonly get: operations["orgs/get"]; readonly put?: never; @@ -1413,7 +1550,22 @@ export interface paths { * Update an organization * @description **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. + * Updates the organization's profile and member privileges. + * + * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * + * The authenticated user must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ readonly patch: operations["orgs/update"]; readonly trace?: never; @@ -1429,7 +1581,8 @@ export interface paths { * Get GitHub Actions cache usage for an organization * @description Gets the total GitHub Actions cache usage for an organization. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ readonly get: operations["actions/get-actions-cache-usage-for-org"]; readonly put?: never; @@ -1451,7 +1604,8 @@ export interface paths { * List repositories with GitHub Actions cache usage for an organization * @description Lists repositories and their GitHub Actions cache usage for an organization. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ readonly get: operations["actions/get-actions-cache-usage-by-repo-for-org"]; readonly put?: never; @@ -1472,15 +1626,15 @@ export interface paths { /** * Get the customization template for an OIDC subject claim for an organization * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. - * GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ readonly get: operations["oidc/get-oidc-custom-sub-template-for-org"]; /** * Set the customization template for an OIDC subject claim for an organization * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `write:org` scope to use this endpoint. - * GitHub Apps must have the `admin:org` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ readonly put: operations["oidc/update-oidc-custom-sub-template-for-org"]; readonly post?: never; @@ -1501,14 +1655,14 @@ export interface paths { * Get GitHub Actions permissions for an organization * @description Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["actions/get-github-actions-permissions-organization"]; /** * Set GitHub Actions permissions for an organization * @description Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["actions/set-github-actions-permissions-organization"]; readonly post?: never; @@ -1529,14 +1683,15 @@ export interface paths { * List selected repositories enabled for GitHub Actions in an organization * @description Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; /** * Set selected repositories enabled for GitHub Actions in an organization * @description Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; readonly post?: never; @@ -1558,7 +1713,7 @@ export interface paths { * Enable a selected repository for GitHub Actions in an organization * @description Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["actions/enable-selected-repository-github-actions-organization"]; readonly post?: never; @@ -1566,7 +1721,7 @@ export interface paths { * Disable a selected repository for GitHub Actions in an organization * @description Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["actions/disable-selected-repository-github-actions-organization"]; readonly options?: never; @@ -1583,16 +1738,16 @@ export interface paths { }; /** * Get allowed actions and reusable workflows for an organization - * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["actions/get-allowed-actions-organization"]; /** * Set allowed actions and reusable workflows for an organization * @description Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["actions/set-allowed-actions-organization"]; readonly post?: never; @@ -1615,7 +1770,7 @@ export interface paths { * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; /** @@ -1624,7 +1779,7 @@ export interface paths { * can submit approving pull request reviews. For more information, see * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; readonly post?: never; @@ -1645,10 +1800,9 @@ export interface paths { * List self-hosted runners for an organization * @description Lists all self-hosted runners configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/list-self-hosted-runners-for-org"]; readonly put?: never; @@ -1670,10 +1824,9 @@ export interface paths { * List runner applications for an organization * @description Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/list-runner-applications-for-org"]; readonly put?: never; @@ -1697,10 +1850,9 @@ export interface paths { * Create configuration for a just-in-time runner for an organization * @description Generates a configuration that can be passed to the runner application at startup. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * The authenticated user must have admin access to the organization. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/generate-runner-jitconfig-for-org"]; readonly delete?: never; @@ -1722,18 +1874,15 @@ export interface paths { * Create a registration token for an organization * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - * - * Example using registration token: - * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * * ``` * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` + * + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/create-registration-token-for-org"]; readonly delete?: never; @@ -1755,19 +1904,15 @@ export interface paths { * Create a remove token for an organization * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - * - * Example using remove token: - * - * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this - * endpoint. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * * ``` * ./config.sh remove --token TOKEN * ``` + * + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/create-remove-token-for-org"]; readonly delete?: never; @@ -1787,10 +1932,9 @@ export interface paths { * Get a self-hosted runner for an organization * @description Gets a specific self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/get-self-hosted-runner-for-org"]; readonly put?: never; @@ -1799,10 +1943,9 @@ export interface paths { * Delete a self-hosted runner from an organization * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-self-hosted-runner-from-org"]; readonly options?: never; @@ -1821,10 +1964,9 @@ export interface paths { * List labels for a self-hosted runner for an organization * @description Lists all labels for a self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; /** @@ -1832,20 +1974,18 @@ export interface paths { * @description Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; /** * Add custom labels to a self-hosted runner for an organization - * @description Add custom labels to a self-hosted runner configured in an organization. + * @description Adds custom labels to a self-hosted runner configured in an organization. + * + * Authenticated users must have admin access to the organization to use this endpoint. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; /** @@ -1853,10 +1993,9 @@ export interface paths { * @description Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; readonly options?: never; @@ -1882,10 +2021,9 @@ export interface paths { * This endpoint returns a `404 Not Found` status if the custom label is not * present on the runner. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; readonly options?: never; @@ -1905,10 +2043,9 @@ export interface paths { * @description Lists all secrets available in an organization without revealing their * encrypted values. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/list-org-secrets"]; readonly put?: never; @@ -1931,10 +2068,9 @@ export interface paths { * @description Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-org-public-key"]; readonly put?: never; @@ -1956,10 +2092,9 @@ export interface paths { * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-org-secret"]; /** @@ -1967,10 +2102,9 @@ export interface paths { * @description Creates or updates an organization secret with an encrypted value. 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)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/create-or-update-org-secret"]; readonly post?: never; @@ -1978,10 +2112,9 @@ export interface paths { * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-org-secret"]; readonly options?: never; @@ -2001,10 +2134,9 @@ export interface paths { * @description Lists all repositories that have been selected when the `visibility` * for repository access to a secret is set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/list-selected-repos-for-org-secret"]; /** @@ -2013,10 +2145,9 @@ export interface paths { * for repository access is set to `selected`. The visibility is set when you [Create * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly put: operations["actions/set-selected-repos-for-org-secret"]; readonly post?: never; @@ -2037,13 +2168,12 @@ export interface paths { /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or + * repository access is set to `selected`. For more information about setting the visibility, see [Create or * update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/add-selected-repo-to-org-secret"]; readonly post?: never; @@ -2053,10 +2183,9 @@ export interface paths { * for repository access is set to `selected`. The visibility is set when you [Create * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly delete: operations["actions/remove-selected-repo-from-org-secret"]; readonly options?: never; @@ -2074,7 +2203,10 @@ export interface paths { /** * List organization variables * @description Lists all organization variables. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/list-org-variables"]; readonly put?: never; @@ -2082,10 +2214,9 @@ export interface paths { * Create an organization variable * @description Creates an organization variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/create-org-variable"]; readonly delete?: never; @@ -2105,10 +2236,9 @@ export interface paths { * Get an organization variable * @description Gets a specific variable in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-org-variable"]; readonly put?: never; @@ -2117,10 +2247,9 @@ export interface paths { * Delete an organization variable * @description Deletes an organization variable using the variable name. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-org-variable"]; readonly options?: never; @@ -2129,10 +2258,9 @@ export interface paths { * Update an organization variable * @description Updates an organization variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly patch: operations["actions/update-org-variable"]; readonly trace?: never; @@ -2149,10 +2277,9 @@ export interface paths { * @description Lists all repositories that can access an organization variable * that is available to selected repositories. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly get: operations["actions/list-selected-repos-for-org-variable"]; /** @@ -2161,11 +2288,9 @@ export interface paths { * to selected repositories. Organization variables that are available to selected * repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this - * endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly put: operations["actions/set-selected-repos-for-org-variable"]; readonly post?: never; @@ -2188,10 +2313,9 @@ export interface paths { * @description Adds a repository to an organization variable that is available to selected repositories. * Organization variables that are available to selected repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/add-selected-repo-to-org-variable"]; readonly post?: never; @@ -2201,10 +2325,9 @@ export interface paths { * available to selected repositories. Organization variables that are available to * selected repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ readonly delete: operations["actions/remove-selected-repo-from-org-variable"]; readonly options?: never; @@ -2271,9 +2394,9 @@ export interface paths { * List code scanning alerts for an organization * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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)." * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * For public repositories, you may instead use the `public_repo` scope. + * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope 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/list-alerts-for-org"]; readonly put?: never; @@ -2295,7 +2418,7 @@ export interface paths { * List codespaces for the organization * @description Lists the codespaces associated to a specified organization. * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["codespaces/list-in-organization"]; readonly put?: never; @@ -2318,7 +2441,7 @@ export interface paths { * Manage access control for organization codespaces * @deprecated * @description Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["codespaces/set-codespaces-access"]; readonly post?: never; @@ -2345,7 +2468,7 @@ export interface paths { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly post: operations["codespaces/set-codespaces-access-users"]; /** @@ -2356,7 +2479,7 @@ export interface paths { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["codespaces/delete-codespaces-access-users"]; readonly options?: never; @@ -2373,8 +2496,10 @@ export interface paths { }; /** * List organization secrets - * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Lists all Codespaces development environment secrets 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["codespaces/list-org-secrets"]; readonly put?: never; @@ -2394,7 +2519,8 @@ export interface paths { }; /** * Get an organization public key - * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["codespaces/get-org-public-key"]; readonly put?: never; @@ -2415,7 +2541,8 @@ export interface paths { /** * Get an organization secret * @description Gets an organization development environment secret without revealing its encrypted value. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["codespaces/get-org-secret"]; /** @@ -2423,14 +2550,15 @@ export interface paths { * @description Creates or updates an organization development environment secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["codespaces/create-or-update-org-secret"]; readonly post?: never; /** * Delete an organization secret - * @description Deletes an organization development environment secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Deletes an organization development environment secret using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["codespaces/delete-org-secret"]; readonly options?: never; @@ -2447,12 +2575,19 @@ export interface paths { }; /** * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Lists all repositories that have been selected when the `visibility` + * for repository access to a secret is set to `selected`. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["codespaces/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Replaces all repositories for an organization development environment secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["codespaces/set-selected-repos-for-org-secret"]; readonly post?: never; @@ -2472,13 +2607,18 @@ export interface paths { readonly get?: never; /** * Add selected repository to an organization secret - * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["codespaces/add-selected-repo-to-org-secret"]; readonly post?: never; /** * Remove selected repository from an organization secret - * @description Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Removes a repository from an organization development environment secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["codespaces/remove-selected-repo-from-org-secret"]; readonly options?: never; @@ -2494,15 +2634,16 @@ export interface paths { readonly cookie?: never; }; /** - * Get Copilot Business seat information and settings for an organization + * Get Copilot seat information and settings for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets information about an organization's Copilot Business subscription, including seat breakdown + * Gets information about an organization's Copilot subscription, including seat breakdown * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * + * Only organization owners can configure and view details about the organization's Copilot Business subscription. * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ readonly get: operations["copilot/get-copilot-organization-details"]; readonly put?: never; @@ -2521,13 +2662,14 @@ export interface paths { readonly cookie?: never; }; /** - * List all Copilot Business seat assignments for an organization + * List all Copilot seat assignments for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ readonly get: operations["copilot/list-copilot-seats"]; readonly put?: never; @@ -2548,33 +2690,35 @@ export interface paths { readonly get?: never; readonly put?: never; /** - * Add teams to the Copilot Business subscription for an organization + * Add teams to the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot Business seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + * Purchases a GitHub Copilot seat for all users within each specified team. + * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * + * Only organization owners can configure GitHub Copilot in their organization. * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * 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. + * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * - * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ - readonly post: operations["copilot/add-copilot-for-business-seats-for-teams"]; + readonly post: operations["copilot/add-copilot-seats-for-teams"]; /** - * Remove teams from the Copilot Business subscription for an organization + * Remove teams from the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot Business seat assignment for all members of each team specified. + * Cancels the Copilot seat assignment for all members of each team specified. * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can configure GitHub Copilot in their organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ readonly delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; readonly options?: never; @@ -2592,33 +2736,35 @@ export interface paths { readonly get?: never; readonly put?: never; /** - * Add users to the Copilot Business subscription for an organization + * Add users to the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot Business seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + * Purchases a GitHub Copilot seat for each user specified. + * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * + * Only organization owners can configure GitHub Copilot in their organization. * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * 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. + * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * - * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ - readonly post: operations["copilot/add-copilot-for-business-seats-for-users"]; + readonly post: operations["copilot/add-copilot-seats-for-users"]; /** - * Remove users from the Copilot Business subscription for an organization + * Remove users from the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot Business seat assignment for each user specified. + * Cancels the Copilot seat assignment for each user specified. * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)" + * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can configure GitHub Copilot in their organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ readonly delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; readonly options?: never; @@ -2626,6 +2772,39 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/copilot/usage": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a summary of Copilot usage for organization members + * @description **Note**: This endpoint is in beta 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 + * across an organization, 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 the prior 28 days. 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. + * + * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view + * Copilot usage metrics. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + */ + readonly get: operations["copilot/usage-metrics-for-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}/dependabot/alerts": { readonly parameters: { readonly query?: never; @@ -2637,11 +2816,9 @@ export interface paths { * List Dependabot alerts for an organization * @description Lists Dependabot alerts for an organization. * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * For public repositories, you may instead use the `public_repo` scope. - * - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `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["dependabot/list-alerts-for-org"]; readonly put?: never; @@ -2661,7 +2838,10 @@ export interface paths { }; /** * List organization secrets - * @description Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Lists all secrets available in an organization 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["dependabot/list-org-secrets"]; readonly put?: never; @@ -2681,7 +2861,10 @@ export interface paths { }; /** * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["dependabot/get-org-public-key"]; readonly put?: never; @@ -2701,7 +2884,9 @@ export interface paths { }; /** * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Gets a single organization secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["dependabot/get-org-secret"]; /** @@ -2709,15 +2894,15 @@ export interface paths { * @description Creates or updates an organization secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - * permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["dependabot/create-or-update-org-secret"]; readonly post?: never; /** * Delete an organization secret - * @description Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Deletes a secret in an organization using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["dependabot/delete-org-secret"]; readonly options?: never; @@ -2734,12 +2919,19 @@ export interface paths { }; /** * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Lists all repositories that have been selected when the `visibility` + * for repository access to a secret is set to `selected`. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["dependabot/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Replaces all repositories for an organization secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["dependabot/set-selected-repos-for-org-secret"]; readonly post?: never; @@ -2759,13 +2951,21 @@ export interface paths { readonly get?: never; /** * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Adds a repository to an organization secret when the `visibility` for + * repository access is set to `selected`. The visibility is set when you [Create or + * update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["dependabot/add-selected-repo-to-org-secret"]; readonly post?: never; /** * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Removes a repository from an organization secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["dependabot/remove-selected-repo-from-org-secret"]; readonly options?: never; @@ -2783,7 +2983,8 @@ export interface paths { /** * Get list of conflicting packages during Docker migration for organization * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ readonly get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; readonly put?: never; @@ -2838,12 +3039,23 @@ export interface paths { readonly path?: never; readonly cookie?: never; }; - /** List organization webhooks */ + /** + * List organization webhooks + * @description You 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. + */ readonly get: operations["orgs/list-webhooks"]; readonly put?: never; /** * Create an organization webhook - * @description Here's how you can create a hook that posts payloads in JSON format: + * @description Create a hook that posts payloads in JSON format. + * + * You 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. */ readonly post: operations["orgs/create-webhook"]; readonly delete?: never; @@ -2861,18 +3073,39 @@ export interface paths { }; /** * Get an organization webhook - * @description Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)." + * @description Returns a webhook configured in an organization. To get only the webhook + * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + * + * You 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. */ readonly get: operations["orgs/get-webhook"]; readonly put?: never; readonly post?: never; - /** Delete an organization webhook */ + /** + * Delete an organization webhook + * @description You 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. + */ readonly delete: operations["orgs/delete-webhook"]; readonly options?: never; readonly head?: never; /** * Update an organization webhook - * @description Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)." + * @description Updates a webhook configured in an organization. When you update a webhook, + * the `secret` will be overwritten. If you previously had a `secret` set, you must + * provide the same `secret` or set a new `secret` or the secret will be removed. If + * you are only updating individual webhook `config` properties, use "[Update a webhook + * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". + * + * You 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. */ readonly patch: operations["orgs/update-webhook"]; readonly trace?: never; @@ -2888,7 +3121,10 @@ export interface paths { * Get a webhook configuration for an organization * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." * - * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + * You 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. */ readonly get: operations["orgs/get-webhook-config-for-org"]; readonly put?: never; @@ -2900,7 +3136,10 @@ export interface paths { * Update a webhook configuration for an organization * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." * - * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + * You 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. */ readonly patch: operations["orgs/update-webhook-config-for-org"]; readonly trace?: never; @@ -2915,6 +3154,11 @@ export interface paths { /** * List deliveries for an organization webhook * @description Returns a list of webhook deliveries for a webhook configured in an organization. + * + * You 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. */ readonly get: operations["orgs/list-webhook-deliveries"]; readonly put?: never; @@ -2935,6 +3179,11 @@ export interface paths { /** * Get a webhook delivery for an organization webhook * @description Returns a delivery for a webhook configured in an organization. + * + * You 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. */ readonly get: operations["orgs/get-webhook-delivery"]; readonly put?: never; @@ -2957,6 +3206,11 @@ export interface paths { /** * Redeliver a delivery for an organization webhook * @description Redeliver a delivery for a webhook configured in an organization. + * + * You 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. */ readonly post: operations["orgs/redeliver-webhook-delivery"]; readonly delete?: never; @@ -2976,7 +3230,13 @@ export interface paths { readonly put?: never; /** * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) + * to be sent to the hook. + * + * You 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. */ readonly post: operations["orgs/ping-webhook"]; readonly delete?: never; @@ -3016,7 +3276,12 @@ export interface paths { }; /** * List app installations for an organization - * @description Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. + * @description Lists all GitHub Apps in an organization. The installation count includes + * all GitHub Apps installed on repositories in the organization. + * + * The authenticated user must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. */ readonly get: operations["orgs/list-app-installations"]; readonly put?: never; @@ -3139,6 +3404,13 @@ export interface paths { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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-for-org"]; readonly put?: never; @@ -3204,7 +3476,7 @@ export interface paths { * List codespaces for a user in organization * @description Lists the codespaces that a member of an organization has for repositories in that organization. * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["codespaces/get-codespaces-for-user-in-org"]; readonly put?: never; @@ -3229,10 +3501,7 @@ export interface paths { * Delete a codespace from the organization * @description Deletes a user's codespace. * - * To use this endpoint you must authenticate using one of the following methods: - * - * - An access token with the `admin:org` scope - * - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["codespaces/delete-from-organization"]; readonly options?: never; @@ -3253,10 +3522,7 @@ export interface paths { * Stop a codespace for an organization user * @description Stops a user's codespace. * - * To use this endpoint you must authenticate using one of the following methods: - * - * - An access token with the `admin:org` scope - * - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly post: operations["codespaces/stop-in-organization"]; readonly delete?: never; @@ -3273,12 +3539,14 @@ export interface paths { readonly cookie?: never; }; /** - * Get Copilot Business seat assignment details for a user + * Get Copilot seat assignment details for a user * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * + * Organization owners can view GitHub Copilot seat assignment details for members in their organization. * - * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ readonly get: operations["copilot/get-copilot-seat-details-for-user"]; readonly put?: never; @@ -3453,9 +3721,7 @@ export interface paths { }; /** * List organization fine-grained permissions for an organization - * @description **Note**: This operation is in beta and subject to change. - * - * Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." * @@ -3464,8 +3730,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["orgs/list-organization-fine-grained-permissions"]; readonly put?: never; @@ -3485,33 +3750,27 @@ export interface paths { }; /** * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["orgs/list-org-roles"]; readonly put?: never; /** * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - * - * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly post: operations["orgs/create-custom-organization-role"]; readonly delete?: never; @@ -3532,12 +3791,11 @@ export interface paths { readonly post?: never; /** * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["orgs/revoke-all-org-roles-team"]; readonly options?: never; @@ -3555,22 +3813,21 @@ export interface paths { readonly get?: never; /** * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly put: operations["orgs/assign-team-to-org-role"]; readonly post?: never; /** * Remove an organization role from a team - * @description Removes an organization role from a team. + * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["orgs/revoke-org-role-team"]; readonly options?: never; @@ -3590,12 +3847,11 @@ export interface paths { readonly post?: never; /** * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["orgs/revoke-all-org-roles-user"]; readonly options?: never; @@ -3613,22 +3869,21 @@ export interface paths { readonly get?: never; /** * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * 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. */ readonly put: operations["orgs/assign-user-to-org-role"]; readonly post?: never; /** * Remove an organization role from a user - * @description Remove an organization role from a user. + * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["orgs/revoke-org-role-user"]; readonly options?: never; @@ -3645,51 +3900,43 @@ export interface paths { }; /** * Get an organization role - * @description Gets an organization role that is available to this organization. + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["orgs/get-org-role"]; readonly put?: never; readonly post?: never; /** * Delete a custom organization role. - * @description Deletes a custom organization role. + * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - * - * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["orgs/delete-custom-organization-role"]; readonly options?: never; readonly head?: never; /** * Update a custom organization role - * @description Updates an existing custom organization role. Permission changes will apply to all assignees. + * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - * - * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly patch: operations["orgs/patch-custom-organization-role"]; readonly trace?: never; @@ -3703,12 +3950,11 @@ export interface paths { }; /** * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read permission to use this endpoint. + * To use this endpoint, you must be an administrator for the organization. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["orgs/list-org-role-teams"]; readonly put?: never; @@ -3728,12 +3974,11 @@ export interface paths { }; /** * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read permission to use this endpoint. + * To use this endpoint, you must be an administrator for the organization. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly get: operations["orgs/list-org-role-users"]; readonly put?: never; @@ -3799,7 +4044,7 @@ export interface paths { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/list-packages-for-organization"]; readonly put?: never; @@ -3821,7 +4066,7 @@ export interface paths { * Get a package for an organization * @description Gets a specific package in an organization. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-for-organization"]; readonly put?: never; @@ -3830,9 +4075,9 @@ export interface paths { * Delete a package for an organization * @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-for-org"]; readonly options?: never; @@ -3857,9 +4102,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-for-org"]; readonly delete?: never; @@ -3879,7 +4124,7 @@ export interface paths { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; readonly put?: never; @@ -3901,7 +4146,7 @@ export interface paths { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-version-for-organization"]; readonly put?: never; @@ -3910,9 +4155,9 @@ export interface paths { * Delete package version for an organization * @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-version-for-org"]; readonly options?: never; @@ -3937,9 +4182,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-version-for-org"]; readonly delete?: never; @@ -3957,19 +4202,17 @@ export interface paths { }; /** * List requests to access organization resources with fine-grained personal access tokens - * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: read` permission. + * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly get: operations["orgs/list-pat-grant-requests"]; readonly put?: never; /** * Review requests to access organization resources with fine-grained personal access tokens - * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: write` permission. + * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly post: operations["orgs/review-pat-grant-requests-in-bulk"]; readonly delete?: never; @@ -3989,10 +4232,9 @@ export interface paths { readonly put?: never; /** * Review a request to access organization resources with a fine-grained personal access token - * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: write` permission. + * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly post: operations["orgs/review-pat-grant-request"]; readonly delete?: never; @@ -4010,10 +4252,9 @@ export interface paths { }; /** * List repositories requested to be accessed by a fine-grained personal access token - * @description Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: read` permission. + * @description Lists the repositories a fine-grained personal access token request is requesting access to. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly get: operations["orgs/list-pat-grant-request-repositories"]; readonly put?: never; @@ -4033,19 +4274,17 @@ export interface paths { }; /** * List fine-grained personal access tokens with access to organization resources - * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: read` permission. + * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly get: operations["orgs/list-pat-grants"]; readonly put?: never; /** * Update the access to organization resources via fine-grained personal access tokens - * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: write` permission. + * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly post: operations["orgs/update-pat-accesses"]; readonly delete?: never; @@ -4065,10 +4304,9 @@ export interface paths { readonly put?: never; /** * Update the access a fine-grained personal access token has to organization resources - * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: write` permission. + * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly post: operations["orgs/update-pat-access"]; readonly delete?: never; @@ -4086,10 +4324,9 @@ export interface paths { }; /** * List repositories a fine-grained personal access token has access to - * @description Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: read` permission. + * @description Lists the repositories a fine-grained personal access token has access to. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ readonly get: operations["orgs/list-pat-grant-repositories"]; readonly put?: never; @@ -4134,7 +4371,7 @@ export interface paths { /** * Get all custom properties for an organization * @description Gets all custom properties defined for an organization. - * You must be an organization owner to use this endpoint. + * Organization members can read these properties. */ readonly get: operations["orgs/get-all-custom-properties"]; readonly put?: never; @@ -4145,7 +4382,10 @@ export interface paths { /** * Create or update custom properties for an organization * @description Creates new or updates existing custom properties defined for an organization in a batch. - * Only organization owners (or users with the proper permissions granted by them) can update these properties + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ readonly patch: operations["orgs/create-or-update-custom-properties"]; readonly trace?: never; @@ -4160,20 +4400,26 @@ export interface paths { /** * Get a custom property for an organization * @description Gets a custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * Organization members can read these properties. */ readonly get: operations["orgs/get-custom-property"]; /** * Create or update a custom property for an organization * @description Creates a new or updates an existing custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ readonly put: operations["orgs/create-or-update-custom-property"]; readonly post?: never; /** * Remove a custom property for an organization * @description Removes a custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ readonly delete: operations["orgs/remove-custom-property"]; readonly options?: never; @@ -4208,7 +4454,9 @@ export interface paths { * * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. * - * Only organization owners (or users with the proper permissions granted by them) can update these properties + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. */ readonly patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; readonly trace?: never; @@ -4249,7 +4497,7 @@ export interface paths { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ readonly put: operations["orgs/set-public-membership-for-authenticated-user"]; readonly post?: never; @@ -4282,12 +4530,7 @@ export interface paths { * Create an organization repository * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ readonly post: operations["repos/create-in-org"]; readonly delete?: never; @@ -4400,10 +4643,10 @@ export interface paths { /** * List secret scanning alerts for an organization * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * 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 `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/list-alerts-for-org"]; readonly put?: never; @@ -4425,7 +4668,9 @@ export interface paths { * List repository security advisories for an organization * @description Lists repository security advisories for an organization. * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ readonly get: operations["security-advisories/list-org-repository-advisories"]; readonly put?: never; @@ -4447,9 +4692,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)." * - * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ readonly get: operations["orgs/list-security-manager-teams"]; readonly put?: never; @@ -4472,9 +4717,9 @@ export interface paths { * 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." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ readonly put: operations["orgs/add-security-manager-team"]; readonly post?: never; @@ -4482,9 +4727,9 @@ export interface paths { * 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." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ readonly delete: operations["orgs/remove-security-manager-team"]; readonly options?: never; @@ -4505,7 +4750,7 @@ export interface paths { * * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ readonly get: operations["billing/get-github-actions-billing-org"]; readonly put?: never; @@ -4529,7 +4774,7 @@ export interface paths { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ readonly get: operations["billing/get-github-packages-billing-org"]; readonly put?: never; @@ -4553,7 +4798,7 @@ export interface paths { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ readonly get: operations["billing/get-shared-storage-billing-org"]; readonly put?: never; @@ -4564,6 +4809,41 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/orgs/{org}/team/{team_slug}/copilot/usage": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get a summary of Copilot usage for a team + * @description **Note**: This endpoint is in beta 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 a 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 the prior 28 days. 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 team had five or more members on that day. + * + * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, + * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + */ + readonly get: operations["copilot/usage-metrics-for-team"]; + readonly put?: never; + readonly post?: never; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/orgs/{org}/teams": { readonly parameters: { readonly query?: never; @@ -4635,19 +4915,23 @@ export interface paths { }; /** * List discussions - * @description List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List all discussions on a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/list-discussions-in-org"]; readonly put?: never; /** * Create a discussion - * @description Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Creates a new discussion post on a team's page. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["teams/create-discussion-in-org"]; readonly delete?: never; @@ -4665,27 +4949,33 @@ export interface paths { }; /** * Get a discussion - * @description Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Get a specific discussion on a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/get-discussion-in-org"]; readonly put?: never; readonly post?: never; /** * Delete a discussion - * @description Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Delete a discussion from a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly delete: operations["teams/delete-discussion-in-org"]; readonly options?: never; readonly head?: never; /** * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly patch: operations["teams/update-discussion-in-org"]; readonly trace?: never; @@ -4699,19 +4989,23 @@ export interface paths { }; /** * List discussion comments - * @description List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List all comments on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/list-discussion-comments-in-org"]; readonly put?: never; /** * Create a discussion comment - * @description Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Creates a new comment on a team discussion. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["teams/create-discussion-comment-in-org"]; readonly delete?: never; @@ -4729,27 +5023,33 @@ export interface paths { }; /** * Get a discussion comment - * @description Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Get a specific comment on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/get-discussion-comment-in-org"]; readonly put?: never; readonly post?: never; /** * Delete a discussion comment - * @description Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Deletes a comment on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly delete: operations["teams/delete-discussion-comment-in-org"]; readonly options?: never; readonly head?: never; /** * Update a discussion comment - * @description Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Edits the body text of a discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly patch: operations["teams/update-discussion-comment-in-org"]; readonly trace?: never; @@ -4763,17 +5063,23 @@ export interface paths { }; /** * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["reactions/list-for-team-discussion-comment-in-org"]; readonly put?: never; /** * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["reactions/create-for-team-discussion-comment-in-org"]; readonly delete?: never; @@ -4796,7 +5102,9 @@ export interface paths { * Delete team discussion comment reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly delete: operations["reactions/delete-for-team-discussion-comment"]; readonly options?: never; @@ -4813,17 +5121,23 @@ export interface paths { }; /** * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["reactions/list-for-team-discussion-in-org"]; readonly put?: never; /** * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["reactions/create-for-team-discussion-in-org"]; readonly delete?: never; @@ -4846,7 +5160,9 @@ export interface paths { * Delete team discussion reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly delete: operations["reactions/delete-for-team-discussion"]; readonly options?: never; @@ -5044,14 +5360,14 @@ export interface paths { * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * - * If the repository is private, you must have at least `read` permission for that repository and your token must have the `repo` scope. Otherwise, you will receive a `404 Not Found` response status. + * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ readonly get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions - * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * @@ -5104,14 +5420,11 @@ export interface paths { readonly put?: never; /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. - * - * To use this endpoint, you must be an organization owner or be member of a team with the security manager role. - * A token with the 'write:org' scope is also required. + * @description Enables or disables the specified security feature for all eligible repositories in 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)." * - * GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * 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)." + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ readonly post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; readonly delete?: never; @@ -5354,7 +5667,7 @@ export interface paths { * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." @@ -5392,10 +5705,12 @@ export interface paths { readonly post?: never; /** * Delete a repository - * @description Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + * @description Deleting a repository requires admin access. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. + * + * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. */ readonly delete: operations["repos/delete"]; readonly options?: never; @@ -5416,7 +5731,11 @@ export interface paths { }; /** * List artifacts for a repository - * @description Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Lists all artifacts for a repository. + * + * 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. */ readonly get: operations["actions/list-artifacts-for-repo"]; readonly put?: never; @@ -5436,14 +5755,19 @@ export interface paths { }; /** * Get an artifact - * @description Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific artifact for a workflow run. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-artifact"]; readonly put?: never; readonly post?: never; /** * Delete an artifact - * @description Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * @description Deletes an artifact for a workflow run. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-artifact"]; readonly options?: never; @@ -5463,8 +5787,7 @@ export interface paths { * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/download-artifact"]; readonly put?: never; @@ -5486,7 +5809,10 @@ export interface paths { * Get GitHub Actions cache usage for a repository * @description Gets GitHub Actions cache usage for a repository. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-actions-cache-usage"]; readonly put?: never; @@ -5507,8 +5833,8 @@ export interface paths { /** * List GitHub Actions caches for a repository * @description Lists the GitHub Actions caches for a repository. - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-actions-cache-list"]; readonly put?: never; @@ -5517,9 +5843,7 @@ export interface paths { * Delete GitHub Actions caches for a repository (using a cache key) * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-actions-cache-by-key"]; readonly options?: never; @@ -5541,9 +5865,7 @@ export interface paths { * Delete a GitHub Actions cache for a repository (using a cache ID) * @description Deletes a GitHub Actions cache for a repository, using a cache ID. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-actions-cache-by-id"]; readonly options?: never; @@ -5560,7 +5882,11 @@ export interface paths { }; /** * Get a job for a workflow run - * @description Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific job in a workflow run. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-job-for-workflow-run"]; readonly put?: never; @@ -5581,9 +5907,11 @@ export interface paths { /** * Download job logs for a workflow run * @description Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look - * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can - * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must - * have the `actions:read` permission to use this endpoint. + * for `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/download-job-logs-for-workflow-run"]; readonly put?: never; @@ -5607,8 +5935,7 @@ export interface paths { * Re-run a job from a workflow run * @description Re-run a job and its dependent jobs in a workflow run. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/re-run-job-for-workflow-run"]; readonly delete?: never; @@ -5627,15 +5954,15 @@ export interface paths { /** * Get the customization template for an OIDC subject claim for a repository * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-custom-oidc-sub-claim-for-repo"]; /** * Set the customization template for an OIDC subject claim for a repository * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/set-custom-oidc-sub-claim-for-repo"]; readonly post?: never; @@ -5657,9 +5984,9 @@ export interface paths { * @description Lists all organization secrets shared with a repository without revealing their encrypted * values. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/list-repo-organization-secrets"]; readonly put?: never; @@ -5679,11 +6006,11 @@ export interface paths { }; /** * List repository organization variables - * @description Lists all organiation variables shared with a repository. + * @description Lists all organization variables shared with a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/list-repo-organization-variables"]; readonly put?: never; @@ -5705,14 +6032,14 @@ export interface paths { * Get GitHub Actions permissions for a repository * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-github-actions-permissions-repository"]; /** * Set GitHub Actions permissions for a repository * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/set-github-actions-permissions-repository"]; readonly post?: never; @@ -5735,8 +6062,7 @@ export interface paths { * This endpoint only applies to private repositories. * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - * repository `administration` permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-workflow-access-to-repository"]; /** @@ -5745,8 +6071,7 @@ export interface paths { * This endpoint only applies to private repositories. * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - * repository `administration` permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/set-workflow-access-to-repository"]; readonly post?: never; @@ -5767,14 +6092,14 @@ export interface paths { * Get allowed actions and reusable workflows for a repository * @description Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-allowed-actions-repository"]; /** * Set allowed actions and reusable workflows for a repository * @description Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/set-allowed-actions-repository"]; readonly post?: never; @@ -5797,7 +6122,7 @@ export interface paths { * as well as if GitHub Actions can submit approving pull request reviews. * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-github-actions-default-workflow-permissions-repository"]; /** @@ -5806,7 +6131,7 @@ export interface paths { * can submit approving pull request reviews. * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/set-github-actions-default-workflow-permissions-repository"]; readonly post?: never; @@ -5827,9 +6152,9 @@ export interface paths { * List self-hosted runners for a repository * @description Lists all self-hosted runners configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/list-self-hosted-runners-for-repo"]; readonly put?: never; @@ -5851,9 +6176,9 @@ export interface paths { * List runner applications for a repository * @description Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/list-runner-applications-for-repo"]; readonly put?: never; @@ -5877,9 +6202,9 @@ export interface paths { * Create configuration for a just-in-time runner for a repository * @description Generates a configuration that can be passed to the runner application at startup. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * The authenticated user must have admin access to the repository. + * + * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. */ readonly post: operations["actions/generate-runner-jitconfig-for-repo"]; readonly delete?: never; @@ -5899,19 +6224,17 @@ export interface paths { readonly put?: never; /** * Create a registration token for a repository - * @description Returns a token that you can pass to the `config` script. The token - * expires after one hour. + * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * Example using registration token: + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided - * by this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/create-registration-token-for-repo"]; readonly delete?: never; @@ -5931,19 +6254,17 @@ export interface paths { readonly put?: never; /** * Create a remove token for a repository - * @description Returns a token that you can pass to remove a self-hosted runner from - * a repository. The token expires after one hour. + * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * Example using remove token: + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * To remove your self-hosted runner from a repository, replace TOKEN with - * the remove token provided by this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * ```config.sh remove --token TOKEN``` + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/create-remove-token-for-repo"]; readonly delete?: never; @@ -5963,9 +6284,9 @@ export interface paths { * Get a self-hosted runner for a repository * @description Gets a specific self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-self-hosted-runner-for-repo"]; readonly put?: never; @@ -5974,9 +6295,9 @@ export interface paths { * Delete a self-hosted runner from a repository * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-self-hosted-runner-from-repo"]; readonly options?: never; @@ -5995,9 +6316,9 @@ export interface paths { * List labels for a self-hosted runner for a repository * @description Lists all labels for a self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; /** @@ -6005,18 +6326,18 @@ export interface paths { * @description Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; /** * Add custom labels to a self-hosted runner for a repository - * @description Add custom labels to a self-hosted runner configured in a repository. + * @description Adds custom labels to a self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; /** @@ -6024,9 +6345,9 @@ export interface paths { * @description Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; readonly options?: never; @@ -6052,9 +6373,9 @@ export interface paths { * This endpoint returns a `404 Not Found` status if the custom label is not * present on the runner. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; readonly options?: never; @@ -6071,9 +6392,13 @@ export interface paths { }; /** * List workflow runs for a repository - * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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 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`. */ readonly get: operations["actions/list-workflow-runs-for-repo"]; readonly put?: never; @@ -6093,16 +6418,22 @@ export interface paths { }; /** * Get a workflow run - * @description Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific workflow run. + * + * 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. */ readonly get: operations["actions/get-workflow-run"]; readonly put?: never; readonly post?: never; /** * Delete a workflow run - * @description Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is - * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use - * this endpoint. + * @description Deletes a specific workflow run. + * + * Anyone with write access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-workflow-run"]; readonly options?: never; @@ -6119,7 +6450,9 @@ export interface paths { }; /** * Get the review history for a workflow run - * @description Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description 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. */ readonly get: operations["actions/get-reviews-for-run"]; readonly put?: never; @@ -6143,7 +6476,7 @@ export interface paths { * Approve a workflow run for a fork pull request * @description Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/approve-workflow-run"]; readonly delete?: never; @@ -6161,7 +6494,11 @@ export interface paths { }; /** * List workflow run artifacts - * @description Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Lists artifacts for a workflow run. + * + * 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. */ readonly get: operations["actions/list-workflow-run-artifacts"]; readonly put?: never; @@ -6181,10 +6518,11 @@ export interface paths { }; /** * Get a workflow run attempt - * @description Gets a specific workflow run attempt. Anyone with read access to the repository - * can use this endpoint. If the repository is private you must use an access token - * with the `repo` scope. GitHub Apps must have the `actions:read` permission to - * use this endpoint. + * @description Gets a specific workflow run attempt. + * + * 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. */ readonly get: operations["actions/get-workflow-run-attempt"]; readonly put?: never; @@ -6204,7 +6542,12 @@ export interface paths { }; /** * List jobs for a workflow run attempt - * @description Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information + * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + * + * 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. */ readonly get: operations["actions/list-jobs-for-workflow-run-attempt"]; readonly put?: never; @@ -6225,9 +6568,11 @@ export interface paths { /** * Download workflow run attempt logs * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to - * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * 1 minute. Look for `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/download-workflow-run-attempt-logs"]; readonly put?: never; @@ -6251,8 +6596,7 @@ export interface paths { * Cancel a workflow run * @description Cancels a workflow run using its `id`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/cancel-workflow-run"]; readonly delete?: never; @@ -6277,8 +6621,7 @@ export interface paths { * **Note:** GitHub Apps can only review their own custom deployment protection rules. * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have read and write permission for **Deployments** to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ readonly post: operations["actions/review-custom-gates-for-run"]; readonly delete?: never; @@ -6301,8 +6644,7 @@ export interface paths { * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/force-cancel-workflow-run"]; readonly delete?: never; @@ -6320,7 +6662,12 @@ export interface paths { }; /** * List jobs for a workflow run - * @description Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information + * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + * + * 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. */ readonly get: operations["actions/list-jobs-for-workflow-run"]; readonly put?: never; @@ -6341,16 +6688,20 @@ export interface paths { /** * Download workflow run logs * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use - * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have - * the `actions:read` permission to use this endpoint. + * `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/download-workflow-run-logs"]; readonly put?: never; readonly post?: never; /** * Delete workflow run logs - * @description Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * @description Deletes all logs for a workflow run. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-workflow-run-logs"]; readonly options?: never; @@ -6369,7 +6720,9 @@ export interface paths { * Get pending deployments for a workflow run * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-pending-deployments-for-run"]; readonly put?: never; @@ -6377,7 +6730,9 @@ export interface paths { * Review pending deployments for a workflow run * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint. + * Required reviewers with read access to the repository contents and deployments can use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/review-pending-deployments-for-run"]; readonly delete?: never; @@ -6397,7 +6752,9 @@ export interface paths { readonly put?: never; /** * Re-run a workflow - * @description Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * @description Re-runs your workflow run using its `id`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/re-run-workflow"]; readonly delete?: never; @@ -6417,7 +6774,9 @@ export interface paths { readonly put?: never; /** * Re-run failed jobs from a workflow run - * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. + * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/re-run-workflow-failed-jobs"]; readonly delete?: never; @@ -6437,7 +6796,9 @@ export interface paths { * Get workflow run usage * @description Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ readonly get: operations["actions/get-workflow-run-usage"]; readonly put?: never; @@ -6460,9 +6821,9 @@ export interface paths { * @description Lists all secrets available in a repository without revealing their encrypted * values. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/list-repo-secrets"]; readonly put?: never; @@ -6486,9 +6847,8 @@ export interface paths { * encrypt a secret before you can create or update secrets. * * Anyone with read access to the repository can use this endpoint. - * If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-repo-public-key"]; readonly put?: never; @@ -6510,9 +6870,9 @@ export interface paths { * Get a repository secret * @description Gets a single repository secret without revealing its encrypted value. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-repo-secret"]; /** @@ -6520,9 +6880,9 @@ export interface paths { * @description Creates or updates a repository secret with an encrypted value. 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)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/create-or-update-repo-secret"]; readonly post?: never; @@ -6530,9 +6890,9 @@ export interface paths { * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-repo-secret"]; readonly options?: never; @@ -6550,9 +6910,10 @@ export interface paths { /** * List repository variables * @description Lists all repository variables. - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + * * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/list-repo-variables"]; readonly put?: never; @@ -6560,9 +6921,9 @@ export interface paths { * Create a repository variable * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/create-repo-variable"]; readonly delete?: never; @@ -6582,9 +6943,9 @@ export interface paths { * Get a repository variable * @description Gets a specific variable in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["actions/get-repo-variable"]; readonly put?: never; @@ -6593,9 +6954,9 @@ export interface paths { * Delete a repository variable * @description Deletes a repository variable using the variable name. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["actions/delete-repo-variable"]; readonly options?: never; @@ -6604,9 +6965,9 @@ export interface paths { * Update a repository variable * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly patch: operations["actions/update-repo-variable"]; readonly trace?: never; @@ -6620,7 +6981,11 @@ export interface paths { }; /** * List repository workflows - * @description Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Lists the workflows in a repository. + * + * 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. */ readonly get: operations["actions/list-repo-workflows"]; readonly put?: never; @@ -6640,7 +7005,12 @@ export interface paths { }; /** * Get a workflow - * @description Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific workflow. You can replace `workflow_id` with the workflow + * file name. For example, you could use `main.yaml`. + * + * 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. */ readonly get: operations["actions/get-workflow"]; readonly put?: never; @@ -6663,7 +7033,7 @@ export interface paths { * Disable a workflow * @description Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/disable-workflow"]; readonly post?: never; @@ -6688,7 +7058,7 @@ export interface paths { * * You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["actions/create-workflow-dispatch"]; readonly delete?: never; @@ -6709,7 +7079,7 @@ export interface paths { * Enable a workflow * @description Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["actions/enable-workflow"]; readonly post?: never; @@ -6728,9 +7098,11 @@ export interface paths { }; /** * List workflow runs for a workflow - * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + * 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. */ readonly get: operations["actions/list-workflow-runs"]; readonly put?: never; @@ -6752,7 +7124,11 @@ export interface paths { * Get workflow usage * @description Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * 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. */ readonly get: operations["actions/get-workflow-usage"]; readonly put?: never; @@ -6838,8 +7214,8 @@ export interface paths { readonly cookie?: never; }; /** - * List all autolinks of a repository - * @description This returns a list of autolinks configured for the given repository. + * Get all autolinks of a repository + * @description Gets all autolinks that are configured for a repository. * * Information about autolinks are only available to repository administrators. */ @@ -7183,28 +7559,28 @@ export interface paths { * Get apps with access to the protected branch * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ readonly get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * Set app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ readonly put: operations["repos/set-app-access-restrictions"]; /** * Add app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ readonly post: operations["repos/add-app-access-restrictions"]; /** * Remove app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ readonly delete: operations["repos/remove-app-access-restrictions"]; readonly options?: never; @@ -7319,17 +7695,9 @@ export interface paths { * * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". * - * The permissions required to use this endpoint depends on whether you are renaming the default branch. - * - * To rename a non-default branch: - * - * * Users must have push access. - * * GitHub Apps must have the `contents:write` repository permission. + * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * - * To rename the default branch: - * - * * Users must have admin or owner permissions. - * * GitHub Apps must have the `administration:write` repository permission. + * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. */ readonly post: operations["repos/rename-branch"]; readonly delete?: never; @@ -7349,11 +7717,13 @@ export interface paths { readonly put?: never; /** * Create a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Creates a new check run for a specific commit in a repository. * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + * + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ readonly post: operations["checks/create"]; readonly delete?: never; @@ -7371,9 +7741,11 @@ export interface paths { }; /** * Get a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Gets a single check run using its `id`. * - * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ readonly get: operations["checks/get"]; readonly put?: never; @@ -7383,9 +7755,11 @@ export interface paths { readonly head?: never; /** * Update a check run - * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * @description Updates a check run for a specific commit in a repository. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ readonly patch: operations["checks/update"]; readonly trace?: never; @@ -7399,7 +7773,9 @@ export interface paths { }; /** * List check run annotations - * @description Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. + * @description Lists annotations for a check run using the annotation `id`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ readonly get: operations["checks/list-annotations"]; readonly put?: never; @@ -7423,9 +7799,9 @@ export interface paths { * Rerequest a check run * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. - * * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ readonly post: operations["checks/rerequest-run"]; readonly delete?: never; @@ -7445,9 +7821,11 @@ export interface paths { readonly put?: never; /** * Create a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ readonly post: operations["checks/create-suite"]; readonly delete?: never; @@ -7471,7 +7849,8 @@ export interface paths { readonly head?: never; /** * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. + * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). + * You must have admin permissions in the repository to set preferences for check suites. */ readonly patch: operations["checks/set-suites-preferences"]; readonly trace?: never; @@ -7485,9 +7864,11 @@ export interface paths { }; /** * Get a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Gets a single check suite using its `id`. + * + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ readonly get: operations["checks/get-suite"]; readonly put?: never; @@ -7507,9 +7888,11 @@ export interface paths { }; /** * List check runs in a check suite - * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * @description Lists check runs for a check suite using its `id`. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ readonly get: operations["checks/list-for-suite"]; readonly put?: never; @@ -7533,7 +7916,7 @@ export interface paths { * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ readonly post: operations["checks/rerequest-suite"]; readonly delete?: never; @@ -7553,11 +7936,11 @@ export interface paths { * List code scanning alerts for a repository * @description Lists code scanning alerts. * - * To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. - * * The response includes a `most_recent_instance` object. * This provides details of the most recent instance of this alert * for the default branch (or for the specified Git reference if you used `ref` in the request). + * + * 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/list-alerts-for-repo"]; readonly put?: never; @@ -7577,7 +7960,9 @@ export interface paths { }; /** * Get a code scanning alert - * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. + * @description Gets a single 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-alert"]; readonly put?: never; @@ -7587,7 +7972,8 @@ export interface paths { readonly head?: never; /** * Update a code scanning alert - * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. + * @description Updates the status of a single 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 patch: operations["code-scanning/update-alert"]; readonly trace?: never; @@ -7602,8 +7988,8 @@ export interface paths { /** * List instances of a code scanning alert * @description Lists all instances of the specified code scanning alert. - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. + * + * 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/list-alert-instances"]; readonly put?: never; @@ -7634,11 +8020,10 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. - * * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * + * 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/list-recent-analyses"]; readonly put?: never; @@ -7659,8 +8044,6 @@ export interface paths { /** * Get a code scanning analysis for a repository * @description Gets a specified code scanning analysis for a repository. - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. * * The default JSON response contains fields that describe the analysis. * This includes the Git reference and commit SHA to which the analysis relates, @@ -7672,20 +8055,18 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * If you use the Accept header `application/sarif+json`, - * the response contains the analysis data that was uploaded. - * This is formatted as - * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + * 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/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + * + * 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-analysis"]; readonly put?: never; readonly post?: never; /** * Delete a code scanning analysis from a repository - * @description Deletes a specified code scanning analysis from a repository. For - * private repositories, you must use an access token with the `repo` scope. For public repositories, - * you must use an access token with `public_repo` scope. - * GitHub Apps must have the `security_events` write permission to use this endpoint. + * @description Deletes a specified code scanning analysis from a repository. * * You can delete one analysis at a time. * To delete a series of analyses, start with the most recent analysis and work backwards. @@ -7747,6 +8128,8 @@ export interface paths { * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + * + * 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 delete: operations["code-scanning/delete-analysis"]; readonly options?: never; @@ -7765,8 +8148,7 @@ export interface paths { * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * For private repositories, you must use an access token with the `security_events` scope. - * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + * 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/list-codeql-databases"]; readonly put?: never; @@ -7794,8 +8176,7 @@ export interface paths { * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * For private repositories, you must use an access token with the `security_events` scope. - * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + * 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-codeql-database"]; readonly put?: never; @@ -7816,8 +8197,8 @@ export interface paths { /** * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. - * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. + * + * 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 get: operations["code-scanning/get-default-setup"]; readonly put?: never; @@ -7828,8 +8209,8 @@ export interface paths { /** * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. - * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. + * + * 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 patch: operations["code-scanning/update-default-setup"]; readonly trace?: never; @@ -7845,7 +8226,7 @@ export interface paths { readonly put?: never; /** * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." + * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -7856,7 +8237,7 @@ export interface paths { * ``` * gzip -c analysis-data.sarif | base64 -w0 * ``` - *
+ * * SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * @@ -7875,6 +8256,8 @@ export interface paths { * The `202 Accepted` response includes an `id` value. * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." + * + * 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/upload-sarif"]; readonly delete?: never; @@ -7892,7 +8275,8 @@ export interface paths { }; /** * Get information about a SARIF upload - * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. + * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." + * 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-sarif"]; readonly put?: never; @@ -7938,9 +8322,7 @@ export interface paths { * List codespaces in a repository for the authenticated user * @description Lists the codespaces associated to a specified repository and the authenticated user. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/list-in-repository-for-authenticated-user"]; readonly put?: never; @@ -7948,9 +8330,7 @@ export interface paths { * Create a codespace in a repository * @description Creates a codespace owned by the authenticated user in the specified repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly post: operations["codespaces/create-with-repo-for-authenticated-user"]; readonly delete?: never; @@ -7971,9 +8351,7 @@ export interface paths { * @description Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files * specify launchpoint configurations for codespaces created within the repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/list-devcontainers-in-repository-for-authenticated-user"]; readonly put?: never; @@ -7995,9 +8373,7 @@ export interface paths { * List available machine types for a repository * @description List the machine types available for a given repository based on its configuration. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/repo-machines-for-authenticated-user"]; readonly put?: never; @@ -8019,9 +8395,7 @@ export interface paths { * Get default attributes for a codespace * @description Gets the default attributes for codespaces created by the user with the repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"]; readonly put?: never; @@ -8043,9 +8417,7 @@ export interface paths { * Check if permissions defined by a devcontainer have been accepted by the authenticated user * @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/check-permissions-for-devcontainer"]; readonly put?: never; @@ -8065,7 +8437,10 @@ export interface paths { }; /** * List repository secrets - * @description Lists all development environment secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Lists all development environment secrets available in a repository without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["codespaces/list-repo-secrets"]; readonly put?: never; @@ -8085,7 +8460,12 @@ export interface paths { }; /** * Get a repository public key - * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["codespaces/get-repo-public-key"]; readonly put?: never; @@ -8105,7 +8485,9 @@ export interface paths { }; /** * Get a repository secret - * @description Gets a single repository development environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Gets a single repository development environment secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["codespaces/get-repo-secret"]; /** @@ -8113,15 +8495,15 @@ export interface paths { * @description Creates or updates a repository development environment secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - * repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["codespaces/create-or-update-repo-secret"]; readonly post?: never; /** * Delete a repository secret - * @description Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Deletes a development environment secret in a repository using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["codespaces/delete-repo-secret"]; readonly options?: never; @@ -8143,9 +8525,9 @@ export interface paths { * * Team members will include the members of child teams. * - * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - * endpoint. + * The authenticated user must have push access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ readonly get: operations["repos/list-collaborators"]; readonly put?: never; @@ -8169,9 +8551,9 @@ export interface paths { * * Team members will include the members of child teams. * - * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - * endpoint. + * The authenticated user must have push access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ readonly get: operations["repos/check-collaborator"]; /** @@ -8186,7 +8568,7 @@ export interface paths { * Cannot assign {member} permission of {role name} * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * @@ -8265,9 +8647,14 @@ export interface paths { }; /** * List commit comments for a repository - * @description Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. + * + * 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)." * - * Comments are ordered by ascending ID. + * - **`application/vnd.github-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["repos/list-commit-comments-for-repo"]; readonly put?: never; @@ -8285,7 +8672,17 @@ export interface paths { readonly path?: never; readonly cookie?: never; }; - /** Get a commit comment */ + /** + * Get a commit comment + * @description Gets a specified commit comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ readonly get: operations["repos/get-commit-comment"]; readonly put?: never; readonly post?: never; @@ -8293,7 +8690,17 @@ export interface paths { readonly delete: operations["repos/delete-commit-comment"]; readonly options?: never; readonly head?: never; - /** Update a commit comment */ + /** + * Update a commit comment + * @description Updates the contents of a specified commit comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ readonly patch: operations["repos/update-commit-comment"]; readonly trace?: never; }; @@ -8421,7 +8828,14 @@ export interface paths { }; /** * List commit comments - * @description Use the `:commit_sha` to specify the commit that will have its comments listed. + * @description Lists the comments for a specified commit. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["repos/list-comments-for-commit"]; readonly put?: never; @@ -8430,6 +8844,13 @@ export interface paths { * @description Create a comment for a commit using its `:commit_sha`. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly post: operations["repos/create-commit-comment"]; readonly delete?: never; @@ -8471,11 +8892,13 @@ export interface paths { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property. + * 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)." Pagination query parameters are not supported for these media types. * - * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. * * **Signature verification object** * @@ -8524,11 +8947,13 @@ export interface paths { }; /** * List check runs for a Git reference - * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ readonly get: operations["checks/list-for-ref"]; readonly put?: never; @@ -8548,9 +8973,11 @@ export interface paths { }; /** * List check suites for a Git reference - * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ readonly get: operations["checks/list-suites-for-ref"]; readonly put?: never; @@ -8649,9 +9076,14 @@ export interface paths { }; /** * Compare two commits - * @description Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * + * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. + * + * 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)." * - * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. * * The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. * @@ -8713,50 +9145,40 @@ export interface paths { }; /** * Get repository content - * @description Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit - * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. + * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. + * + * 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 file contents for files and symlinks. + * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + * + * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". * - * Files and symlinks support [a custom media type](https://docs.github.com/rest/overview/media-types) for - * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media - * type](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent - * object format. + * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + * + * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. * * **Notes**: - * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). - * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees - * API](https://docs.github.com/rest/git/trees#get-a-tree). - * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * Size limits: - * If the requested file's size is: - * * 1 MB or smaller: All features of this endpoint are supported. - * * Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * * Greater than 100 MB: This endpoint is not supported. - * - * If the content is a directory: - * The response will be an array of objects, one object for each item in the directory. - * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value - * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). - * In the next major version of the API, the type will be returned as "submodule". - * - * If the content is a symlink: - * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the - * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object - * describing the symlink itself. - * - * If the content is a submodule: - * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific - * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out - * the submodule at that specific commit. - * - * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the - * github.com URLs (`html_url` and `_links["html"]`) will have null values. + * + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). + * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve + * more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). + * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + * - If the requested file's size is: + * - 1 MB or smaller: All features of this endpoint are supported. + * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + * - Greater than 100 MB: This endpoint is not supported. */ readonly get: operations["repos/get-content"]; /** * Create or update file contents - * @description Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. + * @description Creates a new file or replaces an existing file in a repository. * * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ readonly put: operations["repos/create-or-update-file-contents"]; readonly post?: never; @@ -8809,9 +9231,7 @@ export interface paths { }; /** * List Dependabot alerts for a repository - * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * @description OAuth app tokens and personal access tokens (classic) need the `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["dependabot/list-alerts-for-repo"]; readonly put?: never; @@ -8831,9 +9251,7 @@ export interface paths { }; /** * Get a Dependabot alert - * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * @description OAuth app tokens and personal access tokens (classic) need the `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["dependabot/get-alert"]; readonly put?: never; @@ -8843,11 +9261,9 @@ export interface paths { readonly head?: never; /** * Update a Dependabot alert - * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** write permission to use this endpoint. + * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * - * To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + * OAuth app tokens and personal access tokens (classic) need the `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 patch: operations["dependabot/update-alert"]; readonly trace?: never; @@ -8861,7 +9277,10 @@ export interface paths { }; /** * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Lists all secrets available in a repository without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["dependabot/list-repo-secrets"]; readonly put?: never; @@ -8881,7 +9300,11 @@ export interface paths { }; /** * Get a repository public key - * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. 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 if the repository is private. */ readonly get: operations["dependabot/get-repo-public-key"]; readonly put?: never; @@ -8901,7 +9324,9 @@ export interface paths { }; /** * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Gets a single repository secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["dependabot/get-repo-secret"]; /** @@ -8909,15 +9334,15 @@ export interface paths { * @description Creates or updates a repository secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository - * permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["dependabot/create-or-update-repo-secret"]; readonly post?: never; /** * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Deletes a secret in a repository using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["dependabot/delete-repo-secret"]; readonly options?: never; @@ -8976,7 +9401,11 @@ export interface paths { readonly put?: never; /** * Create a snapshot of dependencies for a repository - * @description Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to. + * @description Create a new snapshot of a repository's dependencies. + * + * The authenticated user must have access to the repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["dependency-graph/create-repository-snapshot"]; readonly delete?: never; @@ -9026,8 +9455,6 @@ export interface paths { * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an * application with debugging enabled. * - * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. - * * Merged branch response: * * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating @@ -9048,6 +9475,8 @@ export interface paths { * * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ readonly post: operations["repos/create-deployment"]; readonly delete?: never; @@ -9069,7 +9498,7 @@ export interface paths { readonly post?: never; /** * Delete a deployment - * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. + * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. * * To set a deployment as inactive, you must: * @@ -9077,6 +9506,8 @@ export interface paths { * * Mark the active deployment as inactive by adding any non-successful deployment status. * * For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ readonly delete: operations["repos/delete-deployment"]; readonly options?: never; @@ -9101,7 +9532,7 @@ export interface paths { * Create a deployment status * @description Users with `push` access can create deployment statuses for a given deployment. * - * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. */ readonly post: operations["repos/create-deployment-status"]; readonly delete?: never; @@ -9145,12 +9576,9 @@ export interface paths { * * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * - * This endpoint requires write access to the repository by providing either: - * - * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. - * * This input example shows how you can use the `client_payload` as a test to debug your workflow. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["repos/create-dispatch-event"]; readonly delete?: never; @@ -9170,7 +9598,9 @@ export interface paths { * List environments * @description Lists the environments for a repository. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ readonly get: operations["repos/get-all-environments"]; readonly put?: never; @@ -9192,9 +9622,9 @@ export interface paths { * Get an environment * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * - * Anyone with read access to the repository can use this endpoint. If the - * repository is private, you must use an access token with the `repo` scope. GitHub - * Apps must have the `actions:read` permission to use this endpoint. + * 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. */ readonly get: operations["repos/get-environment"]; /** @@ -9205,13 +9635,13 @@ export interface paths { * * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["repos/create-or-update-environment"]; readonly post?: never; /** * Delete an environment - * @description You must authenticate using an access token with the repo scope to use this endpoint. + * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["repos/delete-an-environment"]; readonly options?: never; @@ -9230,7 +9660,9 @@ export interface paths { * List deployment branch policies * @description Lists the deployment branch policies for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ readonly get: operations["repos/list-deployment-branch-policies"]; readonly put?: never; @@ -9238,7 +9670,7 @@ export interface paths { * Create a deployment branch policy * @description Creates a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["repos/create-deployment-branch-policy"]; readonly delete?: never; @@ -9258,14 +9690,16 @@ export interface paths { * Get a deployment branch policy * @description Gets a deployment branch or tag policy for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ readonly get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy * @description Updates a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["repos/update-deployment-branch-policy"]; readonly post?: never; @@ -9273,7 +9707,7 @@ export interface paths { * Delete a deployment branch policy * @description Deletes a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["repos/delete-deployment-branch-policy"]; readonly options?: never; @@ -9290,9 +9724,11 @@ export interface paths { }; /** * Get all deployment protection rules for an environment - * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ readonly get: operations["repos/get-all-deployment-protection-rules"]; readonly put?: never; @@ -9300,9 +9736,11 @@ export interface paths { * Create a custom deployment protection rule on an environment * @description Enable a custom deployment protection rule for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["repos/create-deployment-protection-rule"]; readonly delete?: never; @@ -9320,11 +9758,13 @@ export interface paths { }; /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ readonly get: operations["repos/list-custom-deployment-rule-integrations"]; readonly put?: never; @@ -9344,9 +9784,11 @@ export interface paths { }; /** * Get a custom deployment protection rule - * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ readonly get: operations["repos/get-custom-deployment-protection-rule"]; readonly put?: never; @@ -9355,7 +9797,9 @@ export interface paths { * Disable a custom protection rule for an environment * @description Disables a custom deployment protection rule for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)". + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["repos/disable-deployment-protection-rule"]; readonly options?: never; @@ -9363,6 +9807,169 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly get: operations["actions/list-environment-secrets"]; + 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}/environments/{environment_name}/secrets/public-key": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly get: operations["actions/get-environment-public-key"]; + 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}/environments/{environment_name}/secrets/{secret_name}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly get: operations["actions/get-environment-secret"]; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. 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)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly put: operations["actions/create-or-update-environment-secret"]; + readonly post?: never; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly delete: operations["actions/delete-environment-secret"]; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly get: operations["actions/list-environment-variables"]; + readonly put?: never; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly post: operations["actions/create-environment-variable"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; + readonly "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly get: operations["actions/get-environment-variable"]; + readonly put?: never; + readonly post?: never; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly delete: operations["actions/delete-environment-variable"]; + readonly options?: never; + readonly head?: never; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + readonly patch: operations["actions/update-environment-variable"]; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/events": { readonly parameters: { readonly query?: never; @@ -9437,7 +10044,12 @@ export interface paths { * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * _Note_: This API supports blobs up to 100 megabytes in size. + * 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 blob data. + * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + * + * **Note** This endpoint supports blobs up to 100 megabytes in size. */ readonly get: operations["git/get-blob"]; readonly put?: never; @@ -9626,11 +10238,17 @@ export interface paths { readonly get?: never; readonly put?: never; readonly post?: never; - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ readonly delete: operations["git/delete-ref"]; readonly options?: never; readonly head?: never; - /** Update a reference */ + /** + * Update a reference + * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + */ readonly patch: operations["git/update-ref"]; readonly trace?: never; }; @@ -9840,7 +10458,7 @@ export interface paths { * Get a webhook configuration for a repository * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * - * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. */ readonly get: operations["repos/get-webhook-config-for-repo"]; readonly put?: never; @@ -9852,7 +10470,7 @@ export interface paths { * Update a webhook configuration for a repository * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * - * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. */ readonly patch: operations["repos/update-webhook-config-for-repo"]; readonly trace?: never; @@ -10250,6 +10868,13 @@ export interface paths { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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-for-repo"]; readonly put?: never; @@ -10259,6 +10884,13 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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/create"]; readonly delete?: never; @@ -10279,6 +10911,13 @@ export interface paths { * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. * * By default, issue comments are ordered by ascending ID. + * + * 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-comments-for-repo"]; readonly put?: never; @@ -10299,6 +10938,13 @@ export interface paths { /** * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + * + * 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/get-comment"]; readonly put?: never; @@ -10313,6 +10959,13 @@ export interface paths { /** * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + * + * 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 patch: operations["issues/update-comment"]; readonly trace?: never; @@ -10412,7 +11065,7 @@ export interface paths { }; /** * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was + * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read @@ -10423,6 +11076,13 @@ export interface paths { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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/get"]; readonly put?: never; @@ -10433,6 +11093,13 @@ export interface paths { /** * Update an issue * @description Issue owners and users with push access can edit 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 patch: operations["issues/update"]; readonly trace?: never; @@ -10497,18 +11164,31 @@ export interface paths { * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * * Issue comments are ordered by ascending ID. + * + * 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-comments"]; readonly put?: never; /** * Create an issue comment - * @description - * You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). * 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/overview/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/create-comment"]; readonly delete?: never; @@ -10601,7 +11281,7 @@ export interface paths { * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ readonly put: operations["issues/lock"]; readonly post?: never; @@ -10806,7 +11486,10 @@ export interface paths { * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. + * 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 contents of the license. + * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ readonly get: operations["licenses/get-for-repo"]; readonly put?: never; @@ -10958,28 +11641,34 @@ export interface paths { * Get a GitHub Pages site * @description Gets information about a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["repos/get-pages"]; /** * Update information about a GitHub Pages site * @description Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly put: operations["repos/update-information-about-pages-site"]; /** * Create a GitHub Pages site * @description Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly post: operations["repos/create-pages-site"]; /** * Delete a GitHub Pages site * @description Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly delete: operations["repos/delete-pages-site"]; readonly options?: never; @@ -10998,7 +11687,7 @@ export interface paths { * List GitHub Pages builds * @description Lists builts of a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["repos/list-pages-builds"]; readonly put?: never; @@ -11026,7 +11715,7 @@ export interface paths { * Get latest Pages build * @description Gets information about the single most recent build of a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["repos/get-latest-pages-build"]; readonly put?: never; @@ -11048,7 +11737,7 @@ export interface paths { * Get GitHub Pages build * @description Gets information about a GitHub Pages build. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["repos/get-pages-build"]; readonly put?: never; @@ -11059,7 +11748,7 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; - readonly "/repos/{owner}/{repo}/pages/deployment": { + readonly "/repos/{owner}/{repo}/pages/deployments": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -11072,7 +11761,7 @@ export interface paths { * Create a GitHub Pages deployment * @description Create a GitHub Pages deployment for a repository. * - * Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint. + * The authenticated user must have write permission to the repository. */ readonly post: operations["repos/create-pages-deployment"]; readonly delete?: never; @@ -11081,6 +11770,50 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + /** + * Get the status of a GitHub Pages deployment + * @description Gets the current status of a GitHub Pages deployment. + * + * The authenticated user must have read permission for the GitHub Pages site. + */ + readonly get: operations["repos/get-pages-deployment"]; + 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}/pages/deployments/{pages_deployment_id}/cancel": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Cancel a GitHub Pages deployment + * @description Cancels a GitHub Pages deployment. + * + * The authenticated user must have write permissions for the GitHub Pages site. + */ + readonly post: operations["repos/cancel-pages-deployment"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/pages/health": { readonly parameters: { readonly query?: never; @@ -11094,7 +11827,9 @@ export interface paths { * * The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["repos/get-pages-health-check"]; readonly put?: never; @@ -11112,7 +11847,11 @@ export interface paths { readonly path?: never; readonly cookie?: never; }; - readonly get?: never; + /** + * Check if private vulnerability reporting is enabled for a repository + * @description Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + */ + readonly get: operations["repos/check-private-vulnerability-reporting"]; /** * Enable private vulnerability reporting for a repository * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." @@ -11171,7 +11910,14 @@ export interface paths { readonly delete?: never; readonly options?: never; readonly head?: never; - readonly patch?: never; + /** + * Create or update custom property values for a repository + * @description Create new or update existing custom property values for a repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + */ + readonly patch: operations["repos/create-or-update-custom-properties-values"]; readonly trace?: never; }; readonly "/repos/{owner}/{repo}/pulls": { @@ -11183,7 +11929,20 @@ export interface paths { }; /** * List pull requests - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Lists pull requests in a specified repository. + * + * Draft pull requests are available in public repositories with GitHub + * Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing + * plans, and in public and private repositories with GitHub Team and GitHub Enterprise + * Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) + * in the GitHub Help documentation. + * + * 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["pulls/list"]; readonly put?: never; @@ -11194,6 +11953,13 @@ export interface paths { * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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["pulls/create"]; readonly delete?: never; @@ -11211,7 +11977,15 @@ export interface paths { }; /** * List review comments in a repository - * @description Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. + * @description Lists review comments for all pull requests in a repository. By default, + * review comments are in ascending order by ID. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["pulls/list-review-comments-for-repo"]; readonly put?: never; @@ -11231,7 +12005,14 @@ export interface paths { }; /** * Get a review comment for a pull request - * @description Provides details for a review comment. + * @description Provides details for a specified review comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["pulls/get-review-comment"]; readonly put?: never; @@ -11245,7 +12026,14 @@ export interface paths { readonly head?: never; /** * Update a review comment for a pull request - * @description Enables you to edit a review comment. + * @description Edits the content of a specified review comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly patch: operations["pulls/update-review-comment"]; readonly trace?: never; @@ -11320,6 +12108,14 @@ export interface paths { * * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * + * 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`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ readonly get: operations["pulls/get"]; readonly put?: never; @@ -11332,6 +12128,13 @@ export interface paths { * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + * + * 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 patch: operations["pulls/update"]; readonly trace?: never; @@ -11349,9 +12152,7 @@ export interface paths { * Create a codespace from a pull request * @description Creates a codespace owned by the authenticated user for the specified pull request. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly post: operations["codespaces/create-with-pr-for-authenticated-user"]; readonly delete?: never; @@ -11369,21 +12170,35 @@ export interface paths { }; /** * List review comments on a pull request - * @description Lists all review comments for a pull request. By default, review comments are in ascending order by ID. + * @description Lists all review comments for a specified pull request. By default, review comments + * are in ascending order by ID. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["pulls/list-review-comments"]; readonly put?: never; /** * Create a review comment for a pull request - * @description - * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. + * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly post: operations["pulls/create-review-comment"]; readonly delete?: never; @@ -11407,6 +12222,13 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly post: operations["pulls/create-reply-for-review-comment"]; readonly delete?: never; @@ -11424,7 +12246,16 @@ export interface paths { }; /** * List commits on a pull request - * @description Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. + * @description Lists a maximum of 250 commits for a pull request. To receive a complete + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) + * endpoint. + * + * 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["pulls/list-commits"]; readonly put?: never; @@ -11444,7 +12275,17 @@ export interface paths { }; /** * List pull requests files - * @description **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. + * @description Lists the files in a specified pull request. + * + * **Note:** Responses include a maximum of 3000 files. The paginated response + * returns 30 files per page by default. + * + * 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["pulls/list-files"]; readonly put?: never; @@ -11518,19 +12359,35 @@ export interface paths { }; /** * List reviews for a pull request - * @description The list of reviews returns in chronological order. + * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["pulls/list-reviews"]; readonly put?: never; /** * Create a review for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + * @description Creates a review on a specified pull request. + * + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly post: operations["pulls/create-review"]; readonly delete?: never; @@ -11549,17 +12406,38 @@ export interface paths { /** * Get a review for a pull request * @description Retrieves a pull request review by its ID. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["pulls/get-review"]; /** * Update a review for a pull request - * @description Update the review summary comment with new text. + * @description Updates the contents of a specified review summary comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly put: operations["pulls/update-review"]; readonly post?: never; /** * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly delete: operations["pulls/delete-pending-review"]; readonly options?: never; @@ -11576,7 +12454,14 @@ export interface paths { }; /** * List comments for a pull request review - * @description List comments for a specific pull request review. + * @description Lists comments for a specific pull request review. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly get: operations["pulls/list-comments-for-review"]; readonly put?: never; @@ -11597,7 +12482,18 @@ export interface paths { readonly get?: never; /** * Dismiss a review for a pull request - * @description **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + * @description Dismisses a specified review on a pull request. + * + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), + * you must be a repository administrator or be included in the list of people or teams + * who can dismiss pull request reviews. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly put: operations["pulls/dismiss-review"]; readonly post?: never; @@ -11619,6 +12515,13 @@ export interface paths { /** * Submit a review for a pull request * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ readonly post: operations["pulls/submit-review"]; readonly delete?: never; @@ -11658,7 +12561,10 @@ export interface paths { * Get a repository README * @description Gets the preferred README for a repository. * - * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + * 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 file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ readonly get: operations["repos/get-readme"]; readonly put?: never; @@ -11680,7 +12586,10 @@ export interface paths { * Get a repository README for a directory * @description Gets the README from a repository directory. * - * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + * 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 file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ readonly get: operations["repos/get-readme-in-directory"]; readonly put?: never; @@ -11815,7 +12724,11 @@ export interface paths { }; /** * Get a release - * @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). + * @description Gets a public release with the specified release ID. + * + * **Note:** This returns an `upload_url` key corresponding to the endpoint + * for uploading release assets. This key is a hypermedia resource. For more information, see + * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ readonly get: operations["repos/get-release"]; readonly put?: never; @@ -11846,7 +12759,7 @@ export interface paths { readonly put?: never; /** * Upload a release asset - * @description This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in + * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset. * * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. @@ -12046,10 +12959,10 @@ export interface paths { /** * List secret scanning alerts for a repository * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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/list-alerts-for-repo"]; readonly put?: never; @@ -12070,10 +12983,10 @@ export interface paths { /** * Get a secret scanning alert * @description Gets a single secret scanning alert detected in an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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-alert"]; readonly put?: never; @@ -12084,10 +12997,10 @@ export interface paths { /** * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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 patch: operations["secret-scanning/update-alert"]; readonly trace?: never; @@ -12102,10 +13015,10 @@ export interface paths { /** * List locations for a secret scanning alert * @description Lists all locations for a given secret scanning alert for an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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/list-locations-for-alert"]; readonly put?: never; @@ -12126,19 +13039,20 @@ export interface paths { /** * List repository security advisories * @description Lists security advisories in a repository. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - * in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to. * - * You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory. + * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ readonly get: operations["security-advisories/list-repository-advisories"]; readonly put?: never; /** * Create a repository security advisory * @description Creates a new repository security advisory. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. * - * In order to create a draft repository security advisory, you must be a security manager or administrator of that repository. + * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ readonly post: operations["security-advisories/create-repository-advisory"]; readonly delete?: never; @@ -12178,12 +13092,13 @@ export interface paths { /** * Get a repository security advisory * @description Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - * You can access any published security advisory on a public repository. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - * in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to. * - * You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a + * Anyone can access any published security advisory on a public repository. + * + * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a * collaborator on the security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ readonly get: operations["security-advisories/get-repository-advisory"]; readonly put?: never; @@ -12194,10 +13109,11 @@ export interface paths { /** * Update a repository security advisory * @description Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. * - * In order to update any security advisory, you must be a security manager or administrator of that repository, + * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, * or a collaborator on the repository security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ readonly patch: operations["security-advisories/update-repository-advisory"]; readonly trace?: never; @@ -12217,9 +13133,9 @@ export interface paths { * * You may request a CVE for public repositories, but cannot do so for private repositories. * - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + * In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. * - * In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ readonly post: operations["security-advisories/create-repository-advisory-cve-request"]; readonly delete?: never; @@ -12228,6 +13144,28 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; + readonly "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path?: never; + readonly cookie?: never; + }; + readonly get?: never; + readonly put?: never; + /** + * Create a temporary private fork + * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. + * + * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + */ + readonly post: operations["security-advisories/create-fork"]; + readonly delete?: never; + readonly options?: never; + readonly head?: never; + readonly patch?: never; + readonly trace?: never; + }; readonly "/repos/{owner}/{repo}/stargazers": { readonly parameters: { readonly query?: never; @@ -12239,7 +13177,9 @@ export interface paths { * List stargazers * @description Lists the people that have starred the repository. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * 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.star+json`**: Includes a timestamp of when the star was created. */ readonly get: operations["activity/list-stargazers-for-repo"]; readonly put?: never; @@ -12259,7 +13199,12 @@ export interface paths { }; /** * Get the weekly commit activity - * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * @description + * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * + * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains + * 10,000 or more commits, a 422 status code will be returned. + * */ readonly get: operations["repos/get-code-frequency-stats"]; readonly put?: never; @@ -12302,10 +13247,12 @@ export interface paths { * @description * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * - * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). * * `a` - Number of additions * * `d` - Number of deletions * * `c` - Number of commits + * + * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ readonly get: operations["repos/get-contributors-stats"]; readonly put?: never; @@ -12537,11 +13484,7 @@ export interface paths { * * For a public repository, a team is listed only if that team added the public repository explicitly. * - * Personal access tokens require the following scopes: - * * `public_repo` to call this endpoint on a public repository - * * `repo` to call this endpoint on a private repository (this scope also includes public repositories) - * - * This endpoint is not compatible with fine-grained personal access tokens. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. */ readonly get: operations["repos/list-teams"]; readonly put?: never; @@ -12662,7 +13605,6 @@ export interface paths { /** * Transfer a repository * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). - * You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. */ readonly post: operations["repos/transfer"]; readonly delete?: never; @@ -12738,12 +13680,7 @@ export interface paths { * Create a repository using a template * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ readonly post: operations["repos/create-using-template"]; readonly delete?: never; @@ -12776,170 +13713,6 @@ export interface paths { readonly patch?: never; readonly trace?: never; }; - readonly "/repositories/{repository_id}/environments/{environment_name}/secrets": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - readonly get: operations["actions/list-environment-secrets"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - readonly get: operations["actions/get-environment-public-key"]; - readonly put?: never; - readonly post?: never; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - readonly get: operations["actions/get-environment-secret"]; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. 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)." - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - readonly put: operations["actions/create-or-update-environment-secret"]; - readonly post?: never; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - readonly delete: operations["actions/delete-environment-secret"]; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repositories/{repository_id}/environments/{environment_name}/variables": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * List environment variables - * @description Lists all environment variables. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environments:read` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - readonly get: operations["actions/list-environment-variables"]; - readonly put?: never; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - readonly post: operations["actions/create-environment-variable"]; - readonly delete?: never; - readonly options?: never; - readonly head?: never; - readonly patch?: never; - readonly trace?: never; - }; - readonly "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path?: never; - readonly cookie?: never; - }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environments:read` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - readonly get: operations["actions/get-environment-variable"]; - readonly put?: never; - readonly post?: never; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - readonly delete: operations["actions/delete-environment-variable"]; - readonly options?: never; - readonly head?: never; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - readonly patch: operations["actions/update-environment-variable"]; - readonly trace?: never; - }; readonly "/search/code": { readonly parameters: { readonly query?: never; @@ -13202,7 +13975,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * - * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List all discussions on a team's page. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/list-discussions-legacy"]; readonly put?: never; @@ -13211,9 +13986,11 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * - * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Creates a new discussion post on a team's page. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["teams/create-discussion-legacy"]; readonly delete?: never; @@ -13234,7 +14011,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * - * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Get a specific discussion on a team's page. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/get-discussion-legacy"]; readonly put?: never; @@ -13244,7 +14023,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * - * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a discussion from a team's page. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly delete: operations["teams/delete-discussion-legacy"]; readonly options?: never; @@ -13254,7 +14035,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly patch: operations["teams/update-discussion-legacy"]; readonly trace?: never; @@ -13271,7 +14054,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * - * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List all comments on a team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/list-discussion-comments-legacy"]; readonly put?: never; @@ -13280,9 +14065,11 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * - * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Creates a new comment on a team discussion. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["teams/create-discussion-comment-legacy"]; readonly delete?: never; @@ -13303,7 +14090,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * - * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Get a specific comment on a team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["teams/get-discussion-comment-legacy"]; readonly put?: never; @@ -13313,7 +14102,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * - * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Deletes a comment on a team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly delete: operations["teams/delete-discussion-comment-legacy"]; readonly options?: never; @@ -13323,7 +14114,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * - * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Edits the body text of a discussion comment. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly patch: operations["teams/update-discussion-comment-legacy"]; readonly trace?: never; @@ -13340,7 +14133,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["reactions/list-for-team-discussion-comment-legacy"]; readonly put?: never; @@ -13349,7 +14144,11 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["reactions/create-for-team-discussion-comment-legacy"]; readonly delete?: never; @@ -13370,7 +14169,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ readonly get: operations["reactions/list-for-team-discussion-legacy"]; readonly put?: never; @@ -13379,7 +14180,11 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ readonly post: operations["reactions/create-for-team-discussion-legacy"]; readonly delete?: never; @@ -13464,7 +14269,7 @@ export interface paths { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ readonly put: operations["teams/add-member-legacy"]; readonly post?: never; @@ -13648,7 +14453,7 @@ export interface paths { * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ readonly put: operations["teams/add-or-update-repo-permissions-legacy"]; readonly post?: never; @@ -13695,9 +14500,7 @@ export interface paths { }; /** * Get the authenticated user - * @description If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information. - * - * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. */ readonly get: operations["users/get-authenticated"]; readonly put?: never; @@ -13771,9 +14574,7 @@ export interface paths { * List codespaces for the authenticated user * @description Lists the authenticated user's codespaces. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/list-for-authenticated-user"]; readonly put?: never; @@ -13783,9 +14584,7 @@ export interface paths { * * This endpoint requires either a `repository_id` OR a `pull_request` but not both. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly post: operations["codespaces/create-for-authenticated-user"]; readonly delete?: never; @@ -13806,9 +14605,9 @@ export interface paths { * @description Lists all development environment secrets available for a user's codespaces without revealing their * encrypted values. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly get: operations["codespaces/list-secrets-for-authenticated-user"]; readonly put?: never; @@ -13830,9 +14629,9 @@ export interface paths { * Get public key for the authenticated user * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly get: operations["codespaces/get-public-key-for-authenticated-user"]; readonly put?: never; @@ -13854,9 +14653,9 @@ export interface paths { * Get a secret for the authenticated user * @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly get: operations["codespaces/get-secret-for-authenticated-user"]; /** @@ -13864,9 +14663,9 @@ export interface paths { * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. 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)." * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; readonly post?: never; @@ -13874,9 +14673,9 @@ export interface paths { * Delete a secret for the authenticated user * @description Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly delete: operations["codespaces/delete-secret-for-authenticated-user"]; readonly options?: never; @@ -13895,18 +14694,18 @@ export interface paths { * List selected repositories for a user secret * @description List the repositories that have been granted the ability to use a user's development environment secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; /** * Set selected repositories for a user secret * @description Select the repositories that will use a user's development environment secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; readonly post?: never; @@ -13927,16 +14726,20 @@ export interface paths { /** * Add a selected repository to a user secret * @description Adds a repository to the selected repositories for a user's development environment secret. - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. + * + * The authenticated user must have Codespaces access to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; readonly post?: never; /** * Remove a selected repository from a user secret * @description Removes a repository from the selected repositories for a user's development environment secret. - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + * + * The authenticated user must have Codespaces access to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ readonly delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; readonly options?: never; @@ -13955,9 +14758,7 @@ export interface paths { * Get a codespace for the authenticated user * @description Gets information about a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/get-for-authenticated-user"]; readonly put?: never; @@ -13966,9 +14767,7 @@ export interface paths { * Delete a codespace for the authenticated user * @description Deletes a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly delete: operations["codespaces/delete-for-authenticated-user"]; readonly options?: never; @@ -13979,9 +14778,7 @@ export interface paths { * * If you specify a new machine type it will be applied the next time your codespace is started. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly patch: operations["codespaces/update-for-authenticated-user"]; readonly trace?: never; @@ -14001,9 +14798,7 @@ export interface paths { * * If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly post: operations["codespaces/export-for-authenticated-user"]; readonly delete?: never; @@ -14023,9 +14818,7 @@ export interface paths { * Get details about a codespace export * @description Gets information about an export of a codespace. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/get-export-details-for-authenticated-user"]; readonly put?: never; @@ -14047,9 +14840,7 @@ export interface paths { * List machine types for a codespace * @description List the machine types a codespace can transition to use. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly get: operations["codespaces/codespace-machines-for-authenticated-user"]; readonly put?: never; @@ -14077,9 +14868,7 @@ export interface paths { * * This will fail for a codespace that is already published, meaning it has an associated repository. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly post: operations["codespaces/publish-for-authenticated-user"]; readonly delete?: never; @@ -14101,9 +14890,7 @@ export interface paths { * Start a codespace for the authenticated user * @description Starts a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly post: operations["codespaces/start-for-authenticated-user"]; readonly delete?: never; @@ -14125,9 +14912,7 @@ export interface paths { * Stop a codespace for the authenticated user * @description Stops a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ readonly post: operations["codespaces/stop-for-authenticated-user"]; readonly delete?: never; @@ -14146,7 +14931,8 @@ export interface paths { /** * Get list of conflicting packages during Docker migration for authenticated-user * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ readonly get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"]; readonly put?: never; @@ -14186,18 +14972,21 @@ export interface paths { }; /** * List email addresses for the authenticated user - * @description Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. + * @description Lists all of your email addresses, and specifies which one is visible + * to the public. + * + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ readonly get: operations["users/list-emails-for-authenticated-user"]; readonly put?: never; /** * Add an email address for the authenticated user - * @description This endpoint is accessible with the `user` scope. + * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ readonly post: operations["users/add-email-for-authenticated-user"]; /** * Delete an email address for the authenticated user - * @description This endpoint is accessible with the `user` scope. + * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ readonly delete: operations["users/delete-email-for-authenticated-user"]; readonly options?: never; @@ -14256,15 +15045,15 @@ export interface paths { readonly get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ readonly put: operations["users/follow"]; readonly post?: never; /** * Unfollow a user - * @description Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ readonly delete: operations["users/unfollow"]; readonly options?: never; @@ -14281,13 +15070,17 @@ export interface paths { }; /** * List GPG keys for the authenticated user - * @description Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Lists the current user's GPG keys. + * + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ readonly get: operations["users/list-gpg-keys-for-authenticated-user"]; readonly put?: never; /** * Create a GPG key for the authenticated user - * @description Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Adds a GPG key to the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ readonly post: operations["users/create-gpg-key-for-authenticated-user"]; readonly delete?: never; @@ -14305,14 +15098,18 @@ export interface paths { }; /** * Get a GPG key for the authenticated user - * @description View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description View extended details for a single GPG key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ readonly get: operations["users/get-gpg-key-for-authenticated-user"]; readonly put?: never; readonly post?: never; /** * Delete a GPG key for the authenticated user - * @description Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Removes a GPG key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. */ readonly delete: operations["users/delete-gpg-key-for-authenticated-user"]; readonly options?: never; @@ -14331,8 +15128,6 @@ export interface paths { * List app installations accessible to the user access token * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * * You can find the permissions for the installation under the `permissions` key. @@ -14359,8 +15154,6 @@ export interface paths { * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - * * The access the user has to each repository is included in the hash under the `permissions` key. */ readonly get: operations["apps/list-installation-repos-for-authenticated-user"]; @@ -14383,16 +15176,12 @@ export interface paths { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ readonly put: operations["apps/add-repo-to-installation-for-authenticated-user"]; readonly post?: never; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ readonly delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; readonly options?: never; @@ -14443,6 +15232,13 @@ export interface paths { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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-for-authenticated-user"]; readonly put?: never; @@ -14462,13 +15258,17 @@ export interface paths { }; /** * List public SSH keys for the authenticated user - * @description Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Lists the public SSH keys for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ readonly get: operations["users/list-public-ssh-keys-for-authenticated-user"]; readonly put?: never; /** * Create a public SSH key for the authenticated user - * @description Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Adds a public SSH key to the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ readonly post: operations["users/create-public-ssh-key-for-authenticated-user"]; readonly delete?: never; @@ -14486,14 +15286,18 @@ export interface paths { }; /** * Get a public SSH key for the authenticated user - * @description View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description View extended details for a single public SSH key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ readonly get: operations["users/get-public-ssh-key-for-authenticated-user"]; readonly put?: never; readonly post?: never; /** * Delete a public SSH key for the authenticated user - * @description Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Removes a public SSH key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. */ readonly delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; readonly options?: never; @@ -14510,7 +15314,7 @@ export interface paths { }; /** * List subscriptions for the authenticated user - * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + * @description Lists the active subscriptions for the authenticated user. */ readonly get: operations["apps/list-subscriptions-for-authenticated-user"]; readonly put?: never; @@ -14530,7 +15334,7 @@ export interface paths { }; /** * List subscriptions for the authenticated user (stubbed) - * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + * @description Lists the active subscriptions for the authenticated user. */ readonly get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; readonly put?: never; @@ -14731,9 +15535,7 @@ export interface paths { * List organizations for the authenticated user * @description List organizations for the authenticated user. * - * **OAuth scope requirements** - * - * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. */ readonly get: operations["orgs/list-for-authenticated-user"]; readonly put?: never; @@ -14755,7 +15557,7 @@ export interface paths { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/list-packages-for-authenticated-user"]; readonly put?: never; @@ -14777,7 +15579,7 @@ export interface paths { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-for-authenticated-user"]; readonly put?: never; @@ -14786,8 +15588,7 @@ export interface paths { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-for-authenticated-user"]; readonly options?: never; @@ -14812,7 +15613,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-for-authenticated-user"]; readonly delete?: never; @@ -14832,7 +15633,7 @@ export interface paths { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; readonly put?: never; @@ -14854,7 +15655,7 @@ export interface paths { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-version-for-authenticated-user"]; readonly put?: never; @@ -14863,8 +15664,9 @@ export interface paths { * Delete a package version for the authenticated user * @description Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-version-for-authenticated-user"]; readonly options?: never; @@ -14889,7 +15691,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-version-for-authenticated-user"]; readonly delete?: never; @@ -14927,7 +15729,11 @@ export interface paths { }; /** * List public email addresses for the authenticated user - * @description Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + * @description Lists your publicly visible email address, which you can set with the + * [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ readonly get: operations["users/list-public-emails-for-authenticated-user"]; readonly put?: never; @@ -14957,12 +15763,7 @@ export interface paths { * Create a repository for the authenticated user * @description Creates a new repository for the authenticated user. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ readonly post: operations["repos/create-for-authenticated-user"]; readonly delete?: never; @@ -15024,12 +15825,16 @@ export interface paths { readonly put?: never; /** * Add social accounts for the authenticated user - * @description Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope. + * @description Add one or more social accounts to the authenticated user's profile. + * + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ readonly post: operations["users/add-social-account-for-authenticated-user"]; /** * Delete social accounts for the authenticated user - * @description Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope. + * @description Deletes one or more social accounts from the authenticated user's profile. + * + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ readonly delete: operations["users/delete-social-account-for-authenticated-user"]; readonly options?: never; @@ -15046,13 +15851,17 @@ export interface paths { }; /** * List SSH signing keys for the authenticated user - * @description Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Lists the SSH signing keys for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ readonly get: operations["users/list-ssh-signing-keys-for-authenticated-user"]; readonly put?: never; /** * Create a SSH signing key for the authenticated user - * @description Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Creates an SSH signing key for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. */ readonly post: operations["users/create-ssh-signing-key-for-authenticated-user"]; readonly delete?: never; @@ -15070,14 +15879,18 @@ export interface paths { }; /** * Get an SSH signing key for the authenticated user - * @description Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Gets extended details for an SSH signing key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ readonly get: operations["users/get-ssh-signing-key-for-authenticated-user"]; readonly put?: never; readonly post?: never; /** * Delete an SSH signing key for the authenticated user - * @description Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Deletes an SSH signing key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. */ readonly delete: operations["users/delete-ssh-signing-key-for-authenticated-user"]; readonly options?: never; @@ -15096,7 +15909,9 @@ export interface paths { * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * 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.star+json`**: Includes a timestamp of when the star was created. */ readonly get: operations["activity/list-repos-starred-by-authenticated-user"]; readonly put?: never; @@ -15121,7 +15936,7 @@ export interface paths { readonly get: operations["activity/check-repo-is-starred-by-authenticated-user"]; /** * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ readonly put: operations["activity/star-repo-for-authenticated-user"]; readonly post?: never; @@ -15164,7 +15979,12 @@ export interface paths { }; /** * List teams for the authenticated user - * @description List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token. + * @description List all of the teams across all of the organizations to which the authenticated + * user belongs. + * + * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + * + * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. */ readonly get: operations["teams/list-for-authenticated-user"]; readonly put?: never; @@ -15208,9 +16028,7 @@ export interface paths { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" - * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". */ @@ -15233,7 +16051,8 @@ export interface paths { /** * Get list of conflicting packages during Docker migration for user * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ readonly get: operations["packages/list-docker-migration-conflicting-packages-for-user"]; readonly put?: never; @@ -15407,14 +16226,11 @@ export interface paths { }; /** * Get contextual information for a user - * @description Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ readonly get: operations["users/get-context-for-user"]; readonly put?: never; @@ -15500,7 +16316,7 @@ export interface paths { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/list-packages-for-user"]; readonly put?: never; @@ -15522,7 +16338,7 @@ export interface paths { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-for-user"]; readonly put?: never; @@ -15531,9 +16347,9 @@ export interface paths { * Delete a package for a user * @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-for-user"]; readonly options?: never; @@ -15558,9 +16374,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-for-user"]; readonly delete?: never; @@ -15580,7 +16396,7 @@ export interface paths { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; readonly put?: never; @@ -15602,7 +16418,7 @@ export interface paths { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly get: operations["packages/get-package-version-for-user"]; readonly put?: never; @@ -15611,9 +16427,9 @@ export interface paths { * Delete package version for a user * @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly delete: operations["packages/delete-package-version-for-user"]; readonly options?: never; @@ -15638,9 +16454,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ readonly post: operations["packages/restore-package-version-for-user"]; readonly delete?: never; @@ -15678,7 +16494,7 @@ export interface paths { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ readonly get: operations["activity/list-received-events-for-user"]; readonly put?: never; @@ -15715,7 +16531,7 @@ export interface paths { }; /** * List repositories for a user - * @description Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. + * @description Lists public repositories for the specified user. */ readonly get: operations["repos/list-for-user"]; readonly put?: never; @@ -15739,7 +16555,7 @@ export interface paths { * * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ readonly get: operations["billing/get-github-actions-billing-user"]; readonly put?: never; @@ -15763,7 +16579,7 @@ export interface paths { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ readonly get: operations["billing/get-github-packages-billing-user"]; readonly put?: never; @@ -15787,7 +16603,7 @@ export interface paths { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ readonly get: operations["billing/get-shared-storage-billing-user"]; readonly put?: never; @@ -15849,7 +16665,9 @@ export interface paths { * List repositories starred by a user * @description Lists repositories a user has starred. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * 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.star+json`**: Includes a timestamp of when the star was created. */ readonly get: operations["activity/list-repos-starred-by-user"]; readonly put?: never; @@ -15949,8 +16767,11 @@ export interface components { readonly following_url: string; /** Format: uri-template */ readonly gists_url: string; - /** Format: uri-template */ - readonly hub_url: string; + /** + * Format: uri-template + * @deprecated + */ + readonly hub_url?: string; /** Format: uri-template */ readonly issue_search_url: string; /** Format: uri-template */ @@ -15997,210 +16818,212 @@ export interface components { * @enum {string} */ readonly "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift"; - /** - * Simple User - * @description A GitHub user. - */ - readonly "simple-user": { - readonly name?: string | null; - readonly email?: string | null; - /** @example octocat */ - readonly login: string; - /** @example 1 */ - readonly id: number; - /** @example MDQ6VXNlcjE= */ - readonly node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - readonly avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - readonly gravatar_id: string | null; - /** - * Format: uri - * @example https://api.github.com/users/octocat - */ - readonly url: string; - /** - * Format: uri - * @example https://github.com/octocat - */ - readonly html_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/followers - */ - readonly followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - readonly following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - readonly gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - readonly starred_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions - */ - readonly subscriptions_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs - */ - readonly organizations_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/repos - */ - readonly repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - readonly events_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events - */ - readonly received_events_url: string; - /** @example User */ - readonly type: string; - readonly site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - readonly starred_at?: string; - }; - /** - * @description The type of credit the user is receiving. - * @enum {string} - */ - readonly "security-advisory-credit-types": "analyst" | "finder" | "reporter" | "coordinator" | "remediation_developer" | "remediation_reviewer" | "remediation_verifier" | "tool" | "sponsor" | "other"; - /** @description A GitHub Security Advisory. */ - readonly "global-advisory": { - /** @description The GitHub Security Advisory ID. */ - readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - readonly cve_id: string | null; - /** @description The API URL for the advisory. */ - readonly url: string; - /** - * Format: uri - * @description The URL for the advisory. - */ - readonly html_url: string; - /** - * Format: uri - * @description The API URL for the repository advisory. - */ - readonly repository_advisory_url: string | null; - /** @description A short summary of the advisory. */ - readonly summary: string; - /** @description A detailed description of what the advisory entails. */ - readonly description: string | null; - /** - * @description The type of advisory. - * @enum {string} - */ - readonly type: "reviewed" | "unreviewed" | "malware"; - /** - * @description The severity of the advisory. - * @enum {string} - */ - readonly severity: "critical" | "high" | "medium" | "low" | "unknown"; - /** - * Format: uri - * @description The URL of the advisory's source code. - */ - readonly source_code_location: string | null; - readonly identifiers: { - /** - * @description The type of identifier. - * @enum {string} - */ - readonly type: "CVE" | "GHSA"; - /** @description The identifier value. */ - readonly value: string; - }[] | null; - readonly references: string[] | null; - /** - * Format: date-time - * @description The date and time of when the advisory was published, in ISO 8601 format. - */ - readonly published_at: string; - /** - * Format: date-time - * @description The date and time of when the advisory was last updated, in ISO 8601 format. - */ - readonly updated_at: string; - /** - * Format: date-time - * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. - */ - readonly github_reviewed_at: string | null; - /** - * Format: date-time - * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. - * This field is only populated when the advisory is imported from the National Vulnerability Database. - */ - readonly nvd_published_at: string | null; - /** - * Format: date-time - * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. - */ - readonly withdrawn_at: string | null; - /** @description The products and respective version ranges affected by the advisory. */ - readonly vulnerabilities: { - /** @description The name of the package affected by the vulnerability. */ - readonly package: { - readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ - readonly name: string | null; - } | null; - /** @description The range of the package versions affected by the vulnerability. */ - readonly vulnerable_version_range: string | null; - /** @description The package version that resolve the vulnerability. */ - readonly first_patched_version: string | null; - /** @description The functions in the package that are affected by the vulnerability. */ - readonly vulnerable_functions: string[] | null; - }[] | null; - readonly cvss: { - /** @description The CVSS vector. */ - readonly vector_string: string | null; - /** @description The CVSS score. */ - readonly score: number | null; + /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ + readonly vulnerability: { + /** @description The name of the package affected by the vulnerability. */ + readonly package: { + readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + readonly name: string | null; } | null; - readonly cwes: { - /** @description The Common Weakness Enumeration (CWE) identifier. */ - readonly cwe_id: string; - /** @description The name of the CWE. */ - readonly name: string; - }[] | null; - /** @description The users who contributed to the advisory. */ - readonly credits: { - readonly user: components["schemas"]["simple-user"]; - readonly type: components["schemas"]["security-advisory-credit-types"]; - }[] | null; - }; - /** - * Basic Error - * @description Basic Error - */ - readonly "basic-error": { - readonly message?: string; - readonly documentation_url?: string; - readonly url?: string; - readonly status?: string; - }; - /** - * Validation Error Simple - * @description Validation Error Simple - */ - readonly "validation-error-simple": { - readonly message: string; - readonly documentation_url: string; - readonly errors?: string[]; + /** @description The range of the package versions affected by the vulnerability. */ + readonly vulnerable_version_range: string | null; + /** @description The package version that resolves the vulnerability. */ + readonly first_patched_version: string | null; + /** @description The functions in the package that are affected by the vulnerability. */ + readonly vulnerable_functions: string[] | null; }; /** * Simple User * @description A GitHub user. */ - readonly "nullable-simple-user": { + readonly "simple-user": { + readonly name?: string | null; + readonly email?: string | null; + /** @example octocat */ + readonly login: string; + /** @example 1 */ + readonly id: number; + /** @example MDQ6VXNlcjE= */ + readonly node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + readonly avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + readonly gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + readonly url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + readonly html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + readonly followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + readonly following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + readonly gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + readonly starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + readonly subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + readonly organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + readonly repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + readonly events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + readonly received_events_url: string; + /** @example User */ + readonly type: string; + readonly site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + readonly starred_at?: string; + }; + /** + * @description The type of credit the user is receiving. + * @enum {string} + */ + readonly "security-advisory-credit-types": "analyst" | "finder" | "reporter" | "coordinator" | "remediation_developer" | "remediation_reviewer" | "remediation_verifier" | "tool" | "sponsor" | "other"; + /** @description A GitHub Security Advisory. */ + readonly "global-advisory": { + /** @description The GitHub Security Advisory ID. */ + readonly ghsa_id: string; + /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + readonly cve_id: string | null; + /** @description The API URL for the advisory. */ + readonly url: string; + /** + * Format: uri + * @description The URL for the advisory. + */ + readonly html_url: string; + /** + * Format: uri + * @description The API URL for the repository advisory. + */ + readonly repository_advisory_url: string | null; + /** @description A short summary of the advisory. */ + readonly summary: string; + /** @description A detailed description of what the advisory entails. */ + readonly description: string | null; + /** + * @description The type of advisory. + * @enum {string} + */ + readonly type: "reviewed" | "unreviewed" | "malware"; + /** + * @description The severity of the advisory. + * @enum {string} + */ + readonly severity: "critical" | "high" | "medium" | "low" | "unknown"; + /** + * Format: uri + * @description The URL of the advisory's source code. + */ + readonly source_code_location: string | null; + readonly identifiers: { + /** + * @description The type of identifier. + * @enum {string} + */ + readonly type: "CVE" | "GHSA"; + /** @description The identifier value. */ + readonly value: string; + }[] | null; + readonly references: string[] | null; + /** + * Format: date-time + * @description The date and time of when the advisory was published, in ISO 8601 format. + */ + readonly published_at: string; + /** + * Format: date-time + * @description The date and time of when the advisory was last updated, in ISO 8601 format. + */ + readonly updated_at: string; + /** + * Format: date-time + * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. + */ + readonly github_reviewed_at: string | null; + /** + * Format: date-time + * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. + * This field is only populated when the advisory is imported from the National Vulnerability Database. + */ + readonly nvd_published_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + */ + readonly withdrawn_at: string | null; + /** @description The products and respective version ranges affected by the advisory. */ + readonly vulnerabilities: components["schemas"]["vulnerability"][] | null; + readonly cvss: { + /** @description The CVSS vector. */ + readonly vector_string: string | null; + /** @description The CVSS score. */ + readonly score: number | null; + } | null; + readonly cwes: { + /** @description The Common Weakness Enumeration (CWE) identifier. */ + readonly cwe_id: string; + /** @description The name of the CWE. */ + readonly name: string; + }[] | null; + /** @description The users who contributed to the advisory. */ + readonly credits: { + readonly user: components["schemas"]["simple-user"]; + readonly type: components["schemas"]["security-advisory-credit-types"]; + }[] | null; + }; + /** + * Basic Error + * @description Basic Error + */ + readonly "basic-error": { + readonly message?: string; + readonly documentation_url?: string; + readonly url?: string; + readonly status?: string; + }; + /** + * Validation Error Simple + * @description Validation Error Simple + */ + readonly "validation-error-simple": { + readonly message: string; + readonly documentation_url: string; + readonly errors?: string[]; + }; + /** + * Simple User + * @description A GitHub user. + */ + readonly "nullable-simple-user": { readonly name?: string | null; readonly email?: string | null; /** @example octocat */ @@ -16346,7 +17169,7 @@ export interface components { readonly webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ readonly pem?: string; - }; + } | null; /** * Format: uri * @description The URL to which the payloads will be delivered. @@ -16642,11 +17465,21 @@ export interface components { * @enum {string} */ readonly checks?: "read" | "write"; + /** + * @description The level of permission to grant the access token to create, edit, delete, and list Codespaces. + * @enum {string} + */ + readonly codespaces?: "read" | "write"; /** * @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. * @enum {string} */ readonly contents?: "read" | "write"; + /** + * @description The leve of permission to grant the access token to manage Dependabot secrets. + * @enum {string} + */ + readonly dependabot_secrets?: "read" | "write"; /** * @description The level of permission to grant the access token for deployments and deployment statuses. * @enum {string} @@ -16682,6 +17515,11 @@ export interface components { * @enum {string} */ readonly pull_requests?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. + * @enum {string} + */ + readonly repository_custom_properties?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. * @enum {string} @@ -16738,20 +17576,35 @@ export interface components { */ readonly organization_administration?: "read" | "write"; /** - * @description The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for custom repository roles management. * @enum {string} */ readonly organization_custom_roles?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom organization roles management. + * @enum {string} + */ + readonly organization_custom_org_roles?: "read" | "write"; /** * @description The level of permission to grant the access token for custom property management. * @enum {string} */ readonly organization_custom_properties?: "read" | "write" | "admin"; + /** + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @enum {string} + */ + readonly organization_copilot_seat_management?: "write"; /** * @description The level of permission to grant the access token to view and manage announcement banners for an organization. * @enum {string} */ readonly organization_announcement_banners?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view events triggered by an activity in an organization. + * @enum {string} + */ + readonly organization_events?: "read"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for an organization. * @enum {string} @@ -16802,6 +17655,41 @@ export interface components { * @enum {string} */ readonly team_discussions?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the email addresses belonging to a user. + * @enum {string} + */ + readonly email_addresses?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the followers belonging to a user. + * @enum {string} + */ + readonly followers?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage git SSH keys. + * @enum {string} + */ + readonly git_ssh_keys?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and manage GPG keys belonging to a user. + * @enum {string} + */ + readonly gpg_keys?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and manage interaction limits on a repository. + * @enum {string} + */ + readonly interaction_limits?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the profile settings belonging to a user. + * @enum {string} + */ + readonly profile?: "write"; + /** + * @description The level of permission to grant the access token to list and manage repositories a user is starring. + * @enum {string} + */ + readonly starring?: "read" | "write"; }; /** * Installation @@ -16904,7 +17792,6 @@ export interface components { /** @example octocat/Hello-World */ readonly full_name: string; readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; readonly forks: number; readonly permissions?: { readonly admin: boolean; @@ -17072,7 +17959,7 @@ export interface components { /** @example 80 */ readonly watchers_count: number; /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ readonly size: number; @@ -17155,150 +18042,6 @@ export interface components { * @example true */ readonly allow_rebase_merge: boolean; - readonly template_repository?: { - readonly id?: number; - readonly node_id?: string; - readonly name?: string; - readonly full_name?: string; - readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; - readonly avatar_url?: string; - readonly gravatar_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly organizations_url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly received_events_url?: string; - readonly type?: string; - readonly site_admin?: boolean; - }; - readonly private?: boolean; - readonly html_url?: string; - readonly description?: string; - readonly fork?: boolean; - readonly url?: string; - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly downloads_url?: string; - readonly events_url?: string; - readonly forks_url?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly notifications_url?: string; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly ssh_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly clone_url?: string; - readonly mirror_url?: string; - readonly hooks_url?: string; - readonly svn_url?: string; - readonly homepage?: string; - readonly language?: string; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; - readonly pushed_at?: string; - readonly created_at?: string; - readonly updated_at?: string; - readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; - }; - readonly allow_rebase_merge?: boolean; - readonly temp_clone_token?: string; - readonly allow_squash_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_update_branch?: boolean; - readonly use_squash_pr_title_as_default?: boolean; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - readonly allow_merge_commit?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - } | null; readonly temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. @@ -17377,8 +18120,6 @@ export interface components { * @default false */ readonly web_commit_signoff_required: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; readonly open_issues: number; readonly watchers: number; readonly master_branch?: string; @@ -17907,6 +18648,51 @@ export interface components { /** Format: uri */ readonly html_url: string | null; }; + /** + * 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: { + /** @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; + }; /** @description The security alert number. */ readonly "alert-number": number; /** @description Details for the vulnerable package. */ @@ -19314,6 +20100,7 @@ export interface components { readonly codespaces?: string[]; readonly copilot?: string[]; readonly packages?: string[]; + readonly actions?: string[]; }; }; readonly "security-and-analysis": { @@ -19487,7 +20274,7 @@ export interface components { readonly forks_count?: number; readonly stargazers_count?: number; readonly watchers_count?: number; - /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */ + /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */ readonly size?: number; readonly default_branch?: string; readonly open_issues_count?: number; @@ -20122,11 +20909,13 @@ export interface components { readonly "code-scanning-alert-dismissed-reason": null | "false positive" | "won't fix" | "used in tests"; /** @description The dismissal comment associated with the dismissal of the alert. */ readonly "code-scanning-alert-dismissed-comment": string | null; - readonly "code-scanning-alert-rule": { + readonly "code-scanning-alert-rule-summary": { /** @description A unique identifier for the rule used to detect the alert. */ readonly id?: string | null; /** @description The name of the rule used to detect the alert. */ readonly name?: string; + /** @description A set of tags applicable for the rule. */ + readonly tags?: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -20139,14 +20928,6 @@ export interface components { readonly security_severity_level?: "low" | "medium" | "high" | "critical"; /** @description A short description of the rule used to detect the alert. */ readonly description?: string; - /** @description description of the rule used to detect the alert. */ - readonly full_description?: string; - /** @description A set of tags applicable for the rule. */ - readonly tags?: string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ readonly "code-scanning-analysis-tool-version": string | null; @@ -20206,7 +20987,7 @@ export interface components { readonly dismissed_at: components["schemas"]["alert-dismissed-at"]; readonly dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - readonly rule: components["schemas"]["code-scanning-alert-rule"]; + readonly rule: components["schemas"]["code-scanning-alert-rule-summary"]; readonly tool: components["schemas"]["code-scanning-analysis-tool"]; readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; readonly repository: components["schemas"]["simple-repository"]; @@ -20496,7 +21277,17 @@ export interface components { * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. * @enum {string} */ - readonly copilot_chat?: "enabled" | "disabled" | "unconfigured"; + readonly ide_chat?: "enabled" | "disabled" | "unconfigured"; + /** + * @description The organization policy for allowing or disallowing organization members to use Copilot features within github.com. + * @enum {string} + */ + readonly platform_chat?: "enabled" | "disabled" | "unconfigured"; + /** + * @description The organization policy for allowing or disallowing organization members to use Copilot within their CLI. + * @enum {string} + */ + readonly cli?: "enabled" | "disabled" | "unconfigured"; /** * @description The mode of assigning new seats. * @enum {string} @@ -20902,7 +21693,7 @@ export interface components { readonly forks_count?: number; readonly stargazers_count?: number; readonly watchers_count?: number; - /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */ + /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */ readonly size?: number; readonly default_branch?: string; readonly open_issues_count?: number; @@ -21433,11 +22224,18 @@ export interface components { /** @description Whether the property is required. */ readonly required?: boolean; /** @description Default value of the property */ - readonly default_value?: string | null; + readonly default_value?: (string | string[]) | null; /** @description Short description of the property */ readonly description?: string | null; - /** @description Ordered list of allowed values of the property */ + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ readonly allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + readonly values_editable_by?: "org_actors" | "org_and_repo_actors"; }; /** * Custom Property Value @@ -21447,7 +22245,7 @@ export interface components { /** @description The name of the property */ readonly property_name: string; /** @description The value assigned to the property */ - readonly value: string | null; + readonly value: (string | string[]) | null; }; /** * Organization Repository Custom Property Values @@ -21464,1150 +22262,395 @@ export interface components { readonly properties: components["schemas"]["custom-property-value"][]; }; /** - * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). - * @enum {string} - */ - readonly "repository-rule-enforcement": "disabled" | "active" | "evaluate"; - /** - * Repository Ruleset Bypass Actor - * @description An actor that can bypass rules in a ruleset + * Repository + * @description A repository on GitHub. */ - readonly "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. */ - readonly actor_id: number; + readonly "nullable-repository": { /** - * @description The type of actor that can bypass a ruleset - * @enum {string} + * @description Unique identifier of the repository + * @example 42 */ - readonly actor_type: "RepositoryRole" | "Team" | "Integration" | "OrganizationAdmin"; + readonly id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + readonly node_id: string; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. - * @enum {string} + * @description The name of the repository. + * @example Team Environment */ - readonly bypass_mode: "always" | "pull_request"; - }; - /** - * Repository ruleset conditions for ref names - * @description Parameters for a repository ruleset ref name condition - */ - readonly "repository-ruleset-conditions": { - readonly ref_name?: { - /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */ - readonly include?: string[]; - /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */ - readonly exclude?: string[]; - }; - }; - /** - * Repository ruleset conditions for repository names - * @description Parameters for a repository name condition - */ - readonly "repository-ruleset-conditions-repository-name-target": { - readonly repository_name: { - /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */ - readonly include?: string[]; - /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */ - readonly exclude?: string[]; - /** @description Whether renaming of target repositories is prevented. */ - readonly protected?: boolean; - }; - }; - /** - * Repository ruleset conditions for repository IDs - * @description Parameters for a repository ID condition - */ - readonly "repository-ruleset-conditions-repository-id-target": { - readonly repository_id: { - /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */ - readonly repository_ids?: number[]; - }; - }; - /** - * Organization ruleset conditions - * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - * - */ - 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"]); - /** - * creation - * @description Only allow users with bypass permission to create matching refs. - */ - readonly "repository-rule-creation": { - /** @enum {string} */ - readonly type: "creation"; - }; - /** - * update - * @description Only allow users with bypass permission to update matching refs. - */ - readonly "repository-rule-update": { - /** @enum {string} */ - readonly type: "update"; - readonly parameters?: { - /** @description Branch can pull changes from its upstream repository */ - readonly update_allows_fetch_and_merge: boolean; - }; - }; - /** - * deletion - * @description Only allow users with bypass permissions to delete matching refs. - */ - readonly "repository-rule-deletion": { - /** @enum {string} */ - readonly type: "deletion"; - }; - /** - * required_linear_history - * @description Prevent merge commits from being pushed to matching refs. - */ - readonly "repository-rule-required-linear-history": { - /** @enum {string} */ - readonly type: "required_linear_history"; - }; - /** - * required_deployments - * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. - */ - readonly "repository-rule-required-deployments": { - /** @enum {string} */ - readonly type: "required_deployments"; - readonly parameters?: { - /** @description The environments that must be successfully deployed to before branches can be merged. */ - readonly required_deployment_environments: string[]; - }; - }; - /** - * required_signatures - * @description Commits pushed to matching refs must have verified signatures. - */ - readonly "repository-rule-required-signatures": { - /** @enum {string} */ - readonly type: "required_signatures"; - }; - /** - * pull_request - * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. - */ - readonly "repository-rule-pull-request": { - /** @enum {string} */ - readonly type: "pull_request"; - readonly parameters?: { - /** @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. */ - readonly require_code_owner_review: boolean; - /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */ - readonly require_last_push_approval: boolean; - /** @description The number of approving reviews that are required before a pull request can be merged. */ - readonly required_approving_review_count: number; - /** @description All conversations on code must be resolved before a pull request can be merged. */ - readonly required_review_thread_resolution: boolean; - }; - }; - /** - * StatusCheckConfiguration - * @description Required status check - */ - readonly "repository-rule-params-status-check-configuration": { - /** @description The status check context name that must be present on the commit. */ - readonly context: string; - /** @description The optional integration ID that this status check must originate from. */ - readonly integration_id?: number; - }; - /** - * required_status_checks - * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. - */ - readonly "repository-rule-required-status-checks": { - /** @enum {string} */ - readonly type: "required_status_checks"; - readonly parameters?: { - /** @description Status checks that are required. */ - readonly required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; - /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ - readonly strict_required_status_checks_policy: boolean; - }; - }; - /** - * non_fast_forward - * @description Prevent users with push access from force pushing to refs. - */ - readonly "repository-rule-non-fast-forward": { - /** @enum {string} */ - readonly type: "non_fast_forward"; - }; - /** - * commit_message_pattern - * @description Parameters to be used for the commit_message_pattern rule - */ - readonly "repository-rule-commit-message-pattern": { - /** @enum {string} */ - readonly type: "commit_message_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - readonly pattern: string; - }; - }; - /** - * commit_author_email_pattern - * @description Parameters to be used for the commit_author_email_pattern rule - */ - readonly "repository-rule-commit-author-email-pattern": { - /** @enum {string} */ - readonly type: "commit_author_email_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - readonly pattern: string; - }; - }; - /** - * committer_email_pattern - * @description Parameters to be used for the committer_email_pattern rule - */ - readonly "repository-rule-committer-email-pattern": { - /** @enum {string} */ - readonly type: "committer_email_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - readonly pattern: string; - }; - }; - /** - * branch_name_pattern - * @description Parameters to be used for the branch_name_pattern rule - */ - readonly "repository-rule-branch-name-pattern": { - /** @enum {string} */ - readonly type: "branch_name_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - readonly pattern: string; - }; - }; - /** - * tag_name_pattern - * @description Parameters to be used for the tag_name_pattern rule - */ - readonly "repository-rule-tag-name-pattern": { - /** @enum {string} */ - readonly type: "tag_name_pattern"; - readonly parameters?: { - /** @description How this rule will appear to users. */ - readonly name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - readonly negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - readonly pattern: string; - }; - }; - /** - * WorkflowFileReference - * @description A workflow that must run for this rule to pass - */ - readonly "repository-rule-params-workflow-file-reference": { - /** @description The path to the workflow file */ - readonly path: string; - /** @description The ref (branch or tag) of the workflow file to use */ - readonly ref?: string; - /** @description The ID of the repository where the workflow is defined */ - readonly repository_id: number; - /** @description The commit SHA of the workflow file to use */ - readonly sha?: string; - }; - /** - * workflows - * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged. - */ - readonly "repository-rule-workflows": { - /** @enum {string} */ - readonly type: "workflows"; - readonly parameters?: { - /** @description Workflows that must pass for this rule to pass. */ - readonly workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; - }; - }; - /** - * Repository Rule - * @description A repository rule. - */ - readonly "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-workflows"]; - /** - * Repository ruleset - * @description A set of rules to apply when specified conditions are met. - */ - readonly "repository-ruleset": { - /** @description The ID of the ruleset */ - readonly id: number; - /** @description The name of the ruleset */ readonly name: string; + /** @example octocat/Hello-World */ + readonly full_name: string; + readonly license: components["schemas"]["nullable-license-simple"]; + readonly forks: number; + readonly permissions?: { + readonly admin: boolean; + readonly pull: boolean; + readonly triage?: boolean; + readonly push: boolean; + readonly maintain?: boolean; + }; + readonly owner: components["schemas"]["simple-user"]; /** - * @description The target of the ruleset - * @enum {string} + * @description Whether the repository is private or public. + * @default false */ - readonly target?: "branch" | "tag"; + readonly private: boolean; /** - * @description The type of the source of the ruleset - * @enum {string} + * Format: uri + * @example https://github.com/octocat/Hello-World */ - readonly source_type?: "Repository" | "Organization"; - /** @description The name of the source */ - readonly source: string; - readonly enforcement: components["schemas"]["repository-rule-enforcement"]; - /** @description The actors that can bypass the rules in this ruleset */ - readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; + readonly html_url: string; + /** @example This your first repo! */ + readonly description: string | null; + readonly fork: boolean; /** - * @description The bypass type of the user making the API request for this ruleset. This field is only returned when - * querying the repository-level endpoint. - * @enum {string} + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World */ - readonly current_user_can_bypass?: "always" | "pull_requests_only" | "never"; - readonly node_id?: string; - readonly _links?: { - readonly self?: { - /** @description The URL of the ruleset */ - readonly href?: string; - }; - readonly html?: { - /** @description The html URL of the ruleset */ - readonly href?: string; - }; - }; - readonly conditions?: components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]; - readonly rules?: components["schemas"]["repository-rule"][]; - /** Format: date-time */ - readonly created_at?: string; - /** Format: date-time */ - readonly updated_at?: string; - }; - /** - * Rule Suites - * @description Response - */ - readonly "rule-suites": { - /** @description The unique identifier of the rule insight. */ - readonly id?: number; - /** @description The number that identifies the user. */ - readonly actor_id?: number; - /** @description The handle for the GitHub user account. */ - readonly actor_name?: string; - /** @description The first commit sha before the push evaluation. */ - readonly before_sha?: string; - /** @description The last commit sha in the push evaluation. */ - readonly after_sha?: string; - /** @description The ref name that the evaluation ran on. */ - readonly ref?: string; - /** @description The ID of the repository associated with the rule evaluation. */ - readonly repository_id?: number; - /** @description The name of the repository without the `.git` extension. */ - readonly repository_name?: string; + readonly url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ + readonly archive_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ + readonly assignees_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ + readonly blobs_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ + readonly branches_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ + readonly collaborators_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ + readonly comments_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ + readonly commits_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ + readonly compare_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ + readonly contents_url: string; /** - * Format: date-time - * @example 2011-01-26T19:06:43Z + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - readonly pushed_at?: string; + readonly contributors_url: string; /** - * @description The result of the rule evaluations for rules with the `active` enforcement status. - * @enum {string} + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - readonly result?: "pass" | "fail" | "bypass"; + readonly deployments_url: string; /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - readonly evaluation_result?: "pass" | "fail"; - }[]; - /** - * Rule Suite - * @description Response - */ - readonly "rule-suite": { - /** @description The unique identifier of the rule insight. */ - readonly id?: number; - /** @description The number that identifies the user. */ - readonly actor_id?: number; - /** @description The handle for the GitHub user account. */ - readonly actor_name?: string; - /** @description The first commit sha before the push evaluation. */ - readonly before_sha?: string; - /** @description The last commit sha in the push evaluation. */ - readonly after_sha?: string; - /** @description The ref name that the evaluation ran on. */ - readonly ref?: string; - /** @description The ID of the repository associated with the rule evaluation. */ - readonly repository_id?: number; - /** @description The name of the repository without the `.git` extension. */ - readonly repository_name?: string; + readonly downloads_url: string; /** - * Format: date-time - * @example 2011-01-26T19:06:43Z + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/events */ - readonly pushed_at?: string; + readonly events_url: string; /** - * @description The result of the rule evaluations for rules with the `active` enforcement status. - * @enum {string} + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/forks */ - readonly result?: "pass" | "fail" | "bypass"; - /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} - */ - readonly evaluation_result?: "pass" | "fail"; - /** @description Details on the evaluated rules. */ - readonly rule_evaluations?: { - readonly rule_source?: { - /** @description The type of rule source. */ - readonly type?: string; - /** @description The ID of the rule source. */ - readonly id?: number | null; - /** @description The name of the rule source. */ - readonly name?: string | null; - }; - /** - * @description The enforcement level of this rule source. - * @enum {string} - */ - readonly enforcement?: "active" | "evaluate" | "deleted ruleset"; - /** - * @description The result of the evaluation of the individual rule. - * @enum {string} - */ - readonly result?: "pass" | "fail"; - /** @description The type of rule. */ - readonly rule_type?: string; - /** @description Any associated details with the rule evaluation. */ - readonly details?: string; - }[]; - }; - /** @description A product affected by the vulnerability detailed in a repository security advisory. */ - readonly "repository-advisory-vulnerability": { - /** @description The name of the package affected by the vulnerability. */ - readonly package: { - readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ - readonly name: string | null; - } | null; - /** @description The range of the package versions affected by the vulnerability. */ - readonly vulnerable_version_range: string | null; - /** @description The package version(s) that resolve the vulnerability. */ - readonly patched_versions: string | null; - /** @description The functions in the package that are affected. */ - readonly vulnerable_functions: string[] | null; - }; - /** @description A credit given to a user for a repository security advisory. */ - readonly "repository-advisory-credit": { - readonly user: components["schemas"]["simple-user"]; - readonly type: components["schemas"]["security-advisory-credit-types"]; - /** - * @description The state of the user's acceptance of the credit. - * @enum {string} - */ - readonly state: "accepted" | "declined" | "pending"; - }; - /** @description A repository security advisory. */ - readonly "repository-advisory": { - /** @description The GitHub Security Advisory ID. */ - readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - readonly cve_id: string | null; + readonly forks_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ + readonly git_commits_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ + readonly git_refs_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ + readonly git_tags_url: string; + /** @example git:github.com/octocat/Hello-World.git */ + readonly git_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ + readonly issue_comment_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ + readonly issue_events_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ + readonly issues_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ + readonly keys_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ + readonly labels_url: string; /** * Format: uri - * @description The API URL for the advisory. + * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly url: string; + readonly languages_url: string; /** * Format: uri - * @description The URL for the advisory. - */ - readonly html_url: string; - /** @description A short summary of the advisory. */ - readonly summary: string; - /** @description A detailed description of what the advisory entails. */ - readonly description: string | null; - /** - * @description The severity of the advisory. - * @enum {string|null} + * @example http://api.github.com/repos/octocat/Hello-World/merges */ - readonly severity: "critical" | "high" | "medium" | "low"; - /** @description The author of the advisory. */ - readonly author: components["schemas"]["simple-user"] | null; - /** @description The publisher of the advisory. */ - readonly publisher: components["schemas"]["simple-user"] | null; - readonly identifiers: { - /** - * @description The type of identifier. - * @enum {string} - */ - readonly type: "CVE" | "GHSA"; - /** @description The identifier value. */ - readonly value: string; - }[]; + readonly merges_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ + readonly milestones_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ + readonly notifications_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ + readonly pulls_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ + readonly releases_url: string; + /** @example git@github.com:octocat/Hello-World.git */ + readonly ssh_url: string; /** - * @description The state of the advisory. - * @enum {string} + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - readonly state: "published" | "closed" | "withdrawn" | "draft" | "triage"; + readonly stargazers_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ + readonly statuses_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was created, in ISO 8601 format. + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly created_at: string | null; + readonly subscribers_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly updated_at: string | null; + readonly subscription_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was published, in ISO 8601 format. + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly published_at: string | null; + readonly tags_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was closed, in ISO 8601 format. + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly closed_at: string | null; + readonly teams_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ + readonly trees_url: string; + /** @example https://github.com/octocat/Hello-World.git */ + readonly clone_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * Format: uri + * @example git:git.example.com/octocat/Hello-World */ - readonly withdrawn_at: string | null; - readonly submission: { - /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ - readonly accepted: boolean; - } | null; - readonly vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; - readonly cvss: { - /** @description The CVSS vector. */ - readonly vector_string: string | null; - /** @description The CVSS score. */ - readonly score: number | null; - } | null; - readonly cwes: { - /** @description The Common Weakness Enumeration (CWE) identifier. */ - readonly cwe_id: string; - /** @description The name of the CWE. */ - readonly name: string; - }[] | null; - /** @description A list of only the CWE IDs. */ - readonly cwe_ids: string[] | null; - readonly credits: { - /** @description The username of the user credited. */ - readonly login?: string; - readonly type?: components["schemas"]["security-advisory-credit-types"]; - }[] | null; - readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null; - /** @description A list of users that collaborate on the advisory. */ - readonly collaborating_users: components["schemas"]["simple-user"][] | null; - /** @description A list of teams that collaborate on the advisory. */ - readonly collaborating_teams: components["schemas"]["team"][] | null; - /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ - readonly private_fork: components["schemas"]["simple-repository"] | null; - }; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly "team-simple": { + readonly mirror_url: string | null; /** - * @description Unique identifier of the team - * @example 1 + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - readonly id: number; - /** @example MDQ6VGVhbTE= */ - readonly node_id: string; + readonly hooks_url: string; /** * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @example https://svn.github.com/octocat/Hello-World */ - readonly url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; + readonly svn_url: string; /** - * @description Name of the team - * @example Justice League + * Format: uri + * @example https://github.com */ - readonly name: string; + readonly homepage: string | null; + readonly language: string | null; + /** @example 9 */ + readonly forks_count: number; + /** @example 80 */ + readonly stargazers_count: number; + /** @example 80 */ + readonly watchers_count: number; /** - * @description Description of the team - * @example A great team. + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + * @example 108 */ - readonly description: string | null; + readonly size: number; /** - * @description Permission that the team will have for its repositories - * @example admin + * @description The default branch of the repository. + * @example master */ - readonly permission: string; + readonly default_branch: string; + /** @example 0 */ + readonly open_issues_count: number; /** - * @description The level of privacy this team should have - * @example closed + * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false + * @example true */ - readonly privacy?: string; + readonly is_template: boolean; + readonly topics?: string[]; /** - * @description The notification setting the team has set - * @example notifications_enabled + * @description Whether issues are enabled. + * @default true + * @example true */ - readonly notification_setting?: string; + readonly has_issues: boolean; /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description Whether projects are enabled. + * @default true + * @example true */ - readonly html_url: string; + readonly has_projects: boolean; /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos + * @description Whether the wiki is enabled. + * @default true + * @example true */ - readonly repositories_url: string; - /** @example justice-league */ - readonly slug: string; + readonly has_wiki: boolean; + readonly has_pages: boolean; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com + * @deprecated + * @description Whether downloads are enabled. + * @default true + * @example true */ - readonly ldap_dn?: string; - }; - readonly "actions-billing-usage": { - /** @description The sum of the free and paid GitHub Actions minutes used. */ - readonly total_minutes_used: number; - /** @description The total paid GitHub Actions minutes used. */ - readonly total_paid_minutes_used: number; - /** @description The amount of free GitHub Actions minutes available. */ - readonly included_minutes: number; - readonly minutes_used_breakdown: { - /** @description Total minutes used on Ubuntu runner machines. */ - readonly UBUNTU?: number; - /** @description Total minutes used on macOS runner machines. */ - readonly MACOS?: number; - /** @description Total minutes used on Windows runner machines. */ - readonly WINDOWS?: number; - /** @description Total minutes used on Ubuntu 4 core runner machines. */ - readonly ubuntu_4_core?: number; - /** @description Total minutes used on Ubuntu 8 core runner machines. */ - readonly ubuntu_8_core?: number; - /** @description Total minutes used on Ubuntu 16 core runner machines. */ - readonly ubuntu_16_core?: number; - /** @description Total minutes used on Ubuntu 32 core runner machines. */ - readonly ubuntu_32_core?: number; - /** @description Total minutes used on Ubuntu 64 core runner machines. */ - readonly ubuntu_64_core?: number; - /** @description Total minutes used on Windows 4 core runner machines. */ - readonly windows_4_core?: number; - /** @description Total minutes used on Windows 8 core runner machines. */ - readonly windows_8_core?: number; - /** @description Total minutes used on Windows 16 core runner machines. */ - readonly windows_16_core?: number; - /** @description Total minutes used on Windows 32 core runner machines. */ - readonly windows_32_core?: number; - /** @description Total minutes used on Windows 64 core runner machines. */ - readonly windows_64_core?: number; - /** @description Total minutes used on macOS 12 core runner machines. */ - readonly macos_12_core?: number; - /** @description Total minutes used on all runner machines. */ - readonly total?: number; - }; - }; - readonly "packages-billing-usage": { - /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ - readonly total_gigabytes_bandwidth_used: number; - /** @description Total paid storage space (GB) for GitHuub Packages. */ - readonly total_paid_gigabytes_bandwidth_used: number; - /** @description Free storage space (GB) for GitHub Packages. */ - readonly included_gigabytes_bandwidth: number; - }; - readonly "combined-billing-usage": { - /** @description Numbers of days left in billing cycle. */ - readonly days_left_in_billing_cycle: number; - /** @description Estimated storage space (GB) used in billing cycle. */ - readonly estimated_paid_storage_for_month: number; - /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ - readonly estimated_storage_for_month: number; - }; - /** - * Team Organization - * @description Team Organization - */ - readonly "team-organization": { - /** @example github */ - readonly login: string; - /** @example 1 */ - readonly id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - readonly node_id: string; + readonly has_downloads: boolean; /** - * Format: uri - * @example https://api.github.com/orgs/github + * @description Whether discussions are enabled. + * @default false + * @example true */ - readonly url: string; + readonly has_discussions: boolean; /** - * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description Whether the repository is archived. + * @default false */ - readonly repos_url: string; + readonly archived: boolean; + /** @description Returns whether or not this repository disabled. */ + readonly disabled: boolean; /** - * Format: uri - * @example https://api.github.com/orgs/github/events + * @description The repository visibility: public, private, or internal. + * @default public */ - 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; - /** @example github */ - readonly name?: string; - /** @example GitHub */ - readonly company?: string; + readonly visibility: string; /** - * Format: uri - * @example https://github.com/blog + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - readonly blog?: string; - /** @example San Francisco */ - readonly location?: string; + readonly pushed_at: string | null; /** - * Format: email - * @example octocat@github.com + * Format: date-time + * @example 2011-01-26T19:01:12Z */ - readonly email?: string; - /** @example github */ - readonly twitter_username?: string | null; - /** @example true */ - readonly is_verified?: boolean; - /** @example true */ - readonly has_organization_projects: boolean; - /** @example true */ - readonly has_repository_projects: boolean; - /** @example 2 */ - readonly public_repos: number; - /** @example 1 */ - readonly public_gists: number; - /** @example 20 */ - readonly followers: number; - /** @example 0 */ - readonly following: number; + readonly created_at: string | null; /** - * Format: uri - * @example https://github.com/octocat + * Format: date-time + * @example 2011-01-26T19:14:43Z */ - readonly html_url: string; + readonly updated_at: string | null; /** - * Format: date-time - * @example 2008-01-14T04:33:35Z + * @description Whether to allow rebase merges for pull requests. + * @default true + * @example true */ - readonly created_at: string; - /** @example Organization */ - readonly type: string; - /** @example 100 */ - readonly total_private_repos?: number; - /** @example 100 */ - readonly owned_private_repos?: number; - /** @example 81 */ - readonly private_gists?: number | null; - /** @example 10000 */ - readonly disk_usage?: number | null; - /** @example 8 */ - readonly collaborators?: number | null; + readonly allow_rebase_merge: boolean; + readonly temp_clone_token?: string; /** - * Format: email - * @example org@example.com + * @description Whether to allow squash merges for pull requests. + * @default true + * @example true */ - readonly billing_email?: string | null; - readonly plan?: { - readonly name: string; - readonly space: number; - readonly private_repos: number; - readonly filled_seats?: number; - readonly seats?: number; - }; - readonly default_repository_permission?: string | null; - /** @example true */ - readonly members_can_create_repositories?: boolean | null; - /** @example true */ - readonly two_factor_requirement_enabled?: boolean | null; - /** @example all */ - readonly members_allowed_repository_creation_type?: string; - /** @example true */ - readonly members_can_create_public_repositories?: boolean; - /** @example true */ - readonly members_can_create_private_repositories?: boolean; - /** @example true */ - readonly members_can_create_internal_repositories?: boolean; - /** @example true */ - readonly members_can_create_pages?: boolean; - /** @example true */ - readonly members_can_create_public_pages?: boolean; - /** @example true */ - readonly members_can_create_private_pages?: boolean; - /** @example false */ - readonly members_can_fork_private_repositories?: boolean | null; - /** @example false */ - readonly web_commit_signoff_required?: boolean; - /** Format: date-time */ - readonly updated_at: string; - /** Format: date-time */ - readonly archived_at: string | null; - }; - /** - * Full Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly "team-full": { + readonly allow_squash_merge: boolean; /** - * @description Unique identifier of the team - * @example 42 + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false */ - readonly id: number; - /** @example MDQ6VGVhbTE= */ - readonly node_id: string; + readonly allow_auto_merge: boolean; /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false */ - readonly url: string; + readonly delete_branch_on_merge: boolean; /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + * @default false + * @example false */ - readonly html_url: string; + readonly allow_update_branch: boolean; /** - * @description Name of the team - * @example Developers + * @deprecated + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false */ - readonly name: string; - /** @example justice-league */ - readonly slug: string; - /** @example A great team. */ - readonly description: string | null; + readonly use_squash_pr_title_as_default: boolean; /** - * @description The level of privacy this team should have - * @example closed + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - readonly privacy?: "closed" | "secret"; + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description The notification setting the team has set - * @example notifications_enabled + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** - * @description Permission that the team will have for its repositories - * @example push - */ - readonly permission: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - readonly members_url: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos - */ - readonly repositories_url: string; - readonly parent?: components["schemas"]["nullable-team-simple"]; - /** @example 3 */ - readonly members_count: number; - /** @example 10 */ - readonly repos_count: number; - /** - * Format: date-time - * @example 2017-07-14T16:53:42Z - */ - readonly created_at: string; - /** - * Format: date-time - * @example 2017-08-17T12:37:15Z - */ - readonly updated_at: string; - readonly organization: components["schemas"]["team-organization"]; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - readonly ldap_dn?: string; - }; - /** - * Team Discussion - * @description A team discussion is a persistent record of a free-form conversation within a team. - */ - readonly "team-discussion": { - readonly author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the discussion. - * @example Please suggest improvements to our workflow in comments. - */ - readonly body: string; - /** @example

Hi! This is an area for us to collaborate as a team

*/ - readonly body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - readonly body_version: string; - /** @example 0 */ - readonly comments_count: number; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments - */ - readonly comments_url: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - readonly created_at: string; - /** Format: date-time */ - readonly last_edited_at: string | null; - /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1 - */ - readonly html_url: string; - /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ - readonly node_id: string; + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The unique sequence number of a team discussion. - * @example 42 + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} */ - readonly number: number; + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** - * @description Whether or not this discussion should be pinned for easy retrieval. - * @example true + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} */ - readonly pinned: boolean; + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** - * @description Whether or not this discussion should be restricted to team members and organization owners. + * @description Whether to allow merge commits for pull requests. + * @default true * @example true */ - readonly private: boolean; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027 - */ - readonly team_url: string; - /** - * @description The title of the discussion. - * @example How can we improve our workflow? - */ - readonly title: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - readonly updated_at: string; + readonly allow_merge_commit: boolean; + /** @description Whether to allow forking this repo */ + readonly allow_forking?: boolean; /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1 + * @description Whether to require contributors to sign off on web-based commits + * @default false */ - readonly url: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; + readonly web_commit_signoff_required: boolean; + readonly open_issues: number; + readonly watchers: number; + readonly master_branch?: string; + /** @example "2020-07-09T00:17:42Z" */ + readonly starred_at?: string; + /** @description Whether anonymous git access is enabled for this repository */ + readonly anonymous_access_enabled?: boolean; + } | null; /** - * Team Discussion Comment - * @description A reply to a discussion within a team. + * Code Of Conduct Simple + * @description Code of Conduct Simple */ - readonly "team-discussion-comment": { - readonly author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the comment. - * @example I agree with this suggestion. - */ - readonly body: string; - /** @example

Do you like apples?

*/ - readonly body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - readonly body_version: string; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - readonly created_at: string; - /** Format: date-time */ - readonly last_edited_at: string | null; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1 - */ - readonly discussion_url: string; - /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 - */ - readonly html_url: string; - /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ - readonly node_id: string; - /** - * @description The unique sequence number of a team discussion comment. - * @example 42 - */ - readonly number: number; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - readonly updated_at: string; + readonly "code-of-conduct-simple": { /** * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - */ - readonly url: string; - readonly reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Reaction - * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. - */ - readonly reaction: { - /** @example 1 */ - readonly id: number; - /** @example MDg6UmVhY3Rpb24x */ - readonly node_id: string; - readonly user: components["schemas"]["nullable-simple-user"]; - /** - * @description The reaction to use - * @example heart - * @enum {string} - */ - readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** - * Format: date-time - * @example 2016-05-20T20:09:31Z + * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - readonly created_at: string; - }; - /** - * Team Membership - * @description Team Membership - */ - readonly "team-membership": { - /** Format: uri */ readonly url: string; + /** @example citizen_code_of_conduct */ + readonly key: string; + /** @example Citizen Code of Conduct */ + readonly name: string; /** - * @description The role of the user in the team. - * @default member - * @example member - * @enum {string} - */ - readonly role: "member" | "maintainer"; - /** - * @description The state of the user's membership in the team. - * @enum {string} + * Format: uri + * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - readonly state: "active" | "pending"; - }; - /** - * Team Project - * @description A team's access to a project. - */ - readonly "team-project": { - readonly owner_url: string; - readonly url: string; - readonly html_url: string; - readonly columns_url: string; - readonly id: number; - readonly node_id: string; - readonly name: string; - readonly body: string | null; - readonly number: number; - readonly state: string; - readonly creator: components["schemas"]["simple-user"]; - readonly created_at: string; - readonly updated_at: string; - /** @description The organization permission for this project. Only present when owner is an organization. */ - readonly organization_permission?: string; - /** @description Whether the project is private or not. Only present when owner is an organization. */ - readonly private?: boolean; - readonly permissions: { - readonly read: boolean; - readonly write: boolean; - readonly admin: boolean; - }; + readonly html_url: string | null; }; /** - * Team Repository - * @description A team's access to a repository. + * Full Repository + * @description Full Repository */ - readonly "team-repository": { - /** - * @description Unique identifier of the repository - * @example 42 - */ + readonly "full-repository": { + /** @example 1296269 */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ readonly node_id: string; - /** - * @description The name of the repository. - * @example Team Environment - */ + /** @example Hello-World */ readonly name: string; /** @example octocat/Hello-World */ readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; - /** @example admin */ - readonly role_name?: string; - readonly owner: components["schemas"]["nullable-simple-user"]; - /** - * @description Whether the repository is private or public. - * @default false - */ + readonly owner: components["schemas"]["simple-user"]; readonly private: boolean; /** * Format: uri @@ -22761,790 +22804,1375 @@ export interface components { readonly stargazers_count: number; /** @example 80 */ readonly watchers_count: number; - /** @example 108 */ - readonly size: number; /** - * @description The default branch of the repository. - * @example master + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + * @example 108 */ + readonly size: number; + /** @example master */ readonly default_branch: string; /** @example 0 */ readonly open_issues_count: number; - /** - * @description Whether this repository acts as a template that can be used to generate new repositories. - * @default false - * @example true - */ - readonly is_template: boolean; + /** @example true */ + readonly is_template?: boolean; + /** @example [ + * "octocat", + * "atom", + * "electron", + * "API" + * ] */ readonly topics?: string[]; - /** - * @description Whether issues are enabled. - * @default true - * @example true - */ + /** @example true */ readonly has_issues: boolean; - /** - * @description Whether projects are enabled. - * @default true - * @example true - */ + /** @example true */ readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - * @example true - */ + /** @example true */ readonly has_wiki: boolean; readonly has_pages: boolean; - /** - * @description Whether downloads are enabled. - * @default true - * @example true - */ - readonly has_downloads: boolean; - /** - * @description Whether the repository is archived. - * @default false - */ + /** @example true */ + readonly has_downloads?: boolean; + /** @example true */ + readonly has_discussions: boolean; readonly archived: boolean; /** @description Returns whether or not this repository disabled. */ readonly disabled: boolean; /** * @description The repository visibility: public, private, or internal. - * @default public + * @example public */ - readonly visibility: string; + readonly visibility?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string | null; + readonly pushed_at: string; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string | null; + readonly created_at: string; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string | null; + readonly updated_at: string; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly push: boolean; + readonly triage?: boolean; + readonly pull: boolean; + }; + /** @example true */ + readonly allow_rebase_merge?: boolean; + readonly template_repository?: components["schemas"]["nullable-repository"]; + readonly temp_clone_token?: string | null; + /** @example true */ + readonly allow_squash_merge?: boolean; + /** @example false */ + readonly allow_auto_merge?: boolean; + /** @example false */ + readonly delete_branch_on_merge?: boolean; + /** @example true */ + readonly allow_merge_commit?: boolean; + /** @example true */ + readonly allow_update_branch?: boolean; + /** @example false */ + readonly use_squash_pr_title_as_default?: boolean; /** - * @description Whether to allow rebase merges for pull requests. - * @default true - * @example true + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @example PR_TITLE + * @enum {string} */ - readonly allow_rebase_merge: boolean; - readonly temp_clone_token?: string; + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether to allow squash merges for pull requests. - * @default true - * @example true + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @example PR_BODY + * @enum {string} */ - readonly allow_squash_merge: boolean; + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description Whether to allow Auto-merge to be used on pull requests. - * @default false - * @example false + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @example PR_TITLE + * @enum {string} */ - readonly allow_auto_merge: boolean; + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** - * @description Whether to delete head branches when pull requests are merged - * @default false - * @example false + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @example PR_BODY + * @enum {string} */ - readonly delete_branch_on_merge: boolean; + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** @example true */ + readonly allow_forking?: boolean; + /** @example false */ + readonly web_commit_signoff_required?: boolean; + /** @example 42 */ + readonly subscribers_count: number; + /** @example 0 */ + readonly network_count: number; + readonly license: components["schemas"]["nullable-license-simple"]; + readonly organization?: components["schemas"]["nullable-simple-user"]; + readonly parent?: components["schemas"]["repository"]; + readonly source?: components["schemas"]["repository"]; + readonly forks: number; + readonly master_branch?: string; + readonly open_issues: number; + readonly watchers: number; /** - * @description Whether to allow merge commits for pull requests. + * @description Whether anonymous git access is allowed. * @default true - * @example true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow forking this repo - * @default false - * @example false */ - readonly allow_forking: boolean; - /** - * @description Whether to require contributors to sign off on web-based commits - * @default false - * @example false - */ - readonly web_commit_signoff_required: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; + readonly anonymous_access_enabled: boolean; + readonly code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; + readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + readonly custom_properties?: { + readonly [key: string]: unknown; + }; }; /** - * Project Card - * @description Project cards represent a scope of work. + * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). + * @enum {string} */ - readonly "project-card": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/cards/1478 - */ - readonly url: string; - /** - * @description The project card's ID - * @example 42 - */ - readonly id: number; - /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ - readonly node_id: string; - /** @example Add payload for delete Project column */ - readonly note: string | null; - readonly creator: components["schemas"]["nullable-simple-user"]; + readonly "repository-rule-enforcement": "disabled" | "active" | "evaluate"; + /** + * Repository Ruleset Bypass Actor + * @description An actor that can bypass rules in a ruleset + */ + readonly "repository-ruleset-bypass-actor": { + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. + * */ + readonly actor_id?: number | null; /** - * Format: date-time - * @example 2016-09-05T14:21:06Z + * @description The type of actor that can bypass a ruleset. + * + * @enum {string} */ - readonly created_at: string; + readonly actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** - * Format: date-time - * @example 2016-09-05T14:20:22Z + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. + * + * @enum {string} */ - readonly updated_at: string; - /** - * @description Whether or not the card is archived - * @example false - */ - readonly archived?: boolean; - readonly column_name?: string; - readonly project_id?: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - readonly column_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test/issues/3 - */ - readonly content_url?: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - readonly project_url: string; + readonly bypass_mode: "always" | "pull_request"; }; /** - * Project Column - * @description Project columns contain cards of work. + * Repository ruleset conditions for ref names + * @description Parameters for a repository ruleset ref name condition */ - readonly "project-column": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - readonly url: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - readonly project_url: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367/cards - */ - readonly cards_url: string; - /** - * @description The unique identifier of the project column - * @example 42 - */ - readonly id: number; - /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - readonly node_id: string; - /** - * @description Name of the project column - * @example Remaining tasks - */ + readonly "repository-ruleset-conditions": { + readonly ref_name?: { + /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */ + readonly include?: string[]; + /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */ + readonly exclude?: string[]; + }; + }; + /** + * Repository ruleset conditions for repository names + * @description Parameters for a repository name condition + */ + readonly "repository-ruleset-conditions-repository-name-target": { + readonly repository_name: { + /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */ + readonly include?: string[]; + /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */ + readonly exclude?: string[]; + /** @description Whether renaming of target repositories is prevented. */ + readonly protected?: boolean; + }; + }; + /** + * Repository ruleset conditions for repository IDs + * @description Parameters for a repository ID condition + */ + readonly "repository-ruleset-conditions-repository-id-target": { + readonly repository_id: { + /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */ + readonly repository_ids?: number[]; + }; + }; + /** + * Repository ruleset property targeting definition + * @description Parameters for a targeting a repository property + */ + readonly "repository-ruleset-conditions-repository-property-spec": { + /** @description The name of the repository property to target */ readonly name: string; - /** - * Format: date-time - * @example 2016-09-05T14:18:44Z - */ - readonly created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:22:28Z - */ - readonly updated_at: string; + /** @description The values to match for the repository property */ + readonly property_values: string[]; }; /** - * Project Collaborator Permission - * @description Project Collaborator Permission + * Repository ruleset conditions for repository properties + * @description Parameters for a repository property condition */ - readonly "project-collaborator-permission": { - readonly permission: string; - readonly user: components["schemas"]["nullable-simple-user"]; + readonly "repository-ruleset-conditions-repository-property-target": { + readonly repository_property: { + /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */ + readonly include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */ + readonly exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + }; }; - /** Rate Limit */ - readonly "rate-limit": { - readonly limit: number; - readonly remaining: number; - readonly reset: number; - readonly used: number; + /** + * Organization ruleset conditions + * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * + */ + 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"]); + /** + * creation + * @description Only allow users with bypass permission to create matching refs. + */ + readonly "repository-rule-creation": { + /** @enum {string} */ + readonly type: "creation"; }; /** - * Rate Limit Overview - * @description Rate Limit Overview + * update + * @description Only allow users with bypass permission to update matching refs. */ - readonly "rate-limit-overview": { - readonly resources: { - readonly core: components["schemas"]["rate-limit"]; - readonly graphql?: components["schemas"]["rate-limit"]; - readonly search: components["schemas"]["rate-limit"]; - readonly code_search?: components["schemas"]["rate-limit"]; - readonly source_import?: components["schemas"]["rate-limit"]; - readonly integration_manifest?: components["schemas"]["rate-limit"]; - readonly code_scanning_upload?: components["schemas"]["rate-limit"]; - readonly actions_runner_registration?: components["schemas"]["rate-limit"]; - readonly scim?: components["schemas"]["rate-limit"]; - readonly dependency_snapshots?: components["schemas"]["rate-limit"]; + readonly "repository-rule-update": { + /** @enum {string} */ + readonly type: "update"; + readonly parameters?: { + /** @description Branch can pull changes from its upstream repository */ + readonly update_allows_fetch_and_merge: boolean; }; - readonly rate: components["schemas"]["rate-limit"]; }; /** - * Repository - * @description A repository on GitHub. + * deletion + * @description Only allow users with bypass permissions to delete matching refs. */ - readonly "nullable-repository": { + readonly "repository-rule-deletion": { + /** @enum {string} */ + readonly type: "deletion"; + }; + /** + * required_linear_history + * @description Prevent merge commits from being pushed to matching refs. + */ + readonly "repository-rule-required-linear-history": { + /** @enum {string} */ + readonly type: "required_linear_history"; + }; + /** + * required_deployments + * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. + */ + readonly "repository-rule-required-deployments": { + /** @enum {string} */ + readonly type: "required_deployments"; + readonly parameters?: { + /** @description The environments that must be successfully deployed to before branches can be merged. */ + readonly required_deployment_environments: string[]; + }; + }; + /** + * required_signatures + * @description Commits pushed to matching refs must have verified signatures. + */ + readonly "repository-rule-required-signatures": { + /** @enum {string} */ + readonly type: "required_signatures"; + }; + /** + * pull_request + * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. + */ + readonly "repository-rule-pull-request": { + /** @enum {string} */ + readonly type: "pull_request"; + readonly parameters?: { + /** @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. */ + readonly require_code_owner_review: boolean; + /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */ + readonly require_last_push_approval: boolean; + /** @description The number of approving reviews that are required before a pull request can be merged. */ + readonly required_approving_review_count: number; + /** @description All conversations on code must be resolved before a pull request can be merged. */ + readonly required_review_thread_resolution: boolean; + }; + }; + /** + * StatusCheckConfiguration + * @description Required status check + */ + readonly "repository-rule-params-status-check-configuration": { + /** @description The status check context name that must be present on the commit. */ + readonly context: string; + /** @description The optional integration ID that this status check must originate from. */ + readonly integration_id?: number; + }; + /** + * required_status_checks + * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. + */ + readonly "repository-rule-required-status-checks": { + /** @enum {string} */ + readonly type: "required_status_checks"; + readonly parameters?: { + /** @description Status checks that are required. */ + readonly required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; + /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ + readonly strict_required_status_checks_policy: boolean; + }; + }; + /** + * non_fast_forward + * @description Prevent users with push access from force pushing to refs. + */ + readonly "repository-rule-non-fast-forward": { + /** @enum {string} */ + readonly type: "non_fast_forward"; + }; + /** + * commit_message_pattern + * @description Parameters to be used for the commit_message_pattern rule + */ + readonly "repository-rule-commit-message-pattern": { + /** @enum {string} */ + readonly type: "commit_message_pattern"; + readonly parameters?: { + /** @description How this rule will appear to users. */ + readonly name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + readonly negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + readonly pattern: string; + }; + }; + /** + * commit_author_email_pattern + * @description Parameters to be used for the commit_author_email_pattern rule + */ + readonly "repository-rule-commit-author-email-pattern": { + /** @enum {string} */ + readonly type: "commit_author_email_pattern"; + readonly parameters?: { + /** @description How this rule will appear to users. */ + readonly name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + readonly negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + readonly pattern: string; + }; + }; + /** + * committer_email_pattern + * @description Parameters to be used for the committer_email_pattern rule + */ + readonly "repository-rule-committer-email-pattern": { + /** @enum {string} */ + readonly type: "committer_email_pattern"; + readonly parameters?: { + /** @description How this rule will appear to users. */ + readonly name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + readonly negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + readonly pattern: string; + }; + }; + /** + * branch_name_pattern + * @description Parameters to be used for the branch_name_pattern rule + */ + readonly "repository-rule-branch-name-pattern": { + /** @enum {string} */ + readonly type: "branch_name_pattern"; + readonly parameters?: { + /** @description How this rule will appear to users. */ + readonly name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + readonly negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + readonly pattern: string; + }; + }; + /** + * tag_name_pattern + * @description Parameters to be used for the tag_name_pattern rule + */ + readonly "repository-rule-tag-name-pattern": { + /** @enum {string} */ + readonly type: "tag_name_pattern"; + readonly parameters?: { + /** @description How this rule will appear to users. */ + readonly name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + readonly negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + readonly operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + readonly pattern: string; + }; + }; + /** + * RestrictedCommits + * @description Restricted commit + */ + readonly "repository-rule-params-restricted-commits": { + /** @description Full or abbreviated commit hash to reject */ + readonly oid: string; + /** @description Reason for restriction */ + readonly reason?: string; + }; + /** + * WorkflowFileReference + * @description A workflow that must run for this rule to pass + */ + readonly "repository-rule-params-workflow-file-reference": { + /** @description The path to the workflow file */ + readonly path: string; + /** @description The ref (branch or tag) of the workflow file to use */ + readonly ref?: string; + /** @description The ID of the repository where the workflow is defined */ + readonly repository_id: number; + /** @description The commit SHA of the workflow file to use */ + readonly sha?: string; + }; + /** + * workflows + * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged. + */ + readonly "repository-rule-workflows": { + /** @enum {string} */ + readonly type: "workflows"; + readonly parameters?: { + /** @description Workflows that must pass for this rule to pass. */ + readonly workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; + }; + }; + /** + * CodeScanningTool + * @description A tool that must provide code scanning results for this rule to pass. + */ + readonly "repository-rule-params-code-scanning-tool": { /** - * @description Unique identifier of the repository - * @example 42 + * @description The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + * @enum {string} */ - readonly id: number; - /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - readonly node_id: string; + readonly alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; /** - * @description The name of the repository. - * @example Team Environment + * @description The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + * @enum {string} */ - readonly name: string; - /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; + readonly security_alerts_threshold: "none" | "critical" | "high_or_higher" | "medium_or_higher" | "all"; + /** @description The name of a code scanning tool */ + readonly tool: string; + }; + /** + * Repository Rule + * @description A repository rule. + */ + readonly "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { + /** @enum {string} */ + readonly type: "file_path_restriction"; + readonly parameters?: { + /** @description The file paths that are restricted from being pushed to the commit graph. */ + readonly restricted_file_paths: string[]; }; - readonly owner: components["schemas"]["simple-user"]; + } | { + /** @enum {string} */ + readonly type: "max_file_path_length"; + readonly parameters?: { + /** @description The maximum amount of characters allowed in file paths */ + readonly max_file_path_length: number; + }; + } | { + /** @enum {string} */ + readonly type: "file_extension_restriction"; + readonly parameters?: { + /** @description The file extensions that are restricted from being pushed to the commit graph. */ + readonly restricted_file_extensions: string[]; + }; + } | { + /** @enum {string} */ + readonly type: "max_file_size"; + readonly parameters?: { + /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ + readonly max_file_size: number; + }; + } | components["schemas"]["repository-rule-workflows"]; + /** + * Repository ruleset + * @description A set of rules to apply when specified conditions are met. + */ + readonly "repository-ruleset": { + /** @description The ID of the ruleset */ + readonly id: number; + /** @description The name of the ruleset */ + readonly name: string; /** - * @description Whether the repository is private or public. - * @default false + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. + * @enum {string} */ - readonly private: boolean; + readonly target?: "branch" | "tag" | "push"; /** - * Format: uri - * @example https://github.com/octocat/Hello-World + * @description The type of the source of the ruleset + * @enum {string} */ - readonly html_url: string; - /** @example This your first repo! */ - readonly description: string | null; - readonly fork: boolean; + readonly source_type?: "Repository" | "Organization"; + /** @description The name of the source */ + readonly source: string; + readonly enforcement: components["schemas"]["repository-rule-enforcement"]; + /** @description The actors that can bypass the rules in this ruleset */ + readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World + * @description The bypass type of the user making the API request for this ruleset. This field is only returned when + * querying the repository-level endpoint. + * @enum {string} */ - readonly url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + readonly current_user_can_bypass?: "always" | "pull_requests_only" | "never"; + readonly node_id?: string; + readonly _links?: { + readonly self?: { + /** @description The URL of the ruleset */ + readonly href?: string; + }; + readonly html?: { + /** @description The html URL of the ruleset */ + readonly href?: string; + }; + }; + readonly conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; + readonly rules?: components["schemas"]["repository-rule"][]; + /** Format: date-time */ + readonly created_at?: string; + /** Format: date-time */ + readonly updated_at?: string; + }; + /** + * Rule Suites + * @description Response + */ + readonly "rule-suites": { + /** @description The unique identifier of the rule insight. */ + readonly id?: number; + /** @description The number that identifies the user. */ + readonly actor_id?: number; + /** @description The handle for the GitHub user account. */ + readonly actor_name?: string; + /** @description The first commit sha before the push evaluation. */ + readonly before_sha?: string; + /** @description The last commit sha in the push evaluation. */ + readonly after_sha?: string; + /** @description The ref name that the evaluation ran on. */ + readonly ref?: string; + /** @description The ID of the repository associated with the rule evaluation. */ + readonly repository_id?: number; + /** @description The name of the repository without the `.git` extension. */ + readonly repository_name?: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/contributors + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - readonly contributors_url: string; + readonly pushed_at?: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} */ - readonly deployments_url: string; + readonly result?: "pass" | "fail" | "bypass"; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + * @enum {string} */ - readonly downloads_url: string; + readonly evaluation_result?: "pass" | "fail"; + }[]; + /** + * Rule Suite + * @description Response + */ + readonly "rule-suite": { + /** @description The unique identifier of the rule insight. */ + readonly id?: number; + /** @description The number that identifies the user. */ + readonly actor_id?: number | null; + /** @description The handle for the GitHub user account. */ + readonly actor_name?: string | null; + /** @description The first commit sha before the push evaluation. */ + readonly before_sha?: string; + /** @description The last commit sha in the push evaluation. */ + readonly after_sha?: string; + /** @description The ref name that the evaluation ran on. */ + readonly ref?: string; + /** @description The ID of the repository associated with the rule evaluation. */ + readonly repository_id?: number; + /** @description The name of the repository without the `.git` extension. */ + readonly repository_name?: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/events + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - readonly events_url: string; + readonly pushed_at?: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/forks + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} */ - readonly forks_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; - /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - readonly labels_url: string; + readonly result?: "pass" | "fail" | "bypass"; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/languages + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + * @enum {string} */ - readonly languages_url: string; + readonly evaluation_result?: "pass" | "fail"; + /** @description Details on the evaluated rules. */ + readonly rule_evaluations?: { + readonly rule_source?: { + /** @description The type of rule source. */ + readonly type?: string; + /** @description The ID of the rule source. */ + readonly id?: number | null; + /** @description The name of the rule source. */ + readonly name?: string | null; + }; + /** + * @description The enforcement level of this rule source. + * @enum {string} + */ + readonly enforcement?: "active" | "evaluate" | "deleted ruleset"; + /** + * @description The result of the evaluation of the individual rule. + * @enum {string} + */ + readonly result?: "pass" | "fail"; + /** @description The type of rule. */ + readonly rule_type?: string; + /** @description Any associated details with the rule evaluation. */ + readonly details?: string; + }[]; + }; + /** @description A product affected by the vulnerability detailed in a repository security advisory. */ + readonly "repository-advisory-vulnerability": { + /** @description The name of the package affected by the vulnerability. */ + readonly package: { + readonly ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + readonly name: string | null; + } | null; + /** @description The range of the package versions affected by the vulnerability. */ + readonly vulnerable_version_range: string | null; + /** @description The package version(s) that resolve the vulnerability. */ + readonly patched_versions: string | null; + /** @description The functions in the package that are affected. */ + readonly vulnerable_functions: string[] | null; + }; + /** @description A credit given to a user for a repository security advisory. */ + readonly "repository-advisory-credit": { + readonly user: components["schemas"]["simple-user"]; + readonly type: components["schemas"]["security-advisory-credit-types"]; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/merges + * @description The state of the user's acceptance of the credit. + * @enum {string} */ - readonly merges_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; - /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; + readonly state: "accepted" | "declined" | "pending"; + }; + /** @description A repository security advisory. */ + readonly "repository-advisory": { + /** @description The GitHub Security Advisory ID. */ + readonly ghsa_id: string; + /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + readonly cve_id: string | null; /** * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @description The API URL for the advisory. */ - readonly stargazers_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; + readonly url: string; /** * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @description The URL for the advisory. */ - readonly subscribers_url: string; + readonly html_url: string; + /** @description A short summary of the advisory. */ + readonly summary: string; + /** @description A detailed description of what the advisory entails. */ + readonly description: string | null; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @description The severity of the advisory. + * @enum {string|null} */ - readonly subscription_url: string; + readonly severity: "critical" | "high" | "medium" | "low"; + /** @description The author of the advisory. */ + readonly author: components["schemas"]["simple-user"] | null; + /** @description The publisher of the advisory. */ + readonly publisher: components["schemas"]["simple-user"] | null; + readonly identifiers: { + /** + * @description The type of identifier. + * @enum {string} + */ + readonly type: "CVE" | "GHSA"; + /** @description The identifier value. */ + readonly value: string; + }[]; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/tags + * @description The state of the advisory. + * @enum {string} */ - readonly tags_url: string; + readonly state: "published" | "closed" | "withdrawn" | "draft" | "triage"; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/teams + * Format: date-time + * @description The date and time of when the advisory was created, in ISO 8601 format. */ - readonly teams_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; - /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; + readonly created_at: string | null; /** - * Format: uri - * @example git:git.example.com/octocat/Hello-World + * Format: date-time + * @description The date and time of when the advisory was last updated, in ISO 8601 format. */ - readonly mirror_url: string | null; + readonly updated_at: string | null; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/hooks + * Format: date-time + * @description The date and time of when the advisory was published, in ISO 8601 format. */ - readonly hooks_url: string; + readonly published_at: string | null; /** - * Format: uri - * @example https://svn.github.com/octocat/Hello-World + * Format: date-time + * @description The date and time of when the advisory was closed, in ISO 8601 format. */ - readonly svn_url: string; + readonly closed_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + */ + readonly withdrawn_at: string | null; + readonly submission: { + /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ + readonly accepted: boolean; + } | null; + readonly vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; + readonly cvss: { + /** @description The CVSS vector. */ + readonly vector_string: string | null; + /** @description The CVSS score. */ + readonly score: number | null; + } | null; + readonly cwes: { + /** @description The Common Weakness Enumeration (CWE) identifier. */ + readonly cwe_id: string; + /** @description The name of the CWE. */ + readonly name: string; + }[] | null; + /** @description A list of only the CWE IDs. */ + readonly cwe_ids: string[] | null; + readonly credits: { + /** @description The username of the user credited. */ + readonly login?: string; + readonly type?: components["schemas"]["security-advisory-credit-types"]; + }[] | null; + readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null; + /** @description A list of users that collaborate on the advisory. */ + readonly collaborating_users: components["schemas"]["simple-user"][] | null; + /** @description A list of teams that collaborate on the advisory. */ + readonly collaborating_teams: components["schemas"]["team"][] | null; + /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ + readonly private_fork: components["schemas"]["simple-repository"] | null; + }; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + readonly "team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + readonly id: number; + /** @example MDQ6VGVhbTE= */ + readonly node_id: string; /** * Format: uri - * @example https://github.com + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 */ - readonly homepage: string | null; - readonly language: string | null; - /** @example 9 */ - readonly forks_count: number; - /** @example 80 */ - readonly stargazers_count: number; - /** @example 80 */ - readonly watchers_count: number; + readonly url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + readonly members_url: string; /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. - * @example 108 + * @description Name of the team + * @example Justice League */ - readonly size: number; + readonly name: string; /** - * @description The default branch of the repository. - * @example master + * @description Description of the team + * @example A great team. */ - readonly default_branch: string; - /** @example 0 */ - readonly open_issues_count: number; + readonly description: string | null; /** - * @description Whether this repository acts as a template that can be used to generate new repositories. - * @default false - * @example true + * @description Permission that the team will have for its repositories + * @example admin */ - readonly is_template: boolean; - readonly topics?: string[]; + readonly permission: string; /** - * @description Whether issues are enabled. - * @default true - * @example true + * @description The level of privacy this team should have + * @example closed */ - readonly has_issues: boolean; + readonly privacy?: string; /** - * @description Whether projects are enabled. - * @default true - * @example true + * @description The notification setting the team has set + * @example notifications_enabled */ - readonly has_projects: boolean; + readonly notification_setting?: string; /** - * @description Whether the wiki is enabled. - * @default true - * @example true + * Format: uri + * @example https://github.com/orgs/rails/teams/core */ - readonly has_wiki: boolean; - readonly has_pages: boolean; + readonly html_url: string; /** - * @deprecated - * @description Whether downloads are enabled. - * @default true - * @example true + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos */ - readonly has_downloads: boolean; + readonly repositories_url: string; + /** @example justice-league */ + readonly slug: string; /** - * @description Whether discussions are enabled. - * @default false - * @example true + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com */ - readonly has_discussions: boolean; + readonly ldap_dn?: string; + }; + readonly "actions-billing-usage": { + /** @description The sum of the free and paid GitHub Actions minutes used. */ + readonly total_minutes_used: number; + /** @description The total paid GitHub Actions minutes used. */ + readonly total_paid_minutes_used: number; + /** @description The amount of free GitHub Actions minutes available. */ + readonly included_minutes: number; + readonly minutes_used_breakdown: { + /** @description Total minutes used on Ubuntu runner machines. */ + readonly UBUNTU?: number; + /** @description Total minutes used on macOS runner machines. */ + readonly MACOS?: number; + /** @description Total minutes used on Windows runner machines. */ + readonly WINDOWS?: number; + /** @description Total minutes used on Ubuntu 4 core runner machines. */ + readonly ubuntu_4_core?: number; + /** @description Total minutes used on Ubuntu 8 core runner machines. */ + readonly ubuntu_8_core?: number; + /** @description Total minutes used on Ubuntu 16 core runner machines. */ + readonly ubuntu_16_core?: number; + /** @description Total minutes used on Ubuntu 32 core runner machines. */ + readonly ubuntu_32_core?: number; + /** @description Total minutes used on Ubuntu 64 core runner machines. */ + readonly ubuntu_64_core?: number; + /** @description Total minutes used on Windows 4 core runner machines. */ + readonly windows_4_core?: number; + /** @description Total minutes used on Windows 8 core runner machines. */ + readonly windows_8_core?: number; + /** @description Total minutes used on Windows 16 core runner machines. */ + readonly windows_16_core?: number; + /** @description Total minutes used on Windows 32 core runner machines. */ + readonly windows_32_core?: number; + /** @description Total minutes used on Windows 64 core runner machines. */ + readonly windows_64_core?: number; + /** @description Total minutes used on macOS 12 core runner machines. */ + readonly macos_12_core?: number; + /** @description Total minutes used on all runner machines. */ + readonly total?: number; + }; + }; + readonly "packages-billing-usage": { + /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ + readonly total_gigabytes_bandwidth_used: number; + /** @description Total paid storage space (GB) for GitHuub Packages. */ + readonly total_paid_gigabytes_bandwidth_used: number; + /** @description Free storage space (GB) for GitHub Packages. */ + readonly included_gigabytes_bandwidth: number; + }; + readonly "combined-billing-usage": { + /** @description Numbers of days left in billing cycle. */ + readonly days_left_in_billing_cycle: number; + /** @description Estimated storage space (GB) used in billing cycle. */ + readonly estimated_paid_storage_for_month: number; + /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ + readonly estimated_storage_for_month: number; + }; + /** + * Team Organization + * @description Team Organization + */ + readonly "team-organization": { + /** @example github */ + readonly login: string; + /** @example 1 */ + readonly id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + readonly node_id: string; /** - * @description Whether the repository is archived. - * @default false + * Format: uri + * @example https://api.github.com/orgs/github */ - readonly archived: boolean; - /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; + readonly url: string; /** - * @description The repository visibility: public, private, or internal. - * @default public + * Format: uri + * @example https://api.github.com/orgs/github/repos */ - readonly visibility: string; + readonly repos_url: string; /** - * Format: date-time - * @example 2011-01-26T19:06:43Z + * Format: uri + * @example https://api.github.com/orgs/github/events */ - readonly pushed_at: string | null; + 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; + /** @example github */ + readonly name?: string; + /** @example GitHub */ + readonly company?: string; /** - * Format: date-time - * @example 2011-01-26T19:01:12Z + * Format: uri + * @example https://github.com/blog */ - readonly created_at: string | null; + readonly blog?: string; + /** @example San Francisco */ + readonly location?: string; + /** + * Format: email + * @example octocat@github.com + */ + readonly email?: string; + /** @example github */ + readonly twitter_username?: string | null; + /** @example true */ + readonly is_verified?: boolean; + /** @example true */ + readonly has_organization_projects: boolean; + /** @example true */ + readonly has_repository_projects: boolean; + /** @example 2 */ + readonly public_repos: number; + /** @example 1 */ + readonly public_gists: number; + /** @example 20 */ + readonly followers: number; + /** @example 0 */ + readonly following: number; + /** + * Format: uri + * @example https://github.com/octocat + */ + readonly html_url: string; /** * Format: date-time - * @example 2011-01-26T19:14:43Z + * @example 2008-01-14T04:33:35Z */ - readonly updated_at: string | null; + readonly created_at: string; + /** @example Organization */ + readonly type: string; + /** @example 100 */ + readonly total_private_repos?: number; + /** @example 100 */ + readonly owned_private_repos?: number; + /** @example 81 */ + readonly private_gists?: number | null; + /** @example 10000 */ + readonly disk_usage?: number | null; + /** @example 8 */ + readonly collaborators?: number | null; /** - * @description Whether to allow rebase merges for pull requests. - * @default true - * @example true + * Format: email + * @example org@example.com */ - readonly allow_rebase_merge: boolean; - readonly template_repository?: { - readonly id?: number; - readonly node_id?: string; - readonly name?: string; - readonly full_name?: string; - readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: string; - readonly avatar_url?: string; - readonly gravatar_id?: string; - readonly url?: string; - readonly html_url?: string; - readonly followers_url?: string; - readonly following_url?: string; - readonly gists_url?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly organizations_url?: string; - readonly repos_url?: string; - readonly events_url?: string; - readonly received_events_url?: string; - readonly type?: string; - readonly site_admin?: boolean; - }; - readonly private?: boolean; - readonly html_url?: string; - readonly description?: string; - readonly fork?: boolean; - readonly url?: string; - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly downloads_url?: string; - readonly events_url?: string; - readonly forks_url?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly notifications_url?: string; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly ssh_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly clone_url?: string; - readonly mirror_url?: string; - readonly hooks_url?: string; - readonly svn_url?: string; - readonly homepage?: string; - readonly language?: string; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; - readonly pushed_at?: string; - readonly created_at?: string; - readonly updated_at?: string; - readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; - }; - readonly allow_rebase_merge?: boolean; - readonly temp_clone_token?: string; - readonly allow_squash_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_update_branch?: boolean; - readonly use_squash_pr_title_as_default?: boolean; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - readonly allow_merge_commit?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - } | null; - readonly temp_clone_token?: string; + readonly billing_email?: string | null; + readonly plan?: { + readonly name: string; + readonly space: number; + readonly private_repos: number; + readonly filled_seats?: number; + readonly seats?: number; + }; + readonly default_repository_permission?: string | null; + /** @example true */ + readonly members_can_create_repositories?: boolean | null; + /** @example true */ + readonly two_factor_requirement_enabled?: boolean | null; + /** @example all */ + readonly members_allowed_repository_creation_type?: string; + /** @example true */ + readonly members_can_create_public_repositories?: boolean; + /** @example true */ + readonly members_can_create_private_repositories?: boolean; + /** @example true */ + readonly members_can_create_internal_repositories?: boolean; + /** @example true */ + readonly members_can_create_pages?: boolean; + /** @example true */ + readonly members_can_create_public_pages?: boolean; + /** @example true */ + readonly members_can_create_private_pages?: boolean; + /** @example false */ + readonly members_can_fork_private_repositories?: boolean | null; + /** @example false */ + readonly web_commit_signoff_required?: boolean; + /** Format: date-time */ + readonly updated_at: string; + /** Format: date-time */ + readonly archived_at: string | null; + }; + /** + * Full Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + readonly "team-full": { /** - * @description Whether to allow squash merges for pull requests. - * @default true - * @example true + * @description Unique identifier of the team + * @example 42 */ - readonly allow_squash_merge: boolean; + readonly id: number; + /** @example MDQ6VGVhbTE= */ + readonly node_id: string; /** - * @description Whether to allow Auto-merge to be used on pull requests. - * @default false - * @example false + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 */ - readonly allow_auto_merge: boolean; + readonly url: string; /** - * @description Whether to delete head branches when pull requests are merged - * @default false - * @example false + * Format: uri + * @example https://github.com/orgs/rails/teams/core */ - readonly delete_branch_on_merge: boolean; + readonly html_url: string; /** - * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. - * @default false - * @example false + * @description Name of the team + * @example Developers */ - readonly allow_update_branch: boolean; + readonly name: string; + /** @example justice-league */ + readonly slug: string; + /** @example A great team. */ + readonly description: string | null; /** - * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false + * @description The level of privacy this team should have + * @example closed + * @enum {string} */ - readonly use_squash_pr_title_as_default: boolean; + readonly privacy?: "closed" | "secret"; /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @description The notification setting the team has set + * @example notifications_enabled * @enum {string} */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} + * @description Permission that the team will have for its repositories + * @example push */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + readonly permission: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + readonly members_url: string; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + readonly repositories_url: string; + readonly parent?: components["schemas"]["nullable-team-simple"]; + /** @example 3 */ + readonly members_count: number; + /** @example 10 */ + readonly repos_count: number; /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} + * Format: date-time + * @example 2017-07-14T16:53:42Z */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + readonly created_at: string; /** - * @description Whether to allow merge commits for pull requests. - * @default true - * @example true + * Format: date-time + * @example 2017-08-17T12:37:15Z */ - readonly allow_merge_commit: boolean; - /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; + readonly updated_at: string; + readonly organization: components["schemas"]["team-organization"]; /** - * @description Whether to require contributors to sign off on web-based commits - * @default false + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com */ - readonly web_commit_signoff_required: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; - /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; - /** @description Whether anonymous git access is enabled for this repository */ - readonly anonymous_access_enabled?: boolean; - } | null; + readonly ldap_dn?: string; + }; /** - * Code Of Conduct Simple - * @description Code of Conduct Simple + * Team Discussion + * @description A team discussion is a persistent record of a free-form conversation within a team. */ - readonly "code-of-conduct-simple": { + readonly "team-discussion": { + readonly author: components["schemas"]["nullable-simple-user"]; + /** + * @description The main text of the discussion. + * @example Please suggest improvements to our workflow in comments. + */ + readonly body: string; + /** @example

Hi! This is an area for us to collaborate as a team

*/ + readonly body_html: string; + /** + * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. + * @example 0307116bbf7ced493b8d8a346c650b71 + */ + readonly body_version: string; + /** @example 0 */ + readonly comments_count: number; /** * Format: uri - * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments + */ + readonly comments_url: string; + /** + * Format: date-time + * @example 2018-01-25T18:56:31Z + */ + readonly created_at: string; + /** Format: date-time */ + readonly last_edited_at: string | null; + /** + * Format: uri + * @example https://github.com/orgs/github/teams/justice-league/discussions/1 + */ + readonly html_url: string; + /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ + readonly node_id: string; + /** + * @description The unique sequence number of a team discussion. + * @example 42 + */ + readonly number: number; + /** + * @description Whether or not this discussion should be pinned for easy retrieval. + * @example true + */ + readonly pinned: boolean; + /** + * @description Whether or not this discussion should be restricted to team members and organization owners. + * @example true + */ + readonly private: boolean; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/2343027 + */ + readonly team_url: string; + /** + * @description The title of the discussion. + * @example How can we improve our workflow? + */ + readonly title: string; + /** + * Format: date-time + * @example 2018-01-25T18:56:31Z + */ + readonly updated_at: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/2343027/discussions/1 */ readonly url: string; - /** @example citizen_code_of_conduct */ - readonly key: string; - /** @example Citizen Code of Conduct */ - readonly name: string; + readonly reactions?: components["schemas"]["reaction-rollup"]; + }; + /** + * Team Discussion Comment + * @description A reply to a discussion within a team. + */ + readonly "team-discussion-comment": { + readonly author: components["schemas"]["nullable-simple-user"]; + /** + * @description The main text of the comment. + * @example I agree with this suggestion. + */ + readonly body: string; + /** @example

Do you like apples?

*/ + readonly body_html: string; + /** + * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. + * @example 0307116bbf7ced493b8d8a346c650b71 + */ + readonly body_version: string; + /** + * Format: date-time + * @example 2018-01-15T23:53:58Z + */ + readonly created_at: string; + /** Format: date-time */ + readonly last_edited_at: string | null; /** * Format: uri - * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @example https://api.github.com/organizations/1/team/2403582/discussions/1 */ - readonly html_url: string | null; + readonly discussion_url: string; + /** + * Format: uri + * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + */ + readonly html_url: string; + /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ + readonly node_id: string; + /** + * @description The unique sequence number of a team discussion comment. + * @example 42 + */ + readonly number: number; + /** + * Format: date-time + * @example 2018-01-15T23:53:58Z + */ + readonly updated_at: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + */ + readonly url: string; + readonly reactions?: components["schemas"]["reaction-rollup"]; }; /** - * Full Repository - * @description Full Repository + * Reaction + * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ - readonly "full-repository": { - /** @example 1296269 */ + readonly reaction: { + /** @example 1 */ + readonly id: number; + /** @example MDg6UmVhY3Rpb24x */ + readonly node_id: string; + readonly user: components["schemas"]["nullable-simple-user"]; + /** + * @description The reaction to use + * @example heart + * @enum {string} + */ + readonly content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Format: date-time + * @example 2016-05-20T20:09:31Z + */ + readonly created_at: string; + }; + /** + * Team Membership + * @description Team Membership + */ + readonly "team-membership": { + /** Format: uri */ + readonly url: string; + /** + * @description The role of the user in the team. + * @default member + * @example member + * @enum {string} + */ + readonly role: "member" | "maintainer"; + /** + * @description The state of the user's membership in the team. + * @enum {string} + */ + readonly state: "active" | "pending"; + }; + /** + * Team Project + * @description A team's access to a project. + */ + readonly "team-project": { + readonly owner_url: string; + readonly url: string; + readonly html_url: string; + readonly columns_url: string; + readonly id: number; + readonly node_id: string; + readonly name: string; + readonly body: string | null; + readonly number: number; + readonly state: string; + readonly creator: components["schemas"]["simple-user"]; + readonly created_at: string; + readonly updated_at: string; + /** @description The organization permission for this project. Only present when owner is an organization. */ + readonly organization_permission?: string; + /** @description Whether the project is private or not. Only present when owner is an organization. */ + readonly private?: boolean; + readonly permissions: { + readonly read: boolean; + readonly write: boolean; + readonly admin: boolean; + }; + }; + /** + * Team Repository + * @description A team's access to a repository. + */ + readonly "team-repository": { + /** + * @description Unique identifier of the repository + * @example 42 + */ readonly id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ readonly node_id: string; - /** @example Hello-World */ + /** + * @description The name of the repository. + * @example Team Environment + */ readonly name: string; /** @example octocat/Hello-World */ readonly full_name: string; - readonly owner: components["schemas"]["simple-user"]; + readonly license: components["schemas"]["nullable-license-simple"]; + readonly forks: number; + readonly permissions?: { + readonly admin: boolean; + readonly pull: boolean; + readonly triage?: boolean; + readonly push: boolean; + readonly maintain?: boolean; + }; + /** @example admin */ + readonly role_name?: string; + readonly owner: components["schemas"]["nullable-simple-user"]; + /** + * @description Whether the repository is private or public. + * @default false + */ readonly private: boolean; /** * Format: uri @@ -23698,142 +24326,252 @@ export interface components { readonly stargazers_count: number; /** @example 80 */ readonly watchers_count: number; + /** @example 108 */ + readonly size: number; /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. - * @example 108 + * @description The default branch of the repository. + * @example master */ - readonly size: number; - /** @example master */ readonly default_branch: string; /** @example 0 */ readonly open_issues_count: number; - /** @example true */ - readonly is_template?: boolean; - /** @example [ - * "octocat", - * "atom", - * "electron", - * "API" - * ] */ + /** + * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false + * @example true + */ + readonly is_template: boolean; readonly topics?: string[]; - /** @example true */ + /** + * @description Whether issues are enabled. + * @default true + * @example true + */ readonly has_issues: boolean; - /** @example true */ + /** + * @description Whether projects are enabled. + * @default true + * @example true + */ readonly has_projects: boolean; - /** @example true */ + /** + * @description Whether the wiki is enabled. + * @default true + * @example true + */ readonly has_wiki: boolean; readonly has_pages: boolean; - /** @example true */ - readonly has_downloads?: boolean; - /** @example true */ - readonly has_discussions: boolean; + /** + * @description Whether downloads are enabled. + * @default true + * @example true + */ + readonly has_downloads: boolean; + /** + * @description Whether the repository is archived. + * @default false + */ readonly archived: boolean; /** @description Returns whether or not this repository disabled. */ readonly disabled: boolean; /** * @description The repository visibility: public, private, or internal. - * @example public + * @default public */ - readonly visibility?: string; + readonly visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - readonly pushed_at: string; + readonly pushed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - readonly created_at: string; + readonly created_at: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - readonly updated_at: string; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly push: boolean; - readonly triage?: boolean; - readonly pull: boolean; - }; - /** @example true */ - readonly allow_rebase_merge?: boolean; - readonly template_repository?: components["schemas"]["nullable-repository"]; - readonly temp_clone_token?: string | null; - /** @example true */ - readonly allow_squash_merge?: boolean; - /** @example false */ - readonly allow_auto_merge?: boolean; - /** @example false */ - readonly delete_branch_on_merge?: boolean; - /** @example true */ - readonly allow_merge_commit?: boolean; - /** @example true */ - readonly allow_update_branch?: boolean; - /** @example false */ - readonly use_squash_pr_title_as_default?: boolean; + readonly updated_at: string | null; /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @example PR_TITLE - * @enum {string} + * @description Whether to allow rebase merges for pull requests. + * @default true + * @example true */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly allow_rebase_merge: boolean; + readonly temp_clone_token?: string; /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @example PR_BODY - * @enum {string} + * @description Whether to allow squash merges for pull requests. + * @default true + * @example true */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + readonly allow_squash_merge: boolean; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @example PR_TITLE - * @enum {string} + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + readonly allow_auto_merge: boolean; /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @example PR_BODY - * @enum {string} + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** @example true */ - readonly allow_forking?: boolean; - /** @example false */ - readonly web_commit_signoff_required?: boolean; - /** @example 42 */ - readonly subscribers_count: number; - /** @example 0 */ - readonly network_count: number; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly parent?: components["schemas"]["repository"]; - readonly source?: components["schemas"]["repository"]; - readonly forks: number; - readonly master_branch?: string; + readonly delete_branch_on_merge: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + * @example true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow forking this repo + * @default false + * @example false + */ + readonly allow_forking: boolean; + /** + * @description Whether to require contributors to sign off on web-based commits + * @default false + * @example false + */ + readonly web_commit_signoff_required: boolean; + readonly subscribers_count?: number; + readonly network_count?: number; readonly open_issues: number; readonly watchers: number; + readonly master_branch?: string; + }; + /** + * Project Card + * @description Project cards represent a scope of work. + */ + readonly "project-card": { /** - * @description Whether anonymous git access is allowed. - * @default true + * Format: uri + * @example https://api.github.com/projects/columns/cards/1478 */ - readonly anonymous_access_enabled: boolean; - readonly code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; - readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; + readonly url: string; + /** + * @description The project card's ID + * @example 42 + */ + readonly id: number; + /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ + readonly node_id: string; + /** @example Add payload for delete Project column */ + readonly note: string | null; + readonly creator: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @example 2016-09-05T14:21:06Z + */ + readonly created_at: string; + /** + * Format: date-time + * @example 2016-09-05T14:20:22Z + */ + readonly updated_at: string; + /** + * @description Whether or not the card is archived + * @example false + */ + readonly archived?: boolean; + readonly column_name?: string; + readonly project_id?: string; + /** + * Format: uri + * @example https://api.github.com/projects/columns/367 + */ + readonly column_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/api-playground/projects-test/issues/3 + */ + readonly content_url?: string; + /** + * Format: uri + * @example https://api.github.com/projects/120 + */ + readonly project_url: string; + }; + /** + * Project Column + * @description Project columns contain cards of work. + */ + readonly "project-column": { + /** + * Format: uri + * @example https://api.github.com/projects/columns/367 + */ + readonly url: string; + /** + * Format: uri + * @example https://api.github.com/projects/120 + */ + readonly project_url: string; + /** + * Format: uri + * @example https://api.github.com/projects/columns/367/cards + */ + readonly cards_url: string; + /** + * @description The unique identifier of the project column + * @example 42 + */ + readonly id: number; + /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ + readonly node_id: string; + /** + * @description Name of the project column + * @example Remaining tasks + */ + readonly name: string; + /** + * Format: date-time + * @example 2016-09-05T14:18:44Z + */ + readonly created_at: string; + /** + * Format: date-time + * @example 2016-09-05T14:22:28Z + */ + readonly updated_at: string; + }; + /** + * Project Collaborator Permission + * @description Project Collaborator Permission + */ + readonly "project-collaborator-permission": { + readonly permission: string; + readonly user: components["schemas"]["nullable-simple-user"]; + }; + /** Rate Limit */ + readonly "rate-limit": { + readonly limit: number; + readonly remaining: number; + readonly reset: number; + readonly used: number; + }; + /** + * Rate Limit Overview + * @description Rate Limit Overview + */ + readonly "rate-limit-overview": { + readonly resources: { + readonly core: components["schemas"]["rate-limit"]; + readonly graphql?: components["schemas"]["rate-limit"]; + readonly search: components["schemas"]["rate-limit"]; + readonly code_search?: components["schemas"]["rate-limit"]; + readonly source_import?: components["schemas"]["rate-limit"]; + readonly integration_manifest?: components["schemas"]["rate-limit"]; + readonly code_scanning_upload?: components["schemas"]["rate-limit"]; + readonly actions_runner_registration?: components["schemas"]["rate-limit"]; + readonly scim?: components["schemas"]["rate-limit"]; + readonly dependency_snapshots?: components["schemas"]["rate-limit"]; + }; + readonly rate: components["schemas"]["rate-limit"]; }; /** * Artifact @@ -23951,7 +24689,7 @@ export interface components { * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting"; + readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @description The outcome of the job. * @example success @@ -24118,7 +24856,7 @@ export interface components { * @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the * repository. * - * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization. + * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. * @enum {string} */ readonly access_level: "none" | "user" | "organization"; @@ -25284,11 +26022,11 @@ export interface components { /** @example https://example.com */ readonly details_url: string | null; /** - * @description The phase of the lifecycle that the check is currently in. + * @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. * @example queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed"; + readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @example neutral * @enum {string|null} @@ -25419,10 +26157,11 @@ export interface components { */ readonly head_sha: string; /** + * @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. * @example completed * @enum {string|null} */ - readonly status: "queued" | "in_progress" | "completed"; + readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @example neutral * @enum {string|null} @@ -25460,21 +26199,6 @@ export interface components { }; readonly repository: components["schemas"]["minimal-repository"]; }; - readonly "code-scanning-alert-rule-summary": { - /** @description A unique identifier for the rule used to detect the alert. */ - readonly id?: string | null; - /** @description The name of the rule used to detect the alert. */ - readonly name?: string; - /** @description A set of tags applicable for the rule. */ - readonly tags?: string[] | null; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - readonly severity?: "none" | "note" | "warning" | "error"; - /** @description A short description of the rule used to detect the alert. */ - readonly description?: string; - }; readonly "code-scanning-alert-items": { readonly number: components["schemas"]["alert-number"]; readonly created_at: components["schemas"]["alert-created-at"]; @@ -25492,6 +26216,32 @@ export interface components { readonly tool: components["schemas"]["code-scanning-analysis-tool"]; readonly most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; }; + readonly "code-scanning-alert-rule": { + /** @description A unique identifier for the rule used to detect the alert. */ + readonly id?: string | null; + /** @description The name of the rule used to detect the alert. */ + readonly name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + readonly severity?: "none" | "note" | "warning" | "error"; + /** + * @description The security severity of the alert. + * @enum {string|null} + */ + readonly security_severity_level?: "low" | "medium" | "high" | "critical"; + /** @description A short description of the rule used to detect the alert. */ + readonly description?: string; + /** @description description of the rule used to detect the alert. */ + readonly full_description?: string; + /** @description A set of tags applicable for the rule. */ + readonly tags?: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + readonly help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + readonly help_uri?: string | null; + }; readonly "code-scanning-alert": { readonly number: components["schemas"]["alert-number"]; readonly created_at: components["schemas"]["alert-created-at"]; @@ -25659,7 +26409,7 @@ export interface components { }; /** * @description The full Git reference, formatted as `refs/heads/`, - * `refs/pull//merge`, or `refs/pull//head`. + * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main */ readonly "code-scanning-ref-full": string; @@ -27447,24 +28197,7 @@ export interface components { * ] */ readonly events: string[]; - readonly config: { - /** @example "foo@bar.com" */ - readonly email?: string; - /** @example "foo" */ - readonly password?: string; - /** @example "roomer" */ - readonly room?: string; - /** @example "foo" */ - readonly subdomain?: string; - readonly url?: components["schemas"]["webhook-config-url"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - /** @example "sha256" */ - readonly digest?: string; - readonly secret?: components["schemas"]["webhook-config-secret"]; - /** @example "abc" */ - readonly token?: string; - }; + readonly config: components["schemas"]["webhook-config"]; /** * Format: date-time * @example 2011-09-06T20:39:23Z @@ -28772,10 +29505,12 @@ export interface components { * @description The GitHub Pages deployment status. */ readonly "page-deployment": { + /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ + readonly id: number | string; /** * Format: uri * @description The URI to monitor GitHub Pages deployment status. - * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status + * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 */ readonly status_url: string; /** @@ -28791,6 +29526,14 @@ export interface components { */ readonly preview_url?: string; }; + /** GitHub Pages deployment status */ + readonly "pages-deployment-status": { + /** + * @description The current status of the deployment. + * @enum {string} + */ + readonly status?: "deployment_in_progress" | "syncing_files" | "finished_file_sync" | "updating_pages" | "purging_cdn" | "deployment_cancelled" | "deployment_failed" | "deployment_content_failed" | "deployment_attempt_error" | "deployment_lost" | "succeed"; + }; /** * Pages Health Check Status * @description Pages Health Check Status @@ -29728,6 +30471,42 @@ export interface components { /** @description The API URL to get the associated commit resource */ readonly commit_url: string; }; + /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ + readonly "secret-scanning-location-wiki-commit": { + /** + * @description The file path of the wiki page + * @example /example/Home.md + */ + readonly path: string; + /** @description Line number at which the secret starts in the file */ + readonly start_line: number; + /** @description Line number at which the secret ends in the file */ + readonly end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ + readonly start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ + readonly end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + readonly blob_sha: string; + /** + * @description The GitHub URL to get the associated wiki page + * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + readonly page_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + readonly commit_sha: string; + /** + * @description The GitHub URL to get the associated wiki commit + * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + readonly commit_url: string; + }; /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ readonly "secret-scanning-location-issue-title": { /** @@ -29755,14 +30534,86 @@ export interface components { */ readonly issue_comment_url: string; }; + /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ + readonly "secret-scanning-location-discussion-title": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082 + */ + readonly discussion_title_url: string; + }; + /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ + readonly "secret-scanning-location-discussion-body": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussion-4566270 + */ + readonly discussion_body_url: string; + }; + /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ + readonly "secret-scanning-location-discussion-comment": { + /** + * Format: uri + * @description The API URL to get the discussion comment where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + */ + readonly discussion_comment_url: string; + }; + /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ + readonly "secret-scanning-location-pull-request-title": { + /** + * 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 + */ + readonly pull_request_title_url: string; + }; + /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ + readonly "secret-scanning-location-pull-request-body": { + /** + * 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 + */ + readonly pull_request_body_url: string; + }; + /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ + readonly "secret-scanning-location-pull-request-comment": { + /** + * Format: uri + * @description The API URL to get the pull request comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + readonly pull_request_comment_url: string; + }; + /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ + readonly "secret-scanning-location-pull-request-review": { + /** + * Format: uri + * @description The API URL to get the pull request review where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + */ + readonly pull_request_review_url: string; + }; + /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ + readonly "secret-scanning-location-pull-request-review-comment": { + /** + * Format: uri + * @description The API URL to get the pull request review comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + */ + readonly pull_request_review_comment_url: string; + }; readonly "secret-scanning-location": { /** - * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found. + * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. * @example commit * @enum {string} */ - readonly type: "commit" | "issue_title" | "issue_body" | "issue_comment"; - readonly details: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"]; + readonly type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; + readonly details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; readonly "repository-advisory-create": { /** @description A short summary of the advisory. */ @@ -29801,6 +30652,11 @@ export interface components { readonly severity?: "critical" | "high" | "medium" | "low"; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ readonly cvss_vector_string?: string | null; + /** + * @description Whether to create a temporary private fork of the repository to collaborate on a fix. + * @default false + */ + readonly start_private_fork: boolean; }; readonly "private-vulnerability-report-create": { /** @description A short summary of the advisory. */ @@ -29831,6 +30687,11 @@ export interface components { readonly severity?: "critical" | "high" | "medium" | "low"; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ readonly cvss_vector_string?: string | null; + /** + * @description Whether to create a temporary private fork of the repository to collaborate on a fix. + * @default false + */ + readonly start_private_fork: boolean; }; readonly "repository-advisory-update": { /** @description A short summary of the advisory. */ @@ -31311,7 +32172,7 @@ export interface components { /** @example 80 */ readonly watchers_count: number; /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ readonly size: number; @@ -31698,6 +32559,50 @@ export interface components { /** @example "2020-07-09T00:17:55Z" */ readonly starred_at?: string; }; + /** + * branch protection rule + * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + */ + readonly webhooks_rule: { + readonly admin_enforced: boolean; + /** @enum {string} */ + readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; + readonly authorized_actor_names: string[]; + readonly authorized_actors_only: boolean; + readonly authorized_dismissal_actors_only: boolean; + readonly create_protected?: boolean; + /** Format: date-time */ + readonly created_at: string; + readonly dismiss_stale_reviews_on_push: boolean; + readonly id: number; + readonly ignore_approvals_from_contributors: boolean; + /** @enum {string} */ + readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + readonly name: string; + /** @enum {string} */ + readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; + readonly repository_id: number; + readonly require_code_owner_review: boolean; + /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ + readonly require_last_push_approval?: boolean; + readonly required_approving_review_count: number; + /** @enum {string} */ + readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; + readonly required_status_checks: string[]; + /** @enum {string} */ + readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + readonly strict_required_status_checks_policy: boolean; + /** Format: date-time */ + readonly updated_at: string; + }; /** @description A suite of checks performed on the code of a given code change */ readonly "simple-check-suite": { /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ @@ -31799,15 +32704,68 @@ export interface components { /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ readonly url: string; }; - /** - * Discussion - * @description A Discussion in a repository. - */ - readonly discussion: { - readonly active_lock_reason: string | null; - readonly answer_chosen_at: string | null; + /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + readonly webhooks_code_scanning_commit_oid: string; + /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + readonly webhooks_code_scanning_ref: string; + /** @description The pusher type for the event. Can be either `user` or a deploy key. */ + readonly webhooks_deploy_pusher_type: string; + /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ + readonly webhooks_ref_0: string; + /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ + readonly webhooks_deploy_key: { + readonly added_by?: string | null; + readonly created_at: string; + readonly id: number; + readonly key: string; + readonly last_used?: string | null; + readonly read_only: boolean; + readonly title: string; + /** Format: uri */ + readonly url: string; + readonly verified: boolean; + }; + /** Workflow */ + readonly webhooks_workflow: { + /** Format: uri */ + readonly badge_url: string; + /** Format: date-time */ + readonly created_at: string; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly name: string; + readonly node_id: string; + readonly path: string; + readonly state: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + } | null; + readonly webhooks_approver: { + 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; + 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 webhooks_reviewers: { /** User */ - readonly answer_chosen_by: { + readonly reviewer?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -31843,7 +32801,57 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - readonly answer_html_url: string | null; + /** @enum {string} */ + readonly type?: "User"; + }[]; + readonly webhooks_workflow_job_run: { + readonly conclusion: unknown; + readonly created_at: string; + readonly environment: string; + readonly html_url: string; + readonly id: number; + readonly name: unknown; + readonly status: string; + readonly updated_at: string; + }; + /** User */ + readonly webhooks_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; + 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 webhooks_answer: { /** * AuthorAssociation * @description How the author is associated with the repository. @@ -31851,27 +32859,14 @@ export interface components { */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; readonly body: string; - readonly category: { - /** Format: date-time */ - readonly created_at: string; - readonly description: string; - readonly emoji: string; - readonly id: number; - readonly is_answerable: boolean; - readonly name: string; - readonly node_id?: string; - readonly repository_id: number; - readonly slug: string; - readonly updated_at: string; - }; - readonly comments: number; + readonly child_comment_count: number; /** Format: date-time */ readonly created_at: string; + readonly discussion_id: number; readonly html_url: string; readonly id: number; - readonly locked: boolean; readonly node_id: string; - readonly number: number; + readonly parent_id: unknown; /** Reactions */ readonly reactions?: { readonly "+1": number; @@ -31887,21 +32882,6 @@ export interface components { readonly url: string; }; readonly repository_url: string; - /** - * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. - * @enum {string} - */ - readonly state: "open" | "closed" | "locked" | "converting" | "transferring"; - /** - * @description The reason for the current state - * @example resolved - * @enum {string|null} - */ - readonly state_reason: "resolved" | "outdated" | "duplicate" | "reopened"; - readonly timeline_url?: string; - readonly title: string; /** Format: date-time */ readonly updated_at: string; /** User */ @@ -31943,11797 +32923,2518 @@ export interface components { } | null; }; /** - * Merge Group - * @description A group of pull requests that the merge queue has grouped together to be merged. - * - */ - readonly "merge-group": { - /** @description The SHA of the merge group. */ - readonly head_sha: string; - /** @description The full ref of the merge group. */ - readonly head_ref: string; - /** @description The SHA of the merge group's parent commit. */ - readonly base_sha: string; - /** @description The full ref of the branch the merge group will be merged into. */ - readonly base_ref: string; - readonly head_commit: components["schemas"]["simple-commit"]; - }; - /** - * Repository - * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * Discussion + * @description A Discussion in a repository. */ - readonly "nullable-repository-webhooks": { + readonly discussion: { + readonly active_lock_reason: string | null; + readonly answer_chosen_at: string | null; + /** User */ + readonly answer_chosen_by: { + /** 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 answer_html_url: string | null; /** - * @description Unique identifier of the repository - * @example 42 + * 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"; + readonly body: string; + readonly category: { + /** Format: date-time */ + readonly created_at: string; + readonly description: string; + readonly emoji: string; + readonly id: number; + readonly is_answerable: boolean; + readonly name: string; + readonly node_id?: string; + readonly repository_id: number; + readonly slug: string; + readonly updated_at: string; + }; + readonly comments: number; + /** Format: date-time */ + readonly created_at: string; + readonly html_url: string; readonly id: number; - /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + readonly locked: boolean; readonly node_id: string; + readonly number: 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; + }; + readonly repository_url: string; /** - * @description The name of the repository. - * @example Team Environment + * @description The current state of the discussion. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. + * @enum {string} */ - readonly name: string; - /** @example octocat/Hello-World */ - readonly full_name: string; - readonly license: components["schemas"]["nullable-license-simple"]; - readonly organization?: components["schemas"]["nullable-simple-user"]; - readonly forks: number; - readonly permissions?: { - readonly admin: boolean; - readonly pull: boolean; - readonly triage?: boolean; - readonly push: boolean; - readonly maintain?: boolean; - }; - readonly owner: components["schemas"]["simple-user"]; + readonly state: "open" | "closed" | "locked" | "converting" | "transferring"; /** - * @description Whether the repository is private or public. - * @default false + * @description The reason for the current state + * @example resolved + * @enum {string|null} */ - readonly private: boolean; + readonly state_reason: "resolved" | "outdated" | "duplicate" | "reopened"; + readonly timeline_url?: string; + readonly title: string; + /** Format: date-time */ + readonly updated_at: 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; + 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 webhooks_comment: { /** - * Format: uri - * @example https://github.com/octocat/Hello-World + * 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"; + readonly body: string; + readonly child_comment_count: number; + readonly created_at: string; + readonly discussion_id: number; readonly html_url: string; - /** @example This your first repo! */ + readonly id: number; + readonly node_id: string; + readonly parent_id: number | null; + /** 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; + }; + readonly repository_url: string; + readonly updated_at: 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; + 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; + }; + /** Label */ + readonly webhooks_label: { + /** @description 6-character hex code, without the leading #, identifying the color */ + readonly color: string; + readonly default: boolean; readonly description: string | null; - readonly fork: boolean; + readonly id: number; + /** @description The name of the label. */ + readonly name: string; + readonly node_id: string; /** * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World + * @description URL for the label */ readonly url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - readonly archive_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - readonly assignees_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - readonly blobs_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - readonly branches_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - readonly collaborators_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - readonly comments_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - readonly commits_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - readonly compare_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - readonly contents_url: string; + }; + /** @description An array of repository objects that the installation can access. */ + readonly webhooks_repositories: { + readonly full_name: string; + /** @description Unique identifier of the repository */ + readonly id: number; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + }[]; + /** @description An array of repository objects, which were added to the installation. */ + readonly webhooks_repositories_added: { + readonly full_name: string; + /** @description Unique identifier of the repository */ + readonly id: number; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + }[]; + /** + * @description Describe whether all repositories have been selected or there's a selection involved + * @enum {string} + */ + readonly webhooks_repository_selection: "all" | "selected"; + /** + * issue comment + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. + */ + readonly webhooks_issue_comment: { /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/contributors + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} */ - readonly contributors_url: string; + readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue comment */ + readonly body: string; + /** Format: date-time */ + readonly created_at: string; + /** Format: uri */ + readonly html_url: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/deployments + * Format: int64 + * @description Unique identifier of the issue comment */ - readonly deployments_url: string; + readonly id: number; + /** Format: uri */ + readonly issue_url: string; + readonly node_id: string; + readonly performed_via_github_app: components["schemas"]["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 - * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @description URL for the issue comment */ - readonly downloads_url: string; + 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; + 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; + } | null; + }; + /** @description The changes to the comment. */ + readonly webhooks_changes: { + readonly body?: { + /** @description The previous version of the body. */ + readonly from: string; + }; + }; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + readonly webhooks_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; + } | null; + readonly assignees: ({ + /** 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; + } | null)[]; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/events + * 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 - * @example http://api.github.com/repos/octocat/Hello-World/forks - */ - readonly forks_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - readonly git_commits_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - readonly git_refs_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - readonly git_tags_url: string; - /** @example git:github.com/octocat/Hello-World.git */ - readonly git_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - readonly issue_comment_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - readonly issue_events_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - readonly issues_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - readonly keys_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ + /** Format: uri */ + readonly html_url: string; + /** Format: int64 */ + readonly id: number; + readonly labels?: { + /** @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: uri - * @example http://api.github.com/repos/octocat/Hello-World/languages - */ - readonly languages_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/merges + * Milestone + * @description A collection of related issues and pull requests. */ - readonly merges_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - readonly milestones_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - readonly notifications_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - readonly pulls_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - readonly releases_url: string; - /** @example git@github.com:octocat/Hello-World.git */ - readonly ssh_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/stargazers - */ - readonly stargazers_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - readonly statuses_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/subscribers - */ - readonly subscribers_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/subscription - */ - readonly subscription_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/tags - */ - readonly tags_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/teams - */ - readonly teams_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - readonly trees_url: string; - /** @example https://github.com/octocat/Hello-World.git */ - readonly clone_url: string; - /** - * Format: uri - * @example git:git.example.com/octocat/Hello-World - */ - readonly mirror_url: string | null; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/hooks - */ - readonly hooks_url: string; - /** - * Format: uri - * @example https://svn.github.com/octocat/Hello-World - */ - readonly svn_url: string; - /** - * Format: uri - * @example https://github.com - */ - readonly homepage: string | null; - readonly language: string | null; - /** @example 9 */ - readonly forks_count: number; - /** @example 80 */ - readonly stargazers_count: number; - /** @example 80 */ - readonly watchers_count: number; - /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. - * @example 108 - */ - readonly size: number; - /** - * @description The default branch of the repository. - * @example master - */ - readonly default_branch: string; - /** @example 0 */ - readonly open_issues_count: number; - /** - * @description Whether this repository acts as a template that can be used to generate new repositories. - * @default false - * @example true - */ - readonly is_template: boolean; - readonly topics?: string[]; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; - }; - /** - * @description Whether issues are enabled. - * @default true - * @example true - */ - readonly has_issues: boolean; - /** - * @description Whether projects are enabled. - * @default true - * @example true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - * @example true - */ - readonly has_wiki: boolean; - readonly has_pages: boolean; - /** - * @description Whether downloads are enabled. - * @default true - * @example true - */ - readonly has_downloads: boolean; - /** - * @description Whether discussions are enabled. - * @default false - * @example true - */ - readonly has_discussions: boolean; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** @description Returns whether or not this repository disabled. */ - readonly disabled: boolean; - /** - * @description The repository visibility: public, private, or internal. - * @default public - */ - readonly visibility: string; - /** - * Format: date-time - * @example 2011-01-26T19:06:43Z - */ - readonly pushed_at: string | null; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - readonly created_at: string | null; - /** - * Format: date-time - * @example 2011-01-26T19:14:43Z - */ - readonly updated_at: string | null; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - * @example true - */ - readonly allow_rebase_merge: boolean; - readonly template_repository?: { - readonly id?: number; - readonly node_id?: string; - readonly name?: string; - readonly full_name?: string; - readonly owner?: { - readonly login?: string; - readonly id?: number; - readonly node_id?: 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 gravatar_id?: string; - readonly url?: string; - readonly html_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 starred_url?: string; - readonly subscriptions_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; - readonly repos_url?: string; - readonly events_url?: string; + /** Format: uri */ readonly received_events_url?: string; - readonly type?: string; + /** Format: uri */ + readonly repos_url?: string; readonly site_admin?: boolean; - }; - readonly private?: boolean; - readonly html_url?: string; - readonly description?: string; - readonly fork?: boolean; - readonly url?: string; - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly downloads_url?: string; - readonly events_url?: string; - readonly forks_url?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly notifications_url?: string; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly ssh_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly clone_url?: string; - readonly mirror_url?: string; - readonly hooks_url?: string; - readonly svn_url?: string; - readonly homepage?: string; - readonly language?: string; - readonly forks_count?: number; - readonly stargazers_count?: number; - readonly watchers_count?: number; - readonly size?: number; - readonly default_branch?: string; - readonly open_issues_count?: number; - readonly is_template?: boolean; - readonly topics?: string[]; - readonly has_issues?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly has_pages?: boolean; - readonly has_downloads?: boolean; - readonly archived?: boolean; - readonly disabled?: boolean; - readonly visibility?: string; - readonly pushed_at?: string; - readonly created_at?: string; - readonly updated_at?: string; - readonly permissions?: { - readonly admin?: boolean; - readonly maintain?: boolean; - readonly push?: boolean; - readonly triage?: boolean; - readonly pull?: boolean; - }; - readonly allow_rebase_merge?: boolean; - readonly temp_clone_token?: string; - readonly allow_squash_merge?: boolean; - readonly allow_auto_merge?: boolean; - readonly delete_branch_on_merge?: boolean; - readonly allow_update_branch?: boolean; - readonly use_squash_pr_title_as_default?: boolean; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** 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; + } | 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 default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * @description The state of the milestone. * @enum {string} */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - readonly allow_merge_commit?: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; + 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 temp_clone_token?: string; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - * @example true - */ - readonly allow_squash_merge: boolean; - /** - * @description Whether to allow Auto-merge to be used on pull requests. - * @default false - * @example false - */ - readonly allow_auto_merge: boolean; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - * @example false - */ - readonly delete_branch_on_merge: boolean; - /** - * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. - * @default false - * @example false - */ - readonly allow_update_branch: boolean; - /** - * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; + readonly node_id: string; + readonly number: number; /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} + * 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 squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + 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?: ("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; + } | 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; + }; + /** 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 The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + 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; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} + * Format: uri + * @description URL for the issue */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - * @example true - */ - readonly allow_merge_commit: boolean; - /** @description Whether to allow forking this repo */ - readonly allow_forking?: boolean; - /** - * @description Whether to require contributors to sign off on web-based commits - * @default false - */ - readonly web_commit_signoff_required: boolean; - readonly subscribers_count?: number; - readonly network_count?: number; - readonly open_issues: number; - readonly watchers: number; - readonly master_branch?: string; - /** @example "2020-07-09T00:17:42Z" */ - readonly starred_at?: string; - /** @description Whether anonymous git access is enabled for this repository */ - readonly anonymous_access_enabled?: boolean; - } | null; - /** - * Personal Access Token Request - * @description Details of a Personal Access Token Request. - */ - readonly "personal-access-token-request": { - /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */ - readonly id: number; - readonly owner: components["schemas"]["simple-user"]; - /** @description New requested permissions, categorized by type of permission. */ - readonly permissions_added: { - readonly organization?: { - readonly [key: string]: string | undefined; - }; - readonly repository?: { - readonly [key: string]: string | undefined; - }; - readonly other?: { - readonly [key: string]: string | undefined; - }; - }; - /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ - readonly permissions_upgraded: { - readonly organization?: { - readonly [key: string]: string | undefined; - }; - readonly repository?: { - readonly [key: string]: string | undefined; - }; - readonly other?: { - readonly [key: string]: string | undefined; - }; - }; - /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ - readonly permissions_result: { - readonly organization?: { - readonly [key: string]: string | undefined; - }; - readonly repository?: { - readonly [key: string]: string | undefined; - }; - readonly other?: { - readonly [key: string]: string | undefined; - }; - }; - /** - * @description Type of repository selection requested. - * @enum {string} - */ - readonly repository_selection: "none" | "all" | "subset"; - /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ - readonly repository_count: number | null; - /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ - readonly repositories: { - readonly full_name: string; - /** @description Unique identifier of the repository */ + 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; readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[] | null; - /** @description Date and time when the request for access was created. */ - readonly created_at: string; - /** @description Whether the associated fine-grained personal access token has expired. */ - readonly token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ - readonly token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ - readonly token_last_used_at: string | null; + 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; + } | null; }; /** - * Projects v2 Project - * @description A projects v2 project + * Milestone + * @description A collection of related issues and pull requests. */ - readonly "projects-v2": { - readonly id: number; - readonly node_id: string; - readonly owner: components["schemas"]["simple-user"]; - readonly creator: components["schemas"]["simple-user"]; - readonly title: string; - readonly description: string | null; - readonly public: boolean; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ + readonly webhooks_milestone: { + /** Format: date-time */ readonly closed_at: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ + readonly closed_issues: number; + /** Format: date-time */ readonly created_at: string; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly updated_at: string; - readonly number: number; - readonly short_description: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly deleted_at: string | null; - readonly deleted_by: components["schemas"]["nullable-simple-user"]; - }; - /** - * Projects v2 Item Content Type - * @description The type of content tracked in a project item - * @enum {string} - */ - readonly "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; - /** - * Projects v2 Item - * @description An item belonging to a project - */ - readonly "projects-v2-item": { + /** 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; + } | null; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; + /** Format: uri */ + readonly html_url: string; readonly id: number; - readonly node_id?: string; - readonly project_node_id?: string; - readonly content_node_id: string; - readonly content_type: components["schemas"]["projects-v2-item-content-type"]; - readonly creator?: components["schemas"]["simple-user"]; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly created_at: string; + /** Format: uri */ + readonly labels_url: string; + readonly node_id: string; + /** @description The number of the milestone. */ + readonly number: number; + readonly open_issues: number; /** - * Format: date-time - * @example 2022-04-28T12:00:00Z + * @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: date-time - * @example 2022-04-28T12:00:00Z - */ - readonly archived_at: string | null; + /** Format: uri */ + readonly url: string; }; /** - * @description The reason for resolving the alert. - * @enum {string|null} + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited"; - readonly "secret-scanning-alert-webhook": { - readonly number?: components["schemas"]["alert-number"]; - readonly created_at?: components["schemas"]["alert-created-at"]; - readonly updated_at?: components["schemas"]["nullable-alert-updated-at"]; - readonly url?: components["schemas"]["alert-url"]; - readonly html_url?: components["schemas"]["alert-html-url"]; - /** - * Format: uri - * @description The REST API URL of the code locations for this alert. - */ - readonly locations_url?: string; - readonly resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; - /** - * Format: date-time - * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly resolved_at?: string | null; - readonly resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ - readonly resolution_comment?: string | null; - /** @description The type of secret that secret scanning detected. */ - readonly secret_type?: string; - /** @description Whether push protection was bypassed for the detected secret. */ - readonly push_protection_bypassed?: boolean | null; - readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; - /** - * Format: date-time - * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly push_protection_bypassed_at?: string | null; - }; - /** branch protection configuration disabled event */ - readonly "webhook-branch-protection-configuration-disabled": { - /** @enum {string} */ - readonly action: "disabled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection configuration enabled event */ - readonly "webhook-branch-protection-configuration-enabled": { - /** @enum {string} */ - readonly action: "enabled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection rule created event */ - readonly "webhook-branch-protection-rule-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - readonly rule: { - readonly admin_enforced: boolean; - /** @enum {string} */ - readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - readonly authorized_actor_names: string[]; - readonly authorized_actors_only: boolean; - readonly authorized_dismissal_actors_only: boolean; - readonly create_protected?: boolean; - /** Format: date-time */ - readonly created_at: string; - readonly dismiss_stale_reviews_on_push: boolean; + readonly webhooks_issue_2: { + /** @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 ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - readonly name: string; - /** @enum {string} */ - readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; - readonly repository_id: number; - readonly require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - readonly require_last_push_approval?: boolean; - readonly required_approving_review_count: number; - /** @enum {string} */ - readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; - readonly required_status_checks: string[]; + 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 required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + readonly assignees: ({ + /** 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 signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - readonly strict_required_status_checks_policy: boolean; - /** Format: date-time */ - readonly updated_at: string; - }; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection rule deleted event */ - readonly "webhook-branch-protection-rule-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null)[]; /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} */ - readonly rule: { - readonly admin_enforced: boolean; - /** @enum {string} */ - readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - readonly authorized_actor_names: string[]; - readonly authorized_actors_only: boolean; - readonly authorized_dismissal_actors_only: boolean; - readonly create_protected?: boolean; - /** Format: date-time */ - readonly created_at: string; - readonly dismiss_stale_reviews_on_push: boolean; + 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?: { + /** @description 6-character hex code, without the leading #, identifying the color */ + readonly color: string; + readonly default: boolean; + readonly description: string | null; readonly id: number; - readonly ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + /** @description The name of the label. */ readonly name: string; - /** @enum {string} */ - readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; - readonly repository_id: number; - readonly require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - readonly require_last_push_approval?: boolean; - readonly required_approving_review_count: number; - /** @enum {string} */ - readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; - readonly required_status_checks: string[]; - /** @enum {string} */ - readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - readonly strict_required_status_checks_policy: boolean; - /** Format: date-time */ - readonly updated_at: string; - }; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection rule edited event */ - readonly "webhook-branch-protection-rule-edited": { - /** @enum {string} */ - readonly action: "edited"; - /** @description If the action was `edited`, the changes to the rule. */ - readonly changes?: { - readonly admin_enforced?: { - readonly from: boolean | null; - }; - readonly authorized_actor_names?: { - readonly from: string[]; - }; - readonly authorized_actors_only?: { - readonly from: boolean | null; - }; - readonly authorized_dismissal_actors_only?: { - readonly from: boolean | null; - }; - readonly linear_history_requirement_enforcement_level?: { - /** @enum {string} */ - readonly from: "off" | "non_admins" | "everyone"; - }; - readonly required_status_checks?: { - readonly from: string[]; - }; - readonly required_status_checks_enforcement_level?: { - /** @enum {string} */ - readonly from: "off" | "non_admins" | "everyone"; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; + readonly node_id: string; + /** + * Format: uri + * @description URL for the label + */ + readonly url: string; + }[]; + /** Format: uri-template */ + readonly labels_url: string; + readonly locked?: boolean; /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + * Milestone + * @description A collection of related issues and pull requests. */ - readonly rule: { - readonly admin_enforced: boolean; - /** @enum {string} */ - readonly allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - readonly authorized_actor_names: string[]; - readonly authorized_actors_only: boolean; - readonly authorized_dismissal_actors_only: boolean; - readonly create_protected?: boolean; + readonly milestone: { + /** Format: date-time */ + readonly closed_at: string | null; + readonly closed_issues: number; /** Format: date-time */ readonly created_at: string; - readonly dismiss_stale_reviews_on_push: boolean; - readonly id: number; - readonly ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - readonly linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - readonly name: string; - /** @enum {string} */ - readonly pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; - readonly repository_id: number; - readonly require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - readonly require_last_push_approval?: boolean; - readonly required_approving_review_count: number; - /** @enum {string} */ - readonly required_conversation_resolution_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; - readonly required_status_checks: string[]; - /** @enum {string} */ - readonly required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - readonly signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - readonly strict_required_status_checks_policy: boolean; + /** 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"; + /** Format: uri */ + readonly url?: 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?: ("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 */ + 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; + } | 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"; + /** @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; }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + /** 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} + */ + 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; + 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; }; - /** Check Run Completed Event */ - readonly "webhook-check-run-completed": { + /** User */ + readonly webhooks_user_mannequin: { + /** 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 action?: "completed"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** - * Check Run Completed Event - * @description The check_run.completed webhook encoded with URL encoding - */ - readonly "webhook-check-run-completed-form-encoded": { - /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + readonly url?: string; + } | null; + /** Marketplace Purchase */ + readonly webhooks_marketplace_purchase: { + readonly account: { + readonly id: number; + readonly login: string; + readonly node_id: string; + readonly organization_billing_email: string | null; + readonly type: string; + }; + readonly billing_cycle: string; + readonly free_trial_ends_on: string | null; + readonly next_billing_date: string | null; + readonly on_free_trial: boolean; + readonly plan: { + readonly bullets: (string | null)[]; + readonly description: string; + readonly has_free_trial: boolean; + readonly id: number; + readonly monthly_price_in_cents: number; + readonly name: string; + /** @enum {string} */ + readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + readonly unit_name: string | null; + readonly yearly_price_in_cents: number; + }; + readonly unit_count: number; }; - /** Check Run Created Event */ - readonly "webhook-check-run-created": { - /** @enum {string} */ - readonly action?: "created"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + /** Marketplace Purchase */ + readonly webhooks_previous_marketplace_purchase: { + readonly account: { + readonly id: number; + readonly login: string; + readonly node_id: string; + readonly organization_billing_email: string | null; + readonly type: string; + }; + readonly billing_cycle: string; + readonly free_trial_ends_on: unknown; + readonly next_billing_date?: string | null; + readonly on_free_trial: boolean; + readonly plan: { + readonly bullets: string[]; + readonly description: string; + readonly has_free_trial: boolean; + readonly id: number; + readonly monthly_price_in_cents: number; + readonly name: string; + /** @enum {string} */ + readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + readonly unit_name: string | null; + readonly yearly_price_in_cents: number; + }; + readonly unit_count: number; }; /** - * Check Run Created Event - * @description The check_run.created webhook encoded with URL encoding + * Team + * @description Groups of organization members that gives permissions on specified repositories. */ - readonly "webhook-check-run-created-form-encoded": { - /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; - }; - /** Check Run Requested Action Event */ - readonly "webhook-check-run-requested-action": { + readonly webhooks_team: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** + * @description Whether team members will receive notifications when their team is @mentioned + * @enum {string} + */ + readonly notification_setting: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; /** @enum {string} */ - readonly action: "requested_action"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - /** @description The action requested by the user. */ - readonly requested_action?: { - /** @description The integrator reference of the action requested by the user. */ - readonly identifier?: string; - }; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly privacy?: "open" | "closed" | "secret"; + /** @enum {string} */ + readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; }; /** - * Check Run Requested Action Event - * @description The check_run.requested_action webhook encoded with URL encoding + * Merge Group + * @description A group of pull requests that the merge queue has grouped together to be merged. + * */ - readonly "webhook-check-run-requested-action-form-encoded": { - /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; - }; - /** Check Run Re-Requested Event */ - readonly "webhook-check-run-rerequested": { - /** @enum {string} */ - readonly action?: "rerequested"; - readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly "merge-group": { + /** @description The SHA of the merge group. */ + readonly head_sha: string; + /** @description The full ref of the merge group. */ + readonly head_ref: string; + /** @description The SHA of the merge group's parent commit. */ + readonly base_sha: string; + /** @description The full ref of the branch the merge group will be merged into. */ + readonly base_ref: string; + readonly head_commit: components["schemas"]["simple-commit"]; }; /** - * Check Run Re-Requested Event - * @description The check_run.rerequested webhook encoded with URL encoding + * Repository + * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property + * when the event occurs from activity in a repository. */ - readonly "webhook-check-run-rerequested-form-encoded": { - /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; - }; - /** check_suite completed event */ - readonly "webhook-check-suite-completed": { - /** @enum {string} */ - readonly action: "completed"; - /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - readonly check_suite: { - readonly after: string | null; - /** - * 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 app: { - /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; - /** @description The list of events for the GitHub app */ - readonly 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" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; - /** 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; - } | 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; - }; - readonly before: string | null; - /** Format: uri */ - readonly check_runs_url: string; - /** - * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. - * @enum {string|null} - */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ - readonly created_at: string; - /** @description The head branch name the changes are on. */ - readonly head_branch: string | null; - /** SimpleCommit */ - readonly head_commit: { - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly author: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly committer: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; - }; - /** @description The SHA of the head commit that is being checked. */ - readonly head_sha: string; - readonly id: number; - readonly latest_check_runs_count: number; - readonly node_id: string; - /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; - /** - * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - * @enum {string|null} - */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; - /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL that points to the check suite API resource. - */ - readonly url: string; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** check_suite requested event */ - readonly "webhook-check-suite-requested": { - /** @enum {string} */ - readonly action: "requested"; - /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - readonly check_suite: { - readonly after: string | null; - /** - * 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 app: { - /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; - /** @description The list of events for the GitHub app */ - readonly 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" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; - /** 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; - } | 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; - }; - readonly before: string | null; - /** Format: uri */ - readonly check_runs_url: string; - /** - * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. - * @enum {string|null} - */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; - /** Format: date-time */ - readonly created_at: string; - /** @description The head branch name the changes are on. */ - readonly head_branch: string | null; - /** SimpleCommit */ - readonly head_commit: { - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly author: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly committer: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; - }; - /** @description The SHA of the head commit that is being checked. */ - readonly head_sha: string; - readonly id: number; - readonly latest_check_runs_count: number; - readonly node_id: string; - /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; - /** - * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - * @enum {string|null} - */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL that points to the check suite API resource. - */ - readonly url: string; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** check_suite rerequested event */ - readonly "webhook-check-suite-rerequested": { - /** @enum {string} */ - readonly action: "rerequested"; - /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - readonly check_suite: { - readonly after: string | null; - /** - * 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 app: { - /** Format: date-time */ - readonly created_at: string | null; - readonly description: string | null; - /** @description The list of events for the GitHub app */ - readonly 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" | "merge_queue_entry" | "workflow_job")[]; - /** 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; - } | 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; - }; - readonly before: string | null; - /** Format: uri */ - readonly check_runs_url: string; - /** - * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. - * @enum {string|null} - */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - readonly created_at: string; - /** @description The head branch name the changes are on. */ - readonly head_branch: string | null; - /** SimpleCommit */ - readonly head_commit: { - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly author: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly committer: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - readonly id: string; - readonly message: string; - readonly timestamp: string; - readonly tree_id: string; - }; - /** @description The SHA of the head commit that is being checked. */ - readonly head_sha: string; - readonly id: number; - readonly latest_check_runs_count: number; - readonly node_id: string; - /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly rerequestable?: boolean; - readonly runs_rerequestable?: boolean; - /** - * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - * @enum {string|null} - */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL that points to the check suite API resource. - */ - readonly url: string; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert appeared_in_branch event */ - readonly "webhook-code-scanning-alert-appeared-in-branch": { - /** @enum {string} */ - readonly action: "appeared_in_branch"; - /** @description The code scanning alert involved in the event. */ - readonly alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - readonly created_at: string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly dismissed_at: string | null; - /** User */ - readonly dismissed_by: { - /** 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; - /** - * @description The reason for dismissing or closing the alert. - * @enum {string|null} - */ - readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly html_url: string; - /** Alert Instance */ - readonly most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: string[]; - readonly commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; - }; - readonly message?: { - readonly text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { - /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - readonly severity: "none" | "note" | "warning" | "error" | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - readonly tool: { - /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; - /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; - }; - /** Format: uri */ - readonly url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly commit_oid: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly ref: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert closed_by_user event */ - readonly "webhook-code-scanning-alert-closed-by-user": { - /** @enum {string} */ - readonly action: "closed_by_user"; - /** @description The code scanning alert involved in the event. */ - readonly alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - readonly created_at: string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly dismissed_at: string; - /** User */ - readonly dismissed_by: { - /** 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; - /** - * @description The reason for dismissing or closing the alert. - * @enum {string|null} - */ - readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly html_url: string; - /** Alert Instance */ - readonly most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: string[]; - readonly commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; - }; - readonly message?: { - readonly text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { - /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "dismissed" | "fixed"; - readonly tool: { - readonly guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; - /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; - }; - /** Format: uri */ - readonly url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly commit_oid: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly ref: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert created event */ - readonly "webhook-code-scanning-alert-created": { - /** @enum {string} */ - readonly action: "created"; - /** @description The code scanning alert involved in the event. */ - readonly alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - readonly created_at: string | null; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: unknown; - readonly dismissed_by: unknown; - readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - readonly dismissed_reason: unknown; - readonly fixed_at?: unknown; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly html_url: string; - readonly instances_url?: string; - /** Alert Instance */ - readonly most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: string[]; - readonly commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; - }; - readonly message?: { - readonly text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { - /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed"; - readonly tool: { - readonly guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; - /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; - } | null; - readonly updated_at?: string | null; - /** Format: uri */ - readonly url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly commit_oid: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly ref: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert fixed event */ - readonly "webhook-code-scanning-alert-fixed": { - /** @enum {string} */ - readonly action: "fixed"; - /** @description The code scanning alert involved in the event. */ - readonly alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - readonly created_at: string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - readonly dismissed_at: string | null; - /** User */ - readonly dismissed_by: { - /** 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; - /** - * @description The reason for dismissing or closing the alert. - * @enum {string|null} - */ - readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly html_url: string; - /** Format: uri */ - readonly instances_url?: string; - /** Alert Instance */ - readonly most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: string[]; - readonly commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; - }; - readonly message?: { - readonly text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { - /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "fixed"; - readonly tool: { - readonly guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; - /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; - }; - /** Format: uri */ - readonly url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly commit_oid: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly ref: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert reopened event */ - readonly "webhook-code-scanning-alert-reopened": { - /** @enum {string} */ - readonly action: "reopened"; - /** @description The code scanning alert involved in the event. */ - readonly alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - readonly created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: string | null; - readonly dismissed_by: Record; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - readonly dismissed_reason: string | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly html_url: string; - /** Alert Instance */ - readonly most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: string[]; - readonly commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; - }; - readonly message?: { - readonly text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { - /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - readonly full_description?: string; - readonly help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - readonly help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - readonly name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - readonly severity: "none" | "note" | "warning" | "error" | null; - readonly tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - readonly tool: { - readonly guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; - /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; - }; - /** Format: uri */ - readonly url: string; - } | null; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly commit_oid: string | null; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly ref: string | null; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert reopened_by_user event */ - readonly "webhook-code-scanning-alert-reopened-by-user": { - /** @enum {string} */ - readonly action: "reopened_by_user"; - /** @description The code scanning alert involved in the event. */ - readonly alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - readonly created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - readonly dismissed_at: unknown; - readonly dismissed_by: unknown; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - readonly dismissed_reason: unknown; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - readonly html_url: string; - /** Alert Instance */ - readonly most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - readonly analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - readonly category?: string; - readonly classifications?: string[]; - readonly commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - readonly environment: string; - readonly location?: { - readonly end_column?: number; - readonly end_line?: number; - readonly path?: string; - readonly start_column?: number; - readonly start_line?: number; - }; - readonly message?: { - readonly text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - readonly ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - readonly number: number; - readonly rule: { - /** @description A short description of the rule used to detect the alert. */ - readonly description: string; - /** @description A unique identifier for the rule used to detect the alert. */ - readonly id: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - readonly severity: "none" | "note" | "warning" | "error" | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - readonly state: "open" | "fixed"; - readonly tool: { - /** @description The name of the tool used to generate the code scanning analysis alert. */ - readonly name: string; - /** @description The version of the tool used to detect the alert. */ - readonly version: string | null; - }; - /** Format: uri */ - readonly url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly commit_oid: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - readonly ref: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** commit_comment created event */ - readonly "webhook-commit-comment-created": { - /** - * @description The action performed. Can be `created`. - * @enum {string} - */ - readonly action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ - readonly comment: { - /** - * 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 The text of the comment. */ - readonly body: string; - /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; - readonly created_at: string; - /** Format: uri */ - readonly html_url: string; - /** @description The ID of the commit comment. */ - readonly id: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; - /** @description The node ID of the commit comment. */ - readonly node_id: string; - /** @description The relative path of the file to which the comment applies. */ - readonly path: string | null; - /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; - /** 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; - }; - readonly updated_at: string; - /** Format: uri */ - 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; - 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 enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** create event */ - readonly "webhook-create": { - /** @description The repository's current description. */ - readonly description: string | null; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The name of the repository's default branch (usually `main`). */ - readonly master_branch: string; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The pusher type for the event. Can be either `user` or a deploy key. */ - readonly pusher_type: string; - /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ - readonly ref: string; - /** - * @description The type of Git ref object created in the repository. - * @enum {string} - */ - readonly ref_type: "tag" | "branch"; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** custom property created event */ - readonly "webhook-custom-property-created": { - /** @enum {string} */ - readonly action: "created"; - readonly definition: components["schemas"]["org-custom-property"]; - 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-webhooks"]; - }; - /** custom property deleted event */ - readonly "webhook-custom-property-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly definition: { - /** @description The name of the property that was deleted. */ - readonly property_name: string; - }; - 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-webhooks"]; - }; - /** custom property updated event */ - readonly "webhook-custom-property-updated": { - /** @enum {string} */ - readonly action: "updated"; - readonly definition: components["schemas"]["org-custom-property"]; - 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-webhooks"]; - }; - /** Custom property values updated event */ - readonly "webhook-custom-property-values-updated": { - /** @enum {string} */ - readonly action: "updated"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - /** @description The new custom property values for the repository. */ - readonly new_property_values: components["schemas"]["custom-property-value"][]; - /** @description The old custom property values for the repository. */ - readonly old_property_values: components["schemas"]["custom-property-value"][]; - }; - /** delete event */ - readonly "webhook-delete": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The pusher type for the event. Can be either `user` or a deploy key. */ - readonly pusher_type: string; - /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ - readonly ref: string; - /** - * @description The type of Git ref object deleted in the repository. - * @enum {string} - */ - readonly ref_type: "tag" | "branch"; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert auto-dismissed event */ - readonly "webhook-dependabot-alert-auto-dismissed": { - /** @enum {string} */ - readonly action: "auto_dismissed"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert auto-reopened event */ - readonly "webhook-dependabot-alert-auto-reopened": { - /** @enum {string} */ - readonly action: "auto_reopened"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert created event */ - readonly "webhook-dependabot-alert-created": { - /** @enum {string} */ - readonly action: "created"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert dismissed event */ - readonly "webhook-dependabot-alert-dismissed": { - /** @enum {string} */ - readonly action: "dismissed"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert fixed event */ - readonly "webhook-dependabot-alert-fixed": { - /** @enum {string} */ - readonly action: "fixed"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert reintroduced event */ - readonly "webhook-dependabot-alert-reintroduced": { - /** @enum {string} */ - readonly action: "reintroduced"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert reopened event */ - readonly "webhook-dependabot-alert-reopened": { - /** @enum {string} */ - readonly action: "reopened"; - readonly alert: components["schemas"]["dependabot-alert"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** deploy_key created event */ - readonly "webhook-deploy-key-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ - readonly key: { - readonly added_by?: string | null; - readonly created_at: string; - readonly id: number; - readonly key: string; - readonly last_used?: string | null; - readonly read_only: boolean; - readonly title: string; - /** Format: uri */ - readonly url: string; - readonly verified: boolean; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** deploy_key deleted event */ - readonly "webhook-deploy-key-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ - readonly key: { - readonly added_by?: string | null; - readonly created_at: string; - readonly id: number; - readonly key: string; - readonly last_used?: string | null; - readonly read_only: boolean; - readonly title: string; - /** Format: uri */ - readonly url: string; - readonly verified: boolean; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** deployment created event */ - readonly "webhook-deployment-created": { - /** @enum {string} */ - readonly action: "created"; - /** - * Deployment - * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). - */ - readonly deployment: { - 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"; - /** Format: uri */ - readonly url?: string; - } | null; - readonly description: string | null; - readonly environment: string; - readonly id: number; - readonly node_id: string; - readonly original_environment: string; - readonly payload: Record | string; - /** - * 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?: ("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" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; - /** 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; - } | 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"; - /** @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 production_environment?: boolean; - readonly ref: string; - /** Format: uri */ - readonly repository_url: string; - readonly sha: string; - /** Format: uri */ - readonly statuses_url: string; - readonly task: string; - readonly transient_environment?: boolean; - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - readonly workflow: { - /** Format: uri */ - readonly badge_url: string; - /** Format: date-time */ - readonly created_at: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly state: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - } | null; - /** Deployment Workflow Run */ - readonly workflow_run: { - /** User */ - readonly actor: { - /** 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 artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; - /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - readonly created_at: string; - readonly display_title: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: unknown; - readonly head_repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: unknown; - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly referenced_workflows?: { - readonly path: string; - readonly ref?: string; - readonly sha: string; - }[] | null; - readonly repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; - /** Format: date-time */ - readonly run_started_at: string; - /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ - readonly triggering_actor?: { - /** 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; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; - } | null; - }; - /** deployment protection rule requested event */ - readonly "webhook-deployment-protection-rule-requested": { - /** @enum {string} */ - readonly action?: "requested"; - /** @description The name of the environment that has the deployment protection rule. */ - readonly environment?: string; - /** @description The event that triggered the deployment protection rule. */ - readonly event?: string; - /** - * Format: uri - * @description The URL to review the deployment protection rule. - */ - readonly deployment_callback_url?: string; - readonly deployment?: components["schemas"]["deployment"]; - readonly pull_requests?: components["schemas"]["pull-request"][]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - readonly "webhook-deployment-review-approved": { - /** @enum {string} */ - readonly action: "approved"; - readonly approver?: { - 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; - 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 comment?: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly reviewers?: { - /** User */ - readonly reviewer?: { - /** 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; - /** @enum {string} */ - readonly type?: "User"; - }[]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly since: string; - readonly workflow_job_run?: { - readonly conclusion: unknown; - readonly created_at: string; - readonly environment: string; - readonly html_url: string; - readonly id: number; - readonly name: unknown; - readonly status: string; - readonly updated_at: string; - }; - readonly workflow_job_runs?: { - readonly conclusion?: unknown; - readonly created_at?: string; - readonly environment?: string; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly status?: string; - readonly updated_at?: string; - }[]; - /** Deployment Workflow Run */ - readonly workflow_run: { - /** User */ - readonly actor: { - /** 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 artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; - /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - readonly created_at: string; - readonly display_title: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: Record; - readonly head_repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly referenced_workflows?: { - readonly path: string; - readonly ref?: string; - readonly sha: string; - }[] | null; - readonly repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; - /** Format: date-time */ - readonly run_started_at: string; - /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ - readonly triggering_actor: { - /** 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; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; - } | null; - }; - readonly "webhook-deployment-review-rejected": { - /** @enum {string} */ - readonly action: "rejected"; - readonly approver?: { - 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; - 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 comment?: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly reviewers?: { - /** User */ - readonly reviewer?: { - /** 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; - /** @enum {string} */ - readonly type?: "User"; - }[]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly since: string; - readonly workflow_job_run?: { - readonly conclusion: unknown; - readonly created_at: string; - readonly environment: string; - readonly html_url: string; - readonly id: number; - readonly name: unknown; - readonly status: string; - readonly updated_at: string; - }; - readonly workflow_job_runs?: { - readonly conclusion?: string | null; - readonly created_at?: string; - readonly environment?: string; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly status?: string; - readonly updated_at?: string; - }[]; - /** Deployment Workflow Run */ - readonly workflow_run: { - /** User */ - readonly actor: { - /** 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 artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; - /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - readonly created_at: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: Record; - readonly head_repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly referenced_workflows?: { - readonly path: string; - readonly ref?: string; - readonly sha: string; - }[] | null; - readonly repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; - /** Format: date-time */ - readonly run_started_at: string; - /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; - /** User */ - readonly triggering_actor: { - /** 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; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; - readonly display_title: string; - } | null; - }; - readonly "webhook-deployment-review-requested": { - /** @enum {string} */ - readonly action: "requested"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly environment: string; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - /** User */ - readonly requestor: { - /** 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 reviewers: { - /** User */ - readonly reviewer?: { - /** 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; - /** @enum {string} */ - readonly type?: "User" | "Team"; - }[]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly since: string; - readonly workflow_job_run: { - readonly conclusion: unknown; - readonly created_at: string; - readonly environment: string; - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly status: string; - readonly updated_at: string; - }; - /** Deployment Workflow Run */ - readonly workflow_run: { - /** User */ - readonly actor: { - /** 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 artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; - /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - readonly created_at: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: Record; - readonly head_repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly referenced_workflows?: { - readonly path: string; - readonly ref?: string; - readonly sha: string; - }[] | null; - readonly repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; - /** Format: date-time */ - readonly run_started_at: string; - /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ - readonly triggering_actor: { - /** 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; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; - readonly display_title: string; - } | null; - }; - /** deployment_status created event */ - readonly "webhook-deployment-status-created": { - /** @enum {string} */ - readonly action: "created"; - readonly check_run?: { - /** Format: date-time */ - readonly completed_at: string | null; - /** - * @description The result of the completed check run. This value will be `null` until the check run has completed. - * @enum {string|null} - */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; - /** Format: uri */ - readonly details_url: string; - readonly external_id: string; - /** @description The SHA of the commit that is being checked. */ - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - /** @description The id of the check. */ - readonly id: number; - /** @description The name of the check run. */ - readonly name: string; - readonly node_id: string; - /** Format: date-time */ - readonly started_at: string; - /** - * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. - * @enum {string} - */ - readonly status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; - /** Format: uri */ - readonly url: string; - } | null; - /** - * Deployment - * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). - */ - readonly deployment: { - 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"; - /** Format: uri */ - readonly url?: string; - } | null; - readonly description: string | null; - readonly environment: string; - readonly id: number; - readonly node_id: string; - readonly original_environment: string; - readonly payload: (string | Record) | null; - /** - * 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?: ("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" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; - /** 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; - } | 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"; - /** @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 production_environment?: boolean; - readonly ref: string; - /** Format: uri */ - readonly repository_url: string; - readonly sha: string; - /** Format: uri */ - readonly statuses_url: string; - readonly task: string; - readonly transient_environment?: boolean; - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ - readonly deployment_status: { - 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"; - /** Format: uri */ - readonly url?: string; - } | null; - /** Format: uri */ - readonly deployment_url: string; - /** @description The optional human-readable description added to the status. */ - readonly description: string; - readonly environment: string; - /** Format: uri */ - readonly environment_url?: string; - readonly id: number; - /** Format: uri */ - readonly log_url?: string; - readonly node_id: string; - /** - * 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?: ("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" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; - /** 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; - } | 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"; - /** @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; - /** Format: uri */ - readonly repository_url: string; - /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ - readonly state: string; - /** @description The optional link added to the status. */ - readonly target_url: string; - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - readonly workflow?: { - /** Format: uri */ - readonly badge_url: string; - /** Format: date-time */ - readonly created_at: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly state: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - } | null; - /** Deployment Workflow Run */ - readonly workflow_run?: { - /** User */ - readonly actor: { - /** 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 artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id: number; - readonly check_suite_node_id: string; - readonly check_suite_url?: string; - /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; - /** Format: date-time */ - readonly created_at: string; - readonly display_title: string; - readonly event: string; - readonly head_branch: string; - readonly head_commit?: unknown; - readonly head_repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly previous_attempt_url?: unknown; - readonly pull_requests: { - readonly base: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly head: { - readonly ref: string; - /** Repo Ref */ - readonly repo: { - readonly id: number; - readonly name: string; - /** Format: uri */ - readonly url: string; - }; - readonly sha: string; - }; - readonly id: number; - readonly number: number; - /** Format: uri */ - readonly url: string; - }[]; - readonly referenced_workflows?: { - readonly path: string; - readonly ref?: string; - readonly sha: string; - }[] | null; - readonly repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: unknown; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt: number; - readonly run_number: number; - /** Format: date-time */ - readonly run_started_at: string; - /** @enum {string} */ - readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ - readonly triggering_actor: { - /** 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; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - readonly workflow_id: number; - readonly workflow_url?: string; - } | null; - }; - /** discussion answered event */ - readonly "webhook-discussion-answered": { - /** @enum {string} */ - readonly action: "answered"; - readonly answer: { - /** - * 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"; - readonly body: string; - readonly child_comment_count: number; - /** Format: date-time */ - readonly created_at: string; - readonly discussion_id: number; - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly parent_id: unknown; - /** 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; - }; - readonly repository_url: string; - /** Format: date-time */ - readonly updated_at: 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; - 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 discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion category changed event */ - readonly "webhook-discussion-category-changed": { - /** @enum {string} */ - readonly action: "category_changed"; - readonly changes: { - readonly category: { - readonly from: { - /** Format: date-time */ - readonly created_at: string; - readonly description: string; - readonly emoji: string; - readonly id: number; - readonly is_answerable: boolean; - readonly name: string; - readonly node_id?: string; - readonly repository_id: number; - readonly slug: string; - readonly updated_at: string; - }; - }; - }; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion closed event */ - readonly "webhook-discussion-closed": { - /** @enum {string} */ - readonly action: "closed"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion_comment created event */ - readonly "webhook-discussion-comment-created": { - /** @enum {string} */ - readonly action: "created"; - readonly comment: { - /** - * 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"; - readonly body: string; - readonly child_comment_count: number; - readonly created_at: string; - readonly discussion_id: number; - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly parent_id: number | null; - /** 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; - }; - readonly repository_url: string; - readonly updated_at: 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; - 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 discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion_comment deleted event */ - readonly "webhook-discussion-comment-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly comment: { - /** - * 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"; - readonly body: string; - readonly child_comment_count: number; - readonly created_at: string; - readonly discussion_id: number; - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly parent_id: number | null; - /** 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; - }; - readonly repository_url: string; - readonly updated_at: 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; - 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 discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion_comment edited event */ - readonly "webhook-discussion-comment-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly body: { - readonly from: string; - }; - }; - readonly comment: { - /** - * 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"; - readonly body: string; - readonly child_comment_count: number; - readonly created_at: string; - readonly discussion_id: number; - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly parent_id: number | null; - /** 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; - }; - readonly repository_url: string; - readonly updated_at: 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; - 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 discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion created event */ - readonly "webhook-discussion-created": { - /** @enum {string} */ - readonly action: "created"; - readonly discussion: { - readonly active_lock_reason: string | null; - readonly answer_chosen_at: string | null; - /** User */ - readonly answer_chosen_by: { - /** 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 answer_html_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"; - readonly body: string | null; - readonly category: { - /** Format: date-time */ - readonly created_at: string; - readonly description: string; - readonly emoji: string; - readonly id: number; - readonly is_answerable: boolean; - readonly name: string; - readonly node_id?: string; - readonly repository_id: number; - readonly slug: string; - readonly updated_at: string; - }; - readonly comments: number; - /** Format: date-time */ - readonly created_at: string; - readonly html_url: string; - readonly id: number; - readonly locked: boolean; - readonly node_id: string; - readonly number: 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; - }; - readonly repository_url: string; - /** @enum {string} */ - readonly state: "open" | "locked" | "converting" | "transferring"; - readonly timeline_url?: string; - readonly title: string; - /** Format: date-time */ - readonly updated_at: 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; - 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 active_lock_reason?: unknown; - readonly answer_chosen_at: unknown; - readonly answer_chosen_by: unknown; - readonly answer_html_url: string | null; - readonly author_association?: string; - readonly body?: string | null; - readonly category?: { - readonly created_at?: string; - readonly description?: string; - readonly emoji?: string; - readonly id?: number; - readonly is_answerable?: boolean; - readonly name?: string; - readonly node_id?: string; - readonly repository_id?: number; - readonly slug?: string; - readonly updated_at?: string; - }; - readonly comments?: number; - readonly created_at?: string; - readonly html_url?: string; - readonly id?: number; - /** @enum {boolean} */ - readonly locked: false; - readonly node_id?: string; - readonly number?: number; - 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: "open" | "converting" | "transferring"; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: 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; - 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 enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion deleted event */ - readonly "webhook-discussion-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion edited event */ - readonly "webhook-discussion-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes?: { - readonly body?: { - readonly from: string; - }; - readonly title?: { - readonly from: string; - }; - }; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion labeled event */ - readonly "webhook-discussion-labeled": { - /** @enum {string} */ - readonly action: "labeled"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** Label */ - readonly label: { - /** @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 organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion locked event */ - readonly "webhook-discussion-locked": { - /** @enum {string} */ - readonly action: "locked"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion pinned event */ - readonly "webhook-discussion-pinned": { - /** @enum {string} */ - readonly action: "pinned"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion reopened event */ - readonly "webhook-discussion-reopened": { - /** @enum {string} */ - readonly action: "reopened"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion transferred event */ - readonly "webhook-discussion-transferred": { - /** @enum {string} */ - readonly action: "transferred"; - readonly changes: { - readonly new_discussion: components["schemas"]["discussion"]; - readonly new_repository: components["schemas"]["repository-webhooks"]; - }; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unanswered event */ - readonly "webhook-discussion-unanswered": { - /** @enum {string} */ - readonly action: "unanswered"; - readonly discussion: components["schemas"]["discussion"]; - readonly old_answer: { - /** - * 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"; - readonly body: string; - readonly child_comment_count: number; - /** Format: date-time */ - readonly created_at: string; - readonly discussion_id: number; - readonly html_url: string; - readonly id: number; - readonly node_id: string; - readonly parent_id: unknown; - /** 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; - }; - readonly repository_url: string; - /** Format: date-time */ - readonly updated_at: 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; - 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 organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unlabeled event */ - readonly "webhook-discussion-unlabeled": { - /** @enum {string} */ - readonly action: "unlabeled"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** Label */ - readonly label: { - /** @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 organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unlocked event */ - readonly "webhook-discussion-unlocked": { - /** @enum {string} */ - readonly action: "unlocked"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unpinned event */ - readonly "webhook-discussion-unpinned": { - /** @enum {string} */ - readonly action: "unpinned"; - readonly discussion: components["schemas"]["discussion"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** - * fork event - * @description A user forks a repository. - */ - readonly "webhook-fork": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */ - readonly forkee: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; - /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: 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; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - } & { - readonly allow_forking?: boolean; - readonly archive_url?: string; - readonly archived?: boolean; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly clone_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly created_at?: string; - readonly default_branch?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly disabled?: boolean; - readonly downloads_url?: string; - readonly events_url?: string; - /** @enum {boolean} */ - readonly fork?: true; - readonly forks?: number; - readonly forks_count?: number; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly git_url?: string; - readonly has_downloads?: boolean; - readonly has_issues?: boolean; - readonly has_pages?: boolean; - readonly has_projects?: boolean; - readonly has_wiki?: boolean; - readonly homepage?: string | null; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly is_template?: boolean; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly language?: unknown; - readonly languages_url?: string; - readonly license?: Record; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly mirror_url?: unknown; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly open_issues?: number; - readonly open_issues_count?: number; - readonly owner?: { - 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; - 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 private?: boolean; - readonly public?: boolean; - readonly pulls_url?: string; - readonly pushed_at?: string; - readonly releases_url?: string; - readonly size?: number; - readonly ssh_url?: string; - readonly stargazers_count?: number; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly svn_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly topics?: unknown[]; - readonly trees_url?: string; - readonly updated_at?: string; - readonly url?: string; - readonly visibility?: string; - readonly watchers?: number; - readonly watchers_count?: number; - }; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** github_app_authorization revoked event */ - readonly "webhook-github-app-authorization-revoked": { - /** @enum {string} */ - readonly action: "revoked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** gollum event */ - readonly "webhook-gollum": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The pages that were updated. */ - readonly pages: { - /** - * @description The action that was performed on the page. Can be `created` or `edited`. - * @enum {string} - */ - readonly action: "created" | "edited"; - /** - * Format: uri - * @description Points to the HTML wiki page. - */ - readonly html_url: string; - /** @description The name of the page. */ - readonly page_name: string; - /** @description The latest commit SHA of the page. */ - readonly sha: string; - readonly summary: string | null; - /** @description The current page title. */ - readonly title: string; - }[]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation created event */ - readonly "webhook-installation-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - readonly repositories?: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - readonly repository?: components["schemas"]["repository-webhooks"]; - /** User */ - readonly requester?: { - /** 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 sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation deleted event */ - readonly "webhook-installation-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - readonly repositories?: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation new_permissions_accepted event */ - readonly "webhook-installation-new-permissions-accepted": { - /** @enum {string} */ - readonly action: "new_permissions_accepted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - readonly repositories?: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation_repositories added event */ - readonly "webhook-installation-repositories-added": { - /** @enum {string} */ - readonly action: "added"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects, which were added to the installation. */ - readonly repositories_added: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - /** @description An array of repository objects, which were removed from the installation. */ - readonly repositories_removed: { - readonly full_name?: string; - /** @description Unique identifier of the repository */ - readonly id?: number; - /** @description The name of the repository. */ - readonly name?: string; - readonly node_id?: string; - /** @description Whether the repository is private or public. */ - readonly private?: boolean; - }[]; - readonly repository?: components["schemas"]["repository-webhooks"]; - /** - * @description Describe whether all repositories have been selected or there's a selection involved - * @enum {string} - */ - readonly repository_selection: "all" | "selected"; - /** User */ - readonly requester: { - /** 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 sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation_repositories removed event */ - readonly "webhook-installation-repositories-removed": { - /** @enum {string} */ - readonly action: "removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects, which were added to the installation. */ - readonly repositories_added: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - /** @description An array of repository objects, which were removed from the installation. */ - readonly repositories_removed: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - readonly repository?: components["schemas"]["repository-webhooks"]; - /** - * @description Describe whether all repositories have been selected or there's a selection involved - * @enum {string} - */ - readonly repository_selection: "all" | "selected"; - /** User */ - readonly requester: { - /** 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 sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation suspend event */ - readonly "webhook-installation-suspend": { - /** @enum {string} */ - readonly action: "suspend"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - readonly repositories?: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - readonly "webhook-installation-target-renamed": { - readonly account: { - readonly archived_at?: string | null; - readonly avatar_url: string; - readonly created_at?: string; - readonly description?: unknown; - readonly events_url?: string; - readonly followers?: number; - readonly followers_url?: string; - readonly following?: number; - readonly following_url?: string; - readonly gists_url?: string; - readonly gravatar_id?: string; - readonly has_organization_projects?: boolean; - readonly has_repository_projects?: boolean; - readonly hooks_url?: string; - readonly html_url: string; - readonly id: number; - readonly is_verified?: boolean; - readonly issues_url?: string; - readonly login?: string; - readonly members_url?: string; - readonly name?: string; - readonly node_id: string; - readonly organizations_url?: string; - readonly public_gists?: number; - readonly public_members_url?: string; - readonly public_repos?: number; - readonly received_events_url?: string; - readonly repos_url?: string; - readonly site_admin?: boolean; - readonly slug?: string; - readonly starred_url?: string; - readonly subscriptions_url?: string; - readonly type?: string; - readonly updated_at?: string; - readonly url?: string; - readonly website_url?: unknown; - }; - /** @enum {string} */ - readonly action: "renamed"; - readonly changes: { - readonly login?: { - readonly from: string; - }; - readonly slug?: { - readonly from: string; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - readonly target_type: string; - }; - /** installation unsuspend event */ - readonly "webhook-installation-unsuspend": { - /** @enum {string} */ - readonly action: "unsuspend"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - readonly repositories?: { - readonly full_name: string; - /** @description Unique identifier of the repository */ - readonly id: number; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - }[]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly requester?: unknown; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issue_comment created event */ - readonly "webhook-issue-comment-created": { - /** @enum {string} */ - readonly action: "created"; - /** - * issue comment - * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. - */ - readonly comment: { - /** - * 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 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; - 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 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; - } | null; - readonly assignees: ({ - /** 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; - } | 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?: { - /** @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; - /** - * 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; - } | 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?: ("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; - } | 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; - 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} - */ - 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; - 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; - } | 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; - } | null; - readonly assignees?: 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: { - /** @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; - 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-webhooks"]; - }; - /** issue_comment deleted event */ - readonly "webhook-issue-comment-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - /** - * issue comment - * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. - */ - readonly comment: { - /** - * 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 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; - 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; - } | 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; - } | null; - readonly assignees: ({ - /** 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; - } | 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?: { - /** @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; - /** - * 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; - } | 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?: ("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 */ - 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; - } | 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"; - /** @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; - }; - /** 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} - */ - 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; - 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; - } | 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; - } | null; - readonly assignees?: 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: { - /** @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; - 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-webhooks"]; - }; - /** issue_comment edited event */ - readonly "webhook-issue-comment-edited": { - /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the comment. */ - readonly changes: { - readonly body?: { - /** @description The previous version of the body. */ - readonly from: string; - }; - }; - /** - * issue comment - * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. - */ - readonly comment: { - /** - * 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 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; - 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; - } | 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; - } | null; - readonly assignees: ({ - /** 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; - } | 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?: { - /** @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; - /** - * 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; - } | 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?: ("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; - } | 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; - }; - /** 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} - */ - 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; - 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; - } | 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; - } | null; - readonly assignees?: 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: { - /** @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; - 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-webhooks"]; - }; - /** issues assigned event */ - readonly "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - readonly action: "assigned"; - /** 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 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" | "Mannequin"; - /** Format: uri */ - readonly url?: string; - } | null; - readonly assignees: ({ - /** 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; - } | 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?: { - /** @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; - /** - * 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; - } | 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?: ("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; - } | 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; - }; - /** 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} - */ - 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; - 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; - } | null; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** 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; - /** 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; - } | null; - readonly assignees: ({ - /** 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; - } | 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?: { - /** @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; - /** - * 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; - } | 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?: ("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 */ - 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; - } | 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; - }; - /** 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} - */ - 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; - 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; - } | null; - } & { - readonly active_lock_reason?: string | null; - readonly assignee?: Record; - readonly assignees?: 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?: 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; - 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-webhooks"]; - }; - /** issues deleted event */ - readonly "webhook-issues-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - 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: ({ - /** 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?: { - /** @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; - /** - * 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"; - /** Format: uri */ - readonly url?: 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?: ("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; - } | 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"; - /** @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; - }; - /** 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} - */ - 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; - 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 organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues demilestoned event */ - readonly "webhook-issues-demilestoned": { - /** @enum {string} */ - readonly action: "demilestoned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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; - } | null; - readonly assignees: ({ - /** 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; - } | 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?: { - /** @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; - /** - * 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; - } | 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?: ("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 */ - 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; - } | 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; - }; - /** 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} - */ - 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; - 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; - } | null; - } & { - readonly active_lock_reason?: string | null; - readonly assignee?: Record; - readonly assignees?: 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?: Record[]; - 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; - } | 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; - 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; - readonly state?: string; - 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; - 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 "nullable-repository-webhooks": { /** - * Milestone - * @description A collection of related issues and pull requests. + * @description Unique identifier of the repository + * @example 42 */ - 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; - } | 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; + readonly id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + readonly node_id: string; + /** + * @description The name of the repository. + * @example Team Environment + */ + readonly name: string; + /** @example octocat/Hello-World */ + readonly full_name: string; + readonly license: components["schemas"]["nullable-license-simple"]; + readonly organization?: components["schemas"]["nullable-simple-user"]; + readonly forks: number; + readonly permissions?: { + readonly admin: boolean; + readonly pull: boolean; + readonly triage?: boolean; + readonly push: boolean; + readonly maintain?: boolean; }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues edited event */ - readonly "webhook-issues-edited": { - /** @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 owner: components["schemas"]["simple-user"]; + /** + * @description Whether the repository is private or public. + * @default false + */ + readonly private: boolean; + /** + * Format: uri + * @example https://github.com/octocat/Hello-World + */ + readonly html_url: string; + /** @example This your first repo! */ + readonly description: string | null; + readonly fork: boolean; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World + */ + readonly url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ + readonly archive_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ + readonly assignees_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ + readonly blobs_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ + readonly branches_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ + readonly collaborators_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ + readonly comments_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ + readonly commits_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ + readonly compare_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ + readonly contents_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/contributors + */ + readonly contributors_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/deployments + */ + readonly deployments_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/downloads + */ + readonly downloads_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/events + */ + readonly events_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/forks + */ + readonly forks_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ + readonly git_commits_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ + readonly git_refs_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ + readonly git_tags_url: string; + /** @example git:github.com/octocat/Hello-World.git */ + readonly git_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ + readonly issue_comment_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ + readonly issue_events_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ + readonly issues_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ + readonly keys_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ + readonly labels_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/languages + */ + readonly languages_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/merges + */ + readonly merges_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ + readonly milestones_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ + readonly notifications_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ + readonly pulls_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ + readonly releases_url: string; + /** @example git@github.com:octocat/Hello-World.git */ + readonly ssh_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/stargazers + */ + readonly stargazers_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ + readonly statuses_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/subscribers + */ + readonly subscribers_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/subscription + */ + readonly subscription_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/tags + */ + readonly tags_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/teams + */ + readonly teams_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ + readonly trees_url: string; + /** @example https://github.com/octocat/Hello-World.git */ + readonly clone_url: string; + /** + * Format: uri + * @example git:git.example.com/octocat/Hello-World + */ + readonly mirror_url: string | null; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/hooks + */ + readonly hooks_url: string; + /** + * Format: uri + * @example https://svn.github.com/octocat/Hello-World + */ + readonly svn_url: string; + /** + * Format: uri + * @example https://github.com + */ + readonly homepage: string | null; + readonly language: string | null; + /** @example 9 */ + readonly forks_count: number; + /** @example 80 */ + readonly stargazers_count: number; + /** @example 80 */ + readonly watchers_count: number; + /** + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + * @example 108 + */ + readonly size: number; + /** + * @description The default branch of the repository. + * @example master + */ + readonly default_branch: string; + /** @example 0 */ + readonly open_issues_count: number; + /** + * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false + * @example true + */ + readonly is_template: boolean; + readonly topics?: string[]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + readonly custom_properties?: { + readonly [key: string]: unknown; }; - 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. + * @description Whether issues are enabled. + * @default true + * @example true */ - readonly issue: { - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ - readonly assignee?: { - /** Format: uri */ + readonly has_issues: boolean; + /** + * @description Whether projects are enabled. + * @default true + * @example true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + * @example true + */ + readonly has_wiki: boolean; + readonly has_pages: boolean; + /** + * @description Whether downloads are enabled. + * @default true + * @example true + */ + readonly has_downloads: boolean; + /** + * @description Whether discussions are enabled. + * @default false + * @example true + */ + readonly has_discussions: boolean; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** @description Returns whether or not this repository disabled. */ + readonly disabled: boolean; + /** + * @description The repository visibility: public, private, or internal. + * @default public + */ + readonly visibility: string; + /** + * Format: date-time + * @example 2011-01-26T19:06:43Z + */ + readonly pushed_at: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + readonly created_at: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:14:43Z + */ + readonly updated_at: string | null; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + * @example true + */ + readonly allow_rebase_merge: boolean; + readonly template_repository?: { + readonly id?: number; + readonly node_id?: string; + readonly name?: string; + readonly full_name?: string; + readonly owner?: { + readonly login?: string; + readonly id?: number; + readonly node_id?: string; 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; - } | null; - readonly assignees: ({ - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ + readonly html_url?: string; 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 starred_url?: string; + readonly subscriptions_url?: string; readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; - /** Format: uri */ readonly repos_url?: string; + readonly events_url?: string; + readonly received_events_url?: string; + readonly type?: 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; - } | null)[]; + }; + readonly private?: boolean; + readonly html_url?: string; + readonly description?: string; + readonly fork?: boolean; + readonly url?: string; + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly downloads_url?: string; + readonly events_url?: string; + readonly forks_url?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly git_url?: string; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly notifications_url?: string; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly ssh_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly clone_url?: string; + readonly mirror_url?: string; + readonly hooks_url?: string; + readonly svn_url?: string; + readonly homepage?: string; + readonly language?: string; + readonly forks_count?: number; + readonly stargazers_count?: number; + readonly watchers_count?: number; + readonly size?: number; + readonly default_branch?: string; + readonly open_issues_count?: number; + readonly is_template?: boolean; + readonly topics?: string[]; + readonly has_issues?: boolean; + readonly has_projects?: boolean; + readonly has_wiki?: boolean; + readonly has_pages?: boolean; + readonly has_downloads?: boolean; + readonly archived?: boolean; + readonly disabled?: boolean; + readonly visibility?: string; + readonly pushed_at?: string; + readonly created_at?: string; + readonly updated_at?: string; + readonly permissions?: { + readonly admin?: boolean; + readonly maintain?: boolean; + readonly push?: boolean; + readonly triage?: boolean; + readonly pull?: boolean; + }; + readonly allow_rebase_merge?: boolean; + readonly temp_clone_token?: string; + readonly allow_squash_merge?: boolean; + readonly allow_auto_merge?: boolean; + readonly delete_branch_on_merge?: boolean; + readonly allow_update_branch?: boolean; + readonly use_squash_pr_title_as_default?: boolean; /** - * AuthorAssociation - * @description How the author is associated with the repository. + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @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?: { - /** @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; - /** - * 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; - } | 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; + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * 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. + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} */ - 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?: ("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 */ - 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; - } | 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; - }; - /** 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; + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description State of the issue; either 'open' or 'closed' + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). * @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; + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** - * Format: uri - * @description URL for the issue + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} */ - 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; - 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; - } | null; - }; - /** Label */ - readonly label?: { - /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + readonly allow_merge_commit?: boolean; + readonly subscribers_count?: number; + readonly network_count?: number; + } | null; + readonly temp_clone_token?: string; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + * @example true + */ + readonly allow_squash_merge: boolean; + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ + readonly allow_auto_merge: boolean; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ + readonly delete_branch_on_merge: boolean; + /** + * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + * @default false + * @example false + */ + readonly allow_update_branch: boolean; + /** + * @deprecated + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + * @example true + */ + readonly allow_merge_commit: boolean; + /** @description Whether to allow forking this repo */ + readonly allow_forking?: boolean; + /** + * @description Whether to require contributors to sign off on web-based commits + * @default false + */ + readonly web_commit_signoff_required: boolean; + readonly subscribers_count?: number; + readonly network_count?: number; + readonly open_issues: number; + readonly watchers: number; + readonly master_branch?: string; + /** @example "2020-07-09T00:17:42Z" */ + readonly starred_at?: string; + /** @description Whether anonymous git access is enabled for this repository */ + readonly anonymous_access_enabled?: boolean; + } | null; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + readonly webhooks_milestone_3: { + /** 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; - /** @description The name of the label. */ - readonly name: string; - readonly node_id: string; - /** - * Format: uri - * @description URL for the label - */ - readonly url: string; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues labeled event */ - readonly "webhook-issues-labeled": { - /** @enum {string} */ - readonly action: "labeled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + 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 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; /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + * @description The state of the milestone. + * @enum {string} */ - 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; - } | null; - readonly assignees: ({ - /** 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; - } | 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; + 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; + }; + /** + * Membership + * @description The membership between the user and the organization. Not present when the action is `member_invited`. + */ + readonly webhooks_membership: { + /** Format: uri */ + readonly organization_url: string; + readonly role: string; + readonly state: string; + /** Format: uri */ + readonly url: string; + /** User */ + readonly user: { /** Format: uri */ - readonly comments_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; /** Format: uri */ - readonly events_url: string; + 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 html_url?: string; readonly id: number; - readonly labels?: { - /** @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 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 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; - } | 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?: ("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 */ - 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; - } | 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; - }; - /** 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; - }; + readonly starred_url?: string; /** 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; + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; /** 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; - 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; - } | null; + readonly url?: string; + } | null; + }; + /** + * Personal Access Token Request + * @description Details of a Personal Access Token Request. + */ + readonly "personal-access-token-request": { + /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */ + readonly id: number; + readonly owner: components["schemas"]["simple-user"]; + /** @description New requested permissions, categorized by type of permission. */ + readonly permissions_added: { + readonly organization?: { + readonly [key: string]: string | undefined; + }; + readonly repository?: { + readonly [key: string]: string | undefined; + }; + readonly other?: { + readonly [key: string]: string | undefined; + }; }; - /** Label */ - readonly label?: { - /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; + /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ + readonly permissions_upgraded: { + readonly organization?: { + readonly [key: string]: string | undefined; + }; + readonly repository?: { + readonly [key: string]: string | undefined; + }; + readonly other?: { + readonly [key: string]: string | undefined; + }; + }; + /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ + readonly permissions_result: { + readonly organization?: { + readonly [key: string]: string | undefined; + }; + readonly repository?: { + readonly [key: string]: string | undefined; + }; + readonly other?: { + readonly [key: string]: string | undefined; + }; + }; + /** + * @description Type of repository selection requested. + * @enum {string} + */ + readonly repository_selection: "none" | "all" | "subset"; + /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + readonly repository_count: number | null; + /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + readonly repositories: { + readonly full_name: string; + /** @description Unique identifier of the repository */ readonly id: number; - /** @description The name of the label. */ + /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** - * Format: uri - * @description URL for the label - */ - readonly url: string; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + }[] | null; + /** @description Date and time when the request for access was created. */ + readonly created_at: string; + /** @description Whether the associated fine-grained personal access token has expired. */ + readonly token_expired: boolean; + /** @description Date and time when the associated fine-grained personal access token expires. */ + readonly token_expires_at: string | null; + /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + readonly token_last_used_at: string | null; }; - /** issues locked event */ - readonly "webhook-issues-locked": { - /** @enum {string} */ - readonly action: "locked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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: ({ - /** 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; + /** Project Card */ + readonly webhooks_project_card: { + readonly after_id?: number | null; + /** @description Whether or not the card is archived */ + readonly archived: boolean; + readonly column_id: number; + /** Format: uri */ + readonly column_url: string; + /** Format: uri */ + readonly content_url?: string; + /** Format: date-time */ + readonly created_at: string; + /** User */ + readonly creator: { /** Format: uri */ - readonly comments_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; /** Format: uri */ - readonly events_url: string; + 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 html_url?: string; readonly id: number; - readonly labels?: { - /** @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 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 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"; - /** Format: uri */ - readonly url?: 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?: ("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 */ - 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; - } | 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"; - /** @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; - }; - /** 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; - }; + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + /** @description The project card's ID */ + readonly id: number; + readonly node_id: string; + readonly note: string | null; + /** Format: uri */ + readonly project_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + }; + /** Project */ + readonly webhooks_project: { + /** @description Body of the project */ + readonly body: string | null; + /** Format: uri */ + readonly columns_url: string; + /** 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 repository_url: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; + readonly url?: string; + } | null; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + /** @description Name of the project */ + readonly name: string; + readonly node_id: string; + readonly number: number; + /** Format: uri */ + readonly owner_url: string; + /** + * @description State of the project; either 'open' or 'closed' + * @enum {string} + */ + readonly state: "open" | "closed"; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + }; + /** Project Column */ + readonly webhooks_project_column: { + readonly after_id?: number | null; + /** Format: uri */ + readonly cards_url: string; + /** Format: date-time */ + readonly created_at: string; + /** @description The unique identifier of the project column */ + readonly id: number; + /** @description Name of the project column */ + readonly name: string; + readonly node_id: string; + /** Format: uri */ + readonly project_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + }; + /** + * Projects v2 Project + * @description A projects v2 project + */ + readonly "projects-v2": { + readonly id: number; + readonly node_id: string; + readonly owner: components["schemas"]["simple-user"]; + readonly creator: components["schemas"]["simple-user"]; + readonly title: string; + readonly description: string | null; + readonly public: boolean; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly closed_at: string | null; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly created_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly updated_at: string; + readonly number: number; + readonly short_description: string | null; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly deleted_at: string | null; + readonly deleted_by: components["schemas"]["nullable-simple-user"]; + }; + readonly webhooks_project_changes: { + readonly archived_at?: { /** 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; + readonly from?: string | null; + /** Format: date-time */ + readonly to?: string | null; + }; + }; + /** + * Projects v2 Item Content Type + * @description The type of content tracked in a project item + * @enum {string} + */ + readonly "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + readonly "projects-v2-item": { + readonly id: number; + readonly node_id?: string; + readonly project_node_id?: string; + readonly content_node_id: string; + readonly content_type: components["schemas"]["projects-v2-item-content-type"]; + readonly creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly created_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly updated_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + readonly archived_at: string | null; + }; + /** @description The pull request number. */ + readonly webhooks_number: number; + readonly "pull-request-webhook": components["schemas"]["pull-request"] & { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow updating the pull request's branch. */ + readonly allow_update_branch?: boolean; + /** + * @description Whether to delete head branches when pull requests are merged. + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** + * @description The default value for a merge commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** + * @description The default value for a squash merge commit message: + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; + }; + /** Pull Request */ + readonly webhooks_pull_request_5: { + readonly _links: { + /** Link */ + readonly comments: { /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; + readonly href: string; + }; + /** Link */ + readonly commits: { /** Format: uri-template */ - readonly following_url?: string; + readonly href: string; + }; + /** Link */ + readonly html: { /** 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; + readonly href: string; + }; + /** Link */ + readonly issue: { /** 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; - } & { - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly assignee?: Record; - readonly assignees?: 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 href: string; + }; + /** Link */ + readonly review_comment: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly statuses: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** @enum {string|null} */ + readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; + /** 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 labels?: Record[]; - readonly labels_url?: string; - /** @enum {boolean} */ - readonly locked: true; - readonly milestone?: Record; + readonly id: number; + readonly login: string; + readonly name?: string; 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; - readonly state?: string; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: 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?: { - 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; - 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-webhooks"]; - }; - /** issues milestoned event */ - readonly "webhook-issues-milestoned": { - /** @enum {string} */ - readonly action: "milestoned"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly issue: { - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + } | null; + readonly assignees: ({ + /** 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; + } | 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"; + /** + * PullRequestAutoMerge + * @description The status of auto merging a pull request. + */ + readonly auto_merge: { + /** @description Commit message for the merge commit. */ + readonly commit_message: string | null; + /** @description Title for the merge commit message. */ + readonly commit_title: string | null; /** User */ - readonly assignee?: { + readonly enabled_by: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -43769,174 +35470,189 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - readonly assignees: ({ - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + /** + * @description The merge method to use. + * @enum {string} + */ + readonly merge_method: "merge" | "squash" | "rebase"; + } | null; + readonly base: { + readonly label: string; + readonly ref: string; + /** + * Repository + * @description A git repository + */ + readonly repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; /** Format: uri-template */ - readonly following_url?: string; + readonly assignees_url: string; /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; /** Format: uri */ - readonly html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; /** Format: uri */ - readonly organizations_url?: string; + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; /** Format: uri */ - readonly received_events_url?: string; + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; + readonly downloads_url: string; /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; /** 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?: { - /** @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; + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; /** - * Format: uri - * @description URL for the label + * @description Whether downloads are enabled. + * @default true */ - readonly url: string; - }[]; - /** 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; - } | null; - readonly description: string | null; - /** Format: date-time */ - readonly due_on: string | null; + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; /** Format: uri */ readonly html_url: string; + /** @description Unique identifier of the repository */ readonly id: number; - /** Format: uri */ + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ readonly labels_url: string; - readonly node_id: string; - /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; /** - * @description The state of the milestone. + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @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?: ("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 merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly external_url: string | null; + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; /** 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 mirror_url: string | null; + /** @description The name of the repository. */ readonly name: string; readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: string; /** User */ readonly owner: { /** Format: uri */ @@ -43974,129 +35690,77 @@ export interface components { /** Format: uri */ readonly url?: 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"; + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; }; - /** @description The slug name of the GitHub app */ - readonly slug?: string; - /** Format: date-time */ - readonly updated_at: string | null; - } | null; - readonly pull_request?: { + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; /** Format: uri */ - readonly diff_url?: string; + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; /** Format: uri */ - readonly html_url?: string; - /** Format: date-time */ - readonly merged_at?: string | null; + readonly subscribers_url: string; /** Format: uri */ - readonly patch_url?: string; + readonly subscription_url: string; /** Format: uri */ - readonly url?: string; - }; - /** 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; + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; }; - /** 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; + readonly sha: string; /** User */ readonly user: { /** Format: uri */ @@ -44104,64 +35768,233 @@ export interface components { readonly deleted?: boolean; readonly email?: string | null; /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; + 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 body: string | null; + readonly changed_files?: number; + /** Format: date-time */ + readonly closed_at: string | null; + readonly comments?: number; + /** Format: uri */ + readonly comments_url: string; + readonly commits?: number; + /** Format: uri */ + readonly commits_url: string; + /** Format: date-time */ + readonly created_at: string; + readonly deletions?: number; + /** Format: uri */ + readonly diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ + readonly draft: boolean; + readonly head: { + readonly label: string; + readonly ref: string; + /** + * Repository + * @description A git repository + */ + readonly repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; /** Format: uri-template */ - readonly following_url?: string; + readonly issues_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; + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; /** Format: uri */ - readonly received_events_url?: string; + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + readonly merges_url: string; /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly milestones_url: string; /** Format: uri */ - readonly url?: string; - } | null; - } & { - readonly active_lock_reason?: string | null; - readonly assignee?: Record; - readonly assignees?: 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?: Record[]; - 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; + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: string; /** User */ - readonly creator: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -44193,76 +36026,185 @@ 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; } | 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; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; /** - * @description The state of the milestone. + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ - readonly state: "open" | "closed"; - /** @description The title of the milestone. */ - readonly title: string; + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; }; - 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; - readonly state?: string; - readonly timeline_url?: string; - readonly title?: string; - readonly updated_at?: string; - readonly url?: string; - readonly user?: { + readonly sha: 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; - readonly id?: number; - readonly login?: 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; - readonly type?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ readonly url?: string; - }; + } | null; }; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + /** Format: uri */ + readonly issue_url: string; + readonly labels: { + /** @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 locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; + readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ + readonly merged_at: string | null; + /** User */ + readonly merged_by?: { + /** 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; + } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -44333,875 +36275,1231 @@ export interface components { readonly updated_at: string; /** Format: uri */ readonly url: string; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues opened event */ - readonly "webhook-issues-opened": { - /** @enum {string} */ - readonly action: "opened"; - readonly changes?: { - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - readonly old_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: ({ - /** 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?: { - /** @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; - /** - * 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"; - /** Format: uri */ - readonly url?: 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; + } | null; + readonly node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ + readonly number: number; + /** Format: uri */ + readonly patch_url: string; + readonly rebaseable?: boolean | null; + readonly requested_reviewers: (({ + /** 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 deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; 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?: ("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 */ - 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; - } | 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"; - /** @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; - }; - /** 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; - }; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repository_url: string; + readonly repositories_url: string; + readonly slug: string; /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} + * Format: uri + * @description URL for the team */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; + })[]; + readonly requested_teams: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; - /** Format: date-time */ - readonly updated_at: string; + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; /** * Format: uri - * @description URL for the issue + * @description URL for the team */ 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; - 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; } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; /** - * Repository - * @description A git repository + * Format: uri + * @description URL for the team */ - readonly old_repository: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + readonly url?: string; + }[]; + /** Format: uri-template */ + readonly review_comment_url: string; + readonly review_comments?: number; + /** Format: uri */ + readonly review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + readonly state: "open" | "closed"; + /** Format: uri */ + readonly statuses_url: string; + /** @description The title of the pull request. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + 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; + 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; + } | null; + }; + /** + * Pull Request Review Comment + * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. + */ + readonly webhooks_review_comment: { + readonly _links: { + /** Link */ + readonly html: { /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; + readonly href: string; + }; + /** Link */ + readonly pull_request: { /** Format: uri-template */ - readonly assignees_url: string; + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** + * 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 The text of the comment. */ + readonly body: string; + /** @description The SHA of the commit to which the comment applies. */ + readonly commit_id: string; + /** Format: date-time */ + readonly created_at: string; + /** @description The diff of the line that the comment refers to. */ + readonly diff_hunk: string; + /** + * Format: uri + * @description HTML URL for the pull request review comment. + */ + readonly html_url: string; + /** @description The ID of the pull request review comment. */ + readonly id: number; + /** @description The comment ID to reply to. */ + readonly in_reply_to_id?: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + readonly line: number | null; + /** @description The node ID of the pull request review comment. */ + readonly node_id: string; + /** @description The SHA of the original commit to which the comment applies. */ + readonly original_commit_id: string; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + readonly original_line: number; + /** @description The index of the original line in the diff to which the comment applies. */ + readonly original_position: number; + /** @description The first line of the range for a multi-line comment. */ + readonly original_start_line: number | null; + /** @description The relative path of the file to which the comment applies. */ + readonly path: string; + /** @description The line index in the diff to which the comment applies. */ + readonly position: number | null; + /** @description The ID of the pull request review to which the comment belongs. */ + readonly pull_request_review_id: number | null; + /** + * Format: uri + * @description URL for the pull request that the review comment belongs to. + */ + readonly pull_request_url: string; + /** 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; + }; + /** + * @description The side of the first line of the range for a multi-line comment. + * @enum {string} + */ + readonly side: "LEFT" | "RIGHT"; + /** @description The first line of the range for a multi-line comment. */ + readonly start_line: number | null; + /** + * @description The side of the first line of the range for a multi-line comment. + * @default RIGHT + * @enum {string|null} + */ + readonly start_side: "LEFT" | "RIGHT" | null; + /** + * @description The level at which the comment is targeted, can be a diff line or a file. + * @enum {string} + */ + readonly subject_type?: "line" | "file"; + /** Format: date-time */ + readonly updated_at: string; + /** + * Format: uri + * @description URL for the pull request review 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; + 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; + }; + /** @description The review that was affected. */ + readonly webhooks_review: { + readonly _links: { + /** Link */ + readonly html: { /** Format: uri-template */ - readonly blobs_url: string; + readonly href: string; + }; + /** Link */ + readonly pull_request: { /** Format: uri-template */ - readonly branches_url: string; + readonly href: string; + }; + }; + /** + * 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 The text of the review. */ + readonly body: string | null; + /** @description A commit SHA for the review. */ + readonly commit_id: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the review */ + readonly id: number; + readonly node_id: string; + /** Format: uri */ + readonly pull_request_url: string; + readonly state: string; + /** Format: date-time */ + readonly submitted_at: string | null; + /** 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; + 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 webhooks_nullable_string: string | null; + /** + * Release + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. + */ + readonly webhooks_release: { + readonly assets: { + /** Format: uri */ + readonly browser_download_url: string; + readonly content_type: string; + /** Format: date-time */ + readonly created_at: string; + readonly download_count: number; + readonly id: number; + readonly label: string | null; + /** @description The file name of the asset. */ + readonly name: string; + readonly node_id: string; + readonly size: number; + /** + * @description State of the release asset. + * @enum {string} + */ + readonly state: "uploaded"; + /** Format: date-time */ + readonly updated_at: string; + /** User */ + readonly uploader?: { /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly commits_url: string; + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; /** Format: uri-template */ - readonly compare_url: string; + readonly following_url?: string; /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; + readonly gists_url?: string; + readonly gravatar_id?: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly downloads_url: string; + readonly organizations_url?: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + readonly received_events_url?: string; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; + readonly repos_url?: string; + readonly site_admin?: boolean; /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** @description Whether the repository has discussions enabled. */ - readonly has_discussions?: boolean; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; + readonly starred_url?: string; /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; + readonly url?: string; + } | null; + /** Format: uri */ + readonly url: string; + }[]; + /** Format: uri */ + readonly assets_url: string; + /** User */ + readonly author: { + /** 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 body: string | null; + /** Format: date-time */ + readonly created_at: string | null; + /** Format: uri */ + readonly discussion_url?: string; + /** @description Whether the release is a draft or published */ + readonly draft: boolean; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly name: string | null; + readonly node_id: string; + /** @description Whether the release is identified as a prerelease or a full release. */ + readonly prerelease: boolean; + /** Format: date-time */ + readonly published_at: string | null; + /** 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; + }; + /** @description The name of the tag. */ + readonly tag_name: string; + /** Format: uri */ + readonly tarball_url: string | null; + /** @description Specifies the commitish value that determines where the Git tag is created from. */ + readonly target_commitish: string; + /** Format: uri-template */ + readonly upload_url: string; + /** Format: uri */ + readonly url: string; + /** Format: uri */ + readonly zipball_url: string | null; + }; + /** + * Release + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. + */ + readonly webhooks_release_1: { + readonly assets: ({ + /** Format: uri */ + readonly browser_download_url: string; + readonly content_type: string; + /** Format: date-time */ + readonly created_at: string; + readonly download_count: number; + readonly id: number; + readonly label: string | null; + /** @description The file name of the asset. */ + readonly name: string; + readonly node_id: string; + readonly size: number; + /** + * @description State of the release asset. + * @enum {string} + */ + readonly state: "uploaded"; + /** Format: date-time */ + readonly updated_at: string; + /** User */ + readonly uploader?: { /** Format: uri */ - readonly merges_url: string; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly milestones_url: string; + readonly events_url?: string; /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: 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; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; + readonly followers_url?: string; /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; + readonly following_url?: string; /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; + readonly gists_url?: string; + readonly gravatar_id?: string; /** Format: uri */ - readonly subscription_url: string; + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly svn_url: string; + readonly organizations_url?: string; /** Format: uri */ - readonly tags_url: string; + readonly received_events_url?: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; + readonly repos_url?: string; + readonly site_admin?: boolean; /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; + readonly starred_url?: string; /** Format: uri */ - readonly url: string; + readonly subscriptions_url?: string; /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require commit signoff. */ - readonly web_commit_signoff_required?: boolean; - }; + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + /** Format: uri */ + readonly url: string; + } | null)[]; + /** Format: uri */ + readonly assets_url: string; + /** User */ + readonly author: { + /** 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 body: string | null; + /** Format: date-time */ + readonly created_at: string | null; + /** Format: uri */ + readonly discussion_url?: string; + /** @description Whether the release is a draft or published */ + readonly draft: boolean; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly name: string | null; + readonly node_id: string; + /** @description Whether the release is identified as a prerelease or a full release. */ + readonly prerelease: boolean; + /** Format: date-time */ + readonly published_at: string | null; + /** 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; }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + /** @description The name of the tag. */ + readonly tag_name: string; + /** Format: uri */ + readonly tarball_url: string | null; + /** @description Specifies the commitish value that determines where the Git tag is created from. */ + readonly target_commitish: string; + /** Format: uri-template */ + readonly upload_url: string; + /** Format: uri */ + readonly url: string; + /** Format: uri */ + readonly zipball_url: string | null; + }; + /** + * Repository Vulnerability Alert Alert + * @description The security alert of the vulnerable dependency. + */ + readonly webhooks_alert: { + readonly affected_package_name: string; + readonly affected_range: string; + readonly created_at: string; + readonly dismiss_reason?: string; + readonly dismissed_at?: string; + /** User */ + readonly dismisser?: { + /** 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 external_identifier: string; + /** Format: uri */ + readonly external_reference: string | null; + readonly fix_reason?: string; + /** Format: date-time */ + readonly fixed_at?: string; + readonly fixed_in?: string; + readonly ghsa_id: string; + readonly id: number; + readonly node_id: string; + readonly number: number; + readonly severity: string; + /** @enum {string} */ + readonly state: "open"; + }; + /** + * @description The reason for resolving the alert. + * @enum {string|null} + */ + readonly "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited"; + readonly "secret-scanning-alert-webhook": { + readonly number?: components["schemas"]["alert-number"]; + readonly created_at?: components["schemas"]["alert-created-at"]; + readonly updated_at?: components["schemas"]["nullable-alert-updated-at"]; + readonly url?: components["schemas"]["alert-url"]; + readonly html_url?: components["schemas"]["alert-html-url"]; /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + * Format: uri + * @description The REST API URL of the code locations for this alert. */ - 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; + readonly locations_url?: string; + readonly resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly resolved_at?: string | null; + readonly resolved_by?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment to resolve an alert. */ + readonly resolution_comment?: string | null; + /** @description The type of secret that secret scanning detected. */ + readonly secret_type?: string; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + readonly validity?: "active" | "inactive" | "unknown"; + /** @description Whether push protection was bypassed for the detected secret. */ + readonly push_protection_bypassed?: boolean | null; + readonly push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly push_protection_bypassed_at?: string | null; + }; + /** @description The details of the security advisory, including summary, description, and severity. */ + readonly webhooks_security_advisory: { + readonly cvss: { + readonly score: number; + readonly vector_string: string | null; + }; + readonly cwes: { + readonly cwe_id: string; + readonly name: string; + }[]; + readonly description: string; + readonly ghsa_id: string; + readonly identifiers: { + readonly type: string; + readonly value: string; + }[]; + readonly published_at: string; + readonly references: { + /** Format: uri */ + readonly url: string; + }[]; + readonly severity: string; + readonly summary: string; + readonly updated_at: string; + readonly vulnerabilities: { + readonly first_patched_version: { + readonly identifier: string; } | null; - readonly assignees: ({ - /** 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; + readonly package: { + readonly ecosystem: string; + readonly name: string; + }; + readonly severity: string; + readonly vulnerable_version_range: string; + }[]; + readonly withdrawn_at: string | null; + }; + readonly webhooks_sponsorship: { + readonly created_at: string; + readonly maintainer?: { + 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; + 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 node_id: string; + readonly privacy_level: string; + /** User */ + readonly sponsor: { /** Format: uri */ - readonly comments_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly draft?: boolean; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; /** Format: uri */ - readonly events_url: string; + 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 html_url?: string; readonly id: number; - readonly labels?: { - /** @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 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 labels_url: string; - readonly locked?: boolean; + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + /** User */ + readonly sponsorable: { + /** 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; + /** + * Sponsorship Tier + * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. + */ + readonly tier: { + readonly created_at: string; + readonly description: string; + readonly is_custom_ammount?: boolean; + readonly is_custom_amount?: boolean; + readonly is_one_time: boolean; + readonly monthly_price_in_cents: number; + readonly monthly_price_in_dollars: number; + readonly name: string; + readonly node_id: string; + }; + }; + /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ + readonly webhooks_effective_date: string; + readonly webhooks_changes_8: { + readonly tier: { /** - * Milestone - * @description A collection of related issues and pull requests. + * Sponsorship Tier + * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. */ - readonly milestone: { - /** Format: date-time */ - readonly closed_at: string | null; - readonly closed_issues: number; - /** Format: date-time */ + readonly from: { 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; - } | 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 description: string; + readonly is_custom_ammount?: boolean; + readonly is_custom_amount?: boolean; + readonly is_one_time: boolean; + readonly monthly_price_in_cents: number; + readonly monthly_price_in_dollars: number; + readonly name: 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; + }; + }; + }; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + readonly webhooks_team_1: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; readonly node_id: string; - readonly number: number; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** + * @description Whether team members will receive notifications when their team is @mentioned + * @enum {string} + */ + readonly notification_setting: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** + * @description Whether team members will receive notifications when their team is @mentioned + * @enum {string} + */ + readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; + }; + /** branch protection configuration disabled event */ + readonly "webhook-branch-protection-configuration-disabled": { + /** @enum {string} */ + readonly action: "disabled"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection configuration enabled event */ + readonly "webhook-branch-protection-configuration-enabled": { + /** @enum {string} */ + readonly action: "enabled"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection rule created event */ + readonly "webhook-branch-protection-rule-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly rule: components["schemas"]["webhooks_rule"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection rule deleted event */ + readonly "webhook-branch-protection-rule-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly rule: components["schemas"]["webhooks_rule"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection rule edited event */ + readonly "webhook-branch-protection-rule-edited": { + /** @enum {string} */ + readonly action: "edited"; + /** @description If the action was `edited`, the changes to the rule. */ + readonly changes?: { + readonly admin_enforced?: { + readonly from: boolean | null; + }; + readonly authorized_actor_names?: { + readonly from: string[]; + }; + readonly authorized_actors_only?: { + readonly from: boolean | null; + }; + readonly authorized_dismissal_actors_only?: { + readonly from: boolean | null; + }; + readonly linear_history_requirement_enforcement_level?: { + /** @enum {string} */ + readonly from: "off" | "non_admins" | "everyone"; + }; + readonly required_status_checks?: { + readonly from: string[]; + }; + readonly required_status_checks_enforcement_level?: { + /** @enum {string} */ + readonly from: "off" | "non_admins" | "everyone"; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly rule: components["schemas"]["webhooks_rule"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Check Run Completed Event */ + readonly "webhook-check-run-completed": { + /** @enum {string} */ + readonly action?: "completed"; + readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Completed Event + * @description The check_run.completed webhook encoded with URL encoding + */ + readonly "webhook-check-run-completed-form-encoded": { + /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */ + readonly payload: string; + }; + /** Check Run Created Event */ + readonly "webhook-check-run-created": { + /** @enum {string} */ + readonly action?: "created"; + readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Created Event + * @description The check_run.created webhook encoded with URL encoding + */ + readonly "webhook-check-run-created-form-encoded": { + /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */ + readonly payload: string; + }; + /** Check Run Requested Action Event */ + readonly "webhook-check-run-requested-action": { + /** @enum {string} */ + readonly action: "requested_action"; + readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + /** @description The action requested by the user. */ + readonly requested_action?: { + /** @description The integrator reference of the action requested by the user. */ + readonly identifier?: string; + }; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Requested Action Event + * @description The check_run.requested_action webhook encoded with URL encoding + */ + readonly "webhook-check-run-requested-action-form-encoded": { + /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */ + readonly payload: string; + }; + /** Check Run Re-Requested Event */ + readonly "webhook-check-run-rerequested": { + /** @enum {string} */ + readonly action?: "rerequested"; + readonly check_run: components["schemas"]["check-run-with-simple-check-suite"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Re-Requested Event + * @description The check_run.rerequested webhook encoded with URL encoding + */ + readonly "webhook-check-run-rerequested-form-encoded": { + /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */ + readonly payload: string; + }; + /** check_suite completed event */ + readonly "webhook-check-suite-completed": { + /** @enum {string} */ + readonly action: "completed"; + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ + readonly check_suite: { + readonly after: string | null; /** * 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?: { + readonly app: { /** Format: date-time */ readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly 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")[]; + readonly 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" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -45301,7 +37599,7 @@ export interface components { /** @enum {string} */ readonly repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + readonly repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ readonly secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ @@ -45325,232 +37623,135 @@ export interface components { 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; - 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 before: string | null; + /** Format: uri */ + readonly check_runs_url: string; + /** + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. + * @enum {string|null} + */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; + /** Format: date-time */ + readonly created_at: string; + /** @description The head branch name the changes are on. */ + readonly head_branch: string | null; + /** SimpleCommit */ + readonly head_commit: { + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly author: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly committer: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + readonly id: string; + readonly message: string; + readonly timestamp: string; + readonly tree_id: string; + }; + /** @description The SHA of the head commit that is being checked. */ + readonly head_sha: string; + readonly id: number; + readonly latest_check_runs_count: number; + readonly node_id: string; + /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly id: number; + readonly number: number; /** Format: uri */ readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; + }[]; + readonly rerequestable?: boolean; + readonly runs_rerequestable?: boolean; /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} + * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + * @enum {string|null} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; - /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; + readonly status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; /** Format: date-time */ readonly updated_at: string; /** * Format: uri - * @description URL for the issue + * @description URL that points to the check suite API resource. */ 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; - 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 enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** issues pinned event */ - readonly "webhook-issues-pinned": { + /** check_suite requested event */ + readonly "webhook-check-suite-requested": { /** @enum {string} */ - readonly action: "pinned"; - 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: ({ - /** 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 action: "requested"; + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ + readonly check_suite: { + readonly after: string | null; /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} + * 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 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?: { - /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; + readonly app: { + /** Format: date-time */ + readonly created_at: string | null; readonly description: string | null; - readonly id: number; - /** @description The name of the label. */ + /** @description The list of events for the GitHub app */ + readonly 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" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; + /** 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; - /** - * Format: uri - * @description URL for the label - */ - readonly url: string; - }[]; - /** 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: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -45586,42 +37787,201 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - readonly description: 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 due_on: string | null; - /** Format: uri */ - readonly html_url: string; + readonly updated_at: string | null; + }; + readonly before: string | null; + /** Format: uri */ + readonly check_runs_url: string; + /** + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. + * @enum {string|null} + */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; + /** Format: date-time */ + readonly created_at: string; + /** @description The head branch name the changes are on. */ + readonly head_branch: string | null; + /** SimpleCommit */ + readonly head_commit: { + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly author: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly committer: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + readonly id: string; + readonly message: string; + readonly timestamp: string; + readonly tree_id: string; + }; + /** @description The SHA of the head commit that is being checked. */ + readonly head_sha: string; + readonly id: number; + readonly latest_check_runs_count: number; + readonly node_id: string; + /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: 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; + }[]; + readonly rerequestable?: boolean; + readonly runs_rerequestable?: boolean; + /** + * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + * @enum {string|null} + */ + readonly status: "requested" | "in_progress" | "completed" | "queued" | null; + /** Format: date-time */ + readonly updated_at: string; + /** + * Format: uri + * @description URL that points to the check suite API resource. + */ + readonly url: string; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** check_suite rerequested event */ + readonly "webhook-check-suite-rerequested": { + /** @enum {string} */ + readonly action: "rerequested"; + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ + readonly check_suite: { + readonly after: string | null; /** * 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?: { + readonly app: { /** Format: date-time */ readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly 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")[]; + readonly 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" | "merge_queue_entry" | "workflow_job")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -45705,7 +38065,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} */ @@ -45721,7 +38081,7 @@ export interface components { /** @enum {string} */ readonly repository_hooks?: "read" | "write"; /** @enum {string} */ - readonly repository_projects?: "read" | "write"; + readonly repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ readonly secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ @@ -45745,54 +38105,125 @@ export interface components { 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; - 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 before: string | null; + /** Format: uri */ + readonly check_runs_url: string; + /** + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. + * @enum {string|null} + */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + readonly created_at: string; + /** @description The head branch name the changes are on. */ + readonly head_branch: string | null; + /** SimpleCommit */ + readonly head_commit: { + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly author: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly committer: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + readonly id: string; + readonly message: string; + readonly timestamp: string; + readonly tree_id: string; + }; + /** @description The SHA of the head commit that is being checked. */ + readonly head_sha: string; + readonly id: number; + readonly latest_check_runs_count: number; + readonly node_id: string; + /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly id: number; + readonly number: number; /** Format: uri */ readonly url: string; - }; - /** Format: uri */ - readonly repository_url: string; + }[]; + readonly rerequestable?: boolean; + readonly runs_rerequestable?: boolean; /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} + * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + * @enum {string|null} */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; - /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; + readonly status: "requested" | "in_progress" | "completed" | "queued" | null; /** Format: date-time */ readonly updated_at: string; /** * Format: uri - * @description URL for the issue + * @description URL that points to the check suite API resource. */ readonly url: string; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert appeared_in_branch event */ + readonly "webhook-code-scanning-alert-appeared-in-branch": { + /** @enum {string} */ + readonly action: "appeared_in_branch"; + /** @description The code scanning alert involved in the event. */ + readonly alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + readonly created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly dismissed_at: string | null; /** User */ - readonly user: { + readonly dismissed_by: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -45828,22 +38259,97 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; + /** + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + readonly html_url: string; + /** Alert Instance */ + readonly most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + readonly analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + readonly category?: string; + readonly classifications?: string[]; + readonly commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + readonly environment: string; + readonly location?: { + readonly end_column?: number; + readonly end_line?: number; + readonly path?: string; + readonly start_column?: number; + readonly start_line?: number; + }; + readonly message?: { + readonly text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + readonly ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + readonly state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + readonly number: number; + readonly rule: { + /** @description A short description of the rule used to detect the alert. */ + readonly description: string; + /** @description A unique identifier for the rule used to detect the alert. */ + readonly id: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + readonly severity: "none" | "note" | "warning" | "error" | null; + }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + readonly state: "open" | "dismissed" | "fixed"; + readonly tool: { + /** @description The name of the tool used to generate the code scanning analysis alert. */ + readonly name: string; + /** @description The version of the tool used to detect the alert. */ + readonly version: string | null; + }; + /** Format: uri */ + readonly url: string; }; + readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** issues reopened event */ - readonly "webhook-issues-reopened": { + /** code_scanning_alert closed_by_user event */ + readonly "webhook-code-scanning-alert-closed-by-user": { /** @enum {string} */ - readonly action: "reopened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly issue: { - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly action: "closed_by_user"; + /** @description The code scanning alert involved in the event. */ + readonly alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + readonly created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly dismissed_at: string; /** User */ - readonly assignee?: { + readonly dismissed_by: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -45879,7 +38385,199 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - readonly assignees: ({ + /** + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + readonly html_url: string; + /** Alert Instance */ + readonly most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + readonly analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + readonly category?: string; + readonly classifications?: string[]; + readonly commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + readonly environment: string; + readonly location?: { + readonly end_column?: number; + readonly end_line?: number; + readonly path?: string; + readonly start_column?: number; + readonly start_line?: number; + }; + readonly message?: { + readonly text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + readonly ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + readonly state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + readonly number: number; + readonly rule: { + /** @description A short description of the rule used to detect the alert. */ + readonly description: string; + readonly full_description?: string; + readonly help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + readonly help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + readonly id: string; + readonly name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + readonly severity: "none" | "note" | "warning" | "error" | null; + readonly tags?: string[] | null; + }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + readonly state: "dismissed" | "fixed"; + readonly tool: { + readonly guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + readonly name: string; + /** @description The version of the tool used to detect the alert. */ + readonly version: string | null; + }; + /** Format: uri */ + readonly url: string; + }; + readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert created event */ + readonly "webhook-code-scanning-alert-created": { + /** @enum {string} */ + readonly action: "created"; + /** @description The code scanning alert involved in the event. */ + readonly alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + readonly created_at: string | null; + /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly dismissed_at: unknown; + readonly dismissed_by: unknown; + readonly dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + readonly dismissed_reason: unknown; + readonly fixed_at?: unknown; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + readonly html_url: string; + readonly instances_url?: string; + /** Alert Instance */ + readonly most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + readonly analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + readonly category?: string; + readonly classifications?: string[]; + readonly commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + readonly environment: string; + readonly location?: { + readonly end_column?: number; + readonly end_line?: number; + readonly path?: string; + readonly start_column?: number; + readonly start_line?: number; + }; + readonly message?: { + readonly text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + readonly ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + readonly state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + readonly number: number; + readonly rule: { + /** @description A short description of the rule used to detect the alert. */ + readonly description: string; + readonly full_description?: string; + readonly help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + readonly help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + readonly id: string; + readonly name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + readonly severity: "none" | "note" | "warning" | "error" | null; + readonly tags?: string[] | null; + }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + readonly state: "open" | "dismissed"; + readonly tool: { + readonly guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + readonly name: string; + /** @description The version of the tool used to detect the alert. */ + readonly version: string | null; + } | null; + readonly updated_at?: string | null; + /** Format: uri */ + readonly url: string; + }; + readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert fixed event */ + readonly "webhook-code-scanning-alert-fixed": { + /** @enum {string} */ + readonly action: "fixed"; + /** @description The code scanning alert involved in the event. */ + readonly alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + readonly created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + readonly dismissed_at: string | null; + /** User */ + readonly dismissed_by: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -45911,271 +38609,303 @@ 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; - } | null)[]; + } | null; /** - * AuthorAssociation - * @description How the author is associated with the repository. + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + readonly dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + readonly html_url: string; + /** Format: uri */ + readonly instances_url?: string; + /** Alert Instance */ + readonly most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + readonly analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + readonly category?: string; + readonly classifications?: string[]; + readonly commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + readonly environment: string; + readonly location?: { + readonly end_column?: number; + readonly end_line?: number; + readonly path?: string; + readonly start_column?: number; + readonly start_line?: number; + }; + readonly message?: { + readonly text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + readonly ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + readonly state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + readonly number: number; + readonly rule: { + /** @description A short description of the rule used to detect the alert. */ + readonly description: string; + readonly full_description?: string; + readonly help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + readonly help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + readonly id: string; + readonly name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + readonly severity: "none" | "note" | "warning" | "error" | null; + readonly tags?: string[] | null; + }; + /** + * @description State of a code scanning alert. * @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; + readonly state: "fixed"; + readonly tool: { + readonly guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + readonly name: string; + /** @description The version of the tool used to detect the alert. */ + readonly version: string | null; + }; /** Format: uri */ - readonly comments_url: string; - /** Format: date-time */ + readonly url: string; + }; + readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert reopened event */ + readonly "webhook-code-scanning-alert-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + /** @description The code scanning alert involved in the event. */ + readonly alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ readonly created_at: string; - readonly draft?: boolean; - /** Format: uri */ - readonly events_url: string; - /** Format: uri */ + /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly dismissed_at: string | null; + readonly dismissed_by: Record; + /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + readonly dismissed_reason: string | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ readonly html_url: string; - /** Format: int64 */ - readonly id: number; - readonly labels?: { - /** @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; + /** Alert Instance */ + readonly most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + readonly analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + readonly category?: string; + readonly classifications?: string[]; + readonly commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + readonly environment: string; + readonly location?: { + readonly end_column?: number; + readonly end_line?: number; + readonly path?: string; + readonly start_column?: number; + readonly start_line?: number; + }; + readonly message?: { + readonly text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + readonly ref: string; /** - * Format: uri - * @description URL for the label + * @description State of a code scanning alert. + * @enum {string} */ - readonly url: string; - }[]; - /** Format: uri-template */ - readonly labels_url: string; - readonly locked?: boolean; + readonly state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + readonly number: number; + readonly rule: { + /** @description A short description of the rule used to detect the alert. */ + readonly description: string; + readonly full_description?: string; + readonly help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + readonly help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + readonly id: string; + readonly name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + readonly severity: "none" | "note" | "warning" | "error" | null; + readonly tags?: string[] | null; + }; /** - * Milestone - * @description A collection of related issues and pull requests. + * @description State of a code scanning alert. + * @enum {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; - } | 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; + readonly state: "open" | "dismissed" | "fixed"; + readonly tool: { + readonly guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + readonly name: string; + /** @description The version of the tool used to detect the alert. */ + readonly version: string | null; + }; + /** Format: uri */ + readonly url: string; + } | null; + /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + readonly commit_oid: string | null; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + readonly ref: string | null; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert reopened_by_user event */ + readonly "webhook-code-scanning-alert-reopened-by-user": { + /** @enum {string} */ + readonly action: "reopened_by_user"; + /** @description The code scanning alert involved in the event. */ + readonly alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + readonly created_at: string; + /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + readonly dismissed_at: unknown; + readonly dismissed_by: unknown; + /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + readonly dismissed_reason: unknown; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + readonly html_url: string; + /** Alert Instance */ + readonly most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + readonly analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + readonly category?: string; + readonly classifications?: string[]; + readonly commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + readonly environment: string; + readonly location?: { + readonly end_column?: number; + readonly end_line?: number; + readonly path?: string; + readonly start_column?: number; + readonly start_line?: number; + }; + readonly message?: { + readonly text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + readonly ref: string; /** - * @description The state of the milestone. + * @description State of a code scanning alert. * @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; + readonly state: "open" | "dismissed" | "fixed"; } | null; - readonly node_id: string; + /** @description The code scanning alert number. */ readonly number: number; + readonly rule: { + /** @description A short description of the rule used to detect the alert. */ + readonly description: string; + /** @description A unique identifier for the rule used to detect the alert. */ + readonly id: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + readonly severity: "none" | "note" | "warning" | "error" | null; + }; /** - * 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. + * @description State of a code scanning alert. + * @enum {string} */ - 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?: ("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 */ - readonly html_url: string; - /** @description Unique identifier of the GitHub app */ - readonly id: number | null; - /** @description The name of the GitHub app */ + readonly state: "open" | "fixed"; + readonly tool: { + /** @description The name of the tool used to generate the code scanning analysis alert. */ 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; - } | 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; + /** @description The version of the tool used to detect the alert. */ + readonly version: string | null; }; + /** Format: uri */ + readonly url: string; + }; + readonly commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly ref: components["schemas"]["webhooks_code_scanning_ref"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** commit_comment created event */ + readonly "webhook-commit-comment-created": { + /** + * @description The action performed. Can be `created`. + * @enum {string} + */ + readonly action: "created"; + /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ + readonly comment: { + /** + * 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 The text of the comment. */ + readonly body: string; + /** @description The SHA of the commit to which the comment applies. */ + readonly commit_id: string; + readonly created_at: string; + /** Format: uri */ + readonly html_url: string; + /** @description The ID of the commit comment. */ + readonly id: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + readonly line: number | null; + /** @description The node ID of the commit comment. */ + readonly node_id: string; + /** @description The relative path of the file to which the comment applies. */ + readonly path: string | null; + /** @description The line index in the diff to which the comment applies. */ + readonly position: number | null; /** Reactions */ - readonly reactions: { + readonly reactions?: { readonly "+1": number; readonly "-1": number; readonly confused: number; @@ -46188,24 +38918,8 @@ export interface components { /** Format: uri */ readonly url: string; }; - /** 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 - */ + /** Format: uri */ readonly url: string; /** User */ readonly user: { @@ -46240,453 +38954,271 @@ 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; } | null; - } & { - readonly active_lock_reason?: string | null; - readonly assignee?: Record; - readonly assignees?: 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?: 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: "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; - 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 enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** issues transferred event */ - readonly "webhook-issues-transferred": { + /** create event */ + readonly "webhook-create": { + /** @description The repository's current description. */ + readonly description: string | null; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + /** @description The name of the repository's default branch (usually `main`). */ + readonly master_branch: string; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; + readonly ref: components["schemas"]["webhooks_ref_0"]; + /** + * @description The type of Git ref object created in the repository. + * @enum {string} + */ + readonly ref_type: "tag" | "branch"; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** custom property created event */ + readonly "webhook-custom-property-created": { /** @enum {string} */ - readonly action: "transferred"; - readonly changes: { - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - readonly new_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: ({ - /** 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?: { - /** @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; - /** - * 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"; - /** Format: uri */ - readonly url?: 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?: ("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 */ - 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; - } | 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"; - /** @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; - }; - /** 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; - }; + readonly action: "created"; + readonly definition: components["schemas"]["org-custom-property"]; + 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-webhooks"]; + }; + /** custom property deleted event */ + readonly "webhook-custom-property-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly definition: { + /** @description The name of the property that was deleted. */ + readonly property_name: string; + }; + 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-webhooks"]; + }; + /** custom property updated event */ + readonly "webhook-custom-property-updated": { + /** @enum {string} */ + readonly action: "updated"; + readonly definition: components["schemas"]["org-custom-property"]; + 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-webhooks"]; + }; + /** Custom property values updated event */ + readonly "webhook-custom-property-values-updated": { + /** @enum {string} */ + readonly action: "updated"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + /** @description The new custom property values for the repository. */ + readonly new_property_values: components["schemas"]["custom-property-value"][]; + /** @description The old custom property values for the repository. */ + readonly old_property_values: components["schemas"]["custom-property-value"][]; + }; + /** delete event */ + readonly "webhook-delete": { + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; + readonly ref: components["schemas"]["webhooks_ref_0"]; + /** + * @description The type of Git ref object deleted in the repository. + * @enum {string} + */ + readonly ref_type: "tag" | "branch"; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert auto-dismissed event */ + readonly "webhook-dependabot-alert-auto-dismissed": { + /** @enum {string} */ + readonly action: "auto_dismissed"; + readonly alert: components["schemas"]["dependabot-alert"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert auto-reopened event */ + readonly "webhook-dependabot-alert-auto-reopened": { + /** @enum {string} */ + readonly action: "auto_reopened"; + readonly alert: components["schemas"]["dependabot-alert"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert created event */ + readonly "webhook-dependabot-alert-created": { + /** @enum {string} */ + readonly action: "created"; + readonly alert: components["schemas"]["dependabot-alert"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert dismissed event */ + readonly "webhook-dependabot-alert-dismissed": { + /** @enum {string} */ + readonly action: "dismissed"; + readonly alert: components["schemas"]["dependabot-alert"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert fixed event */ + readonly "webhook-dependabot-alert-fixed": { + /** @enum {string} */ + readonly action: "fixed"; + readonly alert: components["schemas"]["dependabot-alert"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert reintroduced event */ + readonly "webhook-dependabot-alert-reintroduced": { + /** @enum {string} */ + readonly action: "reintroduced"; + readonly alert: components["schemas"]["dependabot-alert"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert reopened event */ + readonly "webhook-dependabot-alert-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + readonly alert: components["schemas"]["dependabot-alert"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** deploy_key created event */ + readonly "webhook-deploy-key-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly key: components["schemas"]["webhooks_deploy_key"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** deploy_key deleted event */ + readonly "webhook-deploy-key-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly key: components["schemas"]["webhooks_deploy_key"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** deployment created event */ + readonly "webhook-deployment-created": { + /** @enum {string} */ + readonly action: "created"; + /** + * Deployment + * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). + */ + readonly deployment: { + readonly created_at: string; + /** User */ + readonly creator: { /** 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; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; + 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 description: string | null; + readonly environment: string; + readonly id: number; + readonly node_id: string; + readonly original_environment: string; + readonly payload: Record | string; + /** + * 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 updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - readonly url: string; + readonly created_at: string | null; + readonly description: string | null; + /** @description The list of events for the GitHub app */ + readonly 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" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; + /** 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 user: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -46722,265 +39254,665 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - }; - /** - * Repository - * @description A git repository - */ - readonly new_repository: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; + /** @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"; + /** @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 production_environment?: boolean; + readonly ref: string; + /** Format: uri */ + readonly repository_url: string; + readonly sha: string; + /** Format: uri */ + readonly statuses_url: string; + readonly task: string; + readonly transient_environment?: boolean; + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly workflow: components["schemas"]["webhooks_workflow"]; + /** Deployment Workflow Run */ + readonly workflow_run: { + /** User */ + readonly actor: { + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; /** Format: uri-template */ - readonly assignees_url: string; + readonly following_url?: string; /** Format: uri-template */ - readonly blobs_url: string; + 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 branches_url: string; + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + readonly artifacts_url?: string; + readonly cancel_url?: string; + readonly check_suite_id: number; + readonly check_suite_node_id: string; + readonly check_suite_url?: string; + /** @enum {string|null} */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + readonly created_at: string; + readonly display_title: string; + readonly event: string; + readonly head_branch: string; + readonly head_commit?: unknown; + readonly head_repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: unknown; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { + 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; + 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 private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly url?: string; + }; + readonly head_sha: string; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly jobs_url?: string; + readonly logs_url?: string; + readonly name: string; + readonly node_id: string; + readonly path: string; + readonly previous_attempt_url?: unknown; + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly id: number; + readonly number: number; + /** Format: uri */ + readonly url: string; + }[]; + readonly referenced_workflows?: { + readonly path: string; + readonly ref?: string; + readonly sha: string; + }[] | null; + readonly repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: unknown; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { + 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; + 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 private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly url?: string; + }; + readonly rerun_url?: string; + readonly run_attempt: number; + readonly run_number: number; + /** Format: date-time */ + readonly run_started_at: string; + /** @enum {string} */ + readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + /** User */ + readonly triggering_actor?: { /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly commits_url: string; + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; /** Format: uri-template */ - readonly compare_url: string; + readonly following_url?: string; /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; + readonly gists_url?: string; + readonly gravatar_id?: string; /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly downloads_url: string; + readonly organizations_url?: string; /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; + readonly received_events_url?: string; /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; + readonly repos_url?: string; + readonly site_admin?: boolean; /** Format: uri-template */ - readonly git_tags_url: string; + readonly starred_url?: string; /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly homepage: string | null; + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly hooks_url: string; + readonly url?: string; + } | null; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + readonly workflow_id: number; + readonly workflow_url?: string; + } | null; + }; + /** deployment protection rule requested event */ + readonly "webhook-deployment-protection-rule-requested": { + /** @enum {string} */ + readonly action?: "requested"; + /** @description The name of the environment that has the deployment protection rule. */ + readonly environment?: string; + /** @description The event that triggered the deployment protection rule. */ + readonly event?: string; + /** + * Format: uri + * @description The URL to review the deployment protection rule. + */ + readonly deployment_callback_url?: string; + readonly deployment?: components["schemas"]["deployment"]; + readonly pull_requests?: components["schemas"]["pull-request"][]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + readonly "webhook-deployment-review-approved": { + /** @enum {string} */ + readonly action: "approved"; + readonly approver?: components["schemas"]["webhooks_approver"]; + readonly comment?: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly reviewers?: components["schemas"]["webhooks_reviewers"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly since: string; + readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; + readonly workflow_job_runs?: { + readonly conclusion?: unknown; + readonly created_at?: string; + readonly environment?: string; + readonly html_url?: string; + readonly id?: number; + readonly name?: string | null; + readonly status?: string; + readonly updated_at?: string; + }[]; + /** Deployment Workflow Run */ + readonly workflow_run: { + /** User */ + readonly actor: { /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly issues_url: string; + readonly events_url?: string; + /** Format: uri */ + readonly followers_url?: string; /** Format: uri-template */ - readonly keys_url: string; + readonly following_url?: string; /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; + readonly gists_url?: string; + readonly gravatar_id?: string; /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; + readonly organizations_url?: string; /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; - /** User */ - readonly owner: { - /** Format: uri */ + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + readonly artifacts_url?: string; + readonly cancel_url?: string; + readonly check_suite_id: number; + readonly check_suite_node_id: string; + readonly check_suite_url?: string; + /** @enum {string|null} */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + readonly created_at: string; + readonly display_title: string; + readonly event: string; + readonly head_branch: string; + readonly head_commit?: Record; + readonly head_repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: string | null; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { 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 id?: number; + readonly login?: 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 type?: string; readonly url?: string; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; + readonly private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly url?: string; + }; + readonly head_sha: string; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly jobs_url?: string; + readonly logs_url?: string; + readonly name: string; + readonly node_id: string; + readonly path: string; + readonly previous_attempt_url?: string | null; + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly id: number; + readonly number: number; /** Format: uri */ readonly url: string; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; + }[]; + readonly referenced_workflows?: { + readonly path: string; + readonly ref?: string; + readonly sha: string; + }[] | null; + readonly repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: string | null; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { + 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; + 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 private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly url?: string; }; - }; - 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; + readonly rerun_url?: string; + readonly run_attempt: number; + readonly run_number: number; + /** Format: date-time */ + readonly run_started_at: string; + /** @enum {string} */ + readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - readonly assignee?: { + readonly triggering_actor: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -47016,7 +39948,41 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - readonly assignees: ({ + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + readonly workflow_id: number; + readonly workflow_url?: string; + } | null; + }; + readonly "webhook-deployment-review-rejected": { + /** @enum {string} */ + readonly action: "rejected"; + readonly approver?: components["schemas"]["webhooks_approver"]; + readonly comment?: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly reviewers?: components["schemas"]["webhooks_reviewers"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly since: string; + readonly workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; + readonly workflow_job_runs?: { + readonly conclusion?: string | null; + readonly created_at?: string; + readonly environment?: string; + readonly html_url?: string; + readonly id?: number; + readonly name?: string | null; + readonly status?: string; + readonly updated_at?: string; + }[]; + /** Deployment Workflow Run */ + readonly workflow_run: { + /** User */ + readonly actor: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -47051,301 +40017,205 @@ export interface components { 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; + } | null; + readonly artifacts_url?: string; + readonly cancel_url?: string; + readonly check_suite_id: number; + readonly check_suite_node_id: string; + readonly check_suite_url?: string; + /** @enum {string|null} */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** 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?: { - /** @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; - /** - * 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 event: string; + readonly head_branch: string; + readonly head_commit?: Record; + readonly head_repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: string | null; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { 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 id?: number; + readonly login?: 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 type?: string; readonly url?: string; - } | null; - readonly description: string | null; - /** Format: date-time */ - readonly due_on: string | null; - /** Format: uri */ - readonly html_url: string; + }; + readonly private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly url?: string; + }; + readonly head_sha: string; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly jobs_url?: string; + readonly logs_url?: string; + readonly name: string; + readonly node_id: string; + readonly path: string; + readonly previous_attempt_url?: string | null; + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: 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?: ("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 */ - 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 referenced_workflows?: { + readonly path: string; + readonly ref?: string; + readonly sha: string; + }[] | null; + readonly repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: string | null; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { 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 id?: number; + readonly login?: 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 type?: string; readonly url?: 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"; - /** @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 private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; readonly url?: string; }; - /** 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} - */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; - /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; + readonly rerun_url?: string; + readonly run_attempt: number; + readonly run_number: number; /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - readonly url: string; + readonly run_started_at: string; + /** @enum {string} */ + readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; /** User */ - readonly user: { + readonly triggering_actor: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -47353,94 +40223,55 @@ export interface components { /** 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 organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues unassigned event */ - readonly "webhook-issues-unassigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - readonly action: "unassigned"; - /** 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"; + 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; + /** Format: date-time */ + readonly updated_at: string; /** Format: uri */ - readonly url?: string; + readonly url: string; + readonly workflow_id: number; + readonly workflow_url?: string; + readonly display_title: string; } | null; + }; + readonly "webhook-deployment-review-requested": { + /** @enum {string} */ + readonly action: "requested"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly environment: string; 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; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly requestor: components["schemas"]["webhooks_user"]; + readonly reviewers: { /** User */ - readonly assignee?: { + readonly reviewer?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -47457,7 +40288,7 @@ export interface components { /** Format: uri */ readonly html_url?: string; readonly id: number; - readonly login: string; + readonly login?: string; readonly name?: string; readonly node_id?: string; /** Format: uri */ @@ -47472,11 +40303,29 @@ 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; } | null; - readonly assignees: ({ + /** @enum {string} */ + readonly type?: "User" | "Team"; + }[]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly since: string; + readonly workflow_job_run: { + readonly conclusion: unknown; + readonly created_at: string; + readonly environment: string; + readonly html_url: string; + readonly id: number; + readonly name: string | null; + readonly status: string; + readonly updated_at: string; + }; + /** Deployment Workflow Run */ + readonly workflow_run: { + /** User */ + readonly actor: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -47508,359 +40357,208 @@ 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; - } | 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; + } | null; + readonly artifacts_url?: string; + readonly cancel_url?: string; + readonly check_suite_id: number; + readonly check_suite_node_id: string; + readonly check_suite_url?: string; + /** @enum {string|null} */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** 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?: { - /** @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; - /** - * 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 event: string; + readonly head_branch: string; + readonly head_commit?: Record; + readonly head_repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: string | null; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { 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 id?: number; + readonly login?: 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 type?: string; readonly url?: string; - } | null; - readonly description: string | null; - /** Format: date-time */ - readonly due_on: string | null; - /** Format: uri */ - readonly html_url: string; + }; + readonly private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly url?: string; + }; + readonly head_sha: string; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly jobs_url?: string; + readonly logs_url?: string; + readonly name: string; + readonly node_id: string; + readonly path: string; + readonly previous_attempt_url?: string | null; + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: 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?: ("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 referenced_workflows?: { + readonly path: string; + readonly ref?: string; + readonly sha: string; + }[] | null; + readonly repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: string | null; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { 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 id?: number; + readonly login?: 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; - /** @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; - }; - /** 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} - */ - 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; - 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 type?: string; + readonly url?: string; + }; + readonly private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; readonly url?: string; - } | null; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues unlabeled event */ - readonly "webhook-issues-unlabeled": { - /** @enum {string} */ - readonly action: "unlabeled"; - 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; + }; + readonly rerun_url?: string; + readonly run_attempt: number; + readonly run_number: number; + /** Format: date-time */ + readonly run_started_at: string; + /** @enum {string} */ + readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - readonly assignee?: { + readonly triggering_actor: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -47892,11 +40590,61 @@ 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; } | null; - readonly assignees: ({ + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + readonly workflow_id: number; + readonly workflow_url?: string; + readonly display_title: string; + } | null; + }; + /** deployment_status created event */ + readonly "webhook-deployment-status-created": { + /** @enum {string} */ + readonly action: "created"; + readonly check_run?: { + /** Format: date-time */ + readonly completed_at: string | null; + /** + * @description The result of the completed check run. This value will be `null` until the check run has completed. + * @enum {string|null} + */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; + /** Format: uri */ + readonly details_url: string; + readonly external_id: string; + /** @description The SHA of the commit that is being checked. */ + readonly head_sha: string; + /** Format: uri */ + readonly html_url: string; + /** @description The id of the check. */ + readonly id: number; + /** @description The name of the check run. */ + readonly name: string; + readonly node_id: string; + /** Format: date-time */ + readonly started_at: string; + /** + * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. + * @enum {string} + */ + readonly status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; + /** Format: uri */ + readonly url: string; + } | null; + /** + * Deployment + * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). + */ + readonly deployment: { + readonly created_at: string; + /** User */ + readonly creator: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -47928,123 +40676,16 @@ 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; - } | 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?: { - /** @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; - /** - * 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; - } | 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 description: string | null; + readonly environment: string; + readonly id: number; readonly node_id: string; - readonly number: number; + readonly original_environment: string; + readonly payload: (string | Record) | null; /** * 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. @@ -48054,7 +40695,7 @@ export interface components { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly 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")[]; + readonly 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" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -48138,7 +40779,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} */ @@ -48150,333 +40791,99 @@ export interface components { /** @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; - }; - /** 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} - */ - 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; - 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; - } | null; - }; - /** Label */ - readonly label?: { - /** @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 organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues unlocked event */ - readonly "webhook-issues-unlocked": { - /** @enum {string} */ - readonly action: "unlocked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - 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: ({ - /** 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?: { - /** @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; - /** - * 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; + readonly pull_requests?: "read" | "write"; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - } | null; - readonly description: string | null; + 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 due_on: string | null; + readonly updated_at: string | null; + } | null; + readonly production_environment?: boolean; + readonly ref: string; + /** Format: uri */ + readonly repository_url: string; + readonly sha: string; + /** Format: uri */ + readonly statuses_url: string; + readonly task: string; + readonly transient_environment?: boolean; + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + }; + /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ + readonly deployment_status: { + readonly created_at: string; + /** User */ + readonly creator: { /** Format: uri */ - readonly html_url: string; + 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 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; + readonly organizations_url?: string; /** Format: uri */ - readonly url: string; + 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; + /** Format: uri */ + readonly deployment_url: string; + /** @description The optional human-readable description added to the status. */ + readonly description: string; + readonly environment: string; + /** Format: uri */ + readonly environment_url?: string; + readonly id: number; + /** Format: uri */ + readonly log_url?: string; 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. @@ -48486,7 +40893,7 @@ export interface components { readonly created_at: string | null; readonly description: string | null; /** @description The list of events for the GitHub app */ - readonly 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")[]; + readonly 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" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; /** Format: uri */ readonly external_url: string | null; /** Format: uri */ @@ -48611,167 +41018,26 @@ export interface components { /** 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; - 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} - */ - 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 */ + /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ + readonly state: string; + /** @description The optional link added to the status. */ + readonly target_url: string; readonly updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ + /** Format: uri */ 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; - 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 active_lock_reason: unknown; - readonly assignee?: Record; - readonly assignees?: 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?: Record[]; - readonly labels_url?: string; - /** @enum {boolean} */ - readonly locked: false; - readonly milestone?: Record; - readonly node_id?: string; - readonly number?: number; - readonly performed_via_github_app?: unknown; - 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; - readonly state?: string; - 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; - 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 enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues unpinned event */ - readonly "webhook-issues-unpinned": { - /** @enum {string} */ - readonly action: "unpinned"; - 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; + readonly workflow?: components["schemas"]["webhooks_workflow"]; + /** Deployment Workflow Run */ + readonly workflow_run?: { /** User */ - readonly assignee?: { + readonly actor: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -48807,336 +41073,205 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - readonly assignees: ({ - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ + readonly artifacts_url?: string; + readonly cancel_url?: string; + readonly check_suite_id: number; + readonly check_suite_node_id: string; + readonly check_suite_url?: string; + /** @enum {string|null} */ + readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; + /** Format: date-time */ + readonly created_at: string; + readonly display_title: string; + readonly event: string; + readonly head_branch: string; + readonly head_commit?: unknown; + readonly head_repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: unknown; + readonly downloads_url?: string; 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 fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; readonly html_url?: string; - readonly id: number; - readonly login: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: 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?: { - /** @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; - /** - * 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 notifications_url?: string; + readonly owner?: { 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 id?: number; + readonly login?: 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 type?: string; readonly url?: string; - } | null; - readonly description: string | null; - /** Format: date-time */ - readonly due_on: string | null; - /** Format: uri */ - readonly html_url: string; + }; + readonly private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; + readonly url?: string; + }; + readonly head_sha: string; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly jobs_url?: string; + readonly logs_url?: string; + readonly name: string; + readonly node_id: string; + readonly path: string; + readonly previous_attempt_url?: unknown; + readonly pull_requests: { + readonly base: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: string; + }; + readonly head: { + readonly ref: string; + /** Repo Ref */ + readonly repo: { + readonly id: number; + readonly name: string; + /** Format: uri */ + readonly url: string; + }; + readonly sha: 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?: ("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 */ - 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 referenced_workflows?: { + readonly path: string; + readonly ref?: string; + readonly sha: string; + }[] | null; + readonly repository?: { + readonly archive_url?: string; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly deployments_url?: string; + readonly description?: unknown; + readonly downloads_url?: string; + readonly events_url?: string; + readonly fork?: boolean; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly languages_url?: string; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly owner?: { 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 id?: number; + readonly login?: 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 type?: string; readonly url?: 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"; - /** @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 private?: boolean; + readonly pulls_url?: string; + readonly releases_url?: string; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly trees_url?: string; readonly url?: string; }; - /** 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} - */ - readonly state?: "open" | "closed"; - readonly state_reason?: string | null; - /** Format: uri */ - readonly timeline_url?: string; - /** @description Title of the issue */ - readonly title: string; + readonly rerun_url?: string; + readonly run_attempt: number; + readonly run_number: number; /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - readonly url: string; + readonly run_started_at: string; + /** @enum {string} */ + readonly status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - readonly user: { + readonly triggering_actor: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -49172,1055 +41307,930 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + readonly workflow_id: number; + readonly workflow_url?: string; + } | null; + }; + /** discussion answered event */ + readonly "webhook-discussion-answered": { + /** @enum {string} */ + readonly action: "answered"; + readonly answer: components["schemas"]["webhooks_answer"]; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion category changed event */ + readonly "webhook-discussion-category-changed": { + /** @enum {string} */ + readonly action: "category_changed"; + readonly changes: { + readonly category: { + readonly from: { + /** Format: date-time */ + readonly created_at: string; + readonly description: string; + readonly emoji: string; + readonly id: number; + readonly is_answerable: boolean; + readonly name: string; + readonly node_id?: string; + readonly repository_id: number; + readonly slug: string; + readonly updated_at: string; + }; + }; }; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** label created event */ - readonly "webhook-label-created": { + /** discussion closed event */ + readonly "webhook-discussion-closed": { + /** @enum {string} */ + readonly action: "closed"; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion_comment created event */ + readonly "webhook-discussion-comment-created": { /** @enum {string} */ readonly action: "created"; + readonly comment: components["schemas"]["webhooks_comment"]; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** Label */ - readonly label: { - /** @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 organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** label deleted event */ - readonly "webhook-label-deleted": { + /** discussion_comment deleted event */ + readonly "webhook-discussion-comment-deleted": { /** @enum {string} */ readonly action: "deleted"; + readonly comment: components["schemas"]["webhooks_comment"]; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** Label */ - readonly label: { - /** @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 organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** label edited event */ - readonly "webhook-label-edited": { + /** discussion_comment edited event */ + readonly "webhook-discussion-comment-edited": { /** @enum {string} */ readonly action: "edited"; - /** @description The changes to the label if the action was `edited`. */ - readonly changes?: { - readonly color?: { - /** @description The previous version of the color if the action was `edited`. */ + readonly changes: { + readonly body: { readonly from: string; }; - readonly description?: { - /** @description The previous version of the description if the action was `edited`. */ + }; + readonly comment: components["schemas"]["webhooks_comment"]; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion created event */ + readonly "webhook-discussion-created": { + /** @enum {string} */ + readonly action: "created"; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion deleted event */ + readonly "webhook-discussion-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion edited event */ + readonly "webhook-discussion-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes?: { + readonly body?: { readonly from: string; }; - readonly name?: { - /** @description The previous version of the name if the action was `edited`. */ + readonly title?: { readonly from: string; }; }; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** Label */ - readonly label: { - /** @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 organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase cancelled event */ - readonly "webhook-marketplace-purchase-cancelled": { + /** discussion labeled event */ + readonly "webhook-discussion-labeled": { /** @enum {string} */ - readonly action: "cancelled"; - readonly effective_date: string; + readonly action: "labeled"; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - } & { - readonly account?: { - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organization_billing_email?: string | null; - readonly type?: string; - }; - readonly billing_cycle?: string; - readonly free_trial_ends_on?: string | null; - readonly next_billing_date: string | null; - readonly on_free_trial?: boolean; - readonly plan?: { - readonly bullets?: (string | null)[]; - readonly description?: string; - readonly has_free_trial?: boolean; - readonly id?: number; - readonly monthly_price_in_cents?: number; - readonly name?: string; - /** @enum {string} */ - readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name?: string | null; - readonly yearly_price_in_cents?: number; - }; - readonly unit_count?: number; - }; + readonly label: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - readonly previous_marketplace_purchase?: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: unknown; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase changed event */ - readonly "webhook-marketplace-purchase-changed": { + /** discussion locked event */ + readonly "webhook-discussion-locked": { /** @enum {string} */ - readonly action: "changed"; - readonly effective_date: string; + readonly action: "locked"; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - } & { - readonly account?: { - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organization_billing_email?: string | null; - readonly type?: string; - }; - readonly billing_cycle?: string; - readonly free_trial_ends_on?: string | null; - readonly next_billing_date: string | null; - readonly on_free_trial?: boolean; - readonly plan?: { - readonly bullets?: (string | null)[]; - readonly description?: string; - readonly has_free_trial?: boolean; - readonly id?: number; - readonly monthly_price_in_cents?: number; - readonly name?: string; - /** @enum {string} */ - readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name?: string | null; - readonly yearly_price_in_cents?: number; - }; - readonly unit_count?: number; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion pinned event */ + readonly "webhook-discussion-pinned": { + /** @enum {string} */ + readonly action: "pinned"; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion reopened event */ + readonly "webhook-discussion-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion transferred event */ + readonly "webhook-discussion-transferred": { + /** @enum {string} */ + readonly action: "transferred"; + readonly changes: { + readonly new_discussion: components["schemas"]["discussion"]; + readonly new_repository: components["schemas"]["repository-webhooks"]; }; + readonly discussion: components["schemas"]["discussion"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - readonly previous_marketplace_purchase?: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean | null; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase pending_change event */ - readonly "webhook-marketplace-purchase-pending-change": { + /** discussion unanswered event */ + readonly "webhook-discussion-unanswered": { /** @enum {string} */ - readonly action: "pending_change"; - readonly effective_date: string; + readonly action: "unanswered"; + readonly discussion: components["schemas"]["discussion"]; + readonly old_answer: components["schemas"]["webhooks_answer"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion unlabeled event */ + readonly "webhook-discussion-unlabeled": { + /** @enum {string} */ + readonly action: "unlabeled"; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - } & { - readonly account?: { - readonly id?: number; - readonly login?: string; - readonly node_id?: string; - readonly organization_billing_email?: string | null; - readonly type?: string; - }; - readonly billing_cycle?: string; - readonly free_trial_ends_on?: string | null; - readonly next_billing_date: string | null; - readonly on_free_trial?: boolean; - readonly plan?: { - readonly bullets?: (string | null)[]; - readonly description?: string; - readonly has_free_trial?: boolean; - readonly id?: number; - readonly monthly_price_in_cents?: number; - readonly name?: string; - /** @enum {string} */ - readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name?: string | null; - readonly yearly_price_in_cents?: number; - }; - readonly unit_count?: number; - }; + readonly label: components["schemas"]["webhooks_label"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - readonly previous_marketplace_purchase?: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase pending_change_cancelled event */ - readonly "webhook-marketplace-purchase-pending-change-cancelled": { + /** discussion unlocked event */ + readonly "webhook-discussion-unlocked": { /** @enum {string} */ - readonly action: "pending_change_cancelled"; - readonly effective_date: string; + readonly action: "unlocked"; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: unknown; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - } & { - readonly next_billing_date: string; - }; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - readonly previous_marketplace_purchase?: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: unknown; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase purchased event */ - readonly "webhook-marketplace-purchase-purchased": { + /** discussion unpinned event */ + readonly "webhook-discussion-unpinned": { /** @enum {string} */ - readonly action: "purchased"; - readonly effective_date: string; + readonly action: "unpinned"; + readonly discussion: components["schemas"]["discussion"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly marketplace_purchase: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * fork event + * @description A user forks a repository. + */ + readonly "webhook-fork": { + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */ + readonly forkee: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + readonly custom_properties?: { + readonly [key: string]: unknown; }; - readonly billing_cycle: string; - readonly free_trial_ends_on: string | null; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: 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 price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; }; - readonly unit_count: number; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; } & { - readonly account?: { + readonly allow_forking?: boolean; + readonly archive_url?: string; + readonly archived?: boolean; + readonly assignees_url?: string; + readonly blobs_url?: string; + readonly branches_url?: string; + readonly clone_url?: string; + readonly collaborators_url?: string; + readonly comments_url?: string; + readonly commits_url?: string; + readonly compare_url?: string; + readonly contents_url?: string; + readonly contributors_url?: string; + readonly created_at?: string; + readonly default_branch?: string; + readonly deployments_url?: string; + readonly description?: string | null; + readonly disabled?: boolean; + readonly downloads_url?: string; + readonly events_url?: string; + /** @enum {boolean} */ + readonly fork?: true; + readonly forks?: number; + readonly forks_count?: number; + readonly forks_url?: string; + readonly full_name?: string; + readonly git_commits_url?: string; + readonly git_refs_url?: string; + readonly git_tags_url?: string; + readonly git_url?: string; + readonly has_downloads?: boolean; + readonly has_issues?: boolean; + readonly has_pages?: boolean; + readonly has_projects?: boolean; + readonly has_wiki?: boolean; + readonly homepage?: string | null; + readonly hooks_url?: string; + readonly html_url?: string; + readonly id?: number; + readonly is_template?: boolean; + readonly issue_comment_url?: string; + readonly issue_events_url?: string; + readonly issues_url?: string; + readonly keys_url?: string; + readonly labels_url?: string; + readonly language?: unknown; + readonly languages_url?: string; + readonly license?: Record; + readonly merges_url?: string; + readonly milestones_url?: string; + readonly mirror_url?: unknown; + readonly name?: string; + readonly node_id?: string; + readonly notifications_url?: string; + readonly open_issues?: number; + readonly open_issues_count?: number; + readonly owner?: { + 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; readonly id?: number; readonly login?: string; readonly node_id?: string; - readonly organization_billing_email?: string | null; + 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 billing_cycle?: string; - readonly free_trial_ends_on?: string | null; - readonly next_billing_date: string | null; - readonly on_free_trial?: boolean; - readonly plan?: { - readonly bullets?: (string | null)[]; - readonly description?: string; - readonly has_free_trial?: boolean; - readonly id?: number; - readonly monthly_price_in_cents?: number; - readonly name?: string; - /** @enum {string} */ - readonly price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name?: string | null; - readonly yearly_price_in_cents?: number; - }; - readonly unit_count?: number; + readonly private?: boolean; + readonly public?: boolean; + readonly pulls_url?: string; + readonly pushed_at?: string; + readonly releases_url?: string; + readonly size?: number; + readonly ssh_url?: string; + readonly stargazers_count?: number; + readonly stargazers_url?: string; + readonly statuses_url?: string; + readonly subscribers_url?: string; + readonly subscription_url?: string; + readonly svn_url?: string; + readonly tags_url?: string; + readonly teams_url?: string; + readonly topics?: unknown[]; + readonly trees_url?: string; + readonly updated_at?: string; + readonly url?: string; + readonly visibility?: string; + readonly watchers?: number; + readonly watchers_count?: number; }; + readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - readonly previous_marketplace_purchase?: { - readonly account: { - readonly id: number; - readonly login: string; - readonly node_id: string; - readonly organization_billing_email: string | null; - readonly type: string; - }; - readonly billing_cycle: string; - readonly free_trial_ends_on: unknown; - readonly next_billing_date?: string | null; - readonly on_free_trial: boolean; - readonly plan: { - readonly bullets: string[]; - readonly description: string; - readonly has_free_trial: boolean; - readonly id: number; - readonly monthly_price_in_cents: number; - readonly name: string; - /** @enum {string} */ - readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - readonly unit_name: string | null; - readonly yearly_price_in_cents: number; - }; - readonly unit_count: number; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** member added event */ - readonly "webhook-member-added": { + /** github_app_authorization revoked event */ + readonly "webhook-github-app-authorization-revoked": { /** @enum {string} */ - readonly action: "added"; - readonly changes?: { - readonly permission?: { - /** @enum {string} */ - readonly to: "write" | "admin" | "read"; - }; - }; + readonly action: "revoked"; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** gollum event */ + readonly "webhook-gollum": { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** User */ - readonly member: { - /** 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 organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description The pages that were updated. */ + readonly pages: { + /** + * @description The action that was performed on the page. Can be `created` or `edited`. + * @enum {string} + */ + readonly action: "created" | "edited"; + /** + * Format: uri + * @description Points to the HTML wiki page. + */ + readonly html_url: string; + /** @description The name of the page. */ + readonly page_name: string; + /** @description The latest commit SHA of the page. */ + readonly sha: string; + readonly summary: string | null; + /** @description The current page title. */ + readonly title: string; + }[]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** member edited event */ - readonly "webhook-member-edited": { + /** installation created event */ + readonly "webhook-installation-created": { /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the collaborator permissions */ - readonly changes: { - readonly old_permission?: { - /** @description The previous permissions of the collaborator if the action was edited. */ - readonly from: string; - }; - readonly permission?: { - readonly from?: string | null; - readonly to?: string | null; - }; - }; + readonly action: "created"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** User */ - readonly member: { - /** 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 installation: components["schemas"]["installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; + readonly repositories?: components["schemas"]["webhooks_repositories"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly requester?: components["schemas"]["webhooks_user"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** member removed event */ - readonly "webhook-member-removed": { + /** installation deleted event */ + readonly "webhook-installation-deleted": { /** @enum {string} */ - readonly action: "removed"; + readonly action: "deleted"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** User */ - readonly member: { - /** 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 installation: components["schemas"]["installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; + readonly repositories?: components["schemas"]["webhooks_repositories"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly requester?: unknown; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** membership added event */ - readonly "webhook-membership-added": { + /** installation new_permissions_accepted event */ + readonly "webhook-installation-new-permissions-accepted": { + /** @enum {string} */ + readonly action: "new_permissions_accepted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation: components["schemas"]["installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repositories?: components["schemas"]["webhooks_repositories"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly requester?: unknown; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** installation_repositories added event */ + readonly "webhook-installation-repositories-added": { /** @enum {string} */ readonly action: "added"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** User */ - readonly member: { - /** 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 installation: components["schemas"]["installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repositories_added: components["schemas"]["webhooks_repositories_added"]; + /** @description An array of repository objects, which were removed from the installation. */ + readonly repositories_removed: { + readonly full_name?: string; + /** @description Unique identifier of the repository */ + readonly id?: number; + /** @description The name of the repository. */ 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 organization: components["schemas"]["organization-simple-webhooks"]; + /** @description Whether the repository is private or public. */ + readonly private?: boolean; + }[]; readonly repository?: components["schemas"]["repository-webhooks"]; - /** - * @description The scope of the membership. Currently, can only be `team`. - * @enum {string} - */ - readonly scope: "team"; - /** User */ - readonly sender: { - /** 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; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** @enum {string} */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }; + readonly repository_selection: components["schemas"]["webhooks_repository_selection"]; + readonly requester: components["schemas"]["webhooks_user"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** membership removed event */ - readonly "webhook-membership-removed": { + /** installation_repositories removed event */ + readonly "webhook-installation-repositories-removed": { /** @enum {string} */ readonly action: "removed"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** User */ - readonly member: { - /** 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 installation: components["schemas"]["installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repositories_added: components["schemas"]["webhooks_repositories_added"]; + /** @description An array of repository objects, which were removed from the installation. */ + readonly repositories_removed: { + readonly full_name: string; + /** @description Unique identifier of the repository */ 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 organization: components["schemas"]["organization-simple-webhooks"]; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + }[]; readonly repository?: components["schemas"]["repository-webhooks"]; - /** - * @description The scope of the membership. Currently, can only be `team`. - * @enum {string} - */ - readonly scope: "team" | "organization"; - /** User */ - readonly sender: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ + readonly repository_selection: components["schemas"]["webhooks_repository_selection"]; + readonly requester: components["schemas"]["webhooks_user"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** installation suspend event */ + readonly "webhook-installation-suspend": { + /** @enum {string} */ + readonly action: "suspend"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation: components["schemas"]["installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repositories?: components["schemas"]["webhooks_repositories"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly requester?: unknown; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + readonly "webhook-installation-target-renamed": { + readonly account: { + readonly archived_at?: string | null; + readonly avatar_url: string; + readonly created_at?: string; + readonly description?: unknown; readonly events_url?: string; - /** Format: uri */ + readonly followers?: number; readonly followers_url?: string; - /** Format: uri-template */ + readonly following?: number; readonly following_url?: string; - /** Format: uri-template */ readonly gists_url?: string; readonly gravatar_id?: string; - /** Format: uri */ - readonly html_url?: string; + readonly has_organization_projects?: boolean; + readonly has_repository_projects?: boolean; + readonly hooks_url?: string; + readonly html_url: string; readonly id: number; - readonly login: string; + readonly is_verified?: boolean; + readonly issues_url?: string; + readonly login?: string; + readonly members_url?: string; readonly name?: string; - readonly node_id?: string; - /** Format: uri */ + readonly node_id: string; readonly organizations_url?: string; - /** Format: uri */ + readonly public_gists?: number; + readonly public_members_url?: string; + readonly public_repos?: number; readonly received_events_url?: string; - /** Format: uri */ readonly repos_url?: string; readonly site_admin?: boolean; - /** Format: uri-template */ + readonly slug?: string; readonly starred_url?: string; - /** Format: uri */ readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** @enum {string} */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ + readonly type?: string; + readonly updated_at?: string; readonly url?: string; + readonly website_url?: unknown; }; - }; - readonly "webhook-merge-group-checks-requested": { /** @enum {string} */ - readonly action: "checks_requested"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly merge_group: components["schemas"]["merge-group"]; + readonly action: "renamed"; + readonly changes: { + readonly login?: { + readonly from: string; + }; + readonly slug?: { + readonly from: string; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly target_type: string; }; - readonly "webhook-merge-group-destroyed": { + /** installation unsuspend event */ + readonly "webhook-installation-unsuspend": { /** @enum {string} */ - readonly action: "destroyed"; - /** - * @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated). - * @enum {string} - */ - readonly reason?: "merged" | "invalidated" | "dequeued"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly merge_group: components["schemas"]["merge-group"]; + readonly action: "unsuspend"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation: components["schemas"]["installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repositories?: components["schemas"]["webhooks_repositories"]; readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly requester?: unknown; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** meta deleted event */ - readonly "webhook-meta-deleted": { + /** issue_comment created event */ + readonly "webhook-issue-comment-created": { /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ - readonly hook: { - readonly active: boolean; - readonly config: { - /** @enum {string} */ - readonly content_type: "json" | "form"; - readonly insecure_ssl: string; - readonly secret?: string; + readonly action: "created"; + /** + * issue comment + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. + */ + readonly comment: { + /** + * 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 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; }; - readonly created_at: string; - readonly events: ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[]; - readonly id: number; - readonly name: string; - readonly type: 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; + 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; }; - /** @description The id of the modified webhook. */ - readonly hook_id: number; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone closed event */ - readonly "webhook-milestone-closed": { - /** @enum {string} */ - readonly action: "closed"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** - * 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; + /** @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 creator: { + 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; + } | null; + readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -50228,161 +42238,328 @@ export interface components { /** 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; + 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; + } | 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?: { + /** @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; + /** + * 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; + } | 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?: ("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; + } | 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; - 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: date-time */ + readonly merged_at?: string | null; /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly patch_url?: string; /** Format: uri */ readonly url?: string; - } | null; - readonly description: string | null; - /** Format: date-time */ - readonly due_on: string | null; - /** Format: uri */ - readonly html_url: string; - readonly id: 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 labels_url: string; - readonly node_id: string; - /** @description The number of the milestone. */ - readonly number: number; - readonly open_issues: number; + readonly repository_url: string; /** - * @description The state of the milestone. + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; - /** @description The title of the milestone. */ + 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 */ - readonly url: string; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone created event */ - readonly "webhook-milestone-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * 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"; - /** Format: uri */ - readonly url?: 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} + * Format: uri + * @description URL for the issue */ - 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; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone deleted event */ - readonly "webhook-milestone-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * 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: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -50418,67 +42595,10 @@ export interface components { /** Format: uri */ readonly url?: 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; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone edited event */ - readonly "webhook-milestone-edited": { - /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the milestone if the action was `edited`. */ - readonly changes: { - readonly description?: { - /** @description The previous version of the description if the action was `edited`. */ - readonly from: string; - }; - readonly due_on?: { - /** @description The previous version of the due date if the action was `edited`. */ - readonly from: string; - }; - readonly title?: { - /** @description The previous version of the title if the action was `edited`. */ - readonly from: string; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * 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; + } & { + readonly active_lock_reason?: string | null; /** User */ - readonly creator: { + readonly assignee: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -50514,228 +42634,97 @@ export interface components { /** Format: uri */ readonly url?: 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; + readonly assignees?: 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: { + /** @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 The state of the milestone. + * @description State of the issue; either 'open' or 'closed' * @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; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone opened event */ - readonly "webhook-milestone-opened": { - /** @enum {string} */ - readonly action: "opened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * 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 timeline_url?: string; + readonly title?: string; + readonly updated_at?: string; + readonly url?: string; + readonly user?: { 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 id?: number; + readonly login?: 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 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; - }; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** org_block blocked event */ - readonly "webhook-org-block-blocked": { - /** @enum {string} */ - readonly action: "blocked"; - /** User */ - readonly blocked_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; - 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 enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** org_block unblocked event */ - readonly "webhook-org-block-unblocked": { - /** @enum {string} */ - readonly action: "unblocked"; - /** User */ - readonly blocked_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; - 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 enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; + 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-webhooks"]; }; - /** organization deleted event */ - readonly "webhook-organization-deleted": { + /** 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"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - readonly membership?: { - /** Format: uri */ - readonly organization_url: string; - readonly role: string; - readonly state: string; - /** Format: uri */ - readonly url: string; + /** @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 user: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -50767,34 +42756,11 @@ 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; - }; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** organization member_added event */ - readonly "webhook-organization-member-added": { - /** @enum {string} */ - readonly action: "member_added"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - readonly membership: { - /** Format: uri */ - readonly organization_url: string; - readonly role: string; - readonly state: string; - /** Format: uri */ - readonly url: string; - /** User */ - readonly user: { + readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -50826,34 +42792,304 @@ 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; - }; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** organization member_invited event */ - readonly "webhook-organization-member-invited": { - /** @enum {string} */ - readonly action: "member_invited"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The invitation for the user or email if the action is `member_invited`. */ - readonly invitation: { + } | 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 created_at: string; - readonly email: string | null; + readonly closed_at: string | null; + readonly comments: number; + /** Format: uri */ + readonly comments_url: string; /** Format: date-time */ - readonly failed_at: string | null; - readonly failed_reason: string | null; + 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?: { + /** @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; + /** + * 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; + } | 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?: ("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 */ + 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; + } | 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"; + /** @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; + }; + /** 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 invitation_teams_url: string; + 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 inviter: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -50885,76 +43121,14 @@ 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; - readonly login: string | null; - readonly node_id: string; - readonly role: string; - readonly team_count: number; - readonly invitation_source?: string; - }; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - /** 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; - 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; - }; - /** organization member_removed event */ - readonly "webhook-organization-member-removed": { - /** @enum {string} */ - readonly action: "member_removed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - readonly membership: { - /** Format: uri */ - readonly organization_url: string; - readonly role: string; - readonly state: string; - /** Format: uri */ - readonly url: string; + } & { + readonly active_lock_reason?: string | null; /** User */ - readonly user: { + readonly assignee: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -50986,39 +43160,102 @@ 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; + readonly assignees?: 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: { + /** @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; + 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 organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** organization renamed event */ - readonly "webhook-organization-renamed": { + /** issue_comment edited event */ + readonly "webhook-issue-comment-edited": { /** @enum {string} */ - readonly action: "renamed"; - readonly changes?: { - readonly login?: { - readonly from?: string; - }; - }; + 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"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - readonly membership?: { - /** Format: uri */ - readonly organization_url: string; - readonly role: string; - readonly state: string; - /** Format: uri */ - readonly url: string; + /** @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 user: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51050,53 +43287,11 @@ 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; - }; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Ruby Gems metadata */ - readonly "webhook-rubygems-metadata": { - readonly name?: string; - readonly description?: string; - readonly readme?: string; - readonly homepage?: string; - readonly version_info?: { - readonly version?: string; - }; - readonly platform?: string; - readonly metadata?: { - readonly [key: string]: string | undefined; - }; - readonly repo?: string; - readonly dependencies?: { - readonly [key: string]: string | undefined; - }[]; - readonly commit_oid?: string; - }; - /** package published event */ - readonly "webhook-package-published": { - /** @enum {string} */ - readonly action: "published"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description Information about the package. */ - readonly package: { - readonly created_at: string | null; - readonly description: string | null; - readonly ecosystem: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; - /** User */ - readonly owner: { + readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51128,14 +43323,62 @@ 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; - readonly package_type: string; - readonly package_version: { + } | 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?: { + /** @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; + /** + * 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 author?: { + readonly creator: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51167,193 +43410,399 @@ 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; - readonly body?: string | Record; - readonly body_html?: string; - readonly container_metadata?: { - readonly labels?: Record; - readonly manifest?: Record; - readonly tag?: { - readonly digest?: string; - readonly name?: string; - }; - } | null; - readonly created_at?: string; - readonly description: string; - readonly docker_metadata?: { - readonly tags?: string[]; - }[]; - readonly draft?: boolean; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; /** Format: uri */ readonly html_url: string; readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: { - readonly [key: string]: unknown; - }[]; + /** 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?: ("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 npm_metadata?: { - readonly name?: string; - readonly version?: string; - readonly npm_user?: string; - readonly author?: Record; - readonly bugs?: Record; - readonly dependencies?: Record; - readonly dev_dependencies?: Record; - readonly peer_dependencies?: Record; - readonly optional_dependencies?: Record; - readonly description?: string; - readonly dist?: Record; - readonly git_head?: string; - readonly homepage?: string; - readonly license?: string; - readonly main?: string; - readonly repository?: Record; - readonly scripts?: Record; - readonly id?: string; - readonly node_version?: string; - readonly npm_version?: string; - readonly has_shrinkwrap?: boolean; - readonly maintainers?: Record[]; - readonly contributors?: Record[]; - readonly engines?: Record; - readonly keywords?: string[]; - readonly files?: string[]; - readonly bin?: Record; - readonly man?: Record; - readonly directories?: Record; - readonly os?: string[]; - readonly cpu?: string[]; - readonly readme?: string; - readonly installation_command?: string; - readonly release_id?: number; - readonly commit_oid?: string; - readonly published_via_actions?: boolean; - readonly deleted_by_id?: number; - } | null; - readonly nuget_metadata?: { - readonly id?: number | string; - readonly name?: string; - readonly value?: boolean | string | number | { - readonly url?: string; - readonly branch?: string; - readonly commit?: string; - readonly type?: string; - }; - }[] | null; - readonly package_files: { - readonly content_type: string; - readonly created_at: string; + readonly node_id: string; + /** User */ + readonly owner: { /** Format: uri */ - readonly download_url: string; - readonly id: number; - readonly md5: string | null; - readonly name: string; - readonly sha1: string | null; - readonly sha256: string | null; - readonly size: number; - readonly state: string | null; - readonly updated_at: string; - }[]; - readonly package_url?: string; - readonly prerelease?: boolean; - readonly release?: { - /** User */ - readonly author: { - /** 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 created_at: string; - readonly draft: boolean; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; /** Format: uri */ - readonly html_url: string; + 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 name: string | null; - readonly prerelease: boolean; - readonly published_at: string; - readonly tag_name: string; - readonly target_commitish: string; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly url: string; + 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; + /** @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"; }; - readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - readonly source_url?: string; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish?: string; - readonly target_oid?: string; - readonly updated_at?: string; - readonly version: string; + /** @description The slug name of the GitHub app */ + readonly slug?: string; + /** Format: date-time */ + readonly updated_at: string | null; } | null; - readonly registry: { + 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; + 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} + */ + 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; + 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; + } | 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 about_url: string; - readonly name: string; - readonly type: string; + readonly organizations_url?: string; /** Format: uri */ - readonly url: string; - readonly vendor: string; + 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; } | null; - readonly updated_at: string | null; + readonly assignees?: 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: { + /** @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; + 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 repository?: components["schemas"]["repository-webhooks"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** package updated event */ - readonly "webhook-package-updated": { - /** @enum {string} */ - readonly action: "updated"; + /** 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"]; + readonly issue: components["schemas"]["webhooks_issue"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description Information about the package. */ - readonly package: { - readonly created_at: string; - readonly description: string | null; - readonly ecosystem: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** 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; /** User */ - readonly owner: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51385,14 +43834,98 @@ 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; - readonly package_type: string; - readonly package_version: { + readonly assignees: ({ + /** 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; + } | 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?: { + /** @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; + /** + * 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 author: { + readonly creator: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51424,130 +43957,217 @@ 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; - readonly body: string; - readonly body_html: string; - readonly created_at: string; - readonly description: string; - readonly docker_metadata?: { - readonly tags?: string[]; - }[]; - readonly draft?: boolean; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; /** Format: uri */ readonly html_url: string; readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: { - readonly [key: string]: unknown; - }[]; + /** 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?: ("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 */ + 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 package_files: { - readonly content_type: string; - readonly created_at: string; + readonly node_id: string; + /** User */ + readonly owner: { /** Format: uri */ - readonly download_url: string; - readonly id: number; - readonly md5: string | null; - readonly name: string; - readonly sha1: string | null; - readonly sha256: string; - readonly size: number; - readonly state: string; - readonly updated_at: string; - }[]; - readonly package_url?: string; - readonly prerelease?: boolean; - readonly release?: { - /** User */ - readonly author: { - /** 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 created_at: string; - readonly draft: boolean; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; + /** Format: uri-template */ + readonly events_url?: string; /** Format: uri */ - readonly html_url: string; + 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 name: string; - readonly prerelease: boolean; - readonly published_at: string; - readonly tag_name: string; - readonly target_commitish: string; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly url: string; + 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; + /** @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"; }; - readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + /** @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 source_url?: string; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish: string; - readonly target_oid: string; - readonly updated_at: string; - readonly version: string; - }; - readonly registry: { + readonly diff_url?: string; /** Format: uri */ - readonly about_url: string; - readonly name: string; - readonly type: string; + 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; + 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; - readonly vendor: string; - } | null; - readonly updated_at: string; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** page_build event */ - readonly "webhook-page-build": { - /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ - readonly build: { - readonly commit: string | null; - readonly created_at: string; - readonly duration: number; - readonly error: { - readonly message: string | null; }; + /** 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 pusher: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51579,137 +44199,89 @@ 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; - readonly status: string; - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly id: number; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** personal_access_token_request approved event */ - readonly "webhook-personal-access-token-request-approved": { - /** @enum {string} */ - readonly action: "approved"; - readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly installation: components["schemas"]["simple-installation"]; - }; - /** personal_access_token_request cancelled event */ - readonly "webhook-personal-access-token-request-cancelled": { - /** @enum {string} */ - readonly action: "cancelled"; - readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly installation: components["schemas"]["simple-installation"]; - }; - /** personal_access_token_request created event */ - readonly "webhook-personal-access-token-request-created": { - /** @enum {string} */ - readonly action: "created"; - readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly installation: components["schemas"]["simple-installation"]; - }; - /** personal_access_token_request denied event */ - readonly "webhook-personal-access-token-request-denied": { - /** @enum {string} */ - readonly action: "denied"; - readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly installation: components["schemas"]["simple-installation"]; - }; - readonly "webhook-ping": { - /** - * Webhook - * @description The webhook that is being pinged - */ - readonly hook?: { - /** @description Determines whether the hook is actually triggered for the events it subscribes to. */ - readonly active: boolean; - /** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */ - readonly app_id?: number; - readonly config: { - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly url?: components["schemas"]["webhook-config-url"]; + } & { + readonly active_lock_reason?: string | null; + readonly assignee?: Record; + readonly assignees?: 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?: 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; }; - /** Format: date-time */ - readonly created_at: string; - /** Format: uri */ - readonly deliveries_url?: string; - /** @description Determines what events the hook is triggered for. Default: ['push']. */ - readonly events: string[]; - /** @description Unique identifier of the webhook. */ - readonly id: number; - readonly last_response?: components["schemas"]["hook-response"]; - /** - * @description The type of webhook. The only valid value is 'web'. - * @enum {string} - */ - readonly name: "web"; - /** Format: uri */ - readonly ping_url?: string; - /** Format: uri */ - readonly test_url?: string; - readonly type: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ + 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; + 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; + }; }; - /** @description The ID of the webhook that triggered the ping. */ - readonly hook_id?: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - /** @description Random string of GitHub zen. */ - readonly zen?: string; - }; - /** @description The webhooks ping payload encoded with URL encoding. */ - readonly "webhook-ping-form-encoded": { - /** @description A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** project_card converted event */ - readonly "webhook-project-card-converted": { + /** issues deleted event */ + readonly "webhook-issues-deleted": { /** @enum {string} */ - readonly action: "converted"; - readonly changes: { - readonly note: { - readonly from: string; - }; - }; + readonly action: "deleted"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - readonly project_card: { - readonly after_id?: number | null; - /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number; - /** Format: uri */ - readonly column_url: string; - /** Format: uri */ - readonly content_url?: string; - /** Format: date-time */ - readonly created_at: string; + /** + * 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 creator: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51745,41 +44317,336 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - /** @description The project card's ID */ + readonly assignees: ({ + /** 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?: { + /** @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; + /** + * 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"; + /** Format: uri */ + readonly url?: 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 note: string | null; + 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?: ("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; + } | 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"; + /** @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; + }; + /** 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 project_url: string; + 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 */ + /** + * Format: uri + * @description URL for the issue + */ readonly url: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_card created event */ - readonly "webhook-project-card-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - readonly project_card: { - readonly after_id?: number | null; - /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number; - /** Format: uri */ - readonly column_url: string; - /** Format: uri */ - readonly content_url?: string; - /** Format: date-time */ - readonly created_at: string; /** User */ - readonly creator: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51815,41 +44682,26 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - /** @description The project card's ID */ - readonly id: number; - readonly node_id: string; - readonly note: string | null; - /** Format: uri */ - readonly project_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; }; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** project_card deleted event */ - readonly "webhook-project-card-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"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - readonly project_card: { - readonly after_id?: number | null; - /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number | null; - /** Format: uri */ - readonly column_url: string; - /** Format: uri */ - readonly content_url?: string; - /** Format: date-time */ - readonly created_at: string; + /** + * 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 creator: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51885,46 +44737,7 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - /** @description The project card's ID */ - readonly id: number; - readonly node_id: string; - readonly note: string | null; - /** Format: uri */ - readonly project_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_card edited event */ - readonly "webhook-project-card-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly note: { - readonly from: string | null; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - readonly project_card: { - readonly after_id?: number | null; - /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number; - /** Format: uri */ - readonly column_url: string; - /** Format: uri */ - readonly content_url?: string; - /** Format: date-time */ - readonly created_at: string; - /** User */ - readonly creator: { + readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -51956,147 +44769,304 @@ 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; - /** @description The project card's ID */ - readonly id: number; - readonly node_id: string; - readonly note: string | null; - /** Format: uri */ - readonly project_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 updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_card moved event */ - readonly "webhook-project-card-moved": { - /** @enum {string} */ - readonly action: "moved"; - readonly changes?: { - readonly column_id: { - readonly from: number; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly project_card: { - readonly after_id?: number | null; - /** @description Whether or not the card is archived */ - readonly archived: boolean; - readonly column_id: number; - /** Format: uri */ - readonly column_url: string; + readonly closed_at: string | null; + readonly comments: number; /** Format: uri */ - readonly content_url?: string; + readonly comments_url: string; /** Format: date-time */ readonly created_at: string; - /** User */ - readonly creator: { + readonly draft?: boolean; + /** Format: uri */ + readonly events_url: string; + /** Format: uri */ + readonly html_url: string; + /** Format: int64 */ + readonly id: number; + readonly labels?: ({ + /** @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; + } | null; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; - /** Format: uri-template */ - readonly events_url?: string; + readonly html_url: string; + readonly id: number; /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + 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 html_url?: string; - readonly id: number; - readonly login: string; - readonly name?: string; - readonly node_id?: string; + 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?: ("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 organizations_url?: string; + readonly external_url: string | null; /** Format: uri */ - readonly received_events_url?: string; + 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; + } | 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 repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; + readonly diff_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly html_url?: string; + /** Format: date-time */ + readonly merged_at?: string | null; + /** Format: uri */ + readonly patch_url?: string; /** Format: uri */ readonly url?: string; - } | null; - /** @description The project card's ID */ - readonly id: number; - readonly node_id: string; - readonly note: string | null; - /** Format: uri */ - readonly project_url: string; - /** Format: date-time */ - readonly updated_at: string; + }; + /** 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 url: string; - } & { - readonly after_id: number | null; - readonly archived?: boolean; - readonly column_id?: number; - readonly column_url?: string; - readonly created_at?: string; - readonly creator?: { - 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; - 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; - } | null; - readonly id?: number; - readonly node_id?: string; - readonly note?: string | null; - readonly project_url?: string; - readonly updated_at?: string; - readonly url?: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project closed event */ - readonly "webhook-project-closed": { - /** @enum {string} */ - readonly action: "closed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - readonly project: { - /** @description Body of the project */ - readonly body: string | null; + 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 columns_url: string; + readonly timeline_url?: string; + /** @description Title of the issue */ + readonly title: string; /** Format: date-time */ - readonly created_at: string; + readonly updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + readonly url: string; /** User */ - readonly creator: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -52128,170 +45098,42 @@ 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; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - /** @description Name of the project */ - readonly name: string; - readonly node_id: string; - readonly number: number; - /** Format: uri */ - readonly owner_url: string; - /** - * @description State of the project; either 'open' or 'closed' - * @enum {string} - */ - readonly state: "open" | "closed"; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_column created event */ - readonly "webhook-project-column-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - readonly project_column: { - readonly after_id?: number | null; - /** Format: uri */ - readonly cards_url: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The unique identifier of the project column */ - readonly id: number; - /** @description Name of the project column */ - readonly name: string; - readonly node_id: string; - /** Format: uri */ - readonly project_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** project_column deleted event */ - readonly "webhook-project-column-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + readonly milestone?: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - readonly project_column: { - readonly after_id?: number | null; - /** Format: uri */ - readonly cards_url: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The unique identifier of the project column */ - readonly id: number; - /** @description Name of the project column */ - readonly name: string; - readonly node_id: string; - /** Format: uri */ - readonly project_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** project_column edited event */ - readonly "webhook-project-column-edited": { + /** issues edited event */ + readonly "webhook-issues-edited": { /** @enum {string} */ readonly action: "edited"; + /** @description The changes to the issue. */ readonly changes: { - readonly name?: { + 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"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - readonly project_column: { - readonly after_id?: number | null; - /** Format: uri */ - readonly cards_url: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The unique identifier of the project column */ - readonly id: number; - /** @description Name of the project column */ - readonly name: string; - readonly node_id: string; - /** Format: uri */ - readonly project_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** project_column moved event */ - readonly "webhook-project-column-moved": { - /** @enum {string} */ - readonly action: "moved"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - readonly project_column: { - readonly after_id?: number | null; - /** Format: uri */ - readonly cards_url: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The unique identifier of the project column */ - readonly id: number; - /** @description Name of the project column */ - readonly name: string; - readonly node_id: string; - /** Format: uri */ - readonly project_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project created event */ - readonly "webhook-project-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - readonly project: { - /** @description Body of the project */ - readonly body: string | null; - /** Format: uri */ - readonly columns_url: string; - /** Format: date-time */ - readonly created_at: string; + /** + * 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 creator: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -52323,49 +45165,340 @@ 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; + readonly assignees: ({ + /** 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; + } | 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; - /** @description Name of the project */ - readonly name: string; + readonly labels?: { + /** @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; + /** + * 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; + } | 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?: ("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 */ + 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; + } | 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; + }; + /** 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 owner_url: string; + readonly repository_url: string; /** - * @description State of the project; either 'open' or 'closed' + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; + 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 */ + /** + * Format: uri + * @description URL for the issue + */ readonly url: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project deleted event */ - readonly "webhook-project-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - readonly project: { - /** @description Body of the project */ - readonly body: string | null; - /** Format: uri */ - readonly columns_url: string; - /** Format: date-time */ - readonly created_at: string; /** User */ - readonly creator: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -52397,60 +45530,31 @@ 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; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - /** @description Name of the project */ - readonly name: string; - readonly node_id: string; - readonly number: number; - /** Format: uri */ - readonly owner_url: string; - /** - * @description State of the project; either 'open' or 'closed' - * @enum {string} - */ - readonly state: "open" | "closed"; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; }; - readonly repository?: components["schemas"]["nullable-repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + 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-webhooks"]; }; - /** project edited event */ - readonly "webhook-project-edited": { + /** issues labeled event */ + readonly "webhook-issues-labeled": { /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the project if the action was `edited`. */ - readonly changes?: { - readonly body?: { - /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; - }; - readonly name?: { - /** @description The changes to the project if the action was `edited`. */ - readonly from: string; - }; - }; + readonly action: "labeled"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - readonly project: { - /** @description Body of the project */ - readonly body: string | null; - /** Format: uri */ - readonly columns_url: string; - /** Format: date-time */ - readonly created_at: string; + /** + * 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 creator: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -52482,49 +45586,11 @@ 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; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - /** @description Name of the project */ - readonly name: string; - readonly node_id: string; - readonly number: number; - /** Format: uri */ - readonly owner_url: string; - /** - * @description State of the project; either 'open' or 'closed' - * @enum {string} - */ - readonly state: "open" | "closed"; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** project reopened event */ - readonly "webhook-project-reopened": { - /** @enum {string} */ - readonly action: "reopened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - readonly project: { - /** @description Body of the project */ - readonly body: string | null; - /** Format: uri */ - readonly columns_url: string; - /** Format: date-time */ - readonly created_at: string; - /** User */ - readonly creator: { + readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -52556,300 +45622,360 @@ 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; + } | 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; - /** @description Name of the project */ - readonly name: string; + readonly labels?: { + /** @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; + /** + * 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; + } | 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?: ("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 */ + 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; + } | 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; + }; + /** 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 owner_url: string; + readonly repository_url: string; /** - * @description State of the project; either 'open' or 'closed' + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - readonly state: "open" | "closed"; + 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 */ + /** + * 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; + 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; + } | null; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Closed Event */ - readonly "webhook-projects-v2-project-closed": { - /** @enum {string} */ - readonly action: "closed"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** @description A project was created */ - readonly "webhook-projects-v2-project-created": { - /** @enum {string} */ - readonly action: "created"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Deleted Event */ - readonly "webhook-projects-v2-project-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Edited Event */ - readonly "webhook-projects-v2-project-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly description?: { - readonly from?: string | null; - readonly to?: string | null; - }; - readonly public?: { - readonly from?: boolean; - readonly to?: boolean; - }; - readonly short_description?: { - readonly from?: string | null; - readonly to?: string | null; - }; - readonly title?: { - readonly from?: string; - readonly to?: string; - }; - }; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Archived Event */ - readonly "webhook-projects-v2-item-archived": { - /** @enum {string} */ - readonly action: "archived"; - readonly changes: { - readonly archived_at?: { - /** Format: date-time */ - readonly from?: string | null; - /** Format: date-time */ - readonly to?: string | null; - }; - }; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Converted Event */ - readonly "webhook-projects-v2-item-converted": { - /** @enum {string} */ - readonly action: "converted"; - readonly changes: { - readonly content_type?: { - readonly from?: string | null; - readonly to?: string; - }; - }; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Created Event */ - readonly "webhook-projects-v2-item-created": { - /** @enum {string} */ - readonly action: "created"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Deleted Event */ - readonly "webhook-projects-v2-item-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Edited Event */ - readonly "webhook-projects-v2-item-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes?: { - readonly field_value: { - readonly field_node_id?: string; - readonly field_type?: string; - }; - } | { - readonly body: { - readonly from?: string | null; - readonly to?: string | null; - }; - }; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Reordered Event */ - readonly "webhook-projects-v2-item-reordered": { - /** @enum {string} */ - readonly action: "reordered"; - readonly changes: { - readonly previous_projects_v2_item_node_id?: { - readonly from?: string | null; - readonly to?: string | null; - }; - }; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Restored Event */ - readonly "webhook-projects-v2-item-restored": { - /** @enum {string} */ - readonly action: "restored"; - readonly changes: { - readonly archived_at?: { - /** Format: date-time */ - readonly from?: string | null; - /** Format: date-time */ - readonly to?: string | null; - }; - }; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2_item: components["schemas"]["projects-v2-item"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Reopened Event */ - readonly "webhook-projects-v2-project-reopened": { - /** @enum {string} */ - readonly action: "reopened"; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization: components["schemas"]["organization-simple-webhooks"]; - readonly projects_v2: components["schemas"]["projects-v2"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** public event */ - readonly "webhook-public": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; + 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-webhooks"]; }; - /** pull_request assigned event */ - readonly "webhook-pull-request-assigned": { + /** issues locked event */ + readonly "webhook-issues-locked": { /** @enum {string} */ - readonly action: "assigned"; - /** 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 action: "locked"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - readonly pull_request: { - readonly _links: { - /** Link */ - readonly comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly commits: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly issue: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comment: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly statuses: { - /** Format: uri-template */ - readonly href: string; - }; - }; + /** + * 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; - readonly additions?: number; /** User */ - readonly assignee: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -52881,7 +46007,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; } | null; @@ -52917,7 +46043,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; } | null)[]; @@ -52927,345 +46053,53 @@ export interface components { * @enum {string} */ readonly author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. - */ - readonly auto_merge: { - /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; - /** @description Title for the merge commit message. */ - readonly commit_title: string | null; - /** User */ - readonly enabled_by: { - /** 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; - /** - * @description The merge method to use. - * @enum {string} - */ - readonly merge_method: "merge" | "squash" | "rebase"; - } | null; - readonly base: { - readonly label: string; - readonly ref: string; + /** @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?: ({ + /** @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; /** - * Repository - * @description A git repository - */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; - /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: 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; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - }; - readonly sha: string; + * Format: uri + * @description URL for the label + */ + readonly url: string; + } | null)[]; + /** Format: uri-template */ + readonly labels_url: string; + /** @enum {boolean} */ + readonly locked: true; + /** + * 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 user: { + readonly creator: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -53301,311 +46135,53 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - }; - readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; - /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; - /** Format: uri */ - readonly commits_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; - /** Format: uri */ - readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string | null; - readonly ref: string; + 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; /** - * Repository - * @description A git repository + * @description The state of the milestone. + * @enum {string} */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; - /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: 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; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - } | null; - readonly sha: 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?: ("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 */ + 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 user: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -53641,38 +46217,186 @@ export interface components { /** Format: uri */ readonly url?: 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"; + /** @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; + }; + /** 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 html_url: string; - readonly id: number; + 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 issue_url: string; - readonly labels: { - /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; - readonly description: string | null; + 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; 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 locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ - readonly merged_at: string | null; + 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 organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** 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 merged_by?: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -53708,6 +46432,82 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; + readonly assignees: ({ + /** 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?: ({ + /** @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. @@ -53780,300 +46580,188 @@ export interface components { readonly url: string; } | null; readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: (({ - /** 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; - } | null) | { - readonly deleted?: boolean; - /** @description Description of the team */ + /** + * 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?: ("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 team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ + /** @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; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; + /** User */ + readonly owner: { /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly events_url?: string; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - })[]; - readonly requested_teams: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; + 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; - /** @description Unique identifier of the team */ + 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 members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; + readonly url?: string; } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }[]; - /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; - /** Format: uri */ - readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - readonly state: "open" | "closed"; - /** Format: uri */ - readonly statuses_url: string; - /** @description The title of the pull request. */ - readonly title: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - 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; - 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; - } | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request auto_merge_disabled event */ - readonly "webhook-pull-request-auto-merge-disabled": { - /** @enum {string} */ - readonly action: "auto_merge_disabled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - readonly pull_request: { - readonly _links: { - /** Link */ - readonly comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly commits: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly issue: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comment: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly statuses: { - /** Format: uri-template */ - readonly href: string; + /** @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"; }; - }; - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; - /** 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; + /** @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 received_events_url?: string; + readonly diff_url?: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; + readonly html_url?: string; + /** Format: date-time */ + readonly merged_at?: string | null; /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly patch_url?: string; /** Format: uri */ readonly url?: string; - } | null; - readonly assignees: ({ + }; + /** 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} + */ + 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; @@ -54108,24 +46796,27 @@ export interface components { 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"; + } | 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-webhooks"]; + }; + /** issues opened event */ + readonly "webhook-issues-opened": { + /** @enum {string} */ + readonly action: "opened"; + readonly changes?: { /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly auto_merge: { - /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; - /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + readonly old_issue: { + /** @enum {string|null} */ + readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly enabled_by: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -54161,299 +46852,7 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - /** - * @description The merge method to use. - * @enum {string} - */ - readonly merge_method: "merge" | "squash" | "rebase"; - } | null; - readonly base: { - readonly label: string; - readonly ref: string; - /** - * Repository - * @description A git repository - */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; - /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: 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; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - }; - readonly sha: string; - /** User */ - readonly user: { + readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -54485,205 +46884,142 @@ export interface components { /** Format: uri */ readonly subscriptions_url?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - } | null; - }; - readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; - /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; - /** Format: uri */ - readonly commits_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; - /** Format: uri */ - readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; - /** - * Repository - * @description A git repository - */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; + 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?: { + /** @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; /** - * @description Whether discussions are enabled. - * @default false + * Format: uri + * @description URL for the label */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; + readonly url: string; + }[]; + /** 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"; + /** Format: uri */ + readonly url?: string; + } | null; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + readonly labels_url: string; + readonly node_id: string; + /** @description The number of the milestone. */ + readonly number: number; + readonly open_issues: number; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @description The state of the milestone. * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + readonly state: "open" | "closed"; + /** @description The title of the milestone. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; + 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?: ("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 mirror_url: string | null; - /** @description The name of the repository. */ + 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; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; /** User */ readonly owner: { /** Format: uri */ @@ -54721,79 +47057,327 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; + /** @description The set of permissions for the GitHub app */ readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + /** @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"; + /** @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 Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; + /** @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 stargazers_url: string; + 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; + 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} + */ + 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 statuses_url: string; + readonly events_url?: string; /** Format: uri */ - readonly subscribers_url: string; + 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 subscription_url: string; + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly svn_url: string; + readonly organizations_url?: string; /** Format: uri */ - readonly tags_url: string; + readonly received_events_url?: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; + readonly repos_url?: string; + readonly site_admin?: boolean; /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + } | null; + /** + * Repository + * @description A git repository + */ + readonly old_repository: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + readonly custom_properties?: { + readonly [key: string]: unknown; + }; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** @description Whether the repository has discussions enabled. */ + readonly has_discussions?: boolean; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; /** Format: uri */ - readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - }; - readonly sha: string; + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: string; /** User */ - readonly user: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -54829,13 +47413,160 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require commit signoff. */ + readonly web_commit_signoff_required?: boolean; }; + }; + 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: ({ + /** 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; - /** Format: uri */ - readonly issue_url: string; - readonly labels: { + readonly labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ readonly color: string; readonly default: boolean; @@ -54850,17 +47581,329 @@ export interface components { */ readonly url: string; }[]; - readonly locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | 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; + } | 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?: ("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 */ + 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; + } | 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; + }; + /** 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} + */ + 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 merged_at: string | null; + 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; + 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 organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues pinned event */ + readonly "webhook-issues-pinned": { + /** @enum {string} */ + readonly action: "pinned"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly issue: components["schemas"]["webhooks_issue_2"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues reopened event */ + readonly "webhook-issues-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + 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 merged_by?: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -54896,6 +47939,82 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; + readonly assignees: ({ + /** 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; + } | 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?: ({ + /** @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. @@ -54939,7 +48058,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; @@ -54968,165 +48087,185 @@ export interface components { readonly url: string; } | null; readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; - /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: (({ - /** 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; - } | null) | { - readonly deleted?: boolean; - /** @description Description of the team */ + /** + * 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?: ("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 */ readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ + /** @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; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; + /** User */ + readonly owner: { /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly events_url?: string; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - })[]; - readonly requested_teams: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; + 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; - /** @description Unique identifier of the team */ + 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 members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; + readonly url?: string; } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url?: string; + /** @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: uri - * @description URL for the team - */ + /** 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; - }[]; - /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: 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 review_comments_url: string; + readonly repository_url: string; /** - * @description State of this Pull Request. Either `open` or `closed`. + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ readonly state: "open" | "closed"; + readonly state_reason?: string | null; /** Format: uri */ - readonly statuses_url: string; - /** @description The title of the pull request. */ + readonly timeline_url?: string; + /** @description Title of the issue */ readonly title: string; /** Format: date-time */ readonly updated_at: string; - /** Format: uri */ + /** + * Format: uri + * @description URL for the issue + */ readonly url: string; /** User */ readonly user: { @@ -55160,161 +48299,30 @@ export interface components { readonly starred_url?: string; /** Format: uri */ readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ - readonly url?: string; - } | null; - }; - readonly reason: string; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request auto_merge_enabled event */ - readonly "webhook-pull-request-auto-merge-enabled": { - /** @enum {string} */ - readonly action: "auto_merge_enabled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - readonly pull_request: { - readonly _links: { - /** Link */ - readonly comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly commits: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly issue: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comment: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly statuses: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; - /** 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: ({ - /** 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"; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + readonly url?: string; + } | null; + }; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues transferred event */ + readonly "webhook-issues-transferred": { + /** @enum {string} */ + readonly action: "transferred"; + readonly changes: { /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - readonly auto_merge: { - /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; - /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + readonly new_issue: { + /** @enum {string|null} */ + readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - readonly enabled_by: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -55350,299 +48358,7 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - /** - * @description The merge method to use. - * @enum {string} - */ - readonly merge_method: "merge" | "squash" | "rebase"; - } | null; - readonly base: { - readonly label: string; - readonly ref: string; - /** - * Repository - * @description A git repository - */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; - /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: 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; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - }; - readonly sha: string; - /** User */ - readonly user: { + readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -55677,202 +48393,139 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; - } | null; - }; - readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; - /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; - /** Format: uri */ - readonly commits_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; - /** Format: uri */ - readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; + } | null)[]; /** - * Repository - * @description A git repository + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: 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?: { + /** @description 6-character hex code, without the leading #, identifying the color */ + readonly color: string; + readonly default: boolean; readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; + readonly id: number; + /** @description The name of the label. */ + readonly name: string; + readonly node_id: string; /** - * @description Whether discussions are enabled. - * @default false + * Format: uri + * @description URL for the label */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; + readonly url: string; + }[]; + /** 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"; + /** Format: uri */ + readonly url?: string; + } | null; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + readonly labels_url: string; + readonly node_id: string; + /** @description The number of the milestone. */ + readonly number: number; + readonly open_issues: number; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @description The state of the milestone. * @enum {string} */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + readonly state: "open" | "closed"; + /** @description The title of the milestone. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; + 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?: ("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 mirror_url: string | null; - /** @description The name of the repository. */ + 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; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; /** User */ readonly owner: { /** Format: uri */ @@ -55910,77 +48563,129 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; + /** @description The set of permissions for the GitHub app */ readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; + /** @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"; + /** @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 Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; + /** @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 subscription_url: string; + readonly diff_url?: string; /** Format: uri */ - readonly svn_url: string; + readonly html_url?: string; + /** Format: date-time */ + readonly merged_at?: string | null; /** Format: uri */ - readonly tags_url: string; + readonly patch_url?: string; /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; + readonly url?: string; + }; + /** 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; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; }; - readonly sha: string; + /** 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 */ @@ -56019,37 +48724,302 @@ export interface components { readonly url?: string; } | null; }; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - /** Format: uri */ - readonly issue_url: string; - readonly labels: { - /** @description 6-character hex code, without the leading #, identifying the color */ - readonly color: string; - readonly default: boolean; + /** + * Repository + * @description A git repository + */ + readonly new_repository: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + readonly custom_properties?: { + readonly [key: string]: unknown; + }; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ readonly id: number; - /** @description The name of the label. */ + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ readonly name: string; readonly node_id: string; - /** - * Format: uri - * @description URL for the label - */ + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: 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; + } | null; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ readonly url: string; - }[]; - readonly locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ - readonly merged_at: string | null; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly issue: components["schemas"]["webhooks_issue_2"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues unassigned event */ + readonly "webhook-issues-unassigned": { + /** + * @description The action that was performed. + * @enum {string} + */ + readonly action: "unassigned"; + readonly assignee?: components["schemas"]["webhooks_user_mannequin"]; + 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-webhooks"]; + }; + /** issues unlabeled event */ + readonly "webhook-issues-unlabeled": { + /** @enum {string} */ + readonly action: "unlabeled"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly issue: components["schemas"]["webhooks_issue"]; + 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-webhooks"]; + }; + /** issues unlocked event */ + readonly "webhook-issues-unlocked": { + /** @enum {string} */ + readonly action: "unlocked"; + 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 merged_by?: { + readonly assignee?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -56085,6 +49055,83 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; + readonly assignees: ({ + /** 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?: ({ + /** @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; + /** @enum {boolean} */ + readonly locked: false; /** * Milestone * @description A collection of related issues and pull requests. @@ -56128,7 +49175,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; } | null; @@ -56157,12 +49204,188 @@ export interface components { readonly url: string; } | null; readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ 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?: ("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 */ + 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; + } | 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"; + /** @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; + }; + /** 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 patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: (({ + 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; @@ -56194,387 +49417,567 @@ 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; - } | null) | { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ + } | null; + }; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues unpinned event */ + readonly "webhook-issues-unpinned": { + /** @enum {string} */ + readonly action: "unpinned"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly issue: components["schemas"]["webhooks_issue_2"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** label created event */ + readonly "webhook-label-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + 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-webhooks"]; + }; + /** label deleted event */ + readonly "webhook-label-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + 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-webhooks"]; + }; + /** label edited event */ + readonly "webhook-label-edited": { + /** @enum {string} */ + readonly action: "edited"; + /** @description The changes to the label if the action was `edited`. */ + readonly changes?: { + readonly color?: { + /** @description The previous version of the color if the action was `edited`. */ + readonly from: string; + }; + readonly description?: { + /** @description The previous version of the description if the action was `edited`. */ + readonly from: string; + }; + readonly name?: { + /** @description The previous version of the name if the action was `edited`. */ + readonly from: string; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + 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-webhooks"]; + }; + /** marketplace_purchase cancelled event */ + readonly "webhook-marketplace-purchase-cancelled": { + /** @enum {string} */ + readonly action: "cancelled"; + readonly effective_date: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase changed event */ + readonly "webhook-marketplace-purchase-changed": { + /** @enum {string} */ + readonly action: "changed"; + readonly effective_date: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** Marketplace Purchase */ + readonly previous_marketplace_purchase?: { + readonly account: { readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ + readonly login: string; + readonly node_id: string; + readonly organization_billing_email: string | null; + readonly type: string; + }; + readonly billing_cycle: string; + readonly free_trial_ends_on: string | null; + readonly next_billing_date?: string | null; + readonly on_free_trial: boolean | null; + readonly plan: { + readonly bullets: string[]; + readonly description: string; + readonly has_free_trial: boolean; + readonly id: number; + readonly monthly_price_in_cents: number; readonly name: string; + /** @enum {string} */ + readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + readonly unit_name: string | null; + readonly yearly_price_in_cents: number; + }; + readonly unit_count: number; + }; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase pending_change event */ + readonly "webhook-marketplace-purchase-pending-change": { + /** @enum {string} */ + readonly action: "pending_change"; + readonly effective_date: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** Marketplace Purchase */ + readonly previous_marketplace_purchase?: { + readonly account: { + readonly id: number; + readonly login: string; readonly node_id: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly organization_billing_email: string | null; + readonly type: string; + }; + readonly billing_cycle: string; + readonly free_trial_ends_on: string | null; + readonly next_billing_date?: string | null; + readonly on_free_trial: boolean; + readonly plan: { + readonly bullets: string[]; + readonly description: string; + readonly has_free_trial: boolean; + readonly id: number; + readonly monthly_price_in_cents: number; + readonly name: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - })[]; - readonly requested_teams: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ + readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + readonly unit_name: string | null; + readonly yearly_price_in_cents: number; + }; + readonly unit_count: number; + }; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase pending_change_cancelled event */ + readonly "webhook-marketplace-purchase-pending-change-cancelled": { + /** @enum {string} */ + readonly action: "pending_change_cancelled"; + readonly effective_date: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + /** Marketplace Purchase */ + readonly marketplace_purchase: { + readonly account: { readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ + readonly login: string; + readonly node_id: string; + readonly organization_billing_email: string | null; + readonly type: string; + }; + readonly billing_cycle: string; + readonly free_trial_ends_on: unknown; + readonly next_billing_date: string | null; + readonly on_free_trial: boolean; + readonly plan: { + readonly bullets: string[]; + readonly description: string; + readonly has_free_trial: boolean; + readonly id: number; + readonly monthly_price_in_cents: number; readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }[]; + readonly price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + readonly unit_name: string | null; + readonly yearly_price_in_cents: number; + }; + readonly unit_count: number; + }; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase purchased event */ + readonly "webhook-marketplace-purchase-purchased": { + /** @enum {string} */ + readonly action: "purchased"; + readonly effective_date: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member added event */ + readonly "webhook-member-added": { + /** @enum {string} */ + readonly action: "added"; + readonly changes?: { + /** @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. */ + readonly permission?: { + /** @enum {string} */ + readonly to: "write" | "admin" | "read"; + }; + /** @description The role assigned to the collaborator. */ + readonly role_name?: { + readonly to: string; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly member: components["schemas"]["webhooks_user"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member edited event */ + readonly "webhook-member-edited": { + /** @enum {string} */ + readonly action: "edited"; + /** @description The changes to the collaborator permissions */ + readonly changes: { + readonly old_permission?: { + /** @description The previous permissions of the collaborator if the action was edited. */ + readonly from: string; + }; + readonly permission?: { + readonly from?: string | null; + readonly to?: string | null; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly member: components["schemas"]["webhooks_user"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member removed event */ + readonly "webhook-member-removed": { + /** @enum {string} */ + readonly action: "removed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly member: components["schemas"]["webhooks_user"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** membership added event */ + readonly "webhook-membership-added": { + /** @enum {string} */ + readonly action: "added"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly member: components["schemas"]["webhooks_user"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + /** + * @description The scope of the membership. Currently, can only be `team`. + * @enum {string} + */ + readonly scope: "team"; + /** User */ + readonly sender: { + /** Format: uri */ + readonly avatar_url?: string; + readonly deleted?: boolean; + readonly email?: string | null; /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; + readonly events_url?: string; /** Format: uri */ - readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - readonly state: "open" | "closed"; + 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 statuses_url: string; - /** @description The title of the pull request. */ - readonly title: string; - /** Format: date-time */ - readonly updated_at: string; + readonly html_url?: string; + readonly id: number; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - 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; - 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; + 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 team: components["schemas"]["webhooks_team"]; + }; + /** membership removed event */ + readonly "webhook-membership-removed": { + /** @enum {string} */ + readonly action: "removed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly member: components["schemas"]["webhooks_user"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + /** + * @description The scope of the membership. Currently, can only be `team`. + * @enum {string} + */ + readonly scope: "team" | "organization"; + /** User */ + readonly sender: { + /** 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 team: components["schemas"]["webhooks_team"]; + }; + readonly "webhook-merge-group-checks-requested": { + /** @enum {string} */ + readonly action: "checks_requested"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly merge_group: components["schemas"]["merge-group"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + readonly "webhook-merge-group-destroyed": { + /** @enum {string} */ + readonly action: "destroyed"; + /** + * @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated). + * @enum {string} + */ + readonly reason?: "merged" | "invalidated" | "dequeued"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly merge_group: components["schemas"]["merge-group"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** meta deleted event */ + readonly "webhook-meta-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ + readonly hook: { + readonly active: boolean; + readonly config: { /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; + readonly content_type: "json" | "form"; + readonly insecure_ssl: string; + readonly secret?: string; /** Format: uri */ - readonly url?: string; - } | null; + readonly url: string; + }; + readonly created_at: string; + readonly events: ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[]; + readonly id: number; + readonly name: string; + readonly type: string; + readonly updated_at: string; }; - readonly reason?: string; + /** @description The id of the modified webhook. */ + readonly hook_id: number; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["nullable-repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** milestone closed event */ + readonly "webhook-milestone-closed": { + /** @enum {string} */ + readonly action: "closed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + 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-webhooks"]; }; - /** pull_request closed event */ - readonly "webhook-pull-request-closed": { + /** milestone created event */ + readonly "webhook-milestone-created": { /** @enum {string} */ - readonly action: "closed"; + readonly action: "created"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; + readonly milestone: components["schemas"]["webhooks_milestone_3"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - readonly allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - }; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request converted_to_draft event */ - readonly "webhook-pull-request-converted-to-draft": { + /** milestone deleted event */ + readonly "webhook-milestone-deleted": { /** @enum {string} */ - readonly action: "converted_to_draft"; + readonly action: "deleted"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; + readonly milestone: components["schemas"]["webhooks_milestone"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - readonly allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** milestone edited event */ + readonly "webhook-milestone-edited": { + /** @enum {string} */ + readonly action: "edited"; + /** @description The changes to the milestone if the action was `edited`. */ + readonly changes: { + readonly description?: { + /** @description The previous version of the description if the action was `edited`. */ + readonly from: string; + }; + readonly due_on?: { + /** @description The previous version of the due date if the action was `edited`. */ + readonly from: string; + }; + readonly title?: { + /** @description The previous version of the title if the action was `edited`. */ + readonly from: string; + }; }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + 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-webhooks"]; + }; + /** milestone opened event */ + readonly "webhook-milestone-opened": { + /** @enum {string} */ + readonly action: "opened"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly milestone: components["schemas"]["webhooks_milestone_3"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request demilestoned event */ - readonly "webhook-pull-request-demilestoned": { + /** org_block blocked event */ + readonly "webhook-org-block-blocked": { + /** @enum {string} */ + readonly action: "blocked"; + readonly blocked_user: components["schemas"]["webhooks_user"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** org_block unblocked event */ + readonly "webhook-org-block-unblocked": { /** @enum {string} */ - readonly action: "demilestoned"; + readonly action: "unblocked"; + readonly blocked_user: components["schemas"]["webhooks_user"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly milestone?: components["schemas"]["milestone"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - readonly pull_request: { - readonly _links: { - /** Link */ - readonly comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly commits: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly issue: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comment: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly statuses: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization deleted event */ + readonly "webhook-organization-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly membership?: components["schemas"]["webhooks_membership"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization member_added event */ + readonly "webhook-organization-member-added": { + /** @enum {string} */ + readonly action: "member_added"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly membership: components["schemas"]["webhooks_membership"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization member_invited event */ + readonly "webhook-organization-member-invited": { + /** @enum {string} */ + readonly action: "member_invited"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + /** @description The invitation for the user or email if the action is `member_invited`. */ + readonly invitation: { + /** Format: date-time */ + readonly created_at: string; + readonly email: string | null; + /** Format: date-time */ + readonly failed_at: string | null; + readonly failed_reason: string | null; + readonly id: number; + /** Format: uri */ + readonly invitation_teams_url: string; /** 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; - } | null; - readonly assignees: ({ + readonly inviter: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -56606,355 +50009,125 @@ 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; - } | 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"; - /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. - */ - readonly auto_merge: { - /** @description Commit message for the merge commit. */ - readonly commit_message: string | null; - /** @description Title for the merge commit message. */ - readonly commit_title: string | null; - /** User */ - readonly enabled_by: { - /** 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; - /** - * @description The merge method to use. - * @enum {string} - */ - readonly merge_method: "merge" | "squash" | "rebase"; } | null; - readonly base: { - readonly label: string; - readonly ref: string; - /** - * Repository - * @description A git repository - */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ - readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; - /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: 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; - } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - }; - readonly sha: string; + readonly login: string | null; + readonly node_id: string; + readonly role: string; + readonly team_count: number; + readonly invitation_source?: string; + }; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly user?: components["schemas"]["webhooks_user"]; + }; + /** organization member_removed event */ + readonly "webhook-organization-member-removed": { + /** @enum {string} */ + readonly action: "member_removed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly membership: components["schemas"]["webhooks_membership"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization renamed event */ + readonly "webhook-organization-renamed": { + /** @enum {string} */ + readonly action: "renamed"; + readonly changes?: { + readonly login?: { + readonly from?: string; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly membership?: components["schemas"]["webhooks_membership"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Ruby Gems metadata */ + readonly "webhook-rubygems-metadata": { + readonly name?: string; + readonly description?: string; + readonly readme?: string; + readonly homepage?: string; + readonly version_info?: { + readonly version?: string; + }; + readonly platform?: string; + readonly metadata?: { + readonly [key: string]: string | undefined; + }; + readonly repo?: string; + readonly dependencies?: { + readonly [key: string]: string | undefined; + }[]; + readonly commit_oid?: string; + }; + /** package published event */ + readonly "webhook-package-published": { + /** @enum {string} */ + readonly action: "published"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description Information about the package. */ + readonly package: { + readonly created_at: string | null; + readonly description: string | null; + readonly ecosystem: string; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly name: string; + readonly namespace: 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; + } | null; + readonly package_type: string; + readonly package_version: { /** User */ - readonly user: { + readonly author?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -56990,203 +50163,99 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - }; - readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ - readonly closed_at: string | null; - readonly comments?: number; - /** Format: uri */ - readonly comments_url: string; - readonly commits?: number; - /** Format: uri */ - readonly commits_url: string; - /** Format: date-time */ - readonly created_at: string; - readonly deletions?: number; - /** Format: uri */ - readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - readonly draft: boolean; - readonly head: { - readonly label: string; - readonly ref: string; - /** - * Repository - * @description A git repository - */ - readonly repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; + readonly body?: string | Record; + readonly body_html?: string; + readonly container_metadata?: { + readonly labels?: Record; + readonly manifest?: Record; + readonly tag?: { + readonly digest?: string; + readonly name?: string; + }; + } | null; + readonly created_at?: string; + readonly description: string; + readonly docker_metadata?: { + readonly tags?: string[]; + }[]; + readonly draft?: boolean; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly installation_command: string; + readonly manifest?: string; + readonly metadata: { + readonly [key: string]: unknown; + }[]; + readonly name: string; + readonly npm_metadata?: { + readonly name?: string; + readonly version?: string; + readonly npm_user?: string; + readonly author?: Record; + readonly bugs?: Record; + readonly dependencies?: Record; + readonly dev_dependencies?: Record; + readonly peer_dependencies?: Record; + readonly optional_dependencies?: Record; + readonly description?: string; + readonly dist?: Record; + readonly git_head?: string; + readonly homepage?: string; + readonly license?: string; + readonly main?: string; + readonly repository?: Record; + readonly scripts?: Record; + readonly id?: string; + readonly node_version?: string; + readonly npm_version?: string; + readonly has_shrinkwrap?: boolean; + readonly maintainers?: Record[]; + readonly contributors?: Record[]; + readonly engines?: Record; + readonly keywords?: string[]; + readonly files?: string[]; + readonly bin?: Record; + readonly man?: Record; + readonly directories?: Record; + readonly os?: string[]; + readonly cpu?: string[]; + readonly readme?: string; + readonly installation_command?: string; + readonly release_id?: number; + readonly commit_oid?: string; + readonly published_via_actions?: boolean; + readonly deleted_by_id?: number; + } | null; + readonly nuget_metadata?: { + readonly id?: number | string; + readonly name?: string; + readonly value?: boolean | string | number | { + readonly url?: string; + readonly branch?: string; + readonly commit?: string; + readonly type?: string; + }; + }[] | null; + readonly package_files: { + readonly content_type: string; + readonly created_at: string; /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the repository */ + readonly download_url: string; readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; - /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; - readonly name: string; - readonly node_id: string; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ + readonly md5: string | null; readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + readonly sha1: string | null; + readonly sha256: string | null; + readonly size: number; + readonly state: string | null; + readonly updated_at: string; + }[]; + readonly package_url?: string; + readonly prerelease?: boolean; + readonly release?: { /** User */ - readonly owner: { + readonly author: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -57222,146 +50291,61 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; + readonly created_at: string; + readonly draft: boolean; /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; + readonly html_url: string; + readonly id: number; + readonly name: string | null; + readonly prerelease: boolean; + readonly published_at: string; + readonly tag_name: string; + readonly target_commitish: string; /** Format: uri */ readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; }; - readonly sha: 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; - 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 rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + readonly source_url?: string; + readonly summary: string; + readonly tag_name?: string; + readonly target_commitish?: string; + readonly target_oid?: string; + readonly updated_at?: string; + readonly version: string; + } | null; + readonly registry: { + /** Format: uri */ + readonly about_url: string; + readonly name: string; + readonly type: string; + /** Format: uri */ + readonly url: string; + readonly vendor: string; + } | null; + readonly updated_at: string | null; + }; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** package updated event */ + readonly "webhook-package-updated": { + /** @enum {string} */ + readonly action: "updated"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description Information about the package. */ + readonly package: { + readonly created_at: string; + readonly description: string | null; + readonly ecosystem: string; /** Format: uri */ readonly html_url: string; readonly id: number; - /** Format: uri */ - readonly issue_url: string; - readonly labels: { - /** @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 locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ - readonly merged_at: string | null; + readonly name: string; + readonly namespace: string; /** User */ - readonly merged_by?: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -57393,22 +50377,14 @@ 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; } | null; - /** - * 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; + readonly package_type: string; + readonly package_version: { /** User */ - readonly creator: { + readonly author: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -57440,41 +50416,130 @@ 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; } | null; - readonly description: string | null; - /** Format: date-time */ - readonly due_on: string | null; + readonly body: string; + readonly body_html: string; + readonly created_at: string; + readonly description: string; + readonly docker_metadata?: { + readonly tags?: string[]; + }[]; + readonly draft?: boolean; /** Format: uri */ readonly html_url: string; readonly id: number; + readonly installation_command: string; + readonly manifest?: string; + readonly metadata: { + readonly [key: string]: unknown; + }[]; + readonly name: string; + readonly package_files: { + readonly content_type: string; + readonly created_at: string; + /** Format: uri */ + readonly download_url: string; + readonly id: number; + readonly md5: string | null; + readonly name: string; + readonly sha1: string | null; + readonly sha256: string; + readonly size: number; + readonly state: string; + readonly updated_at: string; + }[]; + readonly package_url?: string; + readonly prerelease?: boolean; + readonly release?: { + /** User */ + readonly author: { + /** 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 created_at: string; + readonly draft: boolean; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly name: string; + readonly prerelease: boolean; + readonly published_at: string; + readonly tag_name: string; + readonly target_commitish: string; + /** Format: uri */ + readonly url: string; + }; + readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; /** 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 source_url?: string; + readonly summary: string; + readonly tag_name?: string; + readonly target_commitish: string; + readonly target_oid: string; readonly updated_at: string; + readonly version: string; + }; + readonly registry: { + /** Format: uri */ + readonly about_url: string; + readonly name: string; + readonly type: string; /** Format: uri */ readonly url: string; + readonly vendor: string; } | null; - readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; - /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: (({ + readonly updated_at: string; + }; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** page_build event */ + readonly "webhook-page-build": { + /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ + readonly build: { + readonly commit: string | null; + readonly created_at: string; + readonly duration: number; + readonly error: { + readonly message: string | null; + }; + /** User */ + readonly pusher: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -57509,128 +50574,246 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; - } | null) | { + } | null; + readonly status: string; + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly id: number; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** personal_access_token_request approved event */ + readonly "webhook-personal-access-token-request-approved": { + /** @enum {string} */ + readonly action: "approved"; + readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly installation: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request cancelled event */ + readonly "webhook-personal-access-token-request-cancelled": { + /** @enum {string} */ + readonly action: "cancelled"; + readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly installation: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request created event */ + readonly "webhook-personal-access-token-request-created": { + /** @enum {string} */ + readonly action: "created"; + readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly installation: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request denied event */ + readonly "webhook-personal-access-token-request-denied": { + /** @enum {string} */ + readonly action: "denied"; + readonly personal_access_token_request: components["schemas"]["personal-access-token-request"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly installation: components["schemas"]["simple-installation"]; + }; + readonly "webhook-ping": { + /** + * Webhook + * @description The webhook that is being pinged + */ + readonly hook?: { + /** @description Determines whether the hook is actually triggered for the events it subscribes to. */ + readonly active: boolean; + /** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */ + readonly app_id?: number; + readonly config: { + readonly content_type?: components["schemas"]["webhook-config-content-type"]; + readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + readonly secret?: components["schemas"]["webhook-config-secret"]; + readonly url?: components["schemas"]["webhook-config-url"]; + }; + /** Format: date-time */ + readonly created_at: string; + /** Format: uri */ + readonly deliveries_url?: string; + /** @description Determines what events the hook is triggered for. Default: ['push']. */ + readonly events: string[]; + /** @description Unique identifier of the webhook. */ + readonly id: number; + readonly last_response?: components["schemas"]["hook-response"]; + /** + * @description The type of webhook. The only valid value is 'web'. + * @enum {string} + */ + readonly name: "web"; + /** Format: uri */ + readonly ping_url?: string; + /** Format: uri */ + readonly test_url?: string; + readonly type: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url?: string; + }; + /** @description The ID of the webhook that triggered the ping. */ + readonly hook_id?: number; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + /** @description Random string of GitHub zen. */ + readonly zen?: string; + }; + /** @description The webhooks ping payload encoded with URL encoding. */ + readonly "webhook-ping-form-encoded": { + /** @description A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. */ + readonly payload: string; + }; + /** project_card converted event */ + readonly "webhook-project-card-converted": { + /** @enum {string} */ + readonly action: "converted"; + readonly changes: { + readonly note: { + readonly from: string; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_card: components["schemas"]["webhooks_project_card"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card created event */ + readonly "webhook-project-card-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_card: components["schemas"]["webhooks_project_card"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card deleted event */ + readonly "webhook-project-card-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** Project Card */ + readonly project_card: { + readonly after_id?: number | null; + /** @description Whether or not the card is archived */ + readonly archived: boolean; + readonly column_id: number | null; + /** Format: uri */ + readonly column_url: string; + /** Format: uri */ + readonly content_url?: string; + /** Format: date-time */ + readonly created_at: string; + /** User */ + readonly creator: { + /** Format: uri */ + readonly avatar_url?: string; readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; + 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; - /** @description Unique identifier of the team */ readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; + readonly login: string; + readonly name?: string; readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - })[]; - readonly requested_teams: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; + readonly organizations_url?: string; /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; + readonly received_events_url?: string; + /** Format: uri */ + readonly repos_url?: string; + readonly site_admin?: boolean; /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly starred_url?: string; + /** Format: uri */ + readonly subscriptions_url?: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ readonly url?: string; - }[]; - /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; - /** Format: uri */ - readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - readonly state: "open" | "closed"; + } | null; + /** @description The project card's ID */ + readonly id: number; + readonly node_id: string; + readonly note: string | null; /** Format: uri */ - readonly statuses_url: string; - /** @description The title of the pull request. */ - readonly title: string; + readonly project_url: string; /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; + }; + readonly repository?: components["schemas"]["nullable-repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card edited event */ + readonly "webhook-project-card-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes: { + readonly note: { + readonly from: string | null; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_card: components["schemas"]["webhooks_project_card"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card moved event */ + readonly "webhook-project-card-moved": { + /** @enum {string} */ + readonly action: "moved"; + readonly changes?: { + readonly column_id: { + readonly from: number; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_card: { + readonly after_id?: number | null; + /** @description Whether or not the card is archived */ + readonly archived: boolean; + readonly column_id: number; + /** Format: uri */ + readonly column_url: string; + /** Format: uri */ + readonly content_url?: string; + /** Format: date-time */ + readonly created_at: string; /** User */ - readonly user: { + readonly creator: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -57666,17 +50849,334 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; + /** @description The project card's ID */ + readonly id: number; + readonly node_id: string; + readonly note: string | null; + /** Format: uri */ + readonly project_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + } & { + readonly after_id: number | null; + readonly archived?: boolean; + readonly column_id?: number; + readonly column_url?: string; + readonly created_at?: string; + readonly creator?: { + 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; + 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; + } | null; + readonly id?: number; + readonly node_id?: string; + readonly note?: string | null; + readonly project_url?: string; + readonly updated_at?: string; + readonly url?: string; }; - readonly repository: components["schemas"]["repository-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project closed event */ + readonly "webhook-project-closed": { + /** @enum {string} */ + readonly action: "closed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project: components["schemas"]["webhooks_project"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_column created event */ + readonly "webhook-project-column-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_column: components["schemas"]["webhooks_project_column"]; + readonly repository?: components["schemas"]["repository-webhooks"]; readonly sender?: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request dequeued event */ - readonly "webhook-pull-request-dequeued": { + /** project_column deleted event */ + readonly "webhook-project-column-deleted": { /** @enum {string} */ - readonly action: "dequeued"; + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_column: components["schemas"]["webhooks_project_column"]; + readonly repository?: components["schemas"]["nullable-repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project_column edited event */ + readonly "webhook-project-column-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes: { + readonly name?: { + readonly from: string; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_column: components["schemas"]["webhooks_project_column"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project_column moved event */ + readonly "webhook-project-column-moved": { + /** @enum {string} */ + readonly action: "moved"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project_column: components["schemas"]["webhooks_project_column"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project created event */ + readonly "webhook-project-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project: components["schemas"]["webhooks_project"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project deleted event */ + readonly "webhook-project-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project: components["schemas"]["webhooks_project"]; + readonly repository?: components["schemas"]["nullable-repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project edited event */ + readonly "webhook-project-edited": { + /** @enum {string} */ + readonly action: "edited"; + /** @description The changes to the project if the action was `edited`. */ + readonly changes?: { + readonly body?: { + /** @description The previous version of the body if the action was `edited`. */ + readonly from: string; + }; + readonly name?: { + /** @description The changes to the project if the action was `edited`. */ + readonly from: string; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project: components["schemas"]["webhooks_project"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project reopened event */ + readonly "webhook-project-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly project: components["schemas"]["webhooks_project"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Closed Event */ + readonly "webhook-projects-v2-project-closed": { + /** @enum {string} */ + readonly action: "closed"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2: components["schemas"]["projects-v2"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** @description A project was created */ + readonly "webhook-projects-v2-project-created": { + /** @enum {string} */ + readonly action: "created"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2: components["schemas"]["projects-v2"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Deleted Event */ + readonly "webhook-projects-v2-project-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2: components["schemas"]["projects-v2"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Edited Event */ + readonly "webhook-projects-v2-project-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes: { + readonly description?: { + readonly from?: string | null; + readonly to?: string | null; + }; + readonly public?: { + readonly from?: boolean; + readonly to?: boolean; + }; + readonly short_description?: { + readonly from?: string | null; + readonly to?: string | null; + }; + readonly title?: { + readonly from?: string; + readonly to?: string; + }; + }; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2: components["schemas"]["projects-v2"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Archived Event */ + readonly "webhook-projects-v2-item-archived": { + /** @enum {string} */ + readonly action: "archived"; + readonly changes: components["schemas"]["webhooks_project_changes"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_item: components["schemas"]["projects-v2-item"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Converted Event */ + readonly "webhook-projects-v2-item-converted": { + /** @enum {string} */ + readonly action: "converted"; + readonly changes: { + readonly content_type?: { + readonly from?: string | null; + readonly to?: string; + }; + }; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_item: components["schemas"]["projects-v2-item"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Created Event */ + readonly "webhook-projects-v2-item-created": { + /** @enum {string} */ + readonly action: "created"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_item: components["schemas"]["projects-v2-item"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Deleted Event */ + readonly "webhook-projects-v2-item-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_item: components["schemas"]["projects-v2-item"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Edited Event */ + readonly "webhook-projects-v2-item-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes?: { + readonly field_value: { + readonly field_node_id?: string; + readonly field_type?: string; + }; + } | { + readonly body: { + readonly from?: string | null; + readonly to?: string | null; + }; + }; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_item: components["schemas"]["projects-v2-item"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Reordered Event */ + readonly "webhook-projects-v2-item-reordered": { + /** @enum {string} */ + readonly action: "reordered"; + readonly changes: { + readonly previous_projects_v2_item_node_id?: { + readonly from?: string | null; + readonly to?: string | null; + }; + }; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_item: components["schemas"]["projects-v2-item"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Restored Event */ + readonly "webhook-projects-v2-item-restored": { + /** @enum {string} */ + readonly action: "restored"; + readonly changes: components["schemas"]["webhooks_project_changes"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2_item: components["schemas"]["projects-v2-item"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Reopened Event */ + readonly "webhook-projects-v2-project-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization: components["schemas"]["organization-simple-webhooks"]; + readonly projects_v2: components["schemas"]["projects-v2"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** public event */ + readonly "webhook-public": { readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - readonly number: number; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request assigned event */ + readonly "webhook-pull-request-assigned": { + /** @enum {string} */ + readonly action: "assigned"; + readonly assignee: components["schemas"]["webhooks_user"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ readonly pull_request: { @@ -57758,7 +51258,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; @@ -57794,7 +51294,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)[]; @@ -58197,7 +51697,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string; + readonly label: string | null; readonly ref: string; /** * Repository @@ -58479,7 +51979,7 @@ export interface components { readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - }; + } | null; readonly sha: string; /** User */ readonly user: { @@ -58694,22 +52194,22 @@ 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) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -58736,17 +52236,17 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -58855,94 +52355,13 @@ export interface components { readonly url?: string; } | null; }; - readonly reason: string; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request edited event */ - readonly "webhook-pull-request-edited": { - /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the comment if the action was `edited`. */ - readonly changes: { - readonly base?: { - readonly ref: { - readonly from: string; - }; - readonly sha: { - readonly from: string; - }; - }; - readonly body?: { - /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; - }; - readonly title?: { - /** @description The previous version of the title if the action was `edited`. */ - readonly from: string; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - readonly allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request enqueued event */ - readonly "webhook-pull-request-enqueued": { + /** pull_request auto_merge_disabled event */ + readonly "webhook-pull-request-auto-merge-disabled": { /** @enum {string} */ - readonly action: "enqueued"; + readonly action: "auto_merge_disabled"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly number: number; @@ -59224,6 +52643,11 @@ export interface components { * @default true */ readonly has_issues: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; readonly has_pages: boolean; /** * @description Whether projects are enabled. @@ -59235,11 +52659,6 @@ export interface components { * @default true */ readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; readonly homepage: string | null; /** Format: uri */ readonly hooks_url: string; @@ -59897,7 +53316,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; } | null; @@ -59963,22 +53382,22 @@ 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) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -60005,17 +53424,17 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -60124,32 +53543,16 @@ export interface components { readonly url?: string; } | null; }; + readonly reason: string; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request labeled event */ - readonly "webhook-pull-request-labeled": { + /** pull_request auto_merge_enabled event */ + readonly "webhook-pull-request-auto-merge-enabled": { /** @enum {string} */ - readonly action: "labeled"; + readonly action: "auto_merge_enabled"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** Label */ - readonly label?: { - /** @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; - }; - /** @description The pull request number. */ readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ @@ -60232,7 +53635,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; } | null; @@ -60268,7 +53671,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; } | null)[]; @@ -60671,7 +54074,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string | null; + readonly label: string; readonly ref: string; /** * Repository @@ -60953,7 +54356,7 @@ export interface components { readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - } | null; + }; readonly sha: string; /** User */ readonly user: { @@ -61055,7 +54458,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; } | null; @@ -61329,16 +54732,52 @@ export interface components { readonly url?: string; } | null; }; + readonly reason?: string; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request locked event */ - readonly "webhook-pull-request-locked": { + /** pull_request closed event */ + readonly "webhook-pull-request-closed": { /** @enum {string} */ - readonly action: "locked"; + readonly action: "closed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["pull-request-webhook"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request converted_to_draft event */ + readonly "webhook-pull-request-converted-to-draft": { + /** @enum {string} */ + readonly action: "converted_to_draft"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["pull-request-webhook"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request demilestoned event */ + readonly "webhook-pull-request-demilestoned": { + /** @enum {string} */ + readonly action: "demilestoned"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly milestone?: components["schemas"]["milestone"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["webhooks_pull_request_5"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request dequeued event */ + readonly "webhook-pull-request-dequeued": { + /** @enum {string} */ + readonly action: "dequeued"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ @@ -61457,7 +54896,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; } | null)[]; @@ -61860,7 +55299,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string | null; + readonly label: string; readonly ref: string; /** * Repository @@ -62142,7 +55581,7 @@ export interface components { readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - } | null; + }; readonly sha: string; /** User */ readonly user: { @@ -62244,7 +55683,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; } | null; @@ -62291,7 +55730,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; @@ -62357,22 +55796,22 @@ 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; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + readonly description?: string | null; /** Format: uri */ - readonly html_url: string; + readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url: string; + readonly members_url?: string; /** @description Name of the team */ readonly name: string; - readonly node_id: string; + readonly node_id?: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -62399,17 +55838,17 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly permission?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + readonly repositories_url?: string; + readonly slug?: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + readonly url?: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -62518,16 +55957,47 @@ export interface components { readonly url?: string; } | null; }; + readonly reason: string; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request milestoned event */ - readonly "webhook-pull-request-milestoned": { + /** pull_request edited event */ + readonly "webhook-pull-request-edited": { /** @enum {string} */ - readonly action: "milestoned"; + readonly action: "edited"; + /** @description The changes to the comment if the action was `edited`. */ + readonly changes: { + readonly base?: { + readonly ref: { + readonly from: string; + }; + readonly sha: { + readonly from: string; + }; + }; + readonly body?: { + /** @description The previous version of the body if the action was `edited`. */ + readonly from: string; + }; + readonly title?: { + /** @description The previous version of the title if the action was `edited`. */ + readonly from: string; + }; + }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly milestone?: components["schemas"]["milestone"]; - /** @description The pull request number. */ + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["pull-request-webhook"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request enqueued event */ + readonly "webhook-pull-request-enqueued": { + /** @enum {string} */ + readonly action: "enqueued"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ @@ -62610,7 +56080,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; } | null; @@ -62646,7 +56116,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; } | null)[]; @@ -62981,7 +56451,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -63321,7 +56791,7 @@ export interface components { /** Format: uri */ readonly url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ readonly use_squash_pr_title_as_default: boolean; @@ -63433,7 +56903,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; } | null; @@ -63549,502 +57019,177 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; - } | null) | { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - })[]; - readonly requested_teams: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }[]; - /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; - /** Format: uri */ - readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - readonly state: "open" | "closed"; - /** Format: uri */ - readonly statuses_url: string; - /** @description The title of the pull request. */ - readonly title: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - 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; - 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; - } | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request opened event */ - readonly "webhook-pull-request-opened": { - /** @enum {string} */ - readonly action: "opened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - readonly allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request ready_for_review event */ - readonly "webhook-pull-request-ready-for-review": { - /** @enum {string} */ - readonly action: "ready_for_review"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - readonly allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request reopened event */ - readonly "webhook-pull-request-reopened": { - /** @enum {string} */ - readonly action: "reopened"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - readonly allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request_review_comment created event */ - readonly "webhook-pull-request-review-comment-created": { - /** @enum {string} */ - readonly action: "created"; - /** - * Pull Request Review Comment - * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. - */ - readonly comment: { - readonly _links: { - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly pull_request: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** - * 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 The text of the comment. */ - readonly body: string; - /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ - readonly html_url: string; - /** @description The ID of the pull request review comment. */ - readonly id: number; - /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; - /** @description The node ID of the pull request review comment. */ - readonly node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number | null; - /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - readonly path: string; - /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - readonly pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - readonly start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - readonly subject_type?: "line" | "file"; - /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL for the pull request review 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; - 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 deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; + })[]; + readonly requested_teams: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; + }[]; + /** Format: uri-template */ + readonly review_comment_url: string; + readonly review_comments?: number; + /** Format: uri */ + readonly review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + readonly state: "open" | "closed"; + /** Format: uri */ + readonly statuses_url: string; + /** @description The title of the pull request. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + 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; + 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; } | null; }; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request labeled event */ + readonly "webhook-pull-request-labeled": { + /** @enum {string} */ + readonly action: "labeled"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; + readonly label?: components["schemas"]["webhooks_label"]; + readonly number: components["schemas"]["webhooks_number"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -64090,6 +57235,7 @@ export interface components { }; /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; /** User */ readonly assignee: { /** Format: uri */ @@ -64173,7 +57319,7 @@ export interface components { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge?: { + readonly auto_merge: { /** @description Commit message for the merge commit. */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ @@ -64545,17 +57691,24 @@ export interface components { } | null; }; readonly body: string | null; + readonly changed_files?: number; + /** Format: date-time */ readonly closed_at: string | null; + readonly comments?: number; /** Format: uri */ readonly comments_url: string; + readonly commits?: number; /** Format: uri */ readonly commits_url: string; + /** Format: date-time */ readonly created_at: string; + readonly deletions?: number; /** Format: uri */ readonly diff_url: string; - readonly draft?: boolean; + /** @description Indicates whether or not the pull request is a draft. */ + readonly draft: boolean; readonly head: { - readonly label: string; + readonly label: string | null; readonly ref: string; /** * Repository @@ -64898,8 +58051,51 @@ export interface components { readonly url: string; }[]; readonly locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ readonly merged_at: string | null; + /** User */ + readonly merged_by?: { + /** 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; + } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -64972,9 +58168,11 @@ export interface components { readonly url: string; } | null; readonly node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; + readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -65114,13 +58312,19 @@ export interface components { }[]; /** Format: uri-template */ readonly review_comment_url: string; + readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; + /** @description The title of the pull request. */ readonly title: string; + /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -65165,158 +58369,15 @@ export interface components { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review_comment deleted event */ - readonly "webhook-pull-request-review-comment-deleted": { + /** pull_request locked event */ + readonly "webhook-pull-request-locked": { /** @enum {string} */ - readonly action: "deleted"; - /** - * Pull Request Review Comment - * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. - */ - readonly comment: { - readonly _links: { - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly pull_request: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** - * 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 The text of the comment. */ - readonly body: string; - /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ - readonly html_url: string; - /** @description The ID of the pull request review comment. */ - readonly id: number; - /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; - /** @description The node ID of the pull request review comment. */ - readonly node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number; - /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - readonly path: string; - /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - readonly pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - readonly start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - readonly subject_type?: "line" | "file"; - /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL for the pull request review 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; - 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 action: "locked"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -65362,6 +58423,7 @@ export interface components { }; /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; /** User */ readonly assignee: { /** Format: uri */ @@ -65431,7 +58493,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)[]; @@ -65445,7 +58507,7 @@ export interface components { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge?: { + readonly auto_merge: { /** @description Commit message for the merge commit. */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ @@ -65817,17 +58879,24 @@ export interface components { } | null; }; readonly body: string | null; + readonly changed_files?: number; + /** Format: date-time */ readonly closed_at: string | null; + readonly comments?: number; /** Format: uri */ readonly comments_url: string; + readonly commits?: number; /** Format: uri */ readonly commits_url: string; + /** Format: date-time */ readonly created_at: string; + readonly deletions?: number; /** Format: uri */ readonly diff_url: string; - readonly draft?: boolean; + /** @description Indicates whether or not the pull request is a draft. */ + readonly draft: boolean; readonly head: { - readonly label: string; + readonly label: string | null; readonly ref: string; /** * Repository @@ -66170,8 +59239,51 @@ export interface components { readonly url: string; }[]; readonly locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ readonly merged_at: string | null; + /** User */ + readonly merged_by?: { + /** 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; + } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -66244,9 +59356,11 @@ export interface components { readonly url: string; } | null; readonly node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; + readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -66279,22 +59393,22 @@ 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) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -66321,17 +59435,17 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -66386,13 +59500,19 @@ export interface components { }[]; /** Format: uri-template */ readonly review_comment_url: string; + readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; + /** @description The title of the pull request. */ readonly title: string; + /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -66437,17 +59557,58 @@ export interface components { readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review_comment edited event */ - readonly "webhook-pull-request-review-comment-edited": { + /** pull_request milestoned event */ + readonly "webhook-pull-request-milestoned": { /** @enum {string} */ - readonly action: "edited"; - /** @description The changes to the comment. */ - readonly changes: { - readonly body?: { - /** @description The previous version of the body. */ - readonly from: string; - }; - }; + readonly action: "milestoned"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly milestone?: components["schemas"]["milestone"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["webhooks_pull_request_5"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request opened event */ + readonly "webhook-pull-request-opened": { + /** @enum {string} */ + readonly action: "opened"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["pull-request-webhook"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request ready_for_review event */ + readonly "webhook-pull-request-ready-for-review": { + /** @enum {string} */ + readonly action: "ready_for_review"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["pull-request-webhook"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request reopened event */ + readonly "webhook-pull-request-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: components["schemas"]["pull-request-webhook"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request_review_comment created event */ + readonly "webhook-pull-request-review-comment-created": { + /** @enum {string} */ + readonly action: "created"; /** * Pull Request Review Comment * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -66500,7 +59661,7 @@ export interface components { /** @description The SHA of the original commit to which the comment applies. */ readonly original_commit_id: string; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number; + readonly original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ readonly original_position: number; /** @description The first line of the range for a multi-line comment. */ @@ -66674,7 +59835,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; @@ -66710,7 +59871,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)[]; @@ -67558,22 +60719,22 @@ 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) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -67600,17 +60761,17 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -67712,100 +60873,100 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request_review dismissed event */ - readonly "webhook-pull-request-review-dismissed": { - /** @enum {string} */ - readonly action: "dismissed"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ - readonly pull_request: { - readonly _links: { - /** Link */ - readonly comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly commits: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly issue: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comment: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly statuses: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** @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; - } | null; + }; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request_review_comment deleted event */ + readonly "webhook-pull-request-review-comment-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly comment: components["schemas"]["webhooks_review_comment"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly pull_request: { + readonly _links: { + /** Link */ + readonly comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly commits: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly html: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly issue: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comment: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly statuses: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** @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: ({ /** Format: uri */ readonly avatar_url?: string; @@ -67838,7 +60999,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; } | null)[]; @@ -67852,7 +61013,7 @@ export interface components { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + readonly auto_merge?: { /** @description Commit message for the merge commit. */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ @@ -68232,7 +61393,7 @@ export interface components { readonly created_at: string; /** Format: uri */ readonly diff_url: string; - readonly draft: boolean; + readonly draft?: boolean; readonly head: { readonly label: string; readonly ref: string; @@ -68686,22 +61847,22 @@ 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; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + readonly description?: string | null; /** Format: uri */ - readonly html_url: string; + readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url: string; + readonly members_url?: string; /** @description Name of the team */ readonly name: string; - readonly node_id: string; + readonly node_id?: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -68728,17 +61889,17 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly permission?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + readonly repositories_url?: string; + readonly slug?: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + readonly url?: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -68842,95 +62003,17 @@ export interface components { } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - /** @description The review that was affected. */ - readonly review: { - readonly _links: { - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly pull_request: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** - * 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 The text of the review. */ - readonly body: string | null; - /** @description A commit SHA for the review. */ - readonly commit_id: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the review */ - readonly id: number; - readonly node_id: string; - /** Format: uri */ - readonly pull_request_url: string; - /** @enum {string} */ - readonly state: "dismissed" | "approved" | "changes_requested"; - /** Format: date-time */ - readonly submitted_at: 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; - 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; - } | null; - }; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review edited event */ - readonly "webhook-pull-request-review-edited": { + /** pull_request_review_comment edited event */ + readonly "webhook-pull-request-review-comment-edited": { /** @enum {string} */ readonly action: "edited"; - readonly changes: { - readonly body?: { - /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; - }; - }; + readonly changes: components["schemas"]["webhooks_changes"]; + readonly comment: components["schemas"]["webhooks_review_comment"]; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -69009,7 +62092,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; } | null; @@ -69045,7 +62128,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; } | null)[]; @@ -69059,7 +62142,7 @@ export interface components { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - readonly auto_merge: { + readonly auto_merge?: { /** @description Commit message for the merge commit. */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ @@ -69217,6 +62300,11 @@ export interface components { * @default true */ readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; readonly homepage: string | null; /** Format: uri */ readonly hooks_url: string; @@ -69248,6 +62336,23 @@ export interface components { readonly url: string | null; } | null; readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -69316,6 +62421,23 @@ export interface components { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -69340,10 +62462,17 @@ export interface components { readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; }; readonly sha: string; /** User */ @@ -69393,7 +62522,7 @@ export interface components { readonly created_at: string; /** Format: uri */ readonly diff_url: string; - readonly draft: boolean; + readonly draft?: boolean; readonly head: { readonly label: string; readonly ref: string; @@ -69504,6 +62633,11 @@ export interface components { * @default true */ readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; readonly homepage: string | null; /** Format: uri */ readonly hooks_url: string; @@ -69535,6 +62669,23 @@ export interface components { readonly url: string | null; } | null; readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -69603,6 +62754,23 @@ export interface components { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -69627,10 +62795,17 @@ export interface components { readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; } | null; readonly sha: string; /** User */ @@ -69801,22 +62976,22 @@ 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; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + readonly description?: string | null; /** Format: uri */ - readonly html_url: string; + readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url: string; + readonly members_url?: string; /** @description Name of the team */ readonly name: string; - readonly node_id: string; + readonly node_id?: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -69843,17 +63018,17 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly permission?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + readonly repositories_url?: string; + readonly slug?: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + readonly url?: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -69957,90 +63132,16 @@ export interface components { } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - /** @description The review that was affected. */ - readonly review: { - readonly _links: { - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly pull_request: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** - * 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 The text of the review. */ - readonly body: string | null; - /** @description A commit SHA for the review. */ - readonly commit_id: string; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the review */ - readonly id: number; - readonly node_id: string; - /** Format: uri */ - readonly pull_request_url: string; - readonly state: string; - /** Format: date-time */ - readonly submitted_at: string | null; - /** 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; - 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 sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request review_request_removed event */ - readonly "webhook-pull-request-review-request-removed": { + /** pull_request_review dismissed event */ + readonly "webhook-pull-request-review-dismissed": { /** @enum {string} */ - readonly action: "review_request_removed"; + readonly action: "dismissed"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ + /** Simple Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -70086,7 +63187,6 @@ export interface components { }; /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; /** User */ readonly assignee: { /** Format: uri */ @@ -70120,7 +63220,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; @@ -70156,7 +63256,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)[]; @@ -70450,12 +63550,19 @@ export interface components { readonly role_name?: string | null; readonly size: number; /** - * @description The default value for a squash merge commit message. + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a squash merge commit title. + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -70535,21 +63642,14 @@ export interface components { } | null; }; readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ readonly closed_at: string | null; - readonly comments?: number; /** Format: uri */ readonly comments_url: string; - readonly commits?: number; /** Format: uri */ readonly commits_url: string; - /** Format: date-time */ readonly created_at: string; - readonly deletions?: number; /** Format: uri */ readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { readonly label: string; @@ -70834,7 +63934,7 @@ export interface components { readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - }; + } | null; readonly sha: string; /** User */ readonly user: { @@ -70895,51 +63995,8 @@ export interface components { readonly url: string; }[]; readonly locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ readonly merged_at: string | null; - /** User */ - readonly merged_by?: { - /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -71012,11 +64069,9 @@ export interface components { readonly url: string; } | null; readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; - readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -71049,7 +64104,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) | { @@ -71102,73 +64157,67 @@ export interface components { * @description URL for the team */ readonly url: string; - })[]; - readonly requested_teams: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; + })[]; + readonly requested_teams: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; }[]; /** Format: uri-template */ readonly review_comment_url: string; - readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; - /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -71205,59 +64254,101 @@ 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; }; readonly repository: components["schemas"]["repository-webhooks"]; - /** User */ - readonly requested_reviewer: { - /** 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; + /** @description The review that was affected. */ + readonly review: { + readonly _links: { + /** Link */ + readonly html: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly pull_request: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** + * 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 The text of the review. */ + readonly body: string | null; + /** @description A commit SHA for the review. */ + readonly commit_id: string; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; + /** @description Unique identifier of the review */ 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; + readonly node_id: string; /** Format: uri */ - readonly subscriptions_url?: string; + readonly pull_request_url: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - } | null; + readonly state: "dismissed" | "approved" | "changes_requested"; + /** Format: date-time */ + readonly submitted_at: 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; + 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; + } | null; + }; readonly sender: components["schemas"]["simple-user-webhooks"]; - } | { + }; + /** pull_request_review edited event */ + readonly "webhook-pull-request-review-edited": { /** @enum {string} */ - readonly action: "review_request_removed"; + readonly action: "edited"; + readonly changes: { + readonly body?: { + /** @description The previous version of the body if the action was `edited`. */ + readonly from: string; + }; + }; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ + /** Simple Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -71303,7 +64394,6 @@ export interface components { }; /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; /** User */ readonly assignee: { /** Format: uri */ @@ -71337,7 +64427,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; @@ -71373,7 +64463,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)[]; @@ -71545,11 +64635,6 @@ export interface components { * @default true */ readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; readonly homepage: string | null; /** Format: uri */ readonly hooks_url: string; @@ -71581,23 +64666,6 @@ export interface components { readonly url: string | null; } | null; readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -71666,23 +64734,6 @@ export interface components { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -71707,17 +64758,10 @@ export interface components { readonly updated_at: string; /** Format: uri */ readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; }; readonly sha: string; /** User */ @@ -71759,21 +64803,14 @@ export interface components { } | null; }; readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ readonly closed_at: string | null; - readonly comments?: number; /** Format: uri */ readonly comments_url: string; - readonly commits?: number; /** Format: uri */ readonly commits_url: string; - /** Format: date-time */ readonly created_at: string; - readonly deletions?: number; /** Format: uri */ readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { readonly label: string; @@ -71885,11 +64922,6 @@ export interface components { * @default true */ readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; readonly homepage: string | null; /** Format: uri */ readonly hooks_url: string; @@ -71921,23 +64953,6 @@ export interface components { readonly url: string | null; } | null; readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -72006,23 +65021,6 @@ export interface components { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -72047,18 +65045,11 @@ export interface components { readonly updated_at: string; /** Format: uri */ readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - }; + } | null; readonly sha: string; /** User */ readonly user: { @@ -72119,51 +65110,8 @@ export interface components { readonly url: string; }[]; readonly locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ readonly merged_at: string | null; - /** User */ - readonly merged_by?: { - /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -72207,7 +65155,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; @@ -72236,11 +65184,9 @@ export interface components { readonly url: string; } | null; readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; - readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -72273,7 +65219,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) | { @@ -72330,16 +65276,16 @@ export interface components { readonly requested_teams: { readonly deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + readonly description?: string | null; /** Format: uri */ - readonly html_url: string; + readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url: string; + readonly members_url?: string; /** @description Name of the team */ readonly name: string; - readonly node_id: string; + readonly node_id?: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -72366,33 +65312,27 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly permission?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + readonly repositories_url?: string; + readonly slug?: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + readonly url?: string; }[]; /** Format: uri-template */ readonly review_comment_url: string; - readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; - /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -72429,73 +65369,19 @@ 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; }; readonly repository: components["schemas"]["repository-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly requested_team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - }; + readonly review: components["schemas"]["webhooks_review"]; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request review_requested event */ - readonly "webhook-pull-request-review-requested": { + /** pull_request review_request_removed event */ + readonly "webhook-pull-request-review-request-removed": { /** @enum {string} */ - readonly action: "review_requested"; + readonly action: "review_request_removed"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ @@ -72581,7 +65467,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; } | null; @@ -72617,7 +65503,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; } | null)[]; @@ -72911,19 +65797,12 @@ export interface components { readonly role_name?: string | null; readonly size: number; /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * @description The default value for a squash merge commit message. * @enum {string} */ readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @description The default value for a squash merge commit title. * @enum {string} */ readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -73451,7 +66330,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; } | null; @@ -73574,16 +66453,16 @@ export interface components { readonly requested_teams: { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -73610,17 +66489,17 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; }[]; /** Format: uri-template */ readonly review_comment_url: string; @@ -73673,7 +66552,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; } | null; @@ -73712,14 +66591,14 @@ 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; } | null; readonly sender: components["schemas"]["simple-user-webhooks"]; } | { /** @enum {string} */ - readonly action: "review_requested"; + readonly action: "review_request_removed"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ @@ -73805,7 +66684,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; } | null; @@ -73841,7 +66720,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; } | null)[]; @@ -74675,7 +67554,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; } | null; @@ -74747,16 +67626,16 @@ export interface components { } | null) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -74783,31 +67662,31 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; })[]; readonly requested_teams: { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -74834,17 +67713,17 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; }[]; /** Format: uri-template */ readonly review_comment_url: string; @@ -74897,7 +67776,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; } | null; @@ -74910,16 +67789,16 @@ export interface components { readonly requested_team: { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -74946,28 +67825,30 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; }; readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review submitted event */ - readonly "webhook-pull-request-review-submitted": { + /** pull_request review_requested event */ + readonly "webhook-pull-request-review-requested": { /** @enum {string} */ - readonly action: "submitted"; + readonly action: "review_requested"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; + /** @description The pull request number. */ + readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ + /** Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -75013,6 +67894,7 @@ export interface components { }; /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; /** User */ readonly assignee: { /** Format: uri */ @@ -75468,17 +68350,24 @@ export interface components { } | null; }; readonly body: string | null; + readonly changed_files?: number; + /** Format: date-time */ readonly closed_at: string | null; + readonly comments?: number; /** Format: uri */ readonly comments_url: string; + readonly commits?: number; /** Format: uri */ readonly commits_url: string; + /** Format: date-time */ readonly created_at: string; + readonly deletions?: number; /** Format: uri */ readonly diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string | null; + readonly label: string; readonly ref: string; /** * Repository @@ -75760,7 +68649,7 @@ export interface components { readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - } | null; + }; readonly sha: string; /** User */ readonly user: { @@ -75821,8 +68710,51 @@ export interface components { readonly url: string; }[]; readonly locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ readonly merged_at: string | null; + /** User */ + readonly merged_by?: { + /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -75895,9 +68827,11 @@ export interface components { readonly url: string; } | null; readonly node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; + readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -75930,7 +68864,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; } | null) | { @@ -76037,13 +68971,19 @@ export interface components { }[]; /** Format: uri-template */ readonly review_comment_url: string; + readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; + /** @description The title of the pull request. */ readonly title: string; + /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -76086,88 +69026,53 @@ export interface components { } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - /** @description The review that was affected. */ - readonly review: { - readonly _links: { - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly pull_request: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** - * 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 The text of the review. */ - readonly body: string | null; - /** @description A commit SHA for the review. */ - readonly commit_id: string; + /** User */ + readonly requested_reviewer: { /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the review */ + 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 node_id: string; + readonly login: string; + readonly name?: string; + readonly node_id?: string; /** Format: uri */ - readonly pull_request_url: string; - readonly state: string; - /** Format: date-time */ - readonly submitted_at: string | null; - /** 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; - 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 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; + } | null; readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request_review_thread resolved event */ - readonly "webhook-pull-request-review-thread-resolved": { + } | { /** @enum {string} */ - readonly action: "resolved"; + readonly action: "review_requested"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; + /** @description The pull request number. */ + readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ + /** Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -76213,6 +69118,7 @@ export interface components { }; /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; /** User */ readonly assignee: { /** Format: uri */ @@ -76246,7 +69152,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; @@ -76282,7 +69188,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)[]; @@ -76490,6 +69396,23 @@ export interface components { readonly url: string | null; } | null; readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -76558,6 +69481,23 @@ export interface components { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -76582,6 +69522,11 @@ export interface components { readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; @@ -76629,17 +69574,24 @@ export interface components { } | null; }; readonly body: string | null; + readonly changed_files?: number; + /** Format: date-time */ readonly closed_at: string | null; + readonly comments?: number; /** Format: uri */ readonly comments_url: string; + readonly commits?: number; /** Format: uri */ readonly commits_url: string; + /** Format: date-time */ readonly created_at: string; + readonly deletions?: number; /** Format: uri */ readonly diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string | null; + readonly label: string; readonly ref: string; /** * Repository @@ -76784,6 +69736,23 @@ export interface components { readonly url: string | null; } | null; readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -76852,6 +69821,23 @@ export interface components { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -76876,13 +69862,18 @@ export interface components { readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - } | null; + }; readonly sha: string; /** User */ readonly user: { @@ -76943,8 +69934,51 @@ export interface components { readonly url: string; }[]; readonly locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ readonly merged_at: string | null; + /** User */ + readonly merged_by?: { + /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -76988,7 +70022,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; @@ -77017,9 +70051,11 @@ export interface components { readonly url: string; } | null; readonly node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; + readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -77052,22 +70088,22 @@ 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; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + readonly description?: string | null; /** Format: uri */ - readonly html_url: string; + readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url: string; + readonly members_url?: string; /** @description Name of the team */ readonly name: string; - readonly node_id: string; + readonly node_id?: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -77094,17 +70130,17 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly permission?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + readonly repositories_url?: string; + readonly slug?: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + readonly url?: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -77159,13 +70195,19 @@ export interface components { }[]; /** Format: uri-template */ readonly review_comment_url: string; + readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; + /** @description The title of the pull request. */ readonly title: string; + /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -77208,156 +70250,67 @@ export interface components { } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - readonly thread: { - readonly comments: { - readonly _links: { - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly pull_request: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** - * 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 The text of the comment. */ - readonly body: string; - /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + readonly requested_team: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ readonly html_url: string; - /** @description The ID of the pull request review comment. */ + /** @description Unique identifier of the team */ readonly id: number; - /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; - /** @description The node ID of the pull request review comment. */ + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; readonly node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number | null; - /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - readonly path: string; - /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - readonly pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - readonly start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - readonly subject_type?: "line" | "file"; - /** Format: date-time */ - readonly updated_at: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; /** * Format: uri - * @description URL for the pull request review comment + * @description URL for the team */ 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; - 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; - } | null; - }[]; - readonly node_id: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; }; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review_thread unresolved event */ - readonly "webhook-pull-request-review-thread-unresolved": { + /** pull_request_review submitted event */ + readonly "webhook-pull-request-review-submitted": { /** @enum {string} */ - readonly action: "unresolved"; + readonly action: "submitted"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; @@ -77440,7 +70393,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; @@ -77476,7 +70429,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)[]; @@ -77494,7 +70447,7 @@ export interface components { /** @description Commit message for the merge commit. */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string; + readonly commit_title: string | null; /** User */ readonly enabled_by: { /** Format: uri */ @@ -77684,6 +70637,23 @@ export interface components { readonly url: string | null; } | null; readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -77752,6 +70722,23 @@ export interface components { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -77776,6 +70763,11 @@ export interface components { readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; @@ -77833,7 +70825,7 @@ export interface components { readonly diff_url: string; readonly draft: boolean; readonly head: { - readonly label: string; + readonly label: string | null; readonly ref: string; /** * Repository @@ -77978,6 +70970,23 @@ export interface components { readonly url: string | null; } | null; readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -78046,6 +71055,23 @@ export interface components { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -78070,13 +71096,18 @@ export interface components { readonly updated_at: string; /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - }; + } | null; readonly sha: string; /** User */ readonly user: { @@ -78182,7 +71213,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; @@ -78246,22 +71277,22 @@ 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) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description?: string | null; + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url?: string; + readonly members_url: string; /** @description Name of the team */ readonly name: string; - readonly node_id?: string; + readonly node_id: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -78288,17 +71319,17 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission?: string; + readonly permission: string; /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; + readonly repositories_url: string; + readonly slug: string; /** * Format: uri * @description URL for the team */ - readonly url?: string; + readonly url: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -78365,285 +71396,6 @@ export interface components { 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; - 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 repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - readonly thread: { - readonly comments: { - readonly _links: { - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly pull_request: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** - * 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 The text of the comment. */ - readonly body: string; - /** @description The SHA of the commit to which the comment applies. */ - readonly commit_id: string; - /** Format: date-time */ - readonly created_at: string; - /** @description The diff of the line that the comment refers to. */ - readonly diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ - readonly html_url: string; - /** @description The ID of the pull request review comment. */ - readonly id: number; - /** @description The comment ID to reply to. */ - readonly in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly line: number | null; - /** @description The node ID of the pull request review comment. */ - readonly node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - readonly original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - readonly original_line: number; - /** @description The index of the original line in the diff to which the comment applies. */ - readonly original_position: number; - /** @description The first line of the range for a multi-line comment. */ - readonly original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - readonly path: string; - /** @description The line index in the diff to which the comment applies. */ - readonly position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - readonly pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - readonly pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - readonly side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - readonly start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - readonly start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - readonly subject_type?: "line" | "file"; - /** Format: date-time */ - readonly updated_at: string; - /** - * Format: uri - * @description URL for the pull request review 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; - 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 node_id: string; - }; - }; - /** pull_request synchronize event */ - readonly "webhook-pull-request-synchronize": { - /** @enum {string} */ - readonly action: "synchronize"; - readonly after: string; - readonly before: string; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - readonly pull_request: { - readonly _links: { - /** Link */ - readonly comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly commits: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly issue: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comment: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly statuses: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; - /** 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; - } | null; - readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -78678,6 +71430,137 @@ export interface components { readonly type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ readonly url?: string; + } | null; + }; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly review: components["schemas"]["webhooks_review"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request_review_thread resolved event */ + readonly "webhook-pull-request-review-thread-resolved": { + /** @enum {string} */ + readonly action: "resolved"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** Simple Pull Request */ + readonly pull_request: { + readonly _links: { + /** Link */ + readonly comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly commits: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly html: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly issue: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comment: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly statuses: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** @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: ({ + /** 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 @@ -78883,23 +71766,6 @@ export interface components { readonly url: string | null; } | null; readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -78968,23 +71834,6 @@ export interface components { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -79009,11 +71858,6 @@ export interface components { readonly updated_at: string; /** Format: uri */ readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; @@ -79061,24 +71905,17 @@ export interface components { } | null; }; readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ readonly closed_at: string | null; - readonly comments?: number; /** Format: uri */ readonly comments_url: string; - readonly commits?: number; /** Format: uri */ readonly commits_url: string; - /** Format: date-time */ readonly created_at: string; - readonly deletions?: number; /** Format: uri */ readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string; + readonly label: string | null; readonly ref: string; /** * Repository @@ -79223,16 +72060,6 @@ export interface components { readonly url: string | null; } | null; readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit message title. - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -79301,23 +72128,6 @@ export interface components { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -79342,18 +72152,13 @@ export interface components { readonly updated_at: string; /** Format: uri */ readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - }; + } | null; readonly sha: string; /** User */ readonly user: { @@ -79414,51 +72219,8 @@ export interface components { readonly url: string; }[]; readonly locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ readonly merged_at: string | null; - /** User */ - readonly merged_by?: { - /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -79502,7 +72264,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; } | null; @@ -79531,11 +72293,9 @@ export interface components { readonly url: string; } | null; readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; - readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -79675,19 +72435,13 @@ export interface components { }[]; /** Format: uri-template */ readonly review_comment_url: string; - readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; - /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -79730,55 +72484,160 @@ export interface components { } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly thread: { + readonly comments: { + readonly _links: { + /** Link */ + readonly html: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly pull_request: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** + * 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 The text of the comment. */ + readonly body: string; + /** @description The SHA of the commit to which the comment applies. */ + readonly commit_id: string; + /** Format: date-time */ + readonly created_at: string; + /** @description The diff of the line that the comment refers to. */ + readonly diff_hunk: string; + /** + * Format: uri + * @description HTML URL for the pull request review comment. + */ + readonly html_url: string; + /** @description The ID of the pull request review comment. */ + readonly id: number; + /** @description The comment ID to reply to. */ + readonly in_reply_to_id?: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + readonly line: number | null; + /** @description The node ID of the pull request review comment. */ + readonly node_id: string; + /** @description The SHA of the original commit to which the comment applies. */ + readonly original_commit_id: string; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + readonly original_line: number | null; + /** @description The index of the original line in the diff to which the comment applies. */ + readonly original_position: number; + /** @description The first line of the range for a multi-line comment. */ + readonly original_start_line: number | null; + /** @description The relative path of the file to which the comment applies. */ + readonly path: string; + /** @description The line index in the diff to which the comment applies. */ + readonly position: number | null; + /** @description The ID of the pull request review to which the comment belongs. */ + readonly pull_request_review_id: number | null; + /** + * Format: uri + * @description URL for the pull request that the review comment belongs to. + */ + readonly pull_request_url: string; + /** 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; + }; + /** + * @description The side of the first line of the range for a multi-line comment. + * @enum {string} + */ + readonly side: "LEFT" | "RIGHT"; + /** @description The first line of the range for a multi-line comment. */ + readonly start_line: number | null; + /** + * @description The side of the first line of the range for a multi-line comment. + * @default RIGHT + * @enum {string|null} + */ + readonly start_side: "LEFT" | "RIGHT" | null; + /** + * @description The level at which the comment is targeted, can be a diff line or a file. + * @enum {string} + */ + readonly subject_type?: "line" | "file"; + /** Format: date-time */ + readonly updated_at: string; + /** + * Format: uri + * @description URL for the pull request review 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; + 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; + } | null; + }[]; + readonly node_id: string; + }; }; - /** pull_request unassigned event */ - readonly "webhook-pull-request-unassigned": { + /** pull_request_review_thread unresolved event */ + readonly "webhook-pull-request-review-thread-unresolved": { /** @enum {string} */ - readonly action: "unassigned"; - /** 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; - } | null; + readonly action: "unresolved"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ + /** Simple Pull Request */ readonly pull_request: { readonly _links: { /** Link */ @@ -79824,7 +72683,6 @@ export interface components { }; /** @enum {string|null} */ readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; /** User */ readonly assignee: { /** Format: uri */ @@ -79858,7 +72716,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; } | null; @@ -79894,7 +72752,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; } | null)[]; @@ -79912,7 +72770,7 @@ export interface components { /** @description Commit message for the merge commit. */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string | null; + readonly commit_title: string; /** User */ readonly enabled_by: { /** Format: uri */ @@ -79957,7 +72815,7 @@ export interface components { readonly merge_method: "merge" | "squash" | "rebase"; } | null; readonly base: { - readonly label: string | null; + readonly label: string; readonly ref: string; /** * Repository @@ -80102,23 +72960,6 @@ export interface components { readonly url: string | null; } | null; readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -80187,23 +73028,6 @@ export interface components { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -80228,11 +73052,6 @@ export interface components { readonly updated_at: string; /** Format: uri */ readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; @@ -80280,24 +73099,17 @@ export interface components { } | null; }; readonly body: string | null; - readonly changed_files?: number; - /** Format: date-time */ readonly closed_at: string | null; - readonly comments?: number; /** Format: uri */ readonly comments_url: string; - readonly commits?: number; /** Format: uri */ readonly commits_url: string; - /** Format: date-time */ readonly created_at: string; - readonly deletions?: number; /** Format: uri */ readonly diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string | null; + readonly label: string; readonly ref: string; /** * Repository @@ -80442,23 +73254,6 @@ export interface components { readonly url: string | null; } | null; readonly master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ readonly merges_url: string; /** Format: uri-template */ @@ -80527,23 +73322,6 @@ export interface components { readonly releases_url: string; readonly role_name?: string | null; readonly size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; readonly ssh_url: string; readonly stargazers?: number; readonly stargazers_count: number; @@ -80568,18 +73346,13 @@ export interface components { readonly updated_at: string; /** Format: uri */ readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ readonly visibility: "public" | "private" | "internal"; readonly watchers: number; readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - } | null; + }; readonly sha: string; /** User */ readonly user: { @@ -80640,51 +73413,8 @@ export interface components { readonly url: string; }[]; readonly locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ readonly merged_at: string | null; - /** User */ - readonly merged_by?: { - /** 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; - } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -80728,7 +73458,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; } | null; @@ -80757,11 +73487,9 @@ export interface components { readonly url: string; } | null; readonly node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ readonly number: number; /** Format: uri */ readonly patch_url: string; - readonly rebaseable?: boolean | null; readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; @@ -80794,22 +73522,22 @@ 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; } | null) | { readonly deleted?: boolean; /** @description Description of the team */ - readonly description: string | null; + readonly description?: string | null; /** Format: uri */ - readonly html_url: string; + readonly html_url?: string; /** @description Unique identifier of the team */ readonly id: number; /** Format: uri-template */ - readonly members_url: string; + readonly members_url?: string; /** @description Name of the team */ readonly name: string; - readonly node_id: string; + readonly node_id?: string; readonly parent?: { /** @description Description of the team */ readonly description: string | null; @@ -80836,17 +73564,17 @@ export interface components { readonly url: string; } | null; /** @description Permission that the team will have for its repositories */ - readonly permission: string; + readonly permission?: string; /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; + readonly repositories_url?: string; + readonly slug?: string; /** * Format: uri * @description URL for the team */ - readonly url: string; + readonly url?: string; })[]; readonly requested_teams: { readonly deleted?: boolean; @@ -80901,19 +73629,13 @@ export interface components { }[]; /** Format: uri-template */ readonly review_comment_url: string; - readonly review_comments?: number; /** Format: uri */ readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ readonly state: "open" | "closed"; /** Format: uri */ readonly statuses_url: string; - /** @description The title of the pull request. */ readonly title: string; - /** Format: date-time */ readonly updated_at: string; /** Format: uri */ readonly url: string; @@ -80950,38 +73672,167 @@ 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; } | null; }; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly thread: { + readonly comments: { + readonly _links: { + /** Link */ + readonly html: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly pull_request: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** + * 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 The text of the comment. */ + readonly body: string; + /** @description The SHA of the commit to which the comment applies. */ + readonly commit_id: string; + /** Format: date-time */ + readonly created_at: string; + /** @description The diff of the line that the comment refers to. */ + readonly diff_hunk: string; + /** + * Format: uri + * @description HTML URL for the pull request review comment. + */ + readonly html_url: string; + /** @description The ID of the pull request review comment. */ + readonly id: number; + /** @description The comment ID to reply to. */ + readonly in_reply_to_id?: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + readonly line: number | null; + /** @description The node ID of the pull request review comment. */ + readonly node_id: string; + /** @description The SHA of the original commit to which the comment applies. */ + readonly original_commit_id: string; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + readonly original_line: number; + /** @description The index of the original line in the diff to which the comment applies. */ + readonly original_position: number; + /** @description The first line of the range for a multi-line comment. */ + readonly original_start_line: number | null; + /** @description The relative path of the file to which the comment applies. */ + readonly path: string; + /** @description The line index in the diff to which the comment applies. */ + readonly position: number | null; + /** @description The ID of the pull request review to which the comment belongs. */ + readonly pull_request_review_id: number | null; + /** + * Format: uri + * @description URL for the pull request that the review comment belongs to. + */ + readonly pull_request_url: string; + /** 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; + }; + /** + * @description The side of the first line of the range for a multi-line comment. + * @enum {string} + */ + readonly side: "LEFT" | "RIGHT"; + /** @description The first line of the range for a multi-line comment. */ + readonly start_line: number | null; + /** + * @description The side of the first line of the range for a multi-line comment. + * @default RIGHT + * @enum {string|null} + */ + readonly start_side: "LEFT" | "RIGHT" | null; + /** + * @description The level at which the comment is targeted, can be a diff line or a file. + * @enum {string} + */ + readonly subject_type?: "line" | "file"; + /** Format: date-time */ + readonly updated_at: string; + /** + * Format: uri + * @description URL for the pull request review 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; + 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 node_id: string; + }; }; - /** pull_request unlabeled event */ - readonly "webhook-pull-request-unlabeled": { + /** pull_request synchronize event */ + readonly "webhook-pull-request-synchronize": { /** @enum {string} */ - readonly action: "unlabeled"; + readonly action: "synchronize"; + readonly after: string; + readonly before: string; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; - /** Label */ - readonly label?: { - /** @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; - }; - /** @description The pull request number. */ - readonly number: number; + readonly number: components["schemas"]["webhooks_number"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ readonly pull_request: { @@ -81502,7 +74353,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string | null; + readonly label: string; readonly ref: string; /** * Repository @@ -81777,7 +74628,7 @@ export interface components { readonly watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ readonly web_commit_signoff_required?: boolean; - } | null; + }; readonly sha: string; /** User */ readonly user: { @@ -82152,103 +75003,103 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request unlocked event */ - readonly "webhook-pull-request-unlocked": { - /** @enum {string} */ - readonly action: "unlocked"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - readonly number: number; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - readonly pull_request: { - readonly _links: { - /** Link */ - readonly comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly commits: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly html: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly issue: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comment: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly review_comments: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly self: { - /** Format: uri-template */ - readonly href: string; - }; - /** Link */ - readonly statuses: { - /** Format: uri-template */ - readonly href: string; - }; - }; - /** @enum {string|null} */ - readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - readonly additions?: number; - /** 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 repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request unassigned event */ + readonly "webhook-pull-request-unassigned": { + /** @enum {string} */ + readonly action: "unassigned"; + readonly assignee?: components["schemas"]["webhooks_user_mannequin"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** Pull Request */ + readonly pull_request: { + readonly _links: { + /** Link */ + readonly comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly commits: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly html: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly issue: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comment: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly statuses: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** @enum {string|null} */ + readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; + /** 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; + } | null; readonly assignees: ({ /** Format: uri */ readonly avatar_url?: string; @@ -82281,7 +75132,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)[]; @@ -82299,7 +75150,7 @@ export interface components { /** @description Commit message for the merge commit. */ readonly commit_message: string | null; /** @description Title for the merge commit message. */ - readonly commit_title: string; + readonly commit_title: string | null; /** User */ readonly enabled_by: { /** Format: uri */ @@ -82344,7 +75195,7 @@ export interface components { readonly merge_method: "merge" | "squash" | "rebase"; } | null; readonly base: { - readonly label: string; + readonly label: string | null; readonly ref: string; /** * Repository @@ -82684,7 +75535,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ readonly draft: boolean; readonly head: { - readonly label: string; + readonly label: string | null; readonly ref: string; /** * Repository @@ -82935,714 +75786,108 @@ export interface components { readonly stargazers?: number; readonly stargazers_count: number; /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - readonly use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - } | null; - readonly sha: 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; - 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; - }; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - /** Format: uri */ - readonly issue_url: string; - readonly labels: { - /** @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 locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - readonly maintainer_can_modify?: boolean; - readonly merge_commit_sha: string | null; - readonly mergeable?: boolean | null; - readonly mergeable_state?: string; - readonly merged?: boolean | null; - /** Format: date-time */ - readonly merged_at: string | null; - /** User */ - readonly merged_by?: { - /** 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; - /** - * 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; + readonly stargazers_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; + readonly statuses_url: string; /** Format: uri */ - readonly received_events_url?: string; + readonly subscribers_url: string; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; - /** Format: uri-template */ - readonly starred_url?: string; + readonly subscription_url: string; /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly svn_url: string; /** Format: uri */ - readonly url?: 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; - /** @description Number uniquely identifying the pull request within its repository. */ - readonly number: number; - /** Format: uri */ - readonly patch_url: string; - readonly rebaseable?: boolean | null; - readonly requested_reviewers: (({ - /** 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 deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; + readonly tags_url: string; /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; + readonly teams_url: string; + readonly topics: string[]; /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - })[]; - readonly requested_teams: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; /** - * Format: uri - * @description URL for the team + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }[]; - /** Format: uri-template */ - readonly review_comment_url: string; - readonly review_comments?: number; - /** Format: uri */ - readonly review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - readonly state: "open" | "closed"; - /** Format: uri */ - readonly statuses_url: string; - /** @description The title of the pull request. */ - readonly title: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - 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; - 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 repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** push event */ - readonly "webhook-push": { - /** @description The SHA of the most recent commit on `ref` after the push. */ - readonly after: string; - readonly base_ref: string | null; - /** @description The SHA of the most recent commit on `ref` before the push. */ - readonly before: string; - /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */ - readonly commits: { - /** @description An array of files added in the commit. */ - readonly added?: string[]; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly author: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly committer: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** @description Whether this commit is distinct from any that have been pushed before. */ - readonly distinct: boolean; - readonly id: string; - /** @description The commit message. */ - readonly message: string; - /** @description An array of files modified by the commit. */ - readonly modified?: string[]; - /** @description An array of files removed in the commit. */ - readonly removed?: string[]; - /** - * Format: date-time - * @description The ISO 8601 timestamp of the commit. - */ - readonly timestamp: string; - readonly tree_id: string; - /** - * Format: uri - * @description URL that points to the commit API resource. - */ - readonly url: string; - }[]; - /** @description URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. */ - readonly compare: string; - /** @description Whether this push created the `ref`. */ - readonly created: boolean; - /** @description Whether this push deleted the `ref`. */ - readonly deleted: boolean; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description Whether this push was a force push of the `ref`. */ - readonly forced: boolean; - /** Commit */ - readonly head_commit: { - /** @description An array of files added in the commit. */ - readonly added?: string[]; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly author: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly committer: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** @description Whether this commit is distinct from any that have been pushed before. */ - readonly distinct: boolean; - readonly id: string; - /** @description The commit message. */ - readonly message: string; - /** @description An array of files modified by the commit. */ - readonly modified?: string[]; - /** @description An array of files removed in the commit. */ - readonly removed?: string[]; - /** - * Format: date-time - * @description The ISO 8601 timestamp of the commit. - */ - readonly timestamp: string; - readonly tree_id: string; - /** - * Format: uri - * @description URL that points to the commit API resource. - */ - readonly url: string; - } | null; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - readonly pusher: { - /** Format: date-time */ - readonly date?: string; - /** Format: email */ - readonly email?: string | null; - /** @description The git author's name. */ - readonly name: string; - readonly username?: string; - }; - /** @description The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. */ - readonly ref: string; - /** - * Repository - * @description A git repository - */ - readonly repository: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - readonly allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - readonly allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - readonly allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - readonly allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - readonly allow_squash_merge: boolean; - readonly allow_update_branch?: boolean; - /** Format: uri-template */ - readonly archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - readonly archived: boolean; - /** Format: uri-template */ - readonly assignees_url: string; - /** Format: uri-template */ - readonly blobs_url: string; - /** Format: uri-template */ - readonly branches_url: string; - /** Format: uri */ - readonly clone_url: string; - /** Format: uri-template */ - readonly collaborators_url: string; - /** Format: uri-template */ - readonly comments_url: string; - /** Format: uri-template */ - readonly commits_url: string; - /** Format: uri-template */ - readonly compare_url: string; - /** Format: uri-template */ - readonly contents_url: string; - /** Format: uri */ - readonly contributors_url: string; - readonly created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - readonly custom_properties?: { - readonly [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - readonly default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - readonly delete_branch_on_merge: boolean; - /** Format: uri */ - readonly deployments_url: string; - readonly description: string | null; - /** @description Returns whether or not this repository is disabled. */ - readonly disabled?: boolean; - /** Format: uri */ - readonly downloads_url: string; - /** Format: uri */ - readonly events_url: string; - readonly fork: boolean; - readonly forks: number; - readonly forks_count: number; - /** Format: uri */ - readonly forks_url: string; - readonly full_name: string; - /** Format: uri-template */ - readonly git_commits_url: string; - /** Format: uri-template */ - readonly git_refs_url: string; - /** Format: uri-template */ - readonly git_tags_url: string; - /** Format: uri */ - readonly git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - readonly has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - readonly has_issues: boolean; - readonly has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - readonly has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - readonly has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - readonly has_discussions: boolean; - readonly homepage: string | null; - /** Format: uri */ - readonly hooks_url: string; + readonly use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; + } | null; + readonly sha: 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; + 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; + }; /** Format: uri */ readonly html_url: string; - /** @description Unique identifier of the repository */ readonly id: number; - readonly is_template?: boolean; - /** Format: uri-template */ - readonly issue_comment_url: string; - /** Format: uri-template */ - readonly issue_events_url: string; - /** Format: uri-template */ - readonly issues_url: string; - /** Format: uri-template */ - readonly keys_url: string; - /** Format: uri-template */ - readonly labels_url: string; - readonly language: string | null; /** Format: uri */ - readonly languages_url: string; - /** License */ - readonly license: { - readonly key: string; + readonly issue_url: string; + readonly labels: { + /** @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; - readonly spdx_id: string; - /** Format: uri */ - readonly url: string | null; - } | null; - readonly master_branch?: string; - /** Format: uri */ - readonly merges_url: string; - /** Format: uri-template */ - readonly milestones_url: string; - /** Format: uri */ - readonly mirror_url: string | null; - /** @description The name of the repository. */ - readonly name: string; - readonly node_id: string; - /** Format: uri-template */ - readonly notifications_url: string; - readonly open_issues: number; - readonly open_issues_count: number; - readonly organization?: string; + /** + * Format: uri + * @description URL for the label + */ + readonly url: string; + }[]; + readonly locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; + readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ + readonly merged_at: string | null; /** User */ - readonly owner: { + readonly merged_by?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -83674,423 +75919,757 @@ 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; - readonly permissions?: { - readonly admin: boolean; - readonly maintain?: boolean; - readonly pull: boolean; - readonly push: boolean; - readonly triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - readonly private: boolean; - readonly public?: boolean; - /** Format: uri-template */ - readonly pulls_url: string; - readonly pushed_at: (number | string) | null; - /** Format: uri-template */ - readonly releases_url: string; - readonly role_name?: string | null; - readonly size: number; - readonly ssh_url: string; - readonly stargazers?: number; - readonly stargazers_count: number; - /** Format: uri */ - readonly stargazers_url: string; - /** Format: uri-template */ - readonly statuses_url: string; - /** Format: uri */ - readonly subscribers_url: string; - /** Format: uri */ - readonly subscription_url: string; - /** Format: uri */ - readonly svn_url: string; - /** Format: uri */ - readonly tags_url: string; - /** Format: uri */ - readonly teams_url: string; - readonly topics: string[]; - /** Format: uri-template */ - readonly trees_url: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - /** @enum {string} */ - readonly visibility: "public" | "private" | "internal"; - readonly watchers: number; - readonly watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - readonly web_commit_signoff_required?: boolean; - }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - readonly "webhook-registry-package-published": { - /** @enum {string} */ - readonly action: "published"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly registry_package: { - readonly created_at: string | null; - readonly description: string | null; - readonly ecosystem: string; - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; - readonly owner: { - readonly avatar_url: string; - readonly events_url: string; - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string; + /** + * 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; + } | null; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; + /** Format: uri */ readonly html_url: string; readonly id: number; - readonly login: string; + /** Format: uri */ + readonly labels_url: 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; + /** @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; - }; - readonly package_type: string; - readonly package_version: { - readonly author?: { - readonly avatar_url: string; - readonly events_url: string; - readonly followers_url: string; - readonly following_url: string; - readonly gists_url: string; - readonly gravatar_id: string; + } | null; + readonly node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ + readonly number: number; + /** Format: uri */ + readonly patch_url: string; + readonly rebaseable?: boolean | null; + readonly requested_reviewers: (({ + /** 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; + } | null) | { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ readonly html_url: string; + /** @description Unique identifier of the team */ readonly id: number; - readonly login: string; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: 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; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ readonly url: string; - }; - readonly body?: string | Record; - readonly body_html?: string; - readonly container_metadata?: { - readonly labels?: Record; - readonly manifest?: Record; - readonly tag?: { - readonly digest?: string; - readonly name?: string; - }; - }; - readonly created_at?: string; - readonly description: string; - readonly docker_metadata?: { - readonly tags?: string[]; - }[]; - readonly draft?: boolean; - readonly html_url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + })[]; + readonly requested_teams: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: { - readonly [key: string]: unknown; - }[]; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ readonly name: string; - readonly npm_metadata?: { - readonly name?: string; - readonly version?: string; - readonly npm_user?: string; - readonly author?: (string | Record) | null; - readonly bugs?: (string | Record) | null; - readonly dependencies?: Record; - readonly dev_dependencies?: Record; - readonly peer_dependencies?: Record; - readonly optional_dependencies?: Record; - readonly description?: string; - readonly dist?: (string | Record) | null; - readonly git_head?: string; - readonly homepage?: string; - readonly license?: string; - readonly main?: string; - readonly repository?: (string | Record) | null; - readonly scripts?: Record; - readonly id?: string; - readonly node_version?: string; - readonly npm_version?: string; - readonly has_shrinkwrap?: boolean; - readonly maintainers?: string[]; - readonly contributors?: string[]; - readonly engines?: Record; - readonly keywords?: string[]; - readonly files?: string[]; - readonly bin?: Record; - readonly man?: Record; - readonly directories?: (string | Record) | null; - readonly os?: string[]; - readonly cpu?: string[]; - readonly readme?: string; - readonly installation_command?: string; - readonly release_id?: number; - readonly commit_oid?: string; - readonly published_via_actions?: boolean; - readonly deleted_by_id?: number; - } | null; - readonly nuget_metadata?: { - readonly id?: (string | Record | number) | null; - readonly name?: string; - readonly value?: boolean | string | number | { - readonly url?: string; - readonly branch?: string; - readonly commit?: string; - readonly type?: string; - }; - }[] | null; - readonly package_files: { - readonly content_type: string; - readonly created_at: string; - readonly download_url: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ readonly id: number; - readonly md5: string | null; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ readonly name: string; - readonly sha1: string | null; - readonly sha256: string | null; - readonly size: number; - readonly state: string | null; - readonly updated_at: string; - }[]; - readonly package_url: string; - readonly prerelease?: boolean; - readonly release?: { - readonly author?: { - 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; - 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 created_at?: string; - readonly draft?: boolean; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly prerelease?: boolean; - readonly published_at?: string; - readonly tag_name?: string; - readonly target_commitish?: string; - readonly url?: string; - }; - readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish?: string; - readonly target_oid?: string; - readonly updated_at?: string; - readonly version: string; - } | null; - readonly registry: { - readonly about_url?: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; + }[]; + /** Format: uri-template */ + readonly review_comment_url: string; + readonly review_comments?: number; + /** Format: uri */ + readonly review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + readonly state: "open" | "closed"; + /** Format: uri */ + readonly statuses_url: string; + /** @description The title of the pull request. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + 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; + readonly id: number; + readonly login: string; readonly name?: string; - readonly type?: 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 vendor?: string; } | null; - readonly updated_at: string | null; }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; }; - readonly "webhook-registry-package-updated": { + /** pull_request unlabeled event */ + readonly "webhook-pull-request-unlabeled": { /** @enum {string} */ - readonly action: "updated"; + readonly action: "unlabeled"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; + readonly label?: components["schemas"]["webhooks_label"]; + readonly number: components["schemas"]["webhooks_number"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly registry_package: { - readonly created_at: string; - readonly description: unknown; - readonly ecosystem: string; - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly namespace: string; - readonly owner: { - 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; + /** Pull Request */ + readonly pull_request: { + readonly _links: { + /** Link */ + readonly comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly commits: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly html: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly issue: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comment: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly statuses: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** @enum {string|null} */ + readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; + /** 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 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 package_type: string; - readonly package_version: { - readonly author: { - 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; + 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; + } | null; + readonly assignees: ({ + /** 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; + } | 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"; + /** + * PullRequestAutoMerge + * @description The status of auto merging a pull request. + */ + readonly auto_merge: { + /** @description Commit message for the merge commit. */ + readonly commit_message: string | null; + /** @description Title for the merge commit message. */ + readonly commit_title: string | null; + /** User */ + readonly enabled_by: { + /** 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 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 body: string; - readonly body_html: string; - readonly created_at: string; - readonly description: string; - readonly docker_metadata?: ({ - readonly tags?: string[]; - } | null)[]; - readonly draft?: boolean; - readonly html_url: string; - readonly id: number; - readonly installation_command: string; - readonly manifest?: string; - readonly metadata: { - readonly [key: string]: unknown; - }[]; - readonly name: string; - readonly package_files: { - readonly content_type?: string; - readonly created_at?: string; - readonly download_url?: string; - readonly id?: number; - readonly md5?: string | null; readonly name?: string; - readonly sha1?: string | null; - readonly sha256?: string; - readonly size?: number; - readonly state?: string; - readonly updated_at?: string; - }[]; - readonly package_url: string; - readonly prerelease?: boolean; - readonly release?: { - readonly author: { - 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; + 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; + /** + * @description The merge method to use. + * @enum {string} + */ + readonly merge_method: "merge" | "squash" | "rebase"; + } | null; + readonly base: { + readonly label: string; + readonly ref: string; + /** + * Repository + * @description A git repository + */ + readonly repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: 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 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 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 permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; }; - readonly created_at: string; - readonly draft: boolean; - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly prerelease: boolean; - readonly published_at: string; - readonly tag_name: string; - readonly target_commitish: string; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; }; - readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - readonly summary: string; - readonly tag_name?: string; - readonly target_commitish: string; - readonly target_oid: string; - readonly updated_at: string; - readonly version: string; - }; - readonly registry: Record; - readonly updated_at: string; - }; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** release created event */ - readonly "webhook-release-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - readonly release: { - readonly assets: { - /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; - /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; - /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - readonly state: "uploaded"; - /** Format: date-time */ - readonly updated_at: string; + readonly sha: string; /** User */ - readonly uploader?: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84126,128 +76705,304 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - /** Format: uri */ - readonly url: string; - }[]; - /** Format: uri */ - readonly assets_url: string; - /** User */ - readonly author: { - /** 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 body: string | null; + readonly changed_files?: number; /** Format: date-time */ - readonly created_at: string | null; + readonly closed_at: string | null; + readonly comments?: number; /** Format: uri */ - readonly discussion_url?: string; - /** @description Whether the release is a draft or published */ - readonly draft: boolean; + readonly comments_url: string; + readonly commits?: number; /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; + readonly commits_url: string; /** Format: date-time */ - readonly published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - readonly tag_name: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; - /** Format: uri-template */ - readonly upload_url: string; - /** Format: uri */ - readonly url: string; + readonly created_at: string; + readonly deletions?: number; /** Format: uri */ - readonly zipball_url: string | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** release deleted event */ - readonly "webhook-release-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - readonly release: { - readonly assets: { - /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; - /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; + readonly diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ + readonly draft: boolean; + readonly head: { readonly label: string | null; - /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; + readonly ref: string; /** - * @description State of the release asset. - * @enum {string} + * Repository + * @description A git repository */ - readonly state: "uploaded"; - /** Format: date-time */ - readonly updated_at: string; + readonly repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit message title. + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: 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; + } | null; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; + } | null; + readonly sha: string; /** User */ - readonly uploader?: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84283,13 +77038,38 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - /** Format: uri */ + }; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + /** Format: uri */ + readonly issue_url: string; + readonly labels: { + /** @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 */ - readonly assets_url: string; + readonly locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; + readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ + readonly merged_at: string | null; /** User */ - readonly author: { + readonly merged_by?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84325,100 +77105,18 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - readonly body: string | null; - /** Format: date-time */ - readonly created_at: string | null; - /** Format: uri */ - readonly discussion_url?: string; - /** @description Whether the release is a draft or published */ - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; - /** Format: date-time */ - readonly published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - readonly tag_name: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; - /** Format: uri-template */ - readonly upload_url: string; - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly zipball_url: string | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** release edited event */ - readonly "webhook-release-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly body?: { - /** @description The previous version of the body if the action was `edited`. */ - readonly from: string; - }; - readonly name?: { - /** @description The previous version of the name if the action was `edited`. */ - readonly from: string; - }; - readonly make_latest?: { - /** @description Whether this release was explicitly `edited` to be the latest. */ - readonly to: boolean; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - readonly release: { - readonly assets: { - /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + readonly milestone: { /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; - /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - readonly state: "uploaded"; + readonly closed_at: string | null; + readonly closed_issues: number; /** Format: date-time */ - readonly updated_at: string; + readonly created_at: string; /** User */ - readonly uploader?: { + readonly creator: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84450,17 +77148,41 @@ 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; + 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; + /** @description Number uniquely identifying the pull request within its repository. */ + readonly number: number; /** Format: uri */ - readonly assets_url: string; - /** User */ - readonly author: { + readonly patch_url: string; + readonly rebaseable?: boolean | null; + readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84492,128 +77214,131 @@ 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; - readonly body: string | null; - /** Format: date-time */ - readonly created_at: string | null; - /** Format: uri */ - readonly discussion_url?: string; - /** @description Whether the release is a draft or published */ - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; - /** Format: date-time */ - readonly published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - readonly tag_name: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; - /** Format: uri-template */ - readonly upload_url: string; - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly zipball_url: string | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** release prereleased event */ - readonly "webhook-release-prereleased": { - /** @enum {string} */ - readonly action: "prereleased"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly release: { - readonly assets: { + } | null) | { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description: string | null; /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; - /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; + readonly html_url: string; + /** @description Unique identifier of the team */ readonly id: number; - readonly label: string | null; - /** @description The file name of the asset. */ + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ readonly name: string; readonly node_id: string; - readonly size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - readonly state: "uploaded"; - /** Format: date-time */ - readonly updated_at: string; - /** User */ - readonly uploader?: { + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; /** Format: uri-template */ - readonly events_url?: string; + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly followers_url?: string; - /** Format: uri-template */ - readonly following_url?: string; - /** Format: uri-template */ - readonly gists_url?: string; - readonly gravatar_id?: string; + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + })[]; + readonly requested_teams: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; + /** Format: uri */ + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; /** Format: uri */ - readonly html_url?: string; + readonly html_url: string; + /** @description Unique identifier of the team */ 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; + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly privacy: "open" | "closed" | "secret"; /** Format: uri */ - readonly url?: string; + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly url: string; + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; }[]; + /** Format: uri-template */ + readonly review_comment_url: string; + readonly review_comments?: number; /** Format: uri */ - readonly assets_url: string; + readonly review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + readonly state: "open" | "closed"; + /** Format: uri */ + readonly statuses_url: string; + /** @description The title of the pull request. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; /** User */ - readonly author: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84645,170 +77370,71 @@ 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; - readonly body: string | null; - /** Format: date-time */ - readonly created_at: string | null; - /** Format: uri */ - readonly discussion_url?: string; - /** @description Whether the release is a draft or published */ - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; - /** Format: date-time */ - readonly published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - readonly tag_name: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; - /** Format: uri-template */ - readonly upload_url: string; - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly zipball_url: string | null; - } & { - readonly assets?: Record[]; - readonly assets_url?: string; - readonly author?: { - 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; - 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 body?: string | null; - readonly created_at?: string; - readonly draft?: boolean; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly node_id?: string; - /** - * @description Whether the release is identified as a prerelease or a full release. - * @enum {boolean} - */ - readonly prerelease: true; - readonly published_at?: string | null; - readonly tag_name?: string; - readonly tarball_url?: string | null; - readonly target_commitish?: string; - readonly upload_url?: string; - readonly url?: string; - readonly zipball_url?: string | null; }; readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** release published event */ - readonly "webhook-release-published": { + /** pull_request unlocked event */ + readonly "webhook-pull-request-unlocked": { /** @enum {string} */ - readonly action: "published"; + readonly action: "unlocked"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; + readonly number: components["schemas"]["webhooks_number"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly release: { - readonly assets: { - /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; - /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; - /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - readonly state: "uploaded"; - /** Format: date-time */ - readonly updated_at: string; - /** User */ - readonly uploader?: { - /** Format: uri */ - readonly avatar_url?: string; - readonly deleted?: boolean; - readonly email?: string | null; + /** Pull Request */ + readonly pull_request: { + readonly _links: { + /** Link */ + readonly comments: { /** Format: uri-template */ - readonly events_url?: string; - /** Format: uri */ - readonly followers_url?: string; + readonly href: string; + }; + /** Link */ + readonly commits: { /** Format: uri-template */ - readonly following_url?: string; + readonly href: string; + }; + /** Link */ + readonly html: { /** 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; + readonly href: string; + }; + /** Link */ + readonly issue: { /** 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; - /** Format: uri */ - readonly url: string; - }[]; - /** Format: uri */ - readonly assets_url: string; + readonly href: string; + }; + /** Link */ + readonly review_comment: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly review_comments: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly self: { + /** Format: uri-template */ + readonly href: string; + }; + /** Link */ + readonly statuses: { + /** Format: uri-template */ + readonly href: string; + }; + }; + /** @enum {string|null} */ + readonly active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + readonly additions?: number; /** User */ - readonly author: { + readonly assignee: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84844,125 +77470,59 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - readonly body: string | null; - /** Format: date-time */ - readonly created_at: string | null; - /** Format: uri */ - readonly discussion_url?: string; - /** @description Whether the release is a draft or published */ - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; - /** Format: date-time */ - readonly published_at: string | null; - /** 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; + readonly assignees: ({ /** Format: uri */ - readonly url: string; - }; - /** @description The name of the tag. */ - readonly tag_name: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; - /** Format: uri-template */ - readonly upload_url: string; - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly zipball_url: string | null; - } & { - readonly assets?: Record[]; - readonly assets_url?: string; - readonly author?: { 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 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; - readonly type?: string; - readonly url?: string; - }; - readonly body?: string | null; - readonly created_at?: string; - readonly draft?: boolean; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly node_id?: string; - readonly prerelease?: boolean; - /** Format: date-time */ - readonly published_at: string | null; - readonly tag_name?: string; - readonly tarball_url?: string | null; - readonly target_commitish?: string; - readonly upload_url?: string; - readonly url?: string; - readonly zipball_url?: string | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** release released event */ - readonly "webhook-release-released": { - /** @enum {string} */ - readonly action: "released"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - readonly release: { - readonly assets: { + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; - /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; - /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - readonly state: "uploaded"; - /** Format: date-time */ - readonly updated_at: string; + 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"; + /** + * PullRequestAutoMerge + * @description The status of auto merging a pull request. + */ + readonly auto_merge: { + /** @description Commit message for the merge commit. */ + readonly commit_message: string | null; + /** @description Title for the merge commit message. */ + readonly commit_title: string; /** User */ - readonly uploader?: { + readonly enabled_by: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -84992,130 +77552,305 @@ export interface components { /** Format: uri-template */ readonly starred_url?: string; /** Format: uri */ - readonly subscriptions_url?: string; + readonly subscriptions_url?: string; + /** @enum {string} */ + readonly type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + readonly url?: string; + } | null; + /** + * @description The merge method to use. + * @enum {string} + */ + readonly merge_method: "merge" | "squash" | "rebase"; + } | null; + readonly base: { + readonly label: string; + readonly ref: string; + /** + * Repository + * @description A git repository + */ + readonly repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: 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; + } | null; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - readonly url?: string; - } | null; - /** Format: uri */ - readonly url: string; - }[]; - /** Format: uri */ - readonly assets_url: string; - /** User */ - readonly author: { - /** 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 body: string | null; - /** Format: date-time */ - readonly created_at: string | null; - /** Format: uri */ - readonly discussion_url?: string; - /** @description Whether the release is a draft or published */ - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; - /** Format: date-time */ - readonly published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - readonly tag_name: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; - /** Format: uri-template */ - readonly upload_url: string; - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly zipball_url: string | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** release unpublished event */ - readonly "webhook-release-unpublished": { - /** @enum {string} */ - readonly action: "unpublished"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly release: { - readonly assets: { - /** Format: uri */ - readonly browser_download_url: string; - readonly content_type: string; - /** Format: date-time */ - readonly created_at: string; - readonly download_count: number; - readonly id: number; - readonly label: string | null; - /** @description The file name of the asset. */ - readonly name: string; - readonly node_id: string; - readonly size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - readonly state: "uploaded"; - /** Format: date-time */ - readonly updated_at: string; + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; + }; + readonly sha: string; /** User */ - readonly uploader?: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -85131,403 +77866,223 @@ export interface components { 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; - /** Format: uri */ - readonly url: string; - }[]; - /** Format: uri */ - readonly assets_url: string; - /** User */ - readonly author: { - /** 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 body: string | null; - /** Format: date-time */ - readonly created_at: string | null; - /** Format: uri */ - readonly discussion_url?: string; - /** @description Whether the release is a draft or published */ - readonly draft: boolean; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string | null; - readonly node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - readonly prerelease: boolean; - /** Format: date-time */ - readonly published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - readonly tag_name: string; - /** Format: uri */ - readonly tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - readonly target_commitish: string; - /** Format: uri-template */ - readonly upload_url: string; - /** Format: uri */ - readonly url: string; - /** Format: uri */ - readonly zipball_url: string | null; - } & { - readonly assets?: Record[]; - readonly assets_url?: string; - readonly author?: { - 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; - 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 body?: string | null; - readonly created_at?: string; - readonly draft?: boolean; - readonly html_url?: string; - readonly id?: number; - readonly name?: string | null; - readonly node_id?: string; - readonly prerelease?: boolean; - readonly published_at: string | null; - readonly tag_name?: string; - readonly tarball_url?: string | null; - readonly target_commitish?: string; - readonly upload_url?: string; - readonly url?: string; - readonly zipball_url?: string | null; - }; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** Repository advisory published event */ - readonly "webhook-repository-advisory-published": { - /** @enum {string} */ - readonly action: "published"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly repository_advisory: components["schemas"]["repository-advisory"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** Repository advisory reported event */ - readonly "webhook-repository-advisory-reported": { - /** @enum {string} */ - readonly action: "reported"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly repository_advisory: components["schemas"]["repository-advisory"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** repository archived event */ - readonly "webhook-repository-archived": { - /** @enum {string} */ - readonly action: "archived"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository created event */ - readonly "webhook-repository-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository deleted event */ - readonly "webhook-repository-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_dispatch event */ - readonly "webhook-repository-dispatch-sample": { - /** @enum {string} */ - readonly action: "sample.collected"; - readonly branch: string; - readonly client_payload: { - readonly [key: string]: unknown; - } | null; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository edited event */ - readonly "webhook-repository-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly default_branch?: { - readonly from: string; - }; - readonly description?: { - readonly from: string | null; - }; - readonly homepage?: { - readonly from: string | null; - }; - readonly topics?: { - readonly from?: string[] | null; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_import event */ - readonly "webhook-repository-import": { - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - /** @enum {string} */ - readonly status: "success" | "cancelled" | "failure"; - }; - /** repository privatized event */ - readonly "webhook-repository-privatized": { - /** @enum {string} */ - readonly action: "privatized"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository publicized event */ - readonly "webhook-repository-publicized": { - /** @enum {string} */ - readonly action: "publicized"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository renamed event */ - readonly "webhook-repository-renamed": { - /** @enum {string} */ - readonly action: "renamed"; - readonly changes: { - readonly repository: { - readonly name: { - readonly from: string; - }; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository ruleset created event */ - readonly "webhook-repository-ruleset-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository ruleset deleted event */ - readonly "webhook-repository-ruleset-deleted": { - /** @enum {string} */ - readonly action: "deleted"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository ruleset edited event */ - readonly "webhook-repository-ruleset-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly repository_ruleset: components["schemas"]["repository-ruleset"]; - readonly changes?: { - readonly name?: { - readonly from?: string; - }; - readonly enforcement?: { - readonly from?: string; - }; - readonly conditions?: { - readonly added?: components["schemas"]["repository-ruleset-conditions"][]; - readonly deleted?: components["schemas"]["repository-ruleset-conditions"][]; - readonly updated?: { - readonly condition?: components["schemas"]["repository-ruleset-conditions"]; - readonly changes?: { - readonly condition_type?: { - readonly from?: string; - }; - readonly target?: { - readonly from?: string; - }; - readonly include?: { - readonly from?: string[]; - }; - readonly exclude?: { - readonly from?: string[]; - }; - }; - }[]; - }; - readonly rules?: { - readonly added?: components["schemas"]["repository-rule"][]; - readonly deleted?: components["schemas"]["repository-rule"][]; - readonly updated?: { - readonly rule?: components["schemas"]["repository-rule"]; - readonly changes?: { - readonly configuration?: { - readonly from?: string; - }; - readonly rule_type?: { - readonly from?: string; - }; - readonly pattern?: { - readonly from?: string; - }; - }; - }[]; - }; - }; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository transferred event */ - readonly "webhook-repository-transferred": { - /** @enum {string} */ - readonly action: "transferred"; - readonly changes: { - readonly owner: { - readonly from: { - /** Organization */ - readonly organization?: { - /** Format: uri */ - readonly avatar_url: string; - readonly description: string | null; - /** Format: uri */ - readonly events_url: string; - /** Format: uri */ - readonly hooks_url: string; - /** Format: uri */ - readonly html_url?: string; - readonly id: number; - /** Format: uri */ - readonly issues_url: string; - readonly login: string; - /** Format: uri-template */ - readonly members_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 body: string | null; + readonly changed_files?: number; + /** Format: date-time */ + readonly closed_at: string | null; + readonly comments?: number; + /** Format: uri */ + readonly comments_url: string; + readonly commits?: number; + /** Format: uri */ + readonly commits_url: string; + /** Format: date-time */ + readonly created_at: string; + readonly deletions?: number; + /** Format: uri */ + readonly diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ + readonly draft: boolean; + readonly head: { + readonly label: string; + readonly ref: string; + /** + * Repository + * @description A git repository + */ + readonly repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; readonly node_id: string; - /** Format: uri-template */ - readonly public_members_url: string; - /** Format: uri */ - readonly repos_url: string; + readonly spdx_id: string; /** Format: uri */ - readonly url: string; - }; + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + readonly merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; + readonly node_id: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: string; /** User */ - readonly user?: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -85563,324 +78118,146 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - }; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository unarchived event */ - readonly "webhook-repository-unarchived": { - /** @enum {string} */ - readonly action: "unarchived"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert create event */ - readonly "webhook-repository-vulnerability-alert-create": { - /** @enum {string} */ - readonly action: "create"; - readonly alert: { - readonly affected_package_name: string; - readonly affected_range: string; - readonly created_at: string; - readonly dismiss_reason?: string; - readonly dismissed_at?: string; - /** User */ - readonly dismisser?: { - /** 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 external_identifier: string; - /** Format: uri */ - readonly external_reference: string | null; - readonly fix_reason?: string; - /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id: string; - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly severity: string; - /** @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; - } & { - readonly affected_package_name?: string; - readonly affected_range?: string; - readonly created_at?: string; - readonly external_identifier?: string; - readonly external_reference?: string | null; - readonly fixed_in?: string; - readonly ghsa_id?: string; - readonly id?: number; - readonly node_id?: string; - readonly number?: number; - readonly severity?: string; - /** @enum {string} */ - readonly state: "open"; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert dismiss event */ - readonly "webhook-repository-vulnerability-alert-dismiss": { - /** @enum {string} */ - readonly action: "dismiss"; - readonly alert: { - readonly affected_package_name: string; - readonly affected_range: string; - readonly created_at: string; - readonly dismiss_comment?: string | null; - readonly dismiss_reason?: string; - readonly dismissed_at?: string; - /** User */ - readonly dismisser?: { - /** 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 external_identifier: string; - /** Format: uri */ - readonly external_reference: string | null; - readonly fix_reason?: string; - /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id: string; - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly severity: string; - /** @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; - } & { - readonly affected_package_name?: string; - readonly affected_range?: string; - readonly created_at?: string; - readonly dismiss_comment?: string | null; - readonly dismiss_reason: string; - readonly dismissed_at: string; - /** User */ - readonly dismisser: { - /** 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 external_identifier?: string; - readonly external_reference?: string | null; - readonly fixed_in?: string; - readonly ghsa_id?: string; - readonly id?: number; - readonly node_id?: string; - readonly number?: number; - readonly severity?: string; - /** @enum {string} */ - readonly state: "dismissed"; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert reopen event */ - readonly "webhook-repository-vulnerability-alert-reopen": { - /** @enum {string} */ - readonly action: "reopen"; - readonly alert: { - readonly affected_package_name: string; - readonly affected_range: string; - readonly created_at: string; - readonly dismiss_reason?: string; - readonly dismissed_at?: string; - /** User */ - readonly dismisser?: { - /** 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 external_identifier: string; + readonly permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + readonly squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + readonly squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + readonly use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; + } | null; + readonly sha: 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; + 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; + }; /** Format: uri */ - readonly external_reference: string | null; - readonly fix_reason?: string; - /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id: string; + readonly html_url: string; readonly id: number; - readonly node_id: string; - readonly number: number; - readonly severity: string; - /** @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; - } & { - readonly affected_package_name?: string; - readonly affected_range?: string; - readonly created_at?: string; - readonly external_identifier?: string; - readonly external_reference?: string | null; - readonly fixed_in?: string; - readonly ghsa_id?: string; - readonly id?: number; - readonly node_id?: string; - readonly number?: number; - readonly severity?: string; - /** @enum {string} */ - readonly state: "open"; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert resolve event */ - readonly "webhook-repository-vulnerability-alert-resolve": { - /** @enum {string} */ - readonly action: "resolve"; - readonly alert: { - readonly affected_package_name: string; - readonly affected_range: string; - readonly created_at: string; - readonly dismiss_reason?: string; - readonly dismissed_at?: string; + /** Format: uri */ + readonly issue_url: string; + readonly labels: { + /** @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 locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + readonly maintainer_can_modify?: boolean; + readonly merge_commit_sha: string | null; + readonly mergeable?: boolean | null; + readonly mergeable_state?: string; + readonly merged?: boolean | null; + /** Format: date-time */ + readonly merged_at: string | null; /** User */ - readonly dismisser?: { + readonly merged_by?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -85916,330 +78293,84 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - readonly external_identifier: string; - /** Format: uri */ - readonly external_reference: string | null; - readonly fix_reason?: string; - /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id: string; - readonly id: number; - readonly node_id: string; - readonly number: number; - readonly severity: string; - /** @enum {string} */ - readonly state: "open" | "dismissed" | "fixed"; - } & { - readonly affected_package_name?: string; - readonly affected_range?: string; - readonly created_at?: string; - readonly external_identifier?: string; - readonly external_reference?: string | null; - readonly fix_reason?: string; - /** Format: date-time */ - readonly fixed_at?: string; - readonly fixed_in?: string; - readonly ghsa_id?: string; - readonly id?: number; - readonly node_id?: string; - readonly number?: number; - readonly severity?: string; - /** @enum {string} */ - readonly state: "fixed" | "open"; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** secret_scanning_alert created event */ - readonly "webhook-secret-scanning-alert-created": { - /** @enum {string} */ - readonly action: "created"; - readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** Secret Scanning Alert Location Created Event */ - readonly "webhook-secret-scanning-alert-location-created": { - /** @enum {string} */ - readonly action?: "created"; - readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly location: components["schemas"]["secret-scanning-location"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Secret Scanning Alert Location Created Event */ - readonly "webhook-secret-scanning-alert-location-created-form-encoded": { - /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ - readonly payload: string; - }; - /** secret_scanning_alert reopened event */ - readonly "webhook-secret-scanning-alert-reopened": { - /** @enum {string} */ - readonly action: "reopened"; - readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** secret_scanning_alert resolved event */ - readonly "webhook-secret-scanning-alert-resolved": { - /** @enum {string} */ - readonly action: "resolved"; - readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** secret_scanning_alert revoked event */ - readonly "webhook-secret-scanning-alert-revoked": { - /** @enum {string} */ - readonly action: "revoked"; - readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_advisory published event */ - readonly "webhook-security-advisory-published": { - /** @enum {string} */ - readonly action: "published"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - /** @description The details of the security advisory, including summary, description, and severity. */ - readonly security_advisory: { - readonly cvss: { - readonly score: number; - readonly vector_string: string | null; - }; - readonly cwes: { - readonly cwe_id: string; - readonly name: string; - }[]; - readonly description: string; - readonly ghsa_id: string; - readonly identifiers: { - readonly type: string; - readonly value: string; - }[]; - readonly published_at: string; - readonly references: { - /** Format: uri */ - readonly url: string; - }[]; - readonly severity: string; - readonly summary: string; - readonly updated_at: string; - readonly vulnerabilities: { - readonly first_patched_version: { - readonly identifier: string; - } | null; - readonly package: { - readonly ecosystem: string; - readonly name: string; - }; - readonly severity: string; - readonly vulnerable_version_range: string; - }[]; - readonly withdrawn_at: string | null; - }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_advisory updated event */ - readonly "webhook-security-advisory-updated": { - /** @enum {string} */ - readonly action: "updated"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - /** @description The details of the security advisory, including summary, description, and severity. */ - readonly security_advisory: { - readonly cvss: { - readonly score: number; - readonly vector_string: string | null; - }; - readonly cwes: { - readonly cwe_id: string; - readonly name: string; - }[]; - readonly description: string; - readonly ghsa_id: string; - readonly identifiers: { - readonly type: string; - readonly value: string; - }[]; - readonly published_at: string; - readonly references: { - /** Format: uri */ - readonly url: string; - }[]; - readonly severity: string; - readonly summary: string; - readonly updated_at: string; - readonly vulnerabilities: { - readonly first_patched_version: { - readonly identifier: string; - } | null; - readonly package: { - readonly ecosystem: string; - readonly name: string; - }; - readonly severity: string; - readonly vulnerable_version_range: string; - }[]; - readonly withdrawn_at: string | null; - }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_advisory withdrawn event */ - readonly "webhook-security-advisory-withdrawn": { - /** @enum {string} */ - readonly action: "withdrawn"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - /** @description The details of the security advisory, including summary, description, and severity. */ - readonly security_advisory: { - readonly cvss: { - readonly score: number; - readonly vector_string: string | null; - }; - readonly cwes: { - readonly cwe_id: string; - readonly name: string; - }[]; - readonly description: string; - readonly ghsa_id: string; - readonly identifiers: { - readonly type: string; - readonly value: string; - }[]; - readonly published_at: string; - readonly references: { - /** Format: uri */ - readonly url: string; - }[]; - readonly severity: string; - readonly summary: string; - readonly updated_at: string; - readonly vulnerabilities: { - readonly first_patched_version: { - readonly identifier: string; + /** + * 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"; + /** Format: uri */ + readonly url?: string; } | null; - readonly package: { - readonly ecosystem: string; - readonly name: string; - }; - readonly severity: string; - readonly vulnerable_version_range: string; - }[]; - readonly withdrawn_at: string; - }; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_and_analysis event */ - readonly "webhook-security-and-analysis": { - readonly changes: { - readonly from?: { - readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; - }; - }; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["full-repository"]; - readonly sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** sponsorship cancelled event */ - readonly "webhook-sponsorship-cancelled": { - /** @enum {string} */ - readonly action: "cancelled"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly sponsorship: { - readonly created_at: string; - readonly maintainer?: { - 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; - 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 node_id: string; - readonly privacy_level: string; - /** User */ - readonly sponsor: { - /** 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; + readonly description: string | null; + /** Format: date-time */ + readonly due_on: string | null; /** Format: uri */ - readonly html_url?: string; + 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"; + 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; + readonly url: string; } | null; - /** User */ - readonly sponsorable: { + readonly node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ + readonly number: number; + /** Format: uri */ + readonly patch_url: string; + readonly rebaseable?: boolean | null; + readonly requested_reviewers: (({ /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -86274,96 +78405,128 @@ export interface components { readonly type?: "Bot" | "User" | "Organization"; /** Format: uri */ readonly url?: string; - } | null; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - readonly tier: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; - readonly name: string; - readonly node_id: string; - }; - }; - }; - /** sponsorship created event */ - readonly "webhook-sponsorship-created": { - /** @enum {string} */ - readonly action: "created"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly sponsorship: { - readonly created_at: string; - readonly maintainer?: { - 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; - 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 node_id: string; - readonly privacy_level: string; - /** User */ - readonly sponsor: { - /** Format: uri */ - readonly avatar_url?: string; + } | null) | { 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; + /** @description Description of the team */ + readonly description?: string | null; /** Format: uri */ readonly html_url?: string; + /** @description Unique identifier of the team */ readonly id: number; - readonly login: string; - readonly name?: string; + /** Format: uri-template */ + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; + /** @enum {string} */ + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ - readonly organizations_url?: string; - /** Format: uri */ - readonly received_events_url?: string; + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url?: string; + })[]; + readonly requested_teams: { + readonly deleted?: boolean; + /** @description Description of the team */ + readonly description?: string | null; /** Format: uri */ - readonly repos_url?: string; - readonly site_admin?: boolean; + readonly html_url?: string; + /** @description Unique identifier of the team */ + readonly id: number; /** Format: uri-template */ - readonly starred_url?: string; - /** Format: uri */ - readonly subscriptions_url?: string; + readonly members_url?: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id?: string; + readonly parent?: { + /** @description Description of the team */ + readonly description: string | null; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the team */ + readonly id: number; + /** Format: uri-template */ + readonly members_url: string; + /** @description Name of the team */ + readonly name: string; + readonly node_id: string; + /** @description Permission that the team will have for its repositories */ + readonly permission: string; + /** @enum {string} */ + readonly privacy: "open" | "closed" | "secret"; + /** Format: uri */ + readonly repositories_url: string; + readonly slug: string; + /** + * Format: uri + * @description URL for the team + */ + readonly url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + readonly permission?: string; /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly privacy?: "open" | "closed" | "secret"; /** Format: uri */ + readonly repositories_url?: string; + readonly slug?: string; + /** + * Format: uri + * @description URL for the team + */ readonly url?: string; - } | null; + }[]; + /** Format: uri-template */ + readonly review_comment_url: string; + readonly review_comments?: number; + /** Format: uri */ + readonly review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + readonly state: "open" | "closed"; + /** Format: uri */ + readonly statuses_url: string; + /** @description The title of the pull request. */ + readonly title: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; /** User */ - readonly sponsorable: { + readonly user: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -86399,64 +78562,308 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; + }; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** push event */ + readonly "webhook-push": { + /** @description The SHA of the most recent commit on `ref` after the push. */ + readonly after: string; + readonly base_ref: components["schemas"]["webhooks_nullable_string"]; + /** @description The SHA of the most recent commit on `ref` before the push. */ + readonly before: string; + /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. */ + readonly commits: { + /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ + readonly added?: string[]; /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. + * Committer + * @description Metaproperties for Git author/committer information. */ - readonly tier: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; + readonly author: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ readonly name: string; - readonly node_id: string; + readonly username?: string; }; - }; - }; - /** sponsorship edited event */ - readonly "webhook-sponsorship-edited": { - /** @enum {string} */ - readonly action: "edited"; - readonly changes: { - readonly privacy_level?: { - /** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */ - readonly from: string; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly committer: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; }; - }; + /** @description Whether this commit is distinct from any that have been pushed before. */ + readonly distinct: boolean; + readonly id: string; + /** @description The commit message. */ + readonly message: string; + /** @description An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit. */ + readonly modified?: string[]; + /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */ + readonly removed?: string[]; + /** + * Format: date-time + * @description The ISO 8601 timestamp of the commit. + */ + readonly timestamp: string; + readonly tree_id: string; + /** + * Format: uri + * @description URL that points to the commit API resource. + */ + readonly url: string; + }[]; + /** @description URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. */ + readonly compare: string; + /** @description Whether this push created the `ref`. */ + readonly created: boolean; + /** @description Whether this push deleted the `ref`. */ + readonly deleted: boolean; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @description Whether this push was a force push of the `ref`. */ + readonly forced: boolean; + /** Commit */ + readonly head_commit: { + /** @description An array of files added in the commit. */ + readonly added?: string[]; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly author: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly committer: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + /** @description Whether this commit is distinct from any that have been pushed before. */ + readonly distinct: boolean; + readonly id: string; + /** @description The commit message. */ + readonly message: string; + /** @description An array of files modified by the commit. */ + readonly modified?: string[]; + /** @description An array of files removed in the commit. */ + readonly removed?: string[]; + /** + * Format: date-time + * @description The ISO 8601 timestamp of the commit. + */ + readonly timestamp: string; + readonly tree_id: string; + /** + * Format: uri + * @description URL that points to the commit API resource. + */ + readonly url: string; + } | null; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly sponsorship: { - readonly created_at: string; - readonly maintainer?: { - 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; - 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; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + readonly pusher: { + /** Format: date-time */ + readonly date?: string; + /** Format: email */ + readonly email?: string | null; + /** @description The git author's name. */ + readonly name: string; + readonly username?: string; + }; + /** @description The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. */ + readonly ref: string; + /** + * Repository + * @description A git repository + */ + readonly repository: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + readonly allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + readonly allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + readonly allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + readonly allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + readonly allow_squash_merge: boolean; + readonly allow_update_branch?: boolean; + /** Format: uri-template */ + readonly archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + readonly archived: boolean; + /** Format: uri-template */ + readonly assignees_url: string; + /** Format: uri-template */ + readonly blobs_url: string; + /** Format: uri-template */ + readonly branches_url: string; + /** Format: uri */ + readonly clone_url: string; + /** Format: uri-template */ + readonly collaborators_url: string; + /** Format: uri-template */ + readonly comments_url: string; + /** Format: uri-template */ + readonly commits_url: string; + /** Format: uri-template */ + readonly compare_url: string; + /** Format: uri-template */ + readonly contents_url: string; + /** Format: uri */ + readonly contributors_url: string; + readonly created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + readonly custom_properties?: { + readonly [key: string]: unknown; }; + /** @description The default branch of the repository. */ + readonly default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + readonly delete_branch_on_merge: boolean; + /** Format: uri */ + readonly deployments_url: string; + readonly description: string | null; + /** @description Returns whether or not this repository is disabled. */ + readonly disabled?: boolean; + /** Format: uri */ + readonly downloads_url: string; + /** Format: uri */ + readonly events_url: string; + readonly fork: boolean; + readonly forks: number; + readonly forks_count: number; + /** Format: uri */ + readonly forks_url: string; + readonly full_name: string; + /** Format: uri-template */ + readonly git_commits_url: string; + /** Format: uri-template */ + readonly git_refs_url: string; + /** Format: uri-template */ + readonly git_tags_url: string; + /** Format: uri */ + readonly git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + readonly has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + readonly has_issues: boolean; + readonly has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + readonly has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + readonly has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + readonly has_discussions: boolean; + readonly homepage: string | null; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url: string; + /** @description Unique identifier of the repository */ + readonly id: number; + readonly is_template?: boolean; + /** Format: uri-template */ + readonly issue_comment_url: string; + /** Format: uri-template */ + readonly issue_events_url: string; + /** Format: uri-template */ + readonly issues_url: string; + /** Format: uri-template */ + readonly keys_url: string; + /** Format: uri-template */ + readonly labels_url: string; + readonly language: string | null; + /** Format: uri */ + readonly languages_url: string; + /** License */ + readonly license: { + readonly key: string; + readonly name: string; + readonly node_id: string; + readonly spdx_id: string; + /** Format: uri */ + readonly url: string | null; + } | null; + readonly master_branch?: string; + /** Format: uri */ + readonly merges_url: string; + /** Format: uri-template */ + readonly milestones_url: string; + /** Format: uri */ + readonly mirror_url: string | null; + /** @description The name of the repository. */ + readonly name: string; readonly node_id: string; - readonly privacy_level: string; + /** Format: uri-template */ + readonly notifications_url: string; + readonly open_issues: number; + readonly open_issues_count: number; + readonly organization?: string; /** User */ - readonly sponsor: { + readonly owner: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -86492,134 +78899,508 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - /** User */ - readonly sponsorable: { - /** 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 permissions?: { + readonly admin: boolean; + readonly maintain?: boolean; + readonly pull: boolean; + readonly push: boolean; + readonly triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + readonly private: boolean; + readonly public?: boolean; + /** Format: uri-template */ + readonly pulls_url: string; + readonly pushed_at: (number | string) | null; + /** Format: uri-template */ + readonly releases_url: string; + readonly role_name?: string | null; + readonly size: number; + readonly ssh_url: string; + readonly stargazers?: number; + readonly stargazers_count: number; + /** Format: uri */ + readonly stargazers_url: string; + /** Format: uri-template */ + readonly statuses_url: string; + /** Format: uri */ + readonly subscribers_url: string; + /** Format: uri */ + readonly subscription_url: string; + /** Format: uri */ + readonly svn_url: string; + /** Format: uri */ + readonly tags_url: string; + /** Format: uri */ + readonly teams_url: string; + readonly topics: string[]; + /** Format: uri-template */ + readonly trees_url: string; + /** Format: date-time */ + readonly updated_at: string; + /** Format: uri */ + readonly url: string; + /** @enum {string} */ + readonly visibility: "public" | "private" | "internal"; + readonly watchers: number; + readonly watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + readonly web_commit_signoff_required?: boolean; + }; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + readonly "webhook-registry-package-published": { + /** @enum {string} */ + readonly action: "published"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly registry_package: { + readonly created_at: string | null; + readonly description: string | null; + readonly ecosystem: string; + readonly html_url: string; + readonly id: number; + readonly name: string; + readonly namespace: string; + readonly owner: { + 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; 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 package_type: string; + readonly package_version: { + readonly author?: { + 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; + 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 body?: string | Record; + readonly body_html?: string; + readonly container_metadata?: { + readonly labels?: Record; + readonly manifest?: Record; + readonly tag?: { + readonly digest?: string; + readonly name?: string; + }; + }; + readonly created_at?: string; + readonly description: string; + readonly docker_metadata?: { + readonly tags?: string[]; + }[]; + readonly draft?: boolean; + readonly html_url: string; + readonly id: number; + readonly installation_command: string; + readonly manifest?: string; + readonly metadata: { + readonly [key: string]: unknown; + }[]; + readonly name: string; + readonly npm_metadata?: { + readonly name?: string; + readonly version?: string; + readonly npm_user?: string; + readonly author?: (string | Record) | null; + readonly bugs?: (string | Record) | null; + readonly dependencies?: Record; + readonly dev_dependencies?: Record; + readonly peer_dependencies?: Record; + readonly optional_dependencies?: Record; + readonly description?: string; + readonly dist?: (string | Record) | null; + readonly git_head?: string; + readonly homepage?: string; + readonly license?: string; + readonly main?: string; + readonly repository?: (string | Record) | null; + readonly scripts?: Record; + readonly id?: string; + readonly node_version?: string; + readonly npm_version?: string; + readonly has_shrinkwrap?: boolean; + readonly maintainers?: string[]; + readonly contributors?: string[]; + readonly engines?: Record; + readonly keywords?: string[]; + readonly files?: string[]; + readonly bin?: Record; + readonly man?: Record; + readonly directories?: (string | Record) | null; + readonly os?: string[]; + readonly cpu?: string[]; + readonly readme?: string; + readonly installation_command?: string; + readonly release_id?: number; + readonly commit_oid?: string; + readonly published_via_actions?: boolean; + readonly deleted_by_id?: number; + } | null; + readonly nuget_metadata?: { + readonly id?: (string | Record | number) | null; + readonly name?: string; + readonly value?: boolean | string | number | { + readonly url?: string; + readonly branch?: string; + readonly commit?: string; + readonly type?: string; + }; + }[] | null; + readonly package_files: { + readonly content_type: string; + readonly created_at: string; + readonly download_url: string; + readonly id: number; + readonly md5: string | null; + readonly name: string; + readonly sha1: string | null; + readonly sha256: string | null; + readonly size: number; + readonly state: string | null; + readonly updated_at: string; + }[]; + readonly package_url: string; + readonly prerelease?: boolean; + readonly release?: { + readonly author?: { + 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; + 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 created_at?: string; + readonly draft?: boolean; + readonly html_url?: string; + readonly id?: number; + readonly name?: string | null; + readonly prerelease?: boolean; + readonly published_at?: string; + readonly tag_name?: string; + readonly target_commitish?: string; + readonly url?: string; + }; + readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + readonly summary: string; + readonly tag_name?: string; + readonly target_commitish?: string; + readonly target_oid?: string; + readonly updated_at?: string; + readonly version: string; + } | null; + readonly registry: { + readonly about_url?: 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 type?: string; readonly url?: string; + readonly vendor?: string; } | null; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - readonly tier: { + readonly updated_at: string | null; + }; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + readonly "webhook-registry-package-updated": { + /** @enum {string} */ + readonly action: "updated"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly registry_package: { + readonly created_at: string; + readonly description: unknown; + readonly ecosystem: string; + readonly html_url: string; + readonly id: number; + readonly name: string; + readonly namespace: string; + readonly owner: { + 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; + 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 package_type: string; + readonly package_version: { + readonly author: { + 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; + 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 body: string; + readonly body_html: string; readonly created_at: string; readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; + readonly docker_metadata?: ({ + readonly tags?: string[]; + } | null)[]; + readonly draft?: boolean; + readonly html_url: string; + readonly id: number; + readonly installation_command: string; + readonly manifest?: string; + readonly metadata: { + readonly [key: string]: unknown; + }[]; readonly name: string; - readonly node_id: string; + readonly package_files: { + readonly content_type?: string; + readonly created_at?: string; + readonly download_url?: string; + readonly id?: number; + readonly md5?: string | null; + readonly name?: string; + readonly sha1?: string | null; + readonly sha256?: string; + readonly size?: number; + readonly state?: string; + readonly updated_at?: string; + }[]; + readonly package_url: string; + readonly prerelease?: boolean; + readonly release?: { + readonly author: { + 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; + 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 created_at: string; + readonly draft: boolean; + readonly html_url: string; + readonly id: number; + readonly name: string; + readonly prerelease: boolean; + readonly published_at: string; + readonly tag_name: string; + readonly target_commitish: string; + readonly url: string; + }; + readonly rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + readonly summary: string; + readonly tag_name?: string; + readonly target_commitish: string; + readonly target_oid: string; + readonly updated_at: string; + readonly version: string; }; + readonly registry: Record; + readonly updated_at: string; }; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** sponsorship pending_cancellation event */ - readonly "webhook-sponsorship-pending-cancellation": { + /** release created event */ + readonly "webhook-release-created": { /** @enum {string} */ - readonly action: "pending_cancellation"; - /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ - readonly effective_date?: string; + readonly action: "created"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly release: components["schemas"]["webhooks_release"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly sponsorship: { - readonly created_at: string; - readonly maintainer?: { - 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; - 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; + }; + /** release deleted event */ + readonly "webhook-release-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly release: components["schemas"]["webhooks_release"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** release edited event */ + readonly "webhook-release-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes: { + readonly body?: { + /** @description The previous version of the body if the action was `edited`. */ + readonly from: string; }; - readonly node_id: string; - readonly privacy_level: string; - /** User */ - readonly sponsor: { - /** 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; + readonly name?: { + /** @description The previous version of the name if the action was `edited`. */ + readonly from: string; + }; + readonly make_latest?: { + /** @description Whether this release was explicitly `edited` to be the latest. */ + readonly to: boolean; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly release: components["schemas"]["webhooks_release"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** release prereleased event */ + readonly "webhook-release-prereleased": { + /** @enum {string} */ + readonly action: "prereleased"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + /** + * Release + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. + */ + readonly release: { + readonly assets: ({ /** Format: uri */ - readonly subscriptions_url?: string; - /** @enum {string} */ - readonly type?: "Bot" | "User" | "Organization"; + readonly browser_download_url: string; + readonly content_type: string; + /** Format: date-time */ + readonly created_at: string; + readonly download_count: number; + readonly id: number; + readonly label: string | null; + /** @description The file name of the asset. */ + readonly name: string; + readonly node_id: string; + readonly size: number; + /** + * @description State of the release asset. + * @enum {string} + */ + readonly state: "uploaded"; + /** Format: date-time */ + readonly updated_at: string; + /** User */ + readonly uploader?: { + /** 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; /** Format: uri */ - readonly url?: string; - } | null; + readonly url: string; + } | null)[]; + /** Format: uri */ + readonly assets_url: string; /** User */ - readonly sponsorable: { + readonly author: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -86655,222 +79436,422 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; + readonly body: string | null; + /** Format: date-time */ + readonly created_at: string | null; + /** Format: uri */ + readonly discussion_url?: string; + /** @description Whether the release is a draft or published */ + readonly draft: boolean; + /** Format: uri */ + readonly html_url: string; + readonly id: number; + readonly name: string | null; + readonly node_id: string; /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. + * @description Whether the release is identified as a prerelease or a full release. + * @enum {boolean} */ - readonly tier: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; - readonly name: string; - readonly node_id: string; + readonly prerelease: true; + /** Format: date-time */ + readonly published_at: string | null; + /** 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; }; + /** @description The name of the tag. */ + readonly tag_name: string; + /** Format: uri */ + readonly tarball_url: string | null; + /** @description Specifies the commitish value that determines where the Git tag is created from. */ + readonly target_commitish: string; + /** Format: uri-template */ + readonly upload_url: string; + /** Format: uri */ + readonly url: string; + /** Format: uri */ + readonly zipball_url: string | null; }; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; }; - /** sponsorship pending_tier_change event */ - readonly "webhook-sponsorship-pending-tier-change": { + /** release published event */ + readonly "webhook-release-published": { /** @enum {string} */ - readonly action: "pending_tier_change"; + readonly action: "published"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly release: components["schemas"]["webhooks_release_1"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** release released event */ + readonly "webhook-release-released": { + /** @enum {string} */ + readonly action: "released"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly release: components["schemas"]["webhooks_release"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** release unpublished event */ + readonly "webhook-release-unpublished": { + /** @enum {string} */ + readonly action: "unpublished"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly release: components["schemas"]["webhooks_release_1"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Repository advisory published event */ + readonly "webhook-repository-advisory-published": { + /** @enum {string} */ + readonly action: "published"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly repository_advisory: components["schemas"]["repository-advisory"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Repository advisory reported event */ + readonly "webhook-repository-advisory-reported": { + /** @enum {string} */ + readonly action: "reported"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly repository_advisory: components["schemas"]["repository-advisory"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** repository archived event */ + readonly "webhook-repository-archived": { + /** @enum {string} */ + readonly action: "archived"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository created event */ + readonly "webhook-repository-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository deleted event */ + readonly "webhook-repository-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_dispatch event */ + readonly "webhook-repository-dispatch-sample": { + /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + readonly action: string; + readonly branch: string; + /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + readonly client_payload: { + readonly [key: string]: unknown; + } | null; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository edited event */ + readonly "webhook-repository-edited": { + /** @enum {string} */ + readonly action: "edited"; readonly changes: { - readonly tier: { - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - readonly from: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; - readonly name: string; - readonly node_id: string; + readonly default_branch?: { + readonly from: string; + }; + readonly description?: { + readonly from: string | null; + }; + readonly homepage?: { + readonly from: string | null; + }; + readonly topics?: { + readonly from?: string[] | null; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_import event */ + readonly "webhook-repository-import": { + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + /** @enum {string} */ + readonly status: "success" | "cancelled" | "failure"; + }; + /** repository privatized event */ + readonly "webhook-repository-privatized": { + /** @enum {string} */ + readonly action: "privatized"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository publicized event */ + readonly "webhook-repository-publicized": { + /** @enum {string} */ + readonly action: "publicized"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository renamed event */ + readonly "webhook-repository-renamed": { + /** @enum {string} */ + readonly action: "renamed"; + readonly changes: { + readonly repository: { + readonly name: { + readonly from: string; }; }; }; - /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ - readonly effective_date?: string; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository ruleset created event */ + readonly "webhook-repository-ruleset-created": { + /** @enum {string} */ + readonly action: "created"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository_ruleset: components["schemas"]["repository-ruleset"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly sponsorship: { - readonly created_at: string; - readonly maintainer?: { - 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; - 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; + }; + /** repository ruleset deleted event */ + readonly "webhook-repository-ruleset-deleted": { + /** @enum {string} */ + readonly action: "deleted"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository_ruleset: components["schemas"]["repository-ruleset"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository ruleset edited event */ + readonly "webhook-repository-ruleset-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository_ruleset: components["schemas"]["repository-ruleset"]; + readonly changes?: { + readonly name?: { + readonly from?: string; }; - readonly node_id: string; - readonly privacy_level: string; - /** User */ - readonly sponsor: { - /** 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; - /** User */ - readonly sponsorable: { - /** 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; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - readonly tier: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; - readonly name: string; - readonly node_id: string; + readonly enforcement?: { + readonly from?: string; + }; + readonly conditions?: { + readonly added?: components["schemas"]["repository-ruleset-conditions"][]; + readonly deleted?: components["schemas"]["repository-ruleset-conditions"][]; + readonly updated?: { + readonly condition?: components["schemas"]["repository-ruleset-conditions"]; + readonly changes?: { + readonly condition_type?: { + readonly from?: string; + }; + readonly target?: { + readonly from?: string; + }; + readonly include?: { + readonly from?: string[]; + }; + readonly exclude?: { + readonly from?: string[]; + }; + }; + }[]; + }; + readonly rules?: { + readonly added?: components["schemas"]["repository-rule"][]; + readonly deleted?: components["schemas"]["repository-rule"][]; + readonly updated?: { + readonly rule?: components["schemas"]["repository-rule"]; + readonly changes?: { + readonly configuration?: { + readonly from?: string; + }; + readonly rule_type?: { + readonly from?: string; + }; + readonly pattern?: { + readonly from?: string; + }; + }; + }[]; + }; + }; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository transferred event */ + readonly "webhook-repository-transferred": { + /** @enum {string} */ + readonly action: "transferred"; + readonly changes: { + readonly owner: { + readonly from: { + /** Organization */ + readonly organization?: { + /** Format: uri */ + readonly avatar_url: string; + readonly description: string | null; + /** Format: uri */ + readonly events_url: string; + /** Format: uri */ + readonly hooks_url: string; + /** Format: uri */ + readonly html_url?: string; + readonly id: number; + /** Format: uri */ + readonly issues_url: string; + readonly login: string; + /** Format: uri-template */ + readonly members_url: string; + readonly node_id: string; + /** Format: uri-template */ + readonly public_members_url: string; + /** Format: uri */ + readonly repos_url: string; + /** Format: uri */ + 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; + 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 enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; }; - /** sponsorship tier_changed event */ - readonly "webhook-sponsorship-tier-changed": { + /** repository unarchived event */ + readonly "webhook-repository-unarchived": { /** @enum {string} */ - readonly action: "tier_changed"; - readonly changes: { - readonly tier: { - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - readonly from: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; - readonly name: string; - readonly node_id: string; - }; - }; - }; + readonly action: "unarchived"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository?: components["schemas"]["repository-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_vulnerability_alert create event */ + readonly "webhook-repository-vulnerability-alert-create": { + /** @enum {string} */ + readonly action: "create"; + readonly alert: components["schemas"]["webhooks_alert"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly sponsorship: { + }; + /** repository_vulnerability_alert dismiss event */ + readonly "webhook-repository-vulnerability-alert-dismiss": { + /** @enum {string} */ + readonly action: "dismiss"; + /** + * Repository Vulnerability Alert Alert + * @description The security alert of the vulnerable dependency. + */ + readonly alert: { + readonly affected_package_name: string; + readonly affected_range: string; readonly created_at: string; - readonly maintainer?: { - 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; - 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 node_id: string; - readonly privacy_level: string; + readonly dismiss_comment?: string | null; + readonly dismiss_reason: string; + readonly dismissed_at: string; /** User */ - readonly sponsor: { + readonly dismisser: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -86906,8 +79887,54 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; + readonly external_identifier: string; + /** Format: uri */ + readonly external_reference: string | null; + readonly fix_reason?: string; + /** Format: date-time */ + readonly fixed_at?: string; + readonly fixed_in?: string; + readonly ghsa_id: string; + readonly id: number; + readonly node_id: string; + readonly number: number; + readonly severity: string; + /** @enum {string} */ + readonly state: "dismissed"; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_vulnerability_alert reopen event */ + readonly "webhook-repository-vulnerability-alert-reopen": { + /** @enum {string} */ + readonly action: "reopen"; + readonly alert: components["schemas"]["webhooks_alert"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_vulnerability_alert resolve event */ + readonly "webhook-repository-vulnerability-alert-resolve": { + /** @enum {string} */ + readonly action: "resolve"; + /** + * Repository Vulnerability Alert Alert + * @description The security alert of the vulnerable dependency. + */ + readonly alert: { + readonly affected_package_name: string; + readonly affected_range: string; + readonly created_at: string; + readonly dismiss_reason?: string; + readonly dismissed_at?: string; /** User */ - readonly sponsorable: { + readonly dismisser?: { /** Format: uri */ readonly avatar_url?: string; readonly deleted?: boolean; @@ -86943,22 +79970,255 @@ export interface components { /** Format: uri */ readonly url?: string; } | null; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - readonly tier: { - readonly created_at: string; - readonly description: string; - readonly is_custom_ammount?: boolean; - readonly is_custom_amount?: boolean; - readonly is_one_time: boolean; - readonly monthly_price_in_cents: number; - readonly monthly_price_in_dollars: number; + readonly external_identifier: string; + /** Format: uri */ + readonly external_reference: string | null; + readonly fix_reason?: string; + /** Format: date-time */ + readonly fixed_at?: string; + readonly fixed_in?: string; + readonly ghsa_id: string; + readonly id: number; + readonly node_id: string; + readonly number: number; + readonly severity: string; + /** @enum {string} */ + readonly state: "fixed" | "open"; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert created event */ + readonly "webhook-secret-scanning-alert-created": { + /** @enum {string} */ + readonly action: "created"; + readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Secret Scanning Alert Location Created Event */ + readonly "webhook-secret-scanning-alert-location-created": { + /** @enum {string} */ + readonly action?: "created"; + readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly location: components["schemas"]["secret-scanning-location"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Secret Scanning Alert Location Created Event */ + readonly "webhook-secret-scanning-alert-location-created-form-encoded": { + /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ + readonly payload: string; + }; + /** secret_scanning_alert reopened event */ + readonly "webhook-secret-scanning-alert-reopened": { + /** @enum {string} */ + readonly action: "reopened"; + readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert resolved event */ + readonly "webhook-secret-scanning-alert-resolved": { + /** @enum {string} */ + readonly action: "resolved"; + readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert revoked event */ + readonly "webhook-secret-scanning-alert-revoked": { + /** @enum {string} */ + readonly action: "revoked"; + readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert validated event */ + readonly "webhook-secret-scanning-alert-validated": { + /** @enum {string} */ + readonly action: "validated"; + readonly alert: components["schemas"]["secret-scanning-alert-webhook"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_advisory published event */ + readonly "webhook-security-advisory-published": { + /** @enum {string} */ + readonly action: "published"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly security_advisory: components["schemas"]["webhooks_security_advisory"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_advisory updated event */ + readonly "webhook-security-advisory-updated": { + /** @enum {string} */ + readonly action: "updated"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly security_advisory: components["schemas"]["webhooks_security_advisory"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_advisory withdrawn event */ + readonly "webhook-security-advisory-withdrawn": { + /** @enum {string} */ + readonly action: "withdrawn"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + /** @description The details of the security advisory, including summary, description, and severity. */ + readonly security_advisory: { + readonly cvss: { + readonly score: number; + readonly vector_string: string | null; + }; + readonly cwes: { + readonly cwe_id: string; readonly name: string; - readonly node_id: string; + }[]; + readonly description: string; + readonly ghsa_id: string; + readonly identifiers: { + readonly type: string; + readonly value: string; + }[]; + readonly published_at: string; + readonly references: { + /** Format: uri */ + readonly url: string; + }[]; + readonly severity: string; + readonly summary: string; + readonly updated_at: string; + readonly vulnerabilities: { + readonly first_patched_version: { + readonly identifier: string; + } | null; + readonly package: { + readonly ecosystem: string; + readonly name: string; + }; + readonly severity: string; + readonly vulnerable_version_range: string; + }[]; + readonly withdrawn_at: string; + }; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_and_analysis event */ + readonly "webhook-security-and-analysis": { + readonly changes: { + readonly from?: { + readonly security_and_analysis?: components["schemas"]["security-and-analysis"]; + }; + }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["full-repository"]; + readonly sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sponsorship cancelled event */ + readonly "webhook-sponsorship-cancelled": { + /** @enum {string} */ + readonly action: "cancelled"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship created event */ + readonly "webhook-sponsorship-created": { + /** @enum {string} */ + readonly action: "created"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship edited event */ + readonly "webhook-sponsorship-edited": { + /** @enum {string} */ + readonly action: "edited"; + readonly changes: { + readonly privacy_level?: { + /** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */ + readonly from: string; }; }; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship pending_cancellation event */ + readonly "webhook-sponsorship-pending-cancellation": { + /** @enum {string} */ + readonly action: "pending_cancellation"; + readonly effective_date?: components["schemas"]["webhooks_effective_date"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship pending_tier_change event */ + readonly "webhook-sponsorship-pending-tier-change": { + /** @enum {string} */ + readonly action: "pending_tier_change"; + readonly changes: components["schemas"]["webhooks_changes_8"]; + readonly effective_date?: components["schemas"]["webhooks_effective_date"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship tier_changed event */ + readonly "webhook-sponsorship-tier-changed": { + /** @enum {string} */ + readonly action: "tier_changed"; + readonly changes: components["schemas"]["webhooks_changes_8"]; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository?: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ readonly "webhook-star-created": { @@ -87163,71 +80423,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }; + readonly team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ readonly "webhook-team-added-to-repository": { @@ -87476,71 +80672,7 @@ export interface components { readonly watchers_count: number; }; readonly sender?: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }; + readonly team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ readonly "webhook-team-created": { @@ -87789,71 +80921,7 @@ export interface components { readonly watchers_count: number; }; readonly sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }; + readonly team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ readonly "webhook-team-deleted": { @@ -88102,71 +81170,7 @@ export interface components { readonly watchers_count: number; }; readonly sender?: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }; + readonly team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ readonly "webhook-team-edited": { @@ -88446,71 +81450,7 @@ export interface components { readonly watchers_count: number; }; readonly sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }; + readonly team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ readonly "webhook-team-removed-from-repository": { @@ -88759,71 +81699,7 @@ export interface components { readonly watchers_count: number; }; readonly sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - readonly team: { - readonly deleted?: boolean; - /** @description Description of the team */ - readonly description?: string | null; - /** Format: uri */ - readonly html_url?: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url?: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id?: string; - readonly parent?: { - /** @description Description of the team */ - readonly description: string | null; - /** Format: uri */ - readonly html_url: string; - /** @description Unique identifier of the team */ - readonly id: number; - /** Format: uri-template */ - readonly members_url: string; - /** @description Name of the team */ - readonly name: string; - readonly node_id: string; - /** @description Permission that the team will have for its repositories */ - readonly permission: string; - /** @enum {string} */ - readonly privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url: string; - readonly slug: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - readonly permission?: string; - /** @enum {string} */ - readonly privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - readonly notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - readonly repositories_url?: string; - readonly slug?: string; - /** - * Format: uri - * @description URL for the team - */ - readonly url?: string; - }; + readonly team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ readonly "webhook-watch-started": { @@ -89069,66 +81945,12 @@ export interface components { readonly runner_name: string | null; /** Format: date-time */ readonly started_at: string; - /** @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ - readonly head_branch: string | null; - /** @description The name of the workflow. */ - readonly workflow_name: string | null; - readonly steps: { - readonly completed_at: string | null; - /** @enum {string|null} */ - readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; - readonly name: string; - readonly number: number; - readonly started_at: string | null; - /** @enum {string} */ - readonly status: "completed" | "in_progress" | "queued" | "pending"; - }[]; - /** Format: uri */ - readonly url: string; - }; - readonly deployment?: components["schemas"]["deployment"]; - }; - /** workflow_job waiting event */ - readonly "webhook-workflow-job-waiting": { - /** @enum {string} */ - readonly action: "waiting"; - readonly enterprise?: components["schemas"]["enterprise-webhooks"]; - readonly installation?: components["schemas"]["simple-installation"]; - readonly organization?: components["schemas"]["organization-simple-webhooks"]; - readonly repository: components["schemas"]["repository-webhooks"]; - readonly sender: components["schemas"]["simple-user-webhooks"]; - readonly workflow_job: { - /** Format: uri */ - readonly check_run_url: string; - readonly completed_at: string | null; - readonly conclusion: string | null; - /** @description The time that the job created. */ - readonly created_at: string; - readonly head_sha: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly labels: string[]; - readonly name: string; - readonly node_id: string; - readonly run_attempt: number; - readonly run_id: number; - /** Format: uri */ - readonly run_url: string; - readonly runner_group_id: number | null; - readonly runner_group_name: string | null; - readonly runner_id: number | null; - readonly runner_name: string | null; - /** Format: date-time */ - readonly started_at: string; + /** @enum {string} */ + readonly status: "queued" | "in_progress" | "completed" | "waiting"; /** @description The name of the current branch. */ readonly head_branch: string | null; /** @description The name of the workflow. */ readonly workflow_name: string | null; - /** @enum {string} */ - readonly status: "queued" | "in_progress" | "completed" | "waiting"; readonly steps: { readonly completed_at: string | null; /** @enum {string|null} */ @@ -89137,40 +81959,78 @@ export interface components { readonly number: number; readonly started_at: string | null; /** @enum {string} */ - readonly status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; + readonly status: "completed" | "in_progress" | "queued" | "pending"; }[]; /** Format: uri */ readonly url: string; }; readonly deployment?: components["schemas"]["deployment"]; }; - /** workflow_run completed event */ - readonly "webhook-workflow-run-completed": { + /** workflow_job waiting event */ + readonly "webhook-workflow-job-waiting": { /** @enum {string} */ - readonly action: "completed"; + readonly action: "waiting"; readonly enterprise?: components["schemas"]["enterprise-webhooks"]; readonly installation?: components["schemas"]["simple-installation"]; readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - readonly workflow: { + readonly workflow_job: { /** Format: uri */ - readonly badge_url: string; - /** Format: date-time */ + readonly check_run_url: string; + readonly completed_at: string | null; + readonly conclusion: string | null; + /** @description The time that the job created. */ readonly created_at: string; + readonly head_sha: string; /** Format: uri */ readonly html_url: string; readonly id: number; + readonly labels: string[]; readonly name: string; readonly node_id: string; - readonly path: string; - readonly state: string; + readonly run_attempt: number; + readonly run_id: number; + /** Format: uri */ + readonly run_url: string; + readonly runner_group_id: number | null; + readonly runner_group_name: string | null; + readonly runner_id: number | null; + readonly runner_name: string | null; /** Format: date-time */ - readonly updated_at: string; + readonly started_at: string; + /** @description The name of the current branch. */ + readonly head_branch: string | null; + /** @description The name of the workflow. */ + readonly workflow_name: string | null; + /** @enum {string} */ + readonly status: "queued" | "in_progress" | "completed" | "waiting"; + readonly steps: { + readonly completed_at: string | null; + /** @enum {string|null} */ + readonly conclusion: "failure" | "skipped" | "success" | "cancelled" | null; + readonly name: string; + readonly number: number; + readonly started_at: string | null; + /** @enum {string} */ + readonly status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; + }[]; /** Format: uri */ readonly url: string; - } | null; + }; + readonly deployment?: components["schemas"]["deployment"]; + }; + /** workflow_run completed event */ + readonly "webhook-workflow-run-completed": { + /** @enum {string} */ + readonly action: "completed"; + readonly enterprise?: components["schemas"]["enterprise-webhooks"]; + readonly installation?: components["schemas"]["simple-installation"]; + readonly organization?: components["schemas"]["organization-simple-webhooks"]; + readonly repository: components["schemas"]["repository-webhooks"]; + readonly sender: components["schemas"]["simple-user-webhooks"]; + readonly workflow: components["schemas"]["webhooks_workflow"]; + /** Workflow Run */ readonly workflow_run: { /** User */ readonly actor: { @@ -89218,7 +82078,7 @@ export interface components { /** Format: uri */ readonly check_suite_url: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; + readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out"; /** Format: date-time */ readonly created_at: string; readonly event: string; @@ -89395,7 +82255,7 @@ export interface components { readonly path: string; /** Format: uri */ readonly previous_attempt_url: string | null; - readonly pull_requests: { + readonly pull_requests: ({ readonly base: { readonly ref: string; /** Repo Ref */ @@ -89422,7 +82282,7 @@ export interface components { readonly number: number; /** Format: uri */ readonly url: string; - }[]; + } | null)[]; readonly referenced_workflows?: { readonly path: string; readonly ref?: string; @@ -89606,229 +82466,11 @@ export interface components { readonly workflow_id: number; /** Format: uri */ readonly workflow_url: string; - } & { - readonly actor?: { - 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; - 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 artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id?: number; - readonly check_suite_node_id?: string; - readonly check_suite_url?: string; - /** @enum {string} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped"; - readonly created_at?: string; - readonly event?: string; - readonly head_branch?: string | null; - readonly head_commit?: { - readonly author?: { - readonly email?: string; - readonly name?: string; - }; - readonly committer?: { - readonly email?: string; - readonly name?: string; - }; - readonly id?: string; - readonly message?: string; - readonly timestamp?: string; - readonly tree_id?: string; - }; - readonly head_repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha?: string; - readonly html_url?: string; - readonly id?: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name?: string | null; - readonly node_id?: string; - readonly path?: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests?: Record[]; - readonly referenced_workflows?: { - readonly path: string; - readonly ref?: string; - readonly sha: string; - }[] | null; - readonly repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt?: number; - readonly run_number?: number; - readonly run_started_at?: string; - readonly status?: string; - readonly triggering_actor?: { - 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; - 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; - } | null; - readonly updated_at?: string; - readonly url?: string; - readonly workflow_id?: number; - readonly workflow_url?: string; + /** + * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. + * @example Simple Workflow + */ + readonly display_title?: string; }; }; /** workflow_run in_progress event */ @@ -89840,24 +82482,8 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - readonly workflow: { - /** Format: uri */ - readonly badge_url: string; - /** Format: date-time */ - readonly created_at: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly state: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - } | null; + readonly workflow: components["schemas"]["webhooks_workflow"]; + /** Workflow Run */ readonly workflow_run: { /** User */ readonly actor: { @@ -89905,7 +82531,7 @@ export interface components { /** Format: uri */ readonly check_suite_url: string; /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; + readonly conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out"; /** Format: date-time */ readonly created_at: string; readonly event: string; @@ -90005,7 +82631,7 @@ export interface components { /** Format: uri-template */ readonly milestones_url: string; /** @description The name of the repository. */ - readonly name: string; + readonly name: string | null; readonly node_id: string; /** Format: uri-template */ readonly notifications_url: string; @@ -90082,7 +82708,7 @@ export interface components { readonly path: string; /** Format: uri */ readonly previous_attempt_url: string | null; - readonly pull_requests: { + readonly pull_requests: ({ readonly base: { readonly ref: string; /** Repo Ref */ @@ -90109,7 +82735,7 @@ export interface components { readonly number: number; /** Format: uri */ readonly url: string; - }[]; + } | null)[]; readonly referenced_workflows?: { readonly path: string; readonly ref?: string; @@ -90293,229 +82919,6 @@ export interface components { readonly workflow_id: number; /** Format: uri */ readonly workflow_url: string; - } & { - readonly actor?: { - 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; - 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 artifacts_url?: string; - readonly cancel_url?: string; - readonly check_suite_id?: number; - readonly check_suite_node_id?: string; - readonly check_suite_url?: string; - /** @enum {string|null} */ - readonly conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "skipped" | "stale"; - readonly created_at?: string; - readonly event?: string; - readonly head_branch?: string | null; - readonly head_commit?: { - readonly author?: { - readonly email?: string; - readonly name?: string; - }; - readonly committer?: { - readonly email?: string; - readonly name?: string; - }; - readonly id?: string; - readonly message?: string; - readonly timestamp?: string; - readonly tree_id?: string; - }; - readonly head_repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string | null; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly head_sha?: string; - readonly html_url?: string; - readonly id?: number; - readonly jobs_url?: string; - readonly logs_url?: string; - readonly name?: string | null; - readonly node_id?: string; - readonly path?: string; - readonly previous_attempt_url?: string | null; - readonly pull_requests?: Record[]; - readonly referenced_workflows?: { - readonly path: string; - readonly ref?: string; - readonly sha: string; - }[] | null; - readonly repository?: { - readonly archive_url?: string; - readonly assignees_url?: string; - readonly blobs_url?: string; - readonly branches_url?: string; - readonly collaborators_url?: string; - readonly comments_url?: string; - readonly commits_url?: string; - readonly compare_url?: string; - readonly contents_url?: string; - readonly contributors_url?: string; - readonly deployments_url?: string; - readonly description?: string | null; - readonly downloads_url?: string; - readonly events_url?: string; - readonly fork?: boolean; - readonly forks_url?: string; - readonly full_name?: string; - readonly git_commits_url?: string; - readonly git_refs_url?: string; - readonly git_tags_url?: string; - readonly hooks_url?: string; - readonly html_url?: string; - readonly id?: number; - readonly issue_comment_url?: string; - readonly issue_events_url?: string; - readonly issues_url?: string; - readonly keys_url?: string; - readonly labels_url?: string; - readonly languages_url?: string; - readonly merges_url?: string; - readonly milestones_url?: string; - readonly name?: string; - readonly node_id?: string; - readonly notifications_url?: string; - readonly owner?: { - 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; - 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 private?: boolean; - readonly pulls_url?: string; - readonly releases_url?: string; - readonly stargazers_url?: string; - readonly statuses_url?: string; - readonly subscribers_url?: string; - readonly subscription_url?: string; - readonly tags_url?: string; - readonly teams_url?: string; - readonly trees_url?: string; - readonly url?: string; - }; - readonly rerun_url?: string; - readonly run_attempt?: number; - readonly run_number?: number; - readonly run_started_at?: string; - readonly status?: string; - readonly triggering_actor?: { - 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; - 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 updated_at?: string; - readonly url?: string; - readonly workflow_id?: number; - readonly workflow_url?: string; }; }; /** workflow_run requested event */ @@ -90527,24 +82930,7 @@ export interface components { readonly organization?: components["schemas"]["organization-simple-webhooks"]; readonly repository: components["schemas"]["repository-webhooks"]; readonly sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - readonly workflow: { - /** Format: uri */ - readonly badge_url: string; - /** Format: date-time */ - readonly created_at: string; - /** Format: uri */ - readonly html_url: string; - readonly id: number; - readonly name: string; - readonly node_id: string; - readonly path: string; - readonly state: string; - /** Format: date-time */ - readonly updated_at: string; - /** Format: uri */ - readonly url: string; - } | null; + readonly workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ readonly workflow_run: { /** User */ @@ -91057,6 +83443,15 @@ export interface components { readonly "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Internal Error */ + readonly internal_error: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Service unavailable */ readonly service_unavailable: { headers: { @@ -91142,15 +83537,6 @@ export interface components { }; }; }; - /** @description Internal Error */ - readonly internal_error: { - headers: { - readonly [name: string]: unknown; - }; - 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: { headers: { @@ -91235,22 +83621,31 @@ export interface components { readonly "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Unacceptable */ + readonly unacceptable: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["basic-error"]; + }; + }; }; parameters: { - /** @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. */ + /** @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 "pagination-before": string; - /** @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. */ + /** @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 "pagination-after": string; /** @description The direction to sort the results by. */ readonly direction: "asc" | "desc"; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ readonly ghsa_id: string; - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ readonly cursor: string; readonly "delivery-id": number; - /** @description Page number of the results to fetch. */ + /** @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: number; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since: string; @@ -91341,7 +83736,7 @@ export interface components { readonly "runner-label-name": string; /** @description The name of the secret. */ readonly "secret-name": string; - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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 "variables-per-page": number; /** @description The name of the variable. */ readonly "variable-name": string; @@ -91452,7 +83847,7 @@ export interface components { readonly "workflow-run-branch": string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ readonly event: string; - /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ + /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ readonly "workflow-run-status": "completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting" | "pending"; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ readonly created: string; @@ -91499,12 +83894,17 @@ export interface components { readonly "manifest-path": string; /** @description deployment_id parameter */ readonly "deployment-id": number; - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly "environment-name": string; /** @description The unique identifier of the branch policy. */ readonly "branch-policy-id": number; /** @description The unique identifier of the protection rule. */ readonly "protection-rule-id": number; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + readonly "git-ref-only": string; /** @description A user ID. Only return users with an ID greater than this ID. */ readonly "since-user": number; /** @description The number that identifies the issue. */ @@ -91513,6 +83913,8 @@ export interface components { readonly "key-id": number; /** @description The number that identifies the milestone. */ readonly "milestone-number": number; + /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + readonly "pages-deployment-id": number | string; /** @description The number that identifies the pull request. */ readonly "pull-number": number; /** @description The unique identifier of the review. */ @@ -91599,7 +84001,7 @@ export interface operations { /** @description If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned. */ readonly cve_id?: string; /** @description If specified, only advisories for these ecosystems will be returned. */ - readonly ecosystem?: "actions" | "composer" | "erlang" | "go" | "maven" | "npm" | "nuget" | "other" | "pip" | "pub" | "rubygems" | "rust"; + readonly ecosystem?: components["schemas"]["security-advisory-ecosystems"]; /** @description If specified, only advisories with these severities will be returned. */ readonly severity?: "unknown" | "low" | "medium" | "high" | "critical"; /** @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. @@ -91625,13 +84027,13 @@ export interface operations { * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ readonly modified?: string; - /** @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. */ + /** @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. */ + /** @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 The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 The property to sort the results by. */ readonly sort?: "updated" | "published"; @@ -91789,7 +84191,7 @@ export interface operations { readonly "apps/list-webhook-deliveries": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ readonly cursor?: components["parameters"]["cursor"]; @@ -91857,9 +84259,9 @@ export interface operations { readonly "apps/list-installation-requests-for-authenticated-app": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -91884,9 +84286,9 @@ export interface operations { readonly "apps/list-installations": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; @@ -92271,9 +84673,9 @@ export interface operations { readonly "classroom/list-accepted-assigments-for-an-assignment": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -92323,9 +84725,9 @@ export interface operations { readonly "classroom/list-classrooms": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -92372,9 +84774,9 @@ export interface operations { readonly "classroom/list-assignments-for-a-classroom": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -92465,6 +84867,42 @@ export interface operations { readonly 304: components["responses"]["not_modified"]; }; }; + readonly "copilot/usage-metrics-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 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"]["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 "dependabot/list-alerts-for-enterprise": { readonly parameters: { readonly query?: { @@ -92490,9 +84928,9 @@ export interface operations { readonly sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @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. */ + /** @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. */ + /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. @@ -92502,7 +84940,7 @@ export interface operations { * This parameter must not be used in combination with `first`. * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ readonly last?: components["parameters"]["pagination-last"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; readonly header?: never; @@ -92544,11 +84982,11 @@ export interface operations { readonly sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 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. */ + /** @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. */ + /** @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 validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ readonly validity?: components["parameters"]["secret-scanning-alert-validity"]; @@ -92579,9 +85017,9 @@ export interface operations { readonly "activity/list-public-events": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92629,9 +85067,9 @@ export interface operations { readonly query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92710,9 +85148,9 @@ export interface operations { readonly query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92741,9 +85179,9 @@ export interface operations { readonly query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92876,9 +85314,9 @@ export interface operations { readonly "gists/list-comments": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93036,9 +85474,9 @@ export interface operations { readonly "gists/list-commits": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93069,9 +85507,9 @@ export interface operations { readonly "gists/list-forks": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93281,9 +85719,9 @@ export interface operations { readonly "apps/list-repos-accessible-to-installation": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93349,9 +85787,9 @@ export interface operations { readonly orgs?: boolean; readonly owned?: boolean; readonly pulls?: boolean; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93379,9 +85817,9 @@ export interface operations { readonly parameters: { readonly query?: { readonly featured?: boolean; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93531,9 +85969,9 @@ export interface operations { readonly "apps/list-plans": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93563,9 +86001,9 @@ export interface operations { readonly sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ readonly direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93626,9 +86064,9 @@ export interface operations { readonly "apps/list-plans-stubbed": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93657,9 +86095,9 @@ export interface operations { readonly sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ readonly direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93708,9 +86146,9 @@ export interface operations { readonly "activity/list-public-events-for-repo-network": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93750,9 +86188,9 @@ export interface operations { readonly since?: components["parameters"]["since"]; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly before?: components["parameters"]["before"]; - /** @description Page number of the results to fetch. */ + /** @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 50). */ + /** @description The number of results per page (max 50). 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; @@ -93847,6 +86285,27 @@ export interface operations { readonly 403: components["responses"]["forbidden"]; }; }; + readonly "activity/mark-thread-as-done": { + readonly parameters: { + readonly query?: never; + readonly header?: never; + readonly path: { + /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ + readonly thread_id: components["parameters"]["thread-id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description No content */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; readonly "activity/mark-thread-as-read": { readonly parameters: { readonly query?: never; @@ -93984,7 +86443,7 @@ export interface operations { readonly query?: { /** @description An organization ID. Only return organizations with an ID greater than this ID. */ readonly since?: components["parameters"]["since-org"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; readonly header?: never; @@ -94073,7 +86532,7 @@ export interface operations { readonly location?: string; /** @description The shorthand name of the company. */ readonly name?: string; - /** @description The description of the company. */ + /** @description The description of the company. The maximum size is 160 characters. */ readonly description?: string; /** @description Whether an organization can use organization projects. */ readonly has_organization_projects?: boolean; @@ -94221,9 +86680,9 @@ export interface operations { readonly "actions/get-actions-cache-usage-by-repo-for-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -94356,9 +86815,9 @@ export interface operations { readonly "actions/list-selected-repositories-enabled-github-actions-organization": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -94559,9 +87018,9 @@ export interface operations { readonly query?: { /** @description The name of a self-hosted runner. */ readonly name?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -94850,9 +87309,9 @@ export interface operations { readonly "actions/list-org-secrets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95001,9 +87460,9 @@ export interface operations { readonly "actions/list-selected-repos-for-org-secret": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -95126,9 +87585,9 @@ export interface operations { readonly "actions/list-org-variables": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ + /** @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; @@ -95284,9 +87743,9 @@ export interface operations { readonly "actions/list-selected-repos-for-org-variable": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -95423,9 +87882,9 @@ export interface operations { readonly "orgs/list-blocked-users": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95534,13 +87993,13 @@ export interface operations { readonly tool_name?: components["parameters"]["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["parameters"]["tool-guid"]; - /** @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. */ + /** @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. */ + /** @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 Page number of the results to fetch. */ + /** @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). */ + /** @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 direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; @@ -95577,9 +88036,9 @@ export interface operations { readonly "codespaces/list-in-organization": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95735,9 +88194,9 @@ export interface operations { readonly "codespaces/list-org-secrets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95890,9 +88349,9 @@ export interface operations { readonly "codespaces/list-selected-repos-for-org-secret": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -96049,15 +88508,22 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; + /** @description There is a problem with your account's associated payment method. */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; readonly 500: components["responses"]["internal_error"]; }; }; readonly "copilot/list-copilot-seats": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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; }; readonly header?: never; @@ -96077,7 +88543,7 @@ export interface operations { }; content: { readonly "application/json": { - /** @description Total number of Copilot For Business seats for the organization currently being billed. */ + /** @description Total number of Copilot seats for the organization currently being billed. */ readonly total_seats?: number; readonly seats?: components["schemas"]["copilot-seat-details"][]; }; @@ -96089,7 +88555,7 @@ export interface operations { readonly 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/add-copilot-for-business-seats-for-teams": { + readonly "copilot/add-copilot-seats-for-teams": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -96122,7 +88588,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -96165,7 +88631,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -96175,7 +88641,7 @@ export interface operations { readonly 500: components["responses"]["internal_error"]; }; }; - readonly "copilot/add-copilot-for-business-seats-for-users": { + readonly "copilot/add-copilot-seats-for-users": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -96208,7 +88674,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -96251,7 +88717,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -96261,6 +88727,42 @@ export interface operations { readonly 500: components["responses"]["internal_error"]; }; }; + readonly "copilot/usage-metrics-for-org": { + 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 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 [name: string]: unknown; + }; + content: { + readonly "application/json": 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 "dependabot/list-alerts-for-org": { readonly parameters: { readonly query?: { @@ -96286,9 +88788,9 @@ export interface operations { readonly sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @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. */ + /** @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. */ + /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. @@ -96298,7 +88800,7 @@ export interface operations { * This parameter must not be used in combination with `first`. * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ readonly last?: components["parameters"]["pagination-last"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; readonly header?: never; @@ -96329,9 +88831,9 @@ export interface operations { readonly "dependabot/list-org-secrets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96480,9 +88982,9 @@ export interface operations { readonly "dependabot/list-selected-repos-for-org-secret": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -96630,9 +89132,9 @@ export interface operations { readonly "activity/list-public-org-events": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96658,9 +89160,9 @@ export interface operations { readonly "orgs/list-failed-invitations": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96688,9 +89190,9 @@ export interface operations { readonly "orgs/list-webhooks": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96937,7 +89439,7 @@ export interface operations { readonly "orgs/list-webhook-deliveries": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ readonly cursor?: components["parameters"]["cursor"]; @@ -97065,9 +89567,9 @@ export interface operations { readonly "orgs/list-app-installations": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97169,9 +89671,9 @@ export interface operations { readonly "orgs/list-pending-invitations": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Filter invitations by their member role. */ readonly role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager"; @@ -97222,10 +89724,11 @@ export interface operations { * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. * @default direct_member * @enum {string} */ - readonly role: "admin" | "direct_member" | "billing_manager"; + readonly role: "admin" | "direct_member" | "billing_manager" | "reinstate"; /** @description Specify IDs for the teams you want to invite new members to. */ readonly team_ids?: number[]; }; @@ -97273,9 +89776,9 @@ export interface operations { readonly "orgs/list-invitation-teams": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97317,9 +89820,9 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97351,9 +89854,9 @@ export interface operations { readonly filter?: "2fa_disabled" | "all"; /** @description Filter members returned by their role. */ readonly role?: "all" | "admin" | "member"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97444,9 +89947,9 @@ export interface operations { readonly "codespaces/get-codespaces-for-user-in-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97561,7 +90064,7 @@ export interface operations { readonly 401: components["responses"]["requires_authentication"]; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization or the user has a pending organization invitation. */ + /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */ readonly 422: { headers: { readonly [name: string]: unknown; @@ -97666,9 +90169,9 @@ export interface operations { readonly "migrations/list-for-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Exclude attributes from the API response to improve performance */ readonly exclude?: "repositories"[]; @@ -97877,9 +90380,9 @@ export interface operations { readonly "migrations/list-repos-for-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98264,9 +90767,9 @@ export interface operations { readonly "orgs/list-org-role-teams": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98309,9 +90812,9 @@ export interface operations { readonly "orgs/list-org-role-users": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98356,9 +90859,9 @@ export interface operations { readonly query?: { /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ readonly filter?: "2fa_disabled" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98477,9 +90980,9 @@ export interface operations { * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ readonly visibility?: components["parameters"]["package-visibility"]; - /** @description Page number of the results to fetch. */ + /** @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?: number; - /** @description The number of results per page (max 100). */ + /** @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; }; readonly header?: never; @@ -98594,9 +91097,9 @@ export interface operations { readonly "packages/get-all-package-versions-for-package-owned-by-org": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 state of the package, either active or deleted. */ readonly state?: "active" | "deleted"; @@ -98720,9 +91223,9 @@ export interface operations { readonly "orgs/list-pat-grant-requests": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 property by which to sort the results. */ readonly sort?: components["parameters"]["personal-access-token-sort"]; @@ -98833,9 +91336,9 @@ export interface operations { readonly "orgs/list-pat-grant-request-repositories": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98867,9 +91370,9 @@ export interface operations { readonly "orgs/list-pat-grants": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 property by which to sort the results. */ readonly sort?: components["parameters"]["personal-access-token-sort"]; @@ -98976,9 +91479,9 @@ export interface operations { readonly "orgs/list-pat-grant-repositories": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99012,9 +91515,9 @@ export interface operations { readonly query?: { /** @description Indicates the state of the projects to return. */ readonly state?: "open" | "closed" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99184,10 +91687,11 @@ export interface operations { /** @description Whether the property is required. */ readonly required?: boolean; /** @description Default value of the property */ - readonly default_value?: string | null; + readonly default_value?: (string | string[]) | null; /** @description Short description of the property */ readonly description?: string | null; - /** @description Ordered list of allowed values of the property */ + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ readonly allowed_values?: string[] | null; }; }; @@ -99228,9 +91732,9 @@ export interface operations { readonly "orgs/list-custom-properties-values-for-repos": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ readonly repository_query?: string; @@ -99288,14 +91792,15 @@ export interface operations { }; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; }; }; readonly "orgs/list-public-members": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99405,9 +91910,9 @@ export interface operations { readonly sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ readonly direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99578,7 +92083,7 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository"]; + readonly "application/json": components["schemas"]["full-repository"]; }; }; readonly 403: components["responses"]["forbidden"]; @@ -99588,9 +92093,9 @@ export interface operations { readonly "repos/get-org-rulesets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99632,10 +92137,12 @@ export interface operations { /** @description The name of the ruleset. */ readonly name: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - readonly target?: "branch" | "tag"; + readonly target?: "branch" | "tag" | "push"; readonly enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -99672,9 +92179,9 @@ export interface operations { readonly actor_name?: components["parameters"]["actor-name-in-query"]; /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ readonly rule_suite_result?: components["parameters"]["rule-suite-result"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99775,10 +92282,12 @@ export interface operations { /** @description The name of the ruleset. */ readonly name?: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - readonly target?: "branch" | "tag"; + readonly target?: "branch" | "tag" | "push"; readonly enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -99842,9 +92351,9 @@ export interface operations { readonly sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ readonly before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; @@ -99883,11 +92392,11 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ readonly sort?: "created" | "updated" | "published"; - /** @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. */ + /** @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. */ + /** @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 The number of advisories to return per page. */ + /** @description The number of advisories to return per page. 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 Filter by the state of the repository advisories. Only advisories of this state will be returned. */ readonly state?: "triage" | "draft" | "published" | "closed"; @@ -100059,12 +92568,50 @@ export interface operations { }; }; }; + readonly "copilot/usage-metrics-for-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 organization name. The name is not case sensitive. */ + readonly org: components["parameters"]["org"]; + /** @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": 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 "teams/list": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100280,9 +92827,9 @@ export interface operations { readonly query?: { /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Pinned discussions only filter */ readonly pinned?: string; @@ -100442,9 +92989,9 @@ export interface operations { readonly query?: { /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100603,9 +93150,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100717,9 +93264,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100823,9 +93370,9 @@ export interface operations { readonly "teams/list-pending-invitations-in-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100856,9 +93403,9 @@ export interface operations { readonly query?: { /** @description Filters members returned by their role in the team. */ readonly role?: "member" | "maintainer" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101005,9 +93552,9 @@ export interface operations { readonly "teams/list-projects-in-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101085,7 +93632,7 @@ export interface operations { readonly content: { readonly "application/json": { /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * @enum {string} */ readonly permission?: "read" | "write" | "admin"; @@ -101142,9 +93689,9 @@ export interface operations { readonly "teams/list-repos-in-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101280,9 +93827,9 @@ export interface operations { readonly "teams/list-child-in-org": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101629,9 +94176,9 @@ export interface operations { readonly query?: { /** @description Filters the project cards that are returned by the card's state. */ readonly archived_state?: "all" | "archived" | "not_archived"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101911,9 +94458,9 @@ export interface operations { readonly query?: { /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ readonly affiliation?: "outside" | "direct" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -102043,9 +94590,9 @@ export interface operations { readonly "projects/list-columns": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -102385,9 +94932,9 @@ export interface operations { readonly "actions/list-artifacts-for-repo": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 name field of an artifact. When specified, only artifacts with this name will be returned. */ readonly name?: components["parameters"]["artifact-name"]; @@ -102526,9 +95073,9 @@ export interface operations { readonly "actions/get-actions-cache-list": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ readonly ref?: components["parameters"]["actions-cache-git-ref-full"]; @@ -102776,9 +95323,9 @@ export interface operations { readonly "actions/list-repo-organization-secrets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -102810,9 +95357,9 @@ export interface operations { readonly "actions/list-repo-organization-variables": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ + /** @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; @@ -103064,9 +95611,9 @@ export interface operations { readonly query?: { /** @description The name of a self-hosted runner. */ readonly name?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -103385,11 +95932,11 @@ export interface operations { readonly branch?: components["parameters"]["workflow-run-branch"]; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ readonly event?: components["parameters"]["event"]; - /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ + /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ readonly status?: components["parameters"]["workflow-run-status"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ readonly created?: components["parameters"]["created"]; @@ -103540,9 +96087,9 @@ export interface operations { readonly "actions/list-workflow-run-artifacts": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 name field of an artifact. When specified, only artifacts with this name will be returned. */ readonly name?: components["parameters"]["artifact-name"]; @@ -103610,9 +96157,9 @@ export interface operations { readonly "actions/list-jobs-for-workflow-run-attempt": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -103765,9 +96312,9 @@ export interface operations { readonly query?: { /** @description Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run. */ readonly filter?: "latest" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104034,9 +96581,9 @@ export interface operations { readonly "actions/list-repo-secrets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104188,9 +96735,9 @@ export interface operations { readonly "actions/list-repo-variables": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ + /** @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; @@ -104342,9 +96889,9 @@ export interface operations { readonly "actions/list-repo-workflows": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104495,11 +97042,11 @@ export interface operations { readonly branch?: components["parameters"]["workflow-run-branch"]; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ readonly event?: components["parameters"]["event"]; - /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ + /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ readonly status?: components["parameters"]["workflow-run-status"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ readonly created?: components["parameters"]["created"]; @@ -104570,11 +97117,11 @@ export interface operations { readonly query?: { /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 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. */ + /** @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. */ + /** @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 The Git reference for the activities you want to list. * @@ -104618,9 +97165,9 @@ export interface operations { readonly "issues/list-assignees": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104682,10 +97229,7 @@ export interface operations { }; readonly "repos/list-autolinks": { readonly parameters: { - readonly query?: { - /** @description Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; + readonly query?: never; readonly header?: never; readonly path: { /** @description The account owner of the repository. The name is not case sensitive. */ @@ -104887,9 +97431,9 @@ export interface operations { readonly query?: { /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ readonly protected?: boolean; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -106144,11 +98688,11 @@ export interface operations { /** @description A reference for the run on the integrator's system. */ readonly external_id?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @default queued * @enum {string} */ - readonly status: "queued" | "in_progress" | "completed"; + readonly status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. @@ -106295,10 +98839,10 @@ export interface operations { */ readonly started_at?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - readonly status?: "queued" | "in_progress" | "completed"; + readonly status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. @@ -106387,9 +98931,9 @@ export interface operations { readonly "checks/list-annotations": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -106580,9 +99124,9 @@ export interface operations { readonly status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ readonly filter?: "latest" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -106647,9 +99191,9 @@ export interface operations { readonly tool_name?: components["parameters"]["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["parameters"]["tool-guid"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ readonly ref?: components["parameters"]["git-ref"]; @@ -106760,9 +99304,9 @@ export interface operations { readonly "code-scanning/list-alert-instances": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ readonly ref?: components["parameters"]["git-ref"]; @@ -106801,9 +99345,9 @@ export interface operations { readonly tool_name?: components["parameters"]["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["parameters"]["tool-guid"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ readonly ref?: components["schemas"]["code-scanning-ref"]; @@ -107176,9 +99720,9 @@ export interface operations { readonly "codespaces/list-in-repository-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107282,9 +99826,9 @@ export interface operations { readonly "codespaces/list-devcontainers-in-repository-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107438,9 +99982,9 @@ export interface operations { readonly "codespaces/list-repo-secrets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107596,9 +100140,9 @@ export interface operations { readonly affiliation?: "outside" | "direct" | "all"; /** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */ readonly permission?: "pull" | "triage" | "push" | "maintain" | "admin"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107764,9 +100308,9 @@ export interface operations { readonly "repos/list-commit-comments-for-repo": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107886,9 +100430,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108006,9 +100550,9 @@ export interface operations { readonly since?: components["parameters"]["since"]; /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly until?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108063,15 +100607,16 @@ export interface operations { readonly "application/json": components["schemas"]["branch-short"][]; }; }; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; readonly "repos/list-comments-for-commit": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108146,9 +100691,9 @@ export interface operations { readonly "repos/list-pull-requests-associated-with-commit": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108174,14 +100719,15 @@ export interface operations { readonly "application/json": components["schemas"]["pull-request-simple"][]; }; }; + readonly 409: components["responses"]["conflict"]; }; }; readonly "repos/get-commit": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -108207,6 +100753,7 @@ export interface operations { }; }; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; readonly 500: components["responses"]["internal_error"]; readonly 503: components["responses"]["service_unavailable"]; @@ -108221,9 +100768,9 @@ export interface operations { readonly status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ readonly filter?: "latest" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 app_id?: number; }; @@ -108265,9 +100812,9 @@ export interface operations { readonly app_id?: number; /** @description Returns check runs with the specified `name`. */ readonly check_name?: components["parameters"]["check-name"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108301,9 +100848,9 @@ export interface operations { readonly "repos/get-combined-status-for-ref": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108334,9 +100881,9 @@ export interface operations { readonly "repos/list-commit-statuses-for-ref": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108393,9 +100940,9 @@ export interface operations { readonly "repos/compare-commits": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -108590,9 +101137,9 @@ export interface operations { readonly query?: { /** @description Set to `1` or `true` to include anonymous contributors in results. */ readonly anon?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108661,12 +101208,12 @@ export interface operations { readonly page?: number; /** * @deprecated - * @description The number of results per page (max 100). + * @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. */ + /** @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. */ + /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. @@ -108793,9 +101340,9 @@ export interface operations { readonly "dependabot/list-repo-secrets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109054,9 +101601,9 @@ export interface operations { readonly task?: string; /** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */ readonly environment?: string | null; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109223,9 +101770,9 @@ export interface operations { readonly "repos/list-deployment-statuses": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109379,15 +101926,16 @@ export interface operations { }; content?: never; }; + readonly 404: components["responses"]["not_found"]; readonly 422: components["responses"]["validation_failed"]; }; }; readonly "repos/get-all-environments": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109428,7 +101976,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; }; readonly cookie?: never; @@ -109455,7 +102003,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; }; readonly cookie?: never; @@ -109508,7 +102056,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; }; readonly cookie?: never; @@ -109527,9 +102075,9 @@ export interface operations { readonly "repos/list-deployment-branch-policies": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109538,7 +102086,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; }; readonly cookie?: never; @@ -109572,7 +102120,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; }; readonly cookie?: never; @@ -109617,7 +102165,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ readonly branch_policy_id: components["parameters"]["branch-policy-id"]; @@ -109646,7 +102194,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ readonly branch_policy_id: components["parameters"]["branch-policy-id"]; @@ -109679,7 +102227,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ readonly branch_policy_id: components["parameters"]["branch-policy-id"]; @@ -109702,7 +102250,7 @@ export interface operations { readonly query?: never; readonly header?: never; readonly path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ readonly repo: components["parameters"]["repo"]; @@ -109736,7 +102284,7 @@ export interface operations { readonly query?: never; readonly header?: never; readonly path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ readonly repo: components["parameters"]["repo"]; @@ -109768,14 +102316,14 @@ export interface operations { readonly "repos/list-custom-deployment-rule-integrations": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; readonly path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ readonly repo: components["parameters"]["repo"]; @@ -109813,7 +102361,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the protection rule. */ readonly protection_rule_id: components["parameters"]["protection-rule-id"]; @@ -109838,7 +102386,7 @@ export interface operations { readonly query?: never; readonly header?: never; readonly path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ readonly environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ readonly repo: components["parameters"]["repo"]; @@ -109860,12 +102408,340 @@ export interface operations { }; }; }; + readonly "actions/list-environment-secrets": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + }; + 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 secrets: components["schemas"]["actions-secret"][]; + }; + }; + }; + }; + }; + readonly "actions/get-environment-public-key": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + readonly "actions/get-environment-secret": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ + readonly secret_name: components["parameters"]["secret-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-secret"]; + }; + }; + }; + }; + readonly "actions/create-or-update-environment-secret": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ + readonly secret_name: components["parameters"]["secret-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + readonly encrypted_value: string; + /** @description ID of the key you used to encrypt the secret. */ + readonly key_id: string; + }; + }; + }; + readonly responses: { + /** @description Response when creating a secret */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response when updating a secret */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/delete-environment-secret": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ + readonly secret_name: components["parameters"]["secret-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Default response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/list-environment-variables": { + readonly parameters: { + readonly query?: { + /** @description The number of results per page (max 30). 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"]["variables-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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + }; + 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 variables: components["schemas"]["actions-variable"][]; + }; + }; + }; + }; + }; + readonly "actions/create-environment-variable": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the variable. */ + readonly name: string; + /** @description The value of the variable. */ + readonly value: string; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["empty-object"]; + }; + }; + }; + }; + readonly "actions/get-environment-variable": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + /** @description The name of the variable. */ + readonly name: components["parameters"]["variable-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 200: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["actions-variable"]; + }; + }; + }; + }; + readonly "actions/delete-environment-variable": { + 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 name of the variable. */ + readonly name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "actions/update-environment-variable": { + 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 name of the variable. */ + readonly name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + readonly environment_name: components["parameters"]["environment-name"]; + }; + readonly cookie?: never; + }; + readonly requestBody: { + readonly content: { + readonly "application/json": { + /** @description The name of the variable. */ + readonly name?: string; + /** @description The value of the variable. */ + readonly value?: string; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; readonly "activity/list-repo-events": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109895,9 +102771,9 @@ export interface operations { readonly query?: { /** @description The sort order. `stargazers` will sort by star count. */ readonly sort?: "newest" | "oldest" | "stargazers" | "watchers"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -110033,6 +102909,7 @@ export interface operations { }; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -110099,6 +102976,7 @@ export interface operations { }; }; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -110128,6 +103006,7 @@ export interface operations { }; }; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; }; }; readonly "git/list-matching-refs": { @@ -110139,8 +103018,11 @@ export interface operations { 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 commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + readonly ref: components["parameters"]["git-ref-only"]; }; readonly cookie?: never; }; @@ -110156,6 +103038,7 @@ export interface operations { readonly "application/json": components["schemas"]["git-ref"][]; }; }; + readonly 409: components["responses"]["conflict"]; }; }; readonly "git/get-ref": { @@ -110167,8 +103050,11 @@ export interface operations { 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 commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + readonly ref: components["parameters"]["git-ref-only"]; }; readonly cookie?: never; }; @@ -110184,6 +103070,7 @@ export interface operations { }; }; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; }; }; readonly "git/create-ref": { @@ -110220,6 +103107,7 @@ export interface operations { readonly "application/json": components["schemas"]["git-ref"]; }; }; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -110232,8 +103120,11 @@ export interface operations { 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 commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - readonly ref: components["parameters"]["commit-ref"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + readonly ref: components["parameters"]["git-ref-only"]; }; readonly cookie?: never; }; @@ -110246,6 +103137,7 @@ export interface operations { }; content?: never; }; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -110259,10 +103151,10 @@ export interface operations { /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ readonly repo: components["parameters"]["repo"]; /** - * @description The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. - * @example heads/featureA + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a */ - readonly ref: string; + readonly ref: components["parameters"]["git-ref-only"]; }; readonly cookie?: never; }; @@ -110289,6 +103181,7 @@ export interface operations { readonly "application/json": components["schemas"]["git-ref"]; }; }; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -110345,6 +103238,7 @@ export interface operations { readonly "application/json": components["schemas"]["git-tag"]; }; }; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -110373,6 +103267,7 @@ export interface operations { }; }; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; }; }; readonly "git/create-tree": { @@ -110434,6 +103329,7 @@ export interface operations { }; readonly 403: components["responses"]["forbidden"]; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; @@ -110466,15 +103362,16 @@ export interface operations { }; }; readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; readonly "repos/list-webhooks": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -110524,10 +103421,6 @@ export interface operations { readonly content_type?: components["schemas"]["webhook-config-content-type"]; readonly secret?: components["schemas"]["webhook-config-secret"]; readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - /** @example "abc" */ - readonly token?: string; - /** @example "sha256" */ - readonly digest?: string; }; /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. @@ -110632,17 +103525,7 @@ export interface operations { readonly requestBody: { readonly content: { readonly "application/json": { - /** @description Key/value pairs to provide settings for this webhook. */ - readonly config?: { - readonly url: components["schemas"]["webhook-config-url"]; - readonly content_type?: components["schemas"]["webhook-config-content-type"]; - readonly secret?: components["schemas"]["webhook-config-secret"]; - readonly insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - /** @example "bar@example.com" */ - readonly address?: string; - /** @example "The Serious Room" */ - readonly room?: string; - }; + readonly config?: components["schemas"]["webhook-config"]; /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ @@ -110742,7 +103625,7 @@ export interface operations { readonly "repos/list-webhook-deliveries": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ readonly cursor?: components["parameters"]["cursor"]; @@ -111275,9 +104158,9 @@ export interface operations { readonly "repos/list-invitations": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111386,9 +104269,9 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111480,9 +104363,9 @@ export interface operations { readonly direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111603,9 +104486,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111711,9 +104594,9 @@ export interface operations { readonly "issues/list-events-for-repo": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111973,9 +104856,9 @@ export interface operations { readonly query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112048,9 +104931,9 @@ export interface operations { readonly "issues/list-events": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112082,9 +104965,9 @@ export interface operations { readonly "issues/list-labels-on-issue": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112337,9 +105220,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112446,9 +105329,9 @@ export interface operations { readonly "issues/list-events-for-timeline": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112481,9 +105364,9 @@ export interface operations { readonly "repos/list-deploy-keys": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112606,9 +105489,9 @@ export interface operations { readonly "issues/list-labels-for-repo": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112790,7 +105673,10 @@ export interface operations { }; readonly "licenses/get-for-repo": { readonly parameters: { - readonly query?: never; + readonly query?: { + /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ + readonly ref?: components["parameters"]["git-ref"]; + }; readonly header?: never; readonly path: { /** @description The account owner of the repository. The name is not case sensitive. */ @@ -112928,9 +105814,9 @@ export interface operations { readonly sort?: "due_on" | "completeness"; /** @description The direction of the sort. Either `asc` or `desc`. */ readonly direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113110,9 +105996,9 @@ export interface operations { readonly "issues/list-labels-for-milestone": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113151,9 +106037,234 @@ export interface operations { readonly since?: components["parameters"]["since"]; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly before?: components["parameters"]["before"]; - /** @description The number of results per page (max 100). */ + /** @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"]; + }; + 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": components["schemas"]["thread"][]; + }; + }; + }; + }; + readonly "activity/mark-repo-notifications-as-read": { + 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?: { + readonly content: { + readonly "application/json": { + /** + * Format: date-time + * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + readonly last_read_at?: string; + }; + }; + }; + readonly responses: { + /** @description Response */ + readonly 202: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": { + readonly message?: string; + readonly url?: string; + }; + }; + }; + /** @description Reset Content */ + readonly 205: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + }; + }; + readonly "repos/get-pages": { + 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"]["page"]; + }; + }; + readonly 404: components["responses"]["not_found"]; + }; + }; + readonly "repos/update-information-about-pages-site": { + 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: { + readonly content: { + readonly "application/json": { + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ + readonly cname?: string | null; + /** @description Specify whether HTTPS should be enforced for the repository. */ + readonly https_enforced?: boolean; + /** + * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch. + * @enum {string} + */ + readonly build_type?: "legacy" | "workflow"; + readonly source?: ("gh-pages" | "master" | "master /docs") | { + /** @description The repository branch used to publish your site's source files. */ + readonly branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. + * @enum {string} + */ + readonly path: "/" | "/docs"; + }; + } | unknown | unknown | unknown | unknown | unknown; + }; + }; + readonly responses: { + /** @description Response */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 400: components["responses"]["bad_request"]; + readonly 409: components["responses"]["conflict"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "repos/create-pages-site": { + 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: { + readonly content: { + readonly "application/json": ({ + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + readonly build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + readonly source?: { + /** @description The repository branch used to publish your site's source files. */ + readonly branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + readonly path: "/" | "/docs"; + }; + } | unknown | unknown) | null; + }; + }; + readonly responses: { + /** @description Response */ + readonly 201: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["page"]; + }; + }; + readonly 409: components["responses"]["conflict"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "repos/delete-pages-site": { + 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 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 404: components["responses"]["not_found"]; + readonly 409: components["responses"]["conflict"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; + readonly "repos/list-pages-builds": { + 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 Page number of the results to fetch. */ + /** @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; @@ -113174,12 +106285,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["thread"][]; + readonly "application/json": components["schemas"]["page-build"][]; }; }; }; }; - readonly "activity/mark-repo-notifications-as-read": { + readonly "repos/request-pages-build": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -113191,40 +106302,20 @@ export interface operations { }; readonly cookie?: never; }; - readonly requestBody?: { - readonly content: { - readonly "application/json": { - /** - * Format: date-time - * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. - */ - readonly last_read_at?: string; - }; - }; - }; + readonly requestBody?: never; readonly responses: { /** @description Response */ - readonly 202: { + readonly 201: { headers: { readonly [name: string]: unknown; }; content: { - readonly "application/json": { - readonly message?: string; - readonly url?: string; - }; - }; - }; - /** @description Reset Content */ - readonly 205: { - headers: { - readonly [name: string]: unknown; + readonly "application/json": components["schemas"]["page-build-status"]; }; - content?: never; }; }; }; - readonly "repos/get-pages": { + readonly "repos/get-latest-pages-build": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -113244,13 +106335,12 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page"]; + readonly "application/json": components["schemas"]["page-build"]; }; }; - readonly 404: components["responses"]["not_found"]; }; }; - readonly "repos/update-information-about-pages-site": { + readonly "repos/get-pages-build": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -113259,47 +106349,24 @@ export interface operations { 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 build_id: number; }; readonly cookie?: never; }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ - readonly cname?: string | null; - /** @description Specify whether HTTPS should be enforced for the repository. */ - readonly https_enforced?: boolean; - /** - * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch. - * @enum {string} - */ - readonly build_type?: "legacy" | "workflow"; - readonly source?: ("gh-pages" | "master" | "master /docs") | { - /** @description The repository branch used to publish your site's source files. */ - readonly branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. - * @enum {string} - */ - readonly path: "/" | "/docs"; - }; - } | unknown | unknown | unknown | unknown | unknown; - }; - }; + readonly requestBody?: never; readonly responses: { /** @description Response */ - readonly 204: { + readonly 200: { headers: { readonly [name: string]: unknown; }; - content?: never; + content: { + readonly "application/json": components["schemas"]["page-build"]; + }; }; - readonly 400: components["responses"]["bad_request"]; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/create-pages-site": { + readonly "repos/create-pages-deployment": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -113313,80 +106380,52 @@ export interface operations { }; readonly requestBody: { readonly content: { - readonly "application/json": ({ + readonly "application/json": { + /** @description The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */ + readonly artifact_id?: number; + /** @description The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */ + readonly artifact_url?: string; /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} + * @description The target environment for this GitHub Pages deployment. + * @default github-pages */ - readonly build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - readonly source?: { - /** @description The repository branch used to publish your site's source files. */ - readonly branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - readonly path: "/" | "/docs"; - }; - } | unknown | unknown) | null; + readonly environment: string; + /** + * @description A unique string that represents the version of the build for this deployment. + * @default GITHUB_SHA + */ + readonly pages_build_version: string; + /** @description The OIDC token issued by GitHub Actions certifying the origin of the deployment. */ + readonly oidc_token: string; + }; }; }; readonly responses: { /** @description Response */ - readonly 201: { + readonly 200: { headers: { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page"]; - }; - }; - readonly 409: components["responses"]["conflict"]; - readonly 422: components["responses"]["validation_failed"]; - }; - }; - readonly "repos/delete-pages-site": { - 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 204: { - headers: { - readonly [name: string]: unknown; + readonly "application/json": components["schemas"]["page-deployment"]; }; - content?: never; }; + readonly 400: components["responses"]["bad_request"]; readonly 404: components["responses"]["not_found"]; - readonly 409: components["responses"]["conflict"]; readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/list-pages-builds": { + readonly "repos/get-pages-deployment": { readonly parameters: { - readonly query?: { - /** @description The number of results per page (max 100). */ - readonly per_page?: components["parameters"]["per-page"]; - /** @description Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; + 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 ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + readonly pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; readonly cookie?: never; }; @@ -113395,16 +106434,16 @@ export interface operations { /** @description Response */ readonly 200: { headers: { - readonly Link: components["headers"]["link"]; readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page-build"][]; + readonly "application/json": components["schemas"]["pages-deployment-status"]; }; }; + readonly 404: components["responses"]["not_found"]; }; }; - readonly "repos/request-pages-build": { + readonly "repos/cancel-pages-deployment": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -113413,23 +106452,18 @@ export interface operations { 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 ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + readonly pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; readonly cookie?: never; }; readonly requestBody?: never; readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["page-build-status"]; - }; - }; + readonly 204: components["responses"]["no_content"]; + readonly 404: components["responses"]["not_found"]; }; }; - readonly "repos/get-latest-pages-build": { + readonly "repos/get-pages-health-check": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -113449,85 +106483,36 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page-build"]; + readonly "application/json": components["schemas"]["pages-health-check"]; }; }; - }; - }; - readonly "repos/get-pages-build": { - 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 build_id: number; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { + /** @description Empty response */ + readonly 202: { headers: { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["page-build"]; + readonly "application/json": components["schemas"]["empty-object"]; }; }; - }; - }; - readonly "repos/create-pages-deployment": { - 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: { - readonly content: { - readonly "application/json": { - /** @description The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. */ - readonly artifact_url: string; - /** - * @description The target environment for this GitHub Pages deployment. - * @default github-pages - */ - readonly environment: string; - /** - * @description A unique string that represents the version of the build for this deployment. - * @default GITHUB_SHA - */ - readonly pages_build_version: string; - /** @description The OIDC token issued by GitHub Actions certifying the origin of the deployment. */ - readonly oidc_token: string; + /** @description Custom domains are not available for GitHub Pages */ + readonly 400: { + headers: { + readonly [name: string]: unknown; }; + content?: never; }; - }; - readonly responses: { - /** @description Response */ - readonly 200: { + readonly 404: components["responses"]["not_found"]; + /** @description There isn't a CNAME for this page */ + readonly 422: { headers: { readonly [name: string]: unknown; }; - content: { - readonly "application/json": components["schemas"]["page-deployment"]; - }; + content?: never; }; - readonly 400: components["responses"]["bad_request"]; - readonly 404: components["responses"]["not_found"]; - readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "repos/get-pages-health-check": { + readonly "repos/check-private-vulnerability-reporting": { readonly parameters: { readonly query?: never; readonly header?: never; @@ -113541,39 +106526,19 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description Response */ + /** @description Private vulnerability reporting status */ readonly 200: { headers: { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["pages-health-check"]; - }; - }; - /** @description Empty response */ - readonly 202: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Custom domains are not available for GitHub Pages */ - readonly 400: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - readonly 404: components["responses"]["not_found"]; - /** @description There isn't a CNAME for this page */ - readonly 422: { - headers: { - readonly [name: string]: unknown; + readonly "application/json": { + /** @description Whether or not private vulnerability reporting is enabled for the repository. */ + readonly enabled: boolean; + }; }; - content?: never; }; + readonly 422: components["responses"]["bad_request"]; }; }; readonly "repos/enable-private-vulnerability-reporting": { @@ -113617,9 +106582,9 @@ export interface operations { readonly query?: { /** @description Indicates the state of the projects to return. */ readonly state?: "open" | "closed" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113716,6 +106681,39 @@ export interface operations { readonly 404: components["responses"]["not_found"]; }; }; + readonly "repos/create-or-update-custom-properties-values": { + 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: { + readonly content: { + readonly "application/json": { + /** @description A list of custom property names and associated values to apply to the repositories. */ + readonly properties: components["schemas"]["custom-property-value"][]; + }; + }; + }; + readonly responses: { + /** @description No Content when custom property values are successfully created or updated */ + readonly 204: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; readonly "pulls/list": { readonly parameters: { readonly query?: { @@ -113729,9 +106727,9 @@ export interface operations { readonly sort?: "created" | "updated" | "popularity" | "long-running"; /** @description The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ readonly direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113825,9 +106823,9 @@ export interface operations { readonly direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113946,9 +106944,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114078,6 +107076,7 @@ export interface operations { }; readonly 304: components["responses"]["not_modified"]; readonly 404: components["responses"]["not_found"]; + readonly 406: components["responses"]["unacceptable"]; readonly 500: components["responses"]["internal_error"]; readonly 503: components["responses"]["service_unavailable"]; }; @@ -114206,9 +107205,9 @@ export interface operations { readonly direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114261,7 +107260,7 @@ export interface operations { readonly path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. + * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ readonly position?: number; /** @@ -114349,9 +107348,9 @@ export interface operations { readonly "pulls/list-commits": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114382,9 +107381,9 @@ export interface operations { readonly "pulls/list-files": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114629,9 +107628,9 @@ export interface operations { readonly "pulls/list-reviews": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114689,7 +107688,7 @@ export interface operations { readonly comments?: { /** @description The relative path to the file that necessitates a review comment. */ readonly path: string; - /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below. */ + /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ readonly position?: number; /** @description Text of the review comment. */ readonly body: string; @@ -114820,9 +107819,9 @@ export interface operations { readonly "pulls/list-comments-for-review": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115044,9 +108043,9 @@ export interface operations { readonly "repos/list-releases": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115346,7 +108345,7 @@ export interface operations { }; readonly requestBody?: never; readonly responses: { - /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ + /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ readonly 200: { headers: { readonly [name: string]: unknown; @@ -115453,9 +108452,9 @@ export interface operations { readonly "repos/list-release-assets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115529,9 +108528,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ readonly content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115637,9 +108636,9 @@ export interface operations { readonly "repos/get-branch-rules": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115669,9 +108668,9 @@ export interface operations { readonly "repos/get-repo-rulesets": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Include rulesets configured at higher levels that apply to this repository */ readonly includes_parents?: boolean; @@ -115719,10 +108718,12 @@ export interface operations { /** @description The name of the ruleset. */ readonly name: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - readonly target?: "branch" | "tag"; + readonly target?: "branch" | "tag" | "push"; readonly enforcement: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -115759,9 +108760,9 @@ export interface operations { readonly actor_name?: components["parameters"]["actor-name-in-query"]; /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ readonly rule_suite_result?: components["parameters"]["rule-suite-result"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115873,10 +108874,12 @@ export interface operations { /** @description The name of the ruleset. */ readonly name?: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - readonly target?: "branch" | "tag"; + readonly target?: "branch" | "tag" | "push"; readonly enforcement?: components["schemas"]["repository-rule-enforcement"]; /** @description The actors that can bypass the rules in this ruleset */ readonly bypass_actors?: components["schemas"]["repository-ruleset-bypass-actor"][]; @@ -115942,9 +108945,9 @@ export interface operations { readonly sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ readonly before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; @@ -116079,9 +109082,9 @@ export interface operations { readonly "secret-scanning/list-locations-for-alert": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -116124,11 +109127,11 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ readonly sort?: "created" | "updated" | "published"; - /** @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. */ + /** @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. */ + /** @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 Number of advisories to return per page. */ + /** @description The number of advisories to return per page. 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 Filter by state of the repository advisories. Only advisories of this state will be returned. */ readonly state?: "triage" | "draft" | "published" | "closed"; @@ -116315,12 +109318,43 @@ export interface operations { readonly 422: components["responses"]["validation_failed"]; }; }; + readonly "security-advisories/create-fork": { + 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 GHSA (GitHub Security Advisory) identifier of the advisory. */ + readonly ghsa_id: components["parameters"]["ghsa_id"]; + }; + readonly cookie?: never; + }; + readonly requestBody?: never; + readonly responses: { + /** @description Response */ + readonly 202: { + headers: { + readonly [name: string]: unknown; + }; + content: { + readonly "application/json": components["schemas"]["full-repository"]; + }; + }; + readonly 400: components["responses"]["bad_request"]; + readonly 403: components["responses"]["forbidden"]; + readonly 404: components["responses"]["not_found"]; + readonly 422: components["responses"]["validation_failed"]; + }; + }; readonly "activity/list-stargazers-for-repo": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116372,6 +109406,13 @@ export interface operations { }; readonly 202: components["responses"]["accepted"]; readonly 204: components["responses"]["no_content"]; + /** @description Repository contains more than 10,000 commits */ + readonly 422: { + headers: { + readonly [name: string]: unknown; + }; + content?: never; + }; }; }; readonly "repos/get-commit-activity-stats": { @@ -116532,9 +109573,9 @@ export interface operations { readonly "activity/list-watchers-for-repo": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116653,9 +109694,9 @@ export interface operations { readonly "repos/list-tags": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116798,9 +109839,9 @@ export interface operations { readonly "repos/list-teams": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116830,9 +109871,9 @@ export interface operations { readonly "repos/get-all-topics": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -117183,7 +110224,7 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository"]; + readonly "application/json": components["schemas"]["full-repository"]; }; }; }; @@ -117215,314 +110256,6 @@ export interface operations { readonly 422: components["responses"]["validation_failed"]; }; }; - readonly "actions/list-environment-secrets": { - readonly parameters: { - readonly query?: { - /** @description The number of results per page (max 100). */ - readonly per_page?: components["parameters"]["per-page"]; - /** @description Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - 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 secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; - readonly "actions/get-environment-public-key": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; - readonly "actions/get-environment-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; - readonly "actions/create-or-update-environment-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ - readonly encrypted_value: string; - /** @description ID of the key you used to encrypt the secret. */ - readonly key_id: string; - }; - }; - }; - readonly responses: { - /** @description Response when creating a secret */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Response when updating a secret */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "actions/delete-environment-secret": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - /** @description The name of the secret. */ - readonly secret_name: components["parameters"]["secret-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Default response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "actions/list-environment-variables": { - readonly parameters: { - readonly query?: { - /** @description The number of results per page (max 30). */ - readonly per_page?: components["parameters"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ - readonly page?: components["parameters"]["page"]; - }; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - 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 variables: components["schemas"]["actions-variable"][]; - }; - }; - }; - }; - }; - readonly "actions/create-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the variable. */ - readonly name: string; - /** @description The value of the variable. */ - readonly value: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 201: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["empty-object"]; - }; - }; - }; - }; - readonly "actions/get-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 200: { - headers: { - readonly [name: string]: unknown; - }; - content: { - readonly "application/json": components["schemas"]["actions-variable"]; - }; - }; - }; - }; - readonly "actions/delete-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody?: never; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; - readonly "actions/update-environment-variable": { - readonly parameters: { - readonly query?: never; - readonly header?: never; - readonly path: { - /** @description The unique identifier of the repository. */ - readonly repository_id: components["parameters"]["repository-id"]; - /** @description The name of the variable. */ - readonly name: components["parameters"]["variable-name"]; - /** @description The name of the environment. */ - readonly environment_name: components["parameters"]["environment-name"]; - }; - readonly cookie?: never; - }; - readonly requestBody: { - readonly content: { - readonly "application/json": { - /** @description The name of the variable. */ - readonly name?: string; - /** @description The value of the variable. */ - readonly value?: string; - }; - }; - }; - readonly responses: { - /** @description Response */ - readonly 204: { - headers: { - readonly [name: string]: unknown; - }; - content?: never; - }; - }; - }; readonly "search/code": { readonly parameters: { readonly query: { @@ -117538,9 +110271,9 @@ export interface operations { * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ readonly order?: "desc" | "asc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117577,9 +110310,9 @@ export interface operations { readonly sort?: "author-date" | "committer-date"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ readonly order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117613,9 +110346,9 @@ export interface operations { readonly sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ readonly order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117654,9 +110387,9 @@ export interface operations { readonly sort?: "created" | "updated"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ readonly order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117693,9 +110426,9 @@ export interface operations { readonly sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ readonly order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117727,9 +110460,9 @@ export interface operations { readonly query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */ readonly q: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117763,9 +110496,9 @@ export interface operations { readonly sort?: "followers" | "repositories" | "joined"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ readonly order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117913,9 +110646,9 @@ export interface operations { readonly query?: { /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118063,9 +110796,9 @@ export interface operations { readonly query?: { /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118214,9 +110947,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118286,9 +111019,9 @@ export interface operations { readonly query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ readonly content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118352,9 +111085,9 @@ export interface operations { readonly "teams/list-pending-invitations-legacy": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118383,9 +111116,9 @@ export interface operations { readonly query?: { /** @description Filters members returned by their role in the team. */ readonly role?: "member" | "maintainer" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118618,9 +111351,9 @@ export interface operations { readonly "teams/list-projects-legacy": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118693,7 +111426,7 @@ export interface operations { readonly content: { readonly "application/json": { /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * @enum {string} */ readonly permission?: "read" | "write" | "admin"; @@ -118752,9 +111485,9 @@ export interface operations { readonly "teams/list-repos-legacy": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118885,9 +111618,9 @@ export interface operations { readonly "teams/list-child-legacy": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119004,9 +111737,9 @@ export interface operations { readonly "users/list-blocked-by-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119117,9 +111850,9 @@ export interface operations { readonly "codespaces/list-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 ID of the Repository to filter on */ readonly repository_id?: components["parameters"]["repository-id-in-query"]; @@ -119240,9 +111973,9 @@ export interface operations { readonly "codespaces/list-secrets-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119820,9 +112553,9 @@ export interface operations { readonly "users/list-emails-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119915,9 +112648,9 @@ export interface operations { readonly "users/list-followers-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119944,9 +112677,9 @@ export interface operations { readonly "users/list-followed-by-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120056,9 +112789,9 @@ export interface operations { readonly "users/list-gpg-keys-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120173,9 +112906,9 @@ export interface operations { readonly "apps/list-installations-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120205,9 +112938,9 @@ export interface operations { readonly "apps/list-installation-repos-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120382,9 +113115,9 @@ export interface operations { readonly direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120410,9 +113143,9 @@ export interface operations { readonly "users/list-public-ssh-keys-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120529,9 +113262,9 @@ export interface operations { readonly "apps/list-subscriptions-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120558,9 +113291,9 @@ export interface operations { readonly "apps/list-subscriptions-for-authenticated-user-stubbed": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120588,9 +113321,9 @@ export interface operations { readonly query?: { /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ readonly state?: "active" | "pending"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120679,9 +113412,9 @@ export interface operations { readonly "migrations/list-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120886,9 +113619,9 @@ export interface operations { readonly "migrations/list-repos-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120916,9 +113649,9 @@ export interface operations { readonly "orgs/list-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120952,9 +113685,9 @@ export interface operations { * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ readonly visibility?: components["parameters"]["package-visibility"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -121058,9 +113791,9 @@ export interface operations { readonly "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { readonly parameters: { readonly query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 state of the package, either active or deleted. */ readonly state?: "active" | "deleted"; @@ -121215,9 +113948,9 @@ export interface operations { readonly "users/list-public-emails-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121258,9 +113991,9 @@ export interface operations { readonly sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ readonly direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since-repo-date"]; @@ -121441,7 +114174,7 @@ export interface operations { readonly [name: string]: unknown; }; content: { - readonly "application/json": components["schemas"]["repository"]; + readonly "application/json": components["schemas"]["full-repository"]; }; }; readonly 304: components["responses"]["not_modified"]; @@ -121455,9 +114188,9 @@ export interface operations { readonly "repos/list-invitations-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121535,9 +114268,9 @@ export interface operations { readonly "users/list-social-accounts-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121633,9 +114366,9 @@ export interface operations { readonly "users/list-ssh-signing-keys-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121756,9 +114489,9 @@ export interface operations { readonly sort?: components["parameters"]["sort-starred"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121875,9 +114608,9 @@ export interface operations { readonly "activity/list-watched-repos-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121904,9 +114637,9 @@ export interface operations { readonly "teams/list-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121935,7 +114668,7 @@ export interface operations { readonly query?: { /** @description A user ID. Only return users with an ID greater than this ID. */ readonly since?: components["parameters"]["since-user"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; readonly header?: never; @@ -122010,9 +114743,9 @@ export interface operations { readonly "activity/list-events-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122038,9 +114771,9 @@ export interface operations { readonly "activity/list-org-events-for-authenticated-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122068,9 +114801,9 @@ export interface operations { readonly "activity/list-public-events-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122096,9 +114829,9 @@ export interface operations { readonly "users/list-followers-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122125,9 +114858,9 @@ export interface operations { readonly "users/list-following-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122185,9 +114918,9 @@ export interface operations { readonly query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ readonly since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122215,9 +114948,9 @@ export interface operations { readonly "users/list-gpg-keys-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122297,9 +115030,9 @@ export interface operations { readonly "users/list-public-keys-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122326,9 +115059,9 @@ export interface operations { readonly "orgs/list-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122362,9 +115095,9 @@ export interface operations { * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ readonly visibility?: components["parameters"]["package-visibility"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; readonly header?: never; @@ -122600,9 +115333,9 @@ export interface operations { readonly query?: { /** @description Indicates the state of the projects to return. */ readonly state?: "open" | "closed" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122630,9 +115363,9 @@ export interface operations { readonly "activity/list-received-events-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122658,9 +115391,9 @@ export interface operations { readonly "activity/list-received-public-events-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122692,9 +115425,9 @@ export interface operations { readonly sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ readonly direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122790,9 +115523,9 @@ export interface operations { readonly "users/list-social-accounts-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122819,9 +115552,9 @@ export interface operations { readonly "users/list-ssh-signing-keys-for-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122852,9 +115585,9 @@ export interface operations { readonly sort?: components["parameters"]["sort-starred"]; /** @description The direction to sort the results by. */ readonly direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122881,9 +115614,9 @@ export interface operations { readonly "activity/list-repos-watched-by-user": { readonly parameters: { readonly query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122948,4 +115681,4 @@ export interface operations { }; }; }; -} \ No newline at end of file +} diff --git a/packages/openapi-typescript/examples/github-api-next.ts b/packages/openapi-typescript/examples/github-api-next.ts index c747b2f78..dd16bb079 100644 --- a/packages/openapi-typescript/examples/github-api-next.ts +++ b/packages/openapi-typescript/examples/github-api-next.ts @@ -231,9 +231,9 @@ export interface paths { }; /** * List installations for the authenticated app - * @description 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. + * @description The permissions the installation has are included under the `permissions` key. * - * The permissions the installation has are included under the `permissions` key. + * 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. */ get: operations["apps/list-installations"]; put?: never; @@ -283,7 +283,13 @@ export interface paths { put?: never; /** * Create an installation access token for an app - * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. + * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. + * + * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. + * + * 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. */ @@ -382,7 +388,15 @@ export interface paths { put?: never; /** * Create a scoped access token - * @description Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify + * which repositories the token can access and which permissions are granted to the + * token. + * + * Invalid tokens will return `404 NOT FOUND`. + * + * You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) + * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + * as the username and password. */ post: operations["apps/scope-token"]; delete?: never; @@ -401,8 +415,6 @@ export interface paths { /** * Get an app * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - * - * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ get: operations["apps/get-by-slug"]; put?: never; @@ -593,6 +605,39 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for enterprise members + * @description **Note**: This endpoint is in beta 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 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 response contains metrics for the prior 28 days. 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. + * + * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage + * metrics for the enterprise. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + */ + get: operations["copilot/usage-metrics-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/enterprises/{enterprise}/dependabot/alerts": { parameters: { query?: never; @@ -603,9 +648,12 @@ export interface paths { /** * List Dependabot alerts for an enterprise * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. - * To use this endpoint, you must be a member of the enterprise, and you must use an - * access token with the `repo` scope or `security_events` scope. + * + * The authenticated user must be a member of the enterprise to use this endpoint. + * * 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 the `repo` or `security_events` scope to use this endpoint. */ get: operations["dependabot/list-alerts-for-enterprise"]; put?: never; @@ -626,7 +674,12 @@ export interface paths { /** * List secret scanning alerts for an enterprise * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are 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). + * + * 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). + * + * 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 the `repo` scope or `security_events` scope to use this endpoint. */ get: operations["secret-scanning/list-alerts-for-enterprise"]; put?: never; @@ -666,16 +719,18 @@ export interface paths { }; /** * Get feeds - * @description GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: + * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * * * **Timeline**: The GitHub global public timeline - * * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * * **Current user public**: The public timeline for the authenticated user * * **Current user**: The private timeline for the authenticated user * * **Current user actor**: The private timeline for activity created by the authenticated user * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. * + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; @@ -762,7 +817,15 @@ export interface paths { path?: never; cookie?: never; }; - /** Get a gist */ + /** + * Get a gist + * @description Gets a specified gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ get: operations["gists/get"]; put?: never; post?: never; @@ -772,8 +835,16 @@ export interface paths { head?: never; /** * Update a gist - * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. + * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files + * from the previous version of the gist that aren't explicitly changed during an edit + * are unchanged. + * * At least one of `description` or `files` is required. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ patch: operations["gists/update"]; trace?: never; @@ -785,10 +856,26 @@ export interface paths { path?: never; cookie?: never; }; - /** List gist comments */ + /** + * List gist comments + * @description Lists the comments on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ get: operations["gists/list-comments"]; put?: never; - /** Create a gist comment */ + /** + * Create a gist comment + * @description Creates a comment on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ post: operations["gists/create-comment"]; delete?: never; options?: never; @@ -803,7 +890,15 @@ export interface paths { path?: never; cookie?: never; }; - /** Get a gist comment */ + /** + * Get a gist comment + * @description Gets a comment on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ get: operations["gists/get-comment"]; put?: never; post?: never; @@ -811,7 +906,15 @@ export interface paths { delete: operations["gists/delete-comment"]; options?: never; head?: never; - /** Update a gist comment */ + /** + * Update a gist comment + * @description Updates a comment on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ patch: operations["gists/update-comment"]; trace?: never; }; @@ -861,7 +964,7 @@ export interface paths { get: operations["gists/check-is-starred"]; /** * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["gists/star"]; post?: never; @@ -879,7 +982,15 @@ export interface paths { path?: never; cookie?: never; }; - /** Get a gist revision */ + /** + * Get a gist revision + * @description Gets a specified gist revision. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ get: operations["gists/get-revision"]; put?: never; post?: never; @@ -918,8 +1029,11 @@ export interface paths { }; /** * Get a gitignore template - * @description The API also allows fetching the source of a single template. - * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. + * @description Get the content of a gitignore template. + * + * 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 .gitignore contents. */ get: operations["gitignore/get-template"]; put?: never; @@ -940,8 +1054,6 @@ export interface paths { /** * List repositories accessible to the app installation * @description List repositories that an app installation can access. - * - * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ get: operations["apps/list-repos-accessible-to-installation"]; put?: never; @@ -967,8 +1079,6 @@ export interface paths { * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. - * - * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ delete: operations["apps/revoke-installation-access-token"]; options?: never; @@ -989,11 +1099,17 @@ export interface paths { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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"]; put?: never; @@ -1294,7 +1410,11 @@ export interface paths { get: operations["activity/get-thread"]; put?: never; post?: never; - delete?: never; + /** + * Mark a thread as done + * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications. + */ + delete: operations["activity/mark-thread-as-done"]; options?: never; head?: never; /** @@ -1367,7 +1487,7 @@ export interface paths { }; /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub. + * @description Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -1389,9 +1509,26 @@ export interface paths { }; /** * Get an organization - * @description To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * @description Gets information about an organization. + * + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * + * To see the full details about an organization, the authenticated user must be an organization owner. + * + * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." * - * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + * + * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. */ get: operations["orgs/get"]; put?: never; @@ -1413,7 +1550,22 @@ export interface paths { * Update an organization * @description **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. + * Updates the organization's profile and member privileges. + * + * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * + * The authenticated user must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ patch: operations["orgs/update"]; trace?: never; @@ -1429,7 +1581,8 @@ export interface paths { * Get GitHub Actions cache usage for an organization * @description Gets the total GitHub Actions cache usage for an organization. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-for-org"]; put?: never; @@ -1451,7 +1604,8 @@ export interface paths { * List repositories with GitHub Actions cache usage for an organization * @description Lists repositories and their GitHub Actions cache usage for an organization. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-by-repo-for-org"]; put?: never; @@ -1472,15 +1626,15 @@ export interface paths { /** * Get the customization template for an OIDC subject claim for an organization * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. - * GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["oidc/get-oidc-custom-sub-template-for-org"]; /** * Set the customization template for an OIDC subject claim for an organization * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `write:org` scope to use this endpoint. - * GitHub Apps must have the `admin:org` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ put: operations["oidc/update-oidc-custom-sub-template-for-org"]; post?: never; @@ -1501,14 +1655,14 @@ export interface paths { * Get GitHub Actions permissions for an organization * @description Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-github-actions-permissions-organization"]; /** * Set GitHub Actions permissions for an organization * @description Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-github-actions-permissions-organization"]; post?: never; @@ -1529,14 +1683,15 @@ export interface paths { * List selected repositories enabled for GitHub Actions in an organization * @description Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; /** * Set selected repositories enabled for GitHub Actions in an organization * @description Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; post?: never; @@ -1558,7 +1713,7 @@ export interface paths { * Enable a selected repository for GitHub Actions in an organization * @description Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/enable-selected-repository-github-actions-organization"]; post?: never; @@ -1566,7 +1721,7 @@ export interface paths { * Disable a selected repository for GitHub Actions in an organization * @description Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/disable-selected-repository-github-actions-organization"]; options?: never; @@ -1583,16 +1738,16 @@ export interface paths { }; /** * Get allowed actions and reusable workflows for an organization - * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-allowed-actions-organization"]; /** * Set allowed actions and reusable workflows for an organization * @description Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-allowed-actions-organization"]; post?: never; @@ -1615,7 +1770,7 @@ export interface paths { * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; /** @@ -1624,7 +1779,7 @@ export interface paths { * can submit approving pull request reviews. For more information, see * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; post?: never; @@ -1645,10 +1800,9 @@ export interface paths { * List self-hosted runners for an organization * @description Lists all self-hosted runners configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-self-hosted-runners-for-org"]; put?: never; @@ -1670,10 +1824,9 @@ export interface paths { * List runner applications for an organization * @description Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-runner-applications-for-org"]; put?: never; @@ -1697,10 +1850,9 @@ export interface paths { * Create configuration for a just-in-time runner for an organization * @description Generates a configuration that can be passed to the runner application at startup. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * The authenticated user must have admin access to the organization. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-org"]; delete?: never; @@ -1722,18 +1874,15 @@ export interface paths { * Create a registration token for an organization * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - * - * Example using registration token: - * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * * ``` * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` + * + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-registration-token-for-org"]; delete?: never; @@ -1755,19 +1904,15 @@ export interface paths { * Create a remove token for an organization * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - * - * Example using remove token: - * - * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this - * endpoint. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * * ``` * ./config.sh remove --token TOKEN * ``` + * + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-remove-token-for-org"]; delete?: never; @@ -1787,10 +1932,9 @@ export interface paths { * Get a self-hosted runner for an organization * @description Gets a specific self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/get-self-hosted-runner-for-org"]; put?: never; @@ -1799,10 +1943,9 @@ export interface paths { * Delete a self-hosted runner from an organization * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-from-org"]; options?: never; @@ -1821,10 +1964,9 @@ export interface paths { * List labels for a self-hosted runner for an organization * @description Lists all labels for a self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; /** @@ -1832,20 +1974,18 @@ export interface paths { * @description Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; /** * Add custom labels to a self-hosted runner for an organization - * @description Add custom labels to a self-hosted runner configured in an organization. + * @description Adds custom labels to a self-hosted runner configured in an organization. + * + * Authenticated users must have admin access to the organization to use this endpoint. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; /** @@ -1853,10 +1993,9 @@ export interface paths { * @description Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; options?: never; @@ -1882,10 +2021,9 @@ export interface paths { * This endpoint returns a `404 Not Found` status if the custom label is not * present on the runner. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; options?: never; @@ -1905,10 +2043,9 @@ export interface paths { * @description Lists all secrets available in an organization without revealing their * encrypted values. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-org-secrets"]; put?: never; @@ -1931,10 +2068,9 @@ export interface paths { * @description Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-public-key"]; put?: never; @@ -1956,10 +2092,9 @@ export interface paths { * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-secret"]; /** @@ -1967,10 +2102,9 @@ export interface paths { * @description Creates or updates an organization secret with an encrypted value. 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)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/create-or-update-org-secret"]; post?: never; @@ -1978,10 +2112,9 @@ export interface paths { * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-org-secret"]; options?: never; @@ -2001,10 +2134,9 @@ export interface paths { * @description Lists all repositories that have been selected when the `visibility` * for repository access to a secret is set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-selected-repos-for-org-secret"]; /** @@ -2013,10 +2145,9 @@ export interface paths { * for repository access is set to `selected`. The visibility is set when you [Create * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-selected-repos-for-org-secret"]; post?: never; @@ -2037,13 +2168,12 @@ export interface paths { /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or + * repository access is set to `selected`. For more information about setting the visibility, see [Create or * update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/add-selected-repo-to-org-secret"]; post?: never; @@ -2053,10 +2183,9 @@ export interface paths { * for repository access is set to `selected`. The visibility is set when you [Create * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-selected-repo-from-org-secret"]; options?: never; @@ -2074,7 +2203,10 @@ export interface paths { /** * List organization variables * @description Lists all organization variables. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-org-variables"]; put?: never; @@ -2082,10 +2214,9 @@ export interface paths { * Create an organization variable * @description Creates an organization variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-org-variable"]; delete?: never; @@ -2105,10 +2236,9 @@ export interface paths { * Get an organization variable * @description Gets a specific variable in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-variable"]; put?: never; @@ -2117,10 +2247,9 @@ export interface paths { * Delete an organization variable * @description Deletes an organization variable using the variable name. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-org-variable"]; options?: never; @@ -2129,10 +2258,9 @@ export interface paths { * Update an organization variable * @description Updates an organization variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ patch: operations["actions/update-org-variable"]; trace?: never; @@ -2149,10 +2277,9 @@ export interface paths { * @description Lists all repositories that can access an organization variable * that is available to selected repositories. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-selected-repos-for-org-variable"]; /** @@ -2161,11 +2288,9 @@ export interface paths { * to selected repositories. Organization variables that are available to selected * repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this - * endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-selected-repos-for-org-variable"]; post?: never; @@ -2188,10 +2313,9 @@ export interface paths { * @description Adds a repository to an organization variable that is available to selected repositories. * Organization variables that are available to selected repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/add-selected-repo-to-org-variable"]; post?: never; @@ -2201,10 +2325,9 @@ export interface paths { * available to selected repositories. Organization variables that are available to * selected repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-selected-repo-from-org-variable"]; options?: never; @@ -2271,9 +2394,9 @@ export interface paths { * List code scanning alerts for an organization * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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)." * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * For public repositories, you may instead use the `public_repo` scope. + * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope 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/list-alerts-for-org"]; put?: never; @@ -2295,7 +2418,7 @@ export interface paths { * List codespaces for the organization * @description Lists the codespaces associated to a specified organization. * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/list-in-organization"]; put?: never; @@ -2318,7 +2441,7 @@ export interface paths { * Manage access control for organization codespaces * @deprecated * @description Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/set-codespaces-access"]; post?: never; @@ -2345,7 +2468,7 @@ export interface paths { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["codespaces/set-codespaces-access-users"]; /** @@ -2356,7 +2479,7 @@ export interface paths { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/delete-codespaces-access-users"]; options?: never; @@ -2373,8 +2496,10 @@ export interface paths { }; /** * List organization secrets - * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Lists all Codespaces development environment secrets 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["codespaces/list-org-secrets"]; put?: never; @@ -2394,7 +2519,8 @@ export interface paths { }; /** * Get an organization public key - * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/get-org-public-key"]; put?: never; @@ -2415,7 +2541,8 @@ export interface paths { /** * Get an organization secret * @description Gets an organization development environment secret without revealing its encrypted value. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/get-org-secret"]; /** @@ -2423,14 +2550,15 @@ export interface paths { * @description Creates or updates an organization development environment secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/create-or-update-org-secret"]; post?: never; /** * Delete an organization secret - * @description Deletes an organization development environment secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Deletes an organization development environment secret using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/delete-org-secret"]; options?: never; @@ -2447,12 +2575,19 @@ export interface paths { }; /** * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Lists all repositories that have been selected when the `visibility` + * for repository access to a secret is set to `selected`. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Replaces all repositories for an organization development environment secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/set-selected-repos-for-org-secret"]; post?: never; @@ -2472,13 +2607,18 @@ export interface paths { get?: never; /** * Add selected repository to an organization secret - * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/add-selected-repo-to-org-secret"]; post?: never; /** * Remove selected repository from an organization secret - * @description Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Removes a repository from an organization development environment secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/remove-selected-repo-from-org-secret"]; options?: never; @@ -2494,15 +2634,16 @@ export interface paths { cookie?: never; }; /** - * Get Copilot Business seat information and settings for an organization + * Get Copilot seat information and settings for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets information about an organization's Copilot Business subscription, including seat breakdown + * Gets information about an organization's Copilot subscription, including seat breakdown * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * + * Only organization owners can configure and view details about the organization's Copilot Business subscription. * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/get-copilot-organization-details"]; put?: never; @@ -2521,13 +2662,14 @@ export interface paths { cookie?: never; }; /** - * List all Copilot Business seat assignments for an organization + * List all Copilot seat assignments for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/list-copilot-seats"]; put?: never; @@ -2548,33 +2690,35 @@ export interface paths { get?: never; put?: never; /** - * Add teams to the Copilot Business subscription for an organization + * Add teams to the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot Business seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + * Purchases a GitHub Copilot seat for all users within each specified team. + * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * + * Only organization owners can configure GitHub Copilot in their organization. * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * 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. + * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * - * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ - post: operations["copilot/add-copilot-for-business-seats-for-teams"]; + post: operations["copilot/add-copilot-seats-for-teams"]; /** - * Remove teams from the Copilot Business subscription for an organization + * Remove teams from the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot Business seat assignment for all members of each team specified. + * Cancels the Copilot seat assignment for all members of each team specified. * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can configure GitHub Copilot in their organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; options?: never; @@ -2592,33 +2736,35 @@ export interface paths { get?: never; put?: never; /** - * Add users to the Copilot Business subscription for an organization + * Add users to the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot Business seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + * Purchases a GitHub Copilot seat for each user specified. + * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * + * Only organization owners can configure GitHub Copilot in their organization. * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * 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. + * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * - * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ - post: operations["copilot/add-copilot-for-business-seats-for-users"]; + post: operations["copilot/add-copilot-seats-for-users"]; /** - * Remove users from the Copilot Business subscription for an organization + * Remove users from the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot Business seat assignment for each user specified. + * Cancels the Copilot seat assignment for each user specified. * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)" + * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can configure GitHub Copilot in their organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; options?: never; @@ -2626,6 +2772,39 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for organization members + * @description **Note**: This endpoint is in beta 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 + * across an organization, 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 the prior 28 days. 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. + * + * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view + * Copilot usage metrics. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + */ + get: operations["copilot/usage-metrics-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/dependabot/alerts": { parameters: { query?: never; @@ -2637,11 +2816,9 @@ export interface paths { * List Dependabot alerts for an organization * @description Lists Dependabot alerts for an organization. * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * For public repositories, you may instead use the `public_repo` scope. - * - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `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["dependabot/list-alerts-for-org"]; put?: never; @@ -2661,7 +2838,10 @@ export interface paths { }; /** * List organization secrets - * @description Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Lists all secrets available in an organization without revealing their + * encrypted values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/list-org-secrets"]; put?: never; @@ -2681,7 +2861,10 @@ export interface paths { }; /** * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/get-org-public-key"]; put?: never; @@ -2701,7 +2884,9 @@ export interface paths { }; /** * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Gets a single organization secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/get-org-secret"]; /** @@ -2709,15 +2894,15 @@ export interface paths { * @description Creates or updates an organization secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - * permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/create-or-update-org-secret"]; post?: never; /** * Delete an organization secret - * @description Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Deletes a secret in an organization using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["dependabot/delete-org-secret"]; options?: never; @@ -2734,12 +2919,19 @@ export interface paths { }; /** * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Lists all repositories that have been selected when the `visibility` + * for repository access to a secret is set to `selected`. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Replaces all repositories for an organization secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/set-selected-repos-for-org-secret"]; post?: never; @@ -2759,13 +2951,21 @@ export interface paths { get?: never; /** * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Adds a repository to an organization secret when the `visibility` for + * repository access is set to `selected`. The visibility is set when you [Create or + * update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/add-selected-repo-to-org-secret"]; post?: never; /** * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Removes a repository from an organization secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["dependabot/remove-selected-repo-from-org-secret"]; options?: never; @@ -2783,7 +2983,8 @@ export interface paths { /** * Get list of conflicting packages during Docker migration for organization * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; put?: never; @@ -2838,12 +3039,23 @@ export interface paths { path?: never; cookie?: never; }; - /** List organization webhooks */ + /** + * List organization webhooks + * @description You 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. + */ get: operations["orgs/list-webhooks"]; put?: never; /** * Create an organization webhook - * @description Here's how you can create a hook that posts payloads in JSON format: + * @description Create a hook that posts payloads in JSON format. + * + * You 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. */ post: operations["orgs/create-webhook"]; delete?: never; @@ -2861,18 +3073,39 @@ export interface paths { }; /** * Get an organization webhook - * @description Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)." + * @description Returns a webhook configured in an organization. To get only the webhook + * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + * + * You 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. */ get: operations["orgs/get-webhook"]; put?: never; post?: never; - /** Delete an organization webhook */ + /** + * Delete an organization webhook + * @description You 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. + */ delete: operations["orgs/delete-webhook"]; options?: never; head?: never; /** * Update an organization webhook - * @description Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)." + * @description Updates a webhook configured in an organization. When you update a webhook, + * the `secret` will be overwritten. If you previously had a `secret` set, you must + * provide the same `secret` or set a new `secret` or the secret will be removed. If + * you are only updating individual webhook `config` properties, use "[Update a webhook + * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". + * + * You 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. */ patch: operations["orgs/update-webhook"]; trace?: never; @@ -2888,7 +3121,10 @@ export interface paths { * Get a webhook configuration for an organization * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." * - * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + * You 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. */ get: operations["orgs/get-webhook-config-for-org"]; put?: never; @@ -2900,7 +3136,10 @@ export interface paths { * Update a webhook configuration for an organization * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." * - * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + * You 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. */ patch: operations["orgs/update-webhook-config-for-org"]; trace?: never; @@ -2915,6 +3154,11 @@ export interface paths { /** * List deliveries for an organization webhook * @description Returns a list of webhook deliveries for a webhook configured in an organization. + * + * You 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. */ get: operations["orgs/list-webhook-deliveries"]; put?: never; @@ -2935,6 +3179,11 @@ export interface paths { /** * Get a webhook delivery for an organization webhook * @description Returns a delivery for a webhook configured in an organization. + * + * You 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. */ get: operations["orgs/get-webhook-delivery"]; put?: never; @@ -2957,6 +3206,11 @@ export interface paths { /** * Redeliver a delivery for an organization webhook * @description Redeliver a delivery for a webhook configured in an organization. + * + * You 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. */ post: operations["orgs/redeliver-webhook-delivery"]; delete?: never; @@ -2976,7 +3230,13 @@ export interface paths { put?: never; /** * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) + * to be sent to the hook. + * + * You 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. */ post: operations["orgs/ping-webhook"]; delete?: never; @@ -3016,7 +3276,12 @@ export interface paths { }; /** * List app installations for an organization - * @description Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. + * @description Lists all GitHub Apps in an organization. The installation count includes + * all GitHub Apps installed on repositories in the organization. + * + * The authenticated user must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. */ get: operations["orgs/list-app-installations"]; put?: never; @@ -3139,6 +3404,13 @@ export interface paths { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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-for-org"]; put?: never; @@ -3204,7 +3476,7 @@ export interface paths { * List codespaces for a user in organization * @description Lists the codespaces that a member of an organization has for repositories in that organization. * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/get-codespaces-for-user-in-org"]; put?: never; @@ -3229,10 +3501,7 @@ export interface paths { * Delete a codespace from the organization * @description Deletes a user's codespace. * - * To use this endpoint you must authenticate using one of the following methods: - * - * - An access token with the `admin:org` scope - * - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/delete-from-organization"]; options?: never; @@ -3253,10 +3522,7 @@ export interface paths { * Stop a codespace for an organization user * @description Stops a user's codespace. * - * To use this endpoint you must authenticate using one of the following methods: - * - * - An access token with the `admin:org` scope - * - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["codespaces/stop-in-organization"]; delete?: never; @@ -3273,12 +3539,14 @@ export interface paths { cookie?: never; }; /** - * Get Copilot Business seat assignment details for a user + * Get Copilot seat assignment details for a user * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. * - * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Organization owners can view GitHub Copilot seat assignment details for members in their organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/get-copilot-seat-details-for-user"]; put?: never; @@ -3453,9 +3721,7 @@ export interface paths { }; /** * List organization fine-grained permissions for an organization - * @description **Note**: This operation is in beta and subject to change. - * - * Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." * @@ -3464,8 +3730,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-organization-fine-grained-permissions"]; put?: never; @@ -3485,33 +3750,27 @@ export interface paths { }; /** * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-roles"]; put?: never; /** * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - * - * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["orgs/create-custom-organization-role"]; delete?: never; @@ -3532,12 +3791,11 @@ export interface paths { post?: never; /** * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-all-org-roles-team"]; options?: never; @@ -3555,22 +3813,21 @@ export interface paths { get?: never; /** * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["orgs/assign-team-to-org-role"]; post?: never; /** * Remove an organization role from a team - * @description Removes an organization role from a team. + * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-org-role-team"]; options?: never; @@ -3590,12 +3847,11 @@ export interface paths { post?: never; /** * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-all-org-roles-user"]; options?: never; @@ -3613,22 +3869,21 @@ export interface paths { get?: never; /** * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * 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. */ put: operations["orgs/assign-user-to-org-role"]; post?: never; /** * Remove an organization role from a user - * @description Remove an organization role from a user. + * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-org-role-user"]; options?: never; @@ -3645,51 +3900,43 @@ export interface paths { }; /** * Get an organization role - * @description Gets an organization role that is available to this organization. + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/get-org-role"]; put?: never; post?: never; /** * Delete a custom organization role. - * @description Deletes a custom organization role. + * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - * - * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/delete-custom-organization-role"]; options?: never; head?: never; /** * Update a custom organization role - * @description Updates an existing custom organization role. Permission changes will apply to all assignees. + * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - * - * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["orgs/patch-custom-organization-role"]; trace?: never; @@ -3703,12 +3950,11 @@ export interface paths { }; /** * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read permission to use this endpoint. + * To use this endpoint, you must be an administrator for the organization. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-role-teams"]; put?: never; @@ -3728,12 +3974,11 @@ export interface paths { }; /** * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read permission to use this endpoint. + * To use this endpoint, you must be an administrator for the organization. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-role-users"]; put?: never; @@ -3799,7 +4044,7 @@ export interface paths { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; put?: never; @@ -3821,7 +4066,7 @@ export interface paths { * Get a package for an organization * @description Gets a specific package in an organization. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; put?: never; @@ -3830,9 +4075,9 @@ export interface paths { * Delete a package for an organization * @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; options?: never; @@ -3857,9 +4102,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; delete?: never; @@ -3879,7 +4124,7 @@ export interface paths { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; put?: never; @@ -3901,7 +4146,7 @@ export interface paths { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; put?: never; @@ -3910,9 +4155,9 @@ export interface paths { * Delete package version for an organization * @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; options?: never; @@ -3937,9 +4182,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; delete?: never; @@ -3957,19 +4202,17 @@ export interface paths { }; /** * List requests to access organization resources with fine-grained personal access tokens - * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: read` permission. + * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-requests"]; put?: never; /** * Review requests to access organization resources with fine-grained personal access tokens - * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: write` permission. + * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/review-pat-grant-requests-in-bulk"]; delete?: never; @@ -3989,10 +4232,9 @@ export interface paths { put?: never; /** * Review a request to access organization resources with a fine-grained personal access token - * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: write` permission. + * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/review-pat-grant-request"]; delete?: never; @@ -4010,10 +4252,9 @@ export interface paths { }; /** * List repositories requested to be accessed by a fine-grained personal access token - * @description Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: read` permission. + * @description Lists the repositories a fine-grained personal access token request is requesting access to. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-request-repositories"]; put?: never; @@ -4033,19 +4274,17 @@ export interface paths { }; /** * List fine-grained personal access tokens with access to organization resources - * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: read` permission. + * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grants"]; put?: never; /** * Update the access to organization resources via fine-grained personal access tokens - * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: write` permission. + * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/update-pat-accesses"]; delete?: never; @@ -4065,10 +4304,9 @@ export interface paths { put?: never; /** * Update the access a fine-grained personal access token has to organization resources - * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: write` permission. + * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/update-pat-access"]; delete?: never; @@ -4086,10 +4324,9 @@ export interface paths { }; /** * List repositories a fine-grained personal access token has access to - * @description Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: read` permission. + * @description Lists the repositories a fine-grained personal access token has access to. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-repositories"]; put?: never; @@ -4134,7 +4371,7 @@ export interface paths { /** * Get all custom properties for an organization * @description Gets all custom properties defined for an organization. - * You must be an organization owner to use this endpoint. + * Organization members can read these properties. */ get: operations["orgs/get-all-custom-properties"]; put?: never; @@ -4145,7 +4382,10 @@ export interface paths { /** * Create or update custom properties for an organization * @description Creates new or updates existing custom properties defined for an organization in a batch. - * Only organization owners (or users with the proper permissions granted by them) can update these properties + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ patch: operations["orgs/create-or-update-custom-properties"]; trace?: never; @@ -4160,20 +4400,26 @@ export interface paths { /** * Get a custom property for an organization * @description Gets a custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * Organization members can read these properties. */ get: operations["orgs/get-custom-property"]; /** * Create or update a custom property for an organization * @description Creates a new or updates an existing custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ put: operations["orgs/create-or-update-custom-property"]; post?: never; /** * Remove a custom property for an organization * @description Removes a custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ delete: operations["orgs/remove-custom-property"]; options?: never; @@ -4208,7 +4454,9 @@ export interface paths { * * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. * - * Only organization owners (or users with the proper permissions granted by them) can update these properties + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. */ patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; trace?: never; @@ -4249,7 +4497,7 @@ export interface paths { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["orgs/set-public-membership-for-authenticated-user"]; post?: never; @@ -4282,12 +4530,7 @@ export interface paths { * Create an organization repository * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-in-org"]; delete?: never; @@ -4400,10 +4643,10 @@ export interface paths { /** * List secret scanning alerts for an organization * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * 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 `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/list-alerts-for-org"]; put?: never; @@ -4425,7 +4668,9 @@ export interface paths { * List repository security advisories for an organization * @description Lists repository security advisories for an organization. * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ get: operations["security-advisories/list-org-repository-advisories"]; put?: never; @@ -4447,9 +4692,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)." * - * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["orgs/list-security-manager-teams"]; put?: never; @@ -4472,9 +4717,9 @@ export interface paths { * 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." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ put: operations["orgs/add-security-manager-team"]; post?: never; @@ -4482,9 +4727,9 @@ export interface paths { * 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." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/remove-security-manager-team"]; options?: never; @@ -4505,7 +4750,7 @@ export interface paths { * * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ get: operations["billing/get-github-actions-billing-org"]; put?: never; @@ -4529,7 +4774,7 @@ export interface paths { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ get: operations["billing/get-github-packages-billing-org"]; put?: never; @@ -4553,7 +4798,7 @@ export interface paths { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ get: operations["billing/get-shared-storage-billing-org"]; put?: never; @@ -4564,6 +4809,41 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/team/{team_slug}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for a team + * @description **Note**: This endpoint is in beta 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 a 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 the prior 28 days. 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 team had five or more members on that day. + * + * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, + * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + */ + get: operations["copilot/usage-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/teams": { parameters: { query?: never; @@ -4635,19 +4915,23 @@ export interface paths { }; /** * List discussions - * @description List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List all discussions on a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussions-in-org"]; put?: never; /** * Create a discussion - * @description Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Creates a new discussion post on a team's page. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-in-org"]; delete?: never; @@ -4665,27 +4949,33 @@ export interface paths { }; /** * Get a discussion - * @description Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Get a specific discussion on a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-in-org"]; put?: never; post?: never; /** * Delete a discussion - * @description Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Delete a discussion from a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-in-org"]; options?: never; head?: never; /** * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-in-org"]; trace?: never; @@ -4699,19 +4989,23 @@ export interface paths { }; /** * List discussion comments - * @description List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List all comments on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussion-comments-in-org"]; put?: never; /** * Create a discussion comment - * @description Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Creates a new comment on a team discussion. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-comment-in-org"]; delete?: never; @@ -4729,27 +5023,33 @@ export interface paths { }; /** * Get a discussion comment - * @description Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Get a specific comment on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-comment-in-org"]; put?: never; post?: never; /** * Delete a discussion comment - * @description Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Deletes a comment on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-comment-in-org"]; options?: never; head?: never; /** * Update a discussion comment - * @description Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Edits the body text of a discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-comment-in-org"]; trace?: never; @@ -4763,17 +5063,23 @@ export interface paths { }; /** * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-in-org"]; put?: never; /** * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-comment-in-org"]; delete?: never; @@ -4796,7 +5102,9 @@ export interface paths { * Delete team discussion comment reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["reactions/delete-for-team-discussion-comment"]; options?: never; @@ -4813,17 +5121,23 @@ export interface paths { }; /** * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-in-org"]; put?: never; /** * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-in-org"]; delete?: never; @@ -4846,7 +5160,9 @@ export interface paths { * Delete team discussion reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["reactions/delete-for-team-discussion"]; options?: never; @@ -5044,14 +5360,14 @@ export interface paths { * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * - * If the repository is private, you must have at least `read` permission for that repository and your token must have the `repo` scope. Otherwise, you will receive a `404 Not Found` response status. + * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions - * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * @@ -5104,14 +5420,11 @@ export interface paths { put?: never; /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. - * - * To use this endpoint, you must be an organization owner or be member of a team with the security manager role. - * A token with the 'write:org' scope is also required. + * @description Enables or disables the specified security feature for all eligible repositories in 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)." * - * GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * 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)." + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; delete?: never; @@ -5354,7 +5667,7 @@ export interface paths { * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." @@ -5392,10 +5705,12 @@ export interface paths { post?: never; /** * Delete a repository - * @description Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + * @description Deleting a repository requires admin access. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. + * + * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. */ delete: operations["repos/delete"]; options?: never; @@ -5416,7 +5731,11 @@ export interface paths { }; /** * List artifacts for a repository - * @description Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Lists all artifacts for a repository. + * + * 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. */ get: operations["actions/list-artifacts-for-repo"]; put?: never; @@ -5436,14 +5755,19 @@ export interface paths { }; /** * Get an artifact - * @description Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific artifact for a workflow run. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-artifact"]; put?: never; post?: never; /** * Delete an artifact - * @description Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * @description Deletes an artifact for a workflow run. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-artifact"]; options?: never; @@ -5463,8 +5787,7 @@ export interface paths { * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-artifact"]; put?: never; @@ -5486,7 +5809,10 @@ export interface paths { * Get GitHub Actions cache usage for a repository * @description Gets GitHub Actions cache usage for a repository. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage"]; put?: never; @@ -5507,8 +5833,8 @@ export interface paths { /** * List GitHub Actions caches for a repository * @description Lists the GitHub Actions caches for a repository. - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-list"]; put?: never; @@ -5517,9 +5843,7 @@ export interface paths { * Delete GitHub Actions caches for a repository (using a cache key) * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-actions-cache-by-key"]; options?: never; @@ -5541,9 +5865,7 @@ export interface paths { * Delete a GitHub Actions cache for a repository (using a cache ID) * @description Deletes a GitHub Actions cache for a repository, using a cache ID. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-actions-cache-by-id"]; options?: never; @@ -5560,7 +5882,11 @@ export interface paths { }; /** * Get a job for a workflow run - * @description Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific job in a workflow run. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-job-for-workflow-run"]; put?: never; @@ -5581,9 +5907,11 @@ export interface paths { /** * Download job logs for a workflow run * @description Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look - * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can - * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must - * have the `actions:read` permission to use this endpoint. + * for `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-job-logs-for-workflow-run"]; put?: never; @@ -5607,8 +5935,7 @@ export interface paths { * Re-run a job from a workflow run * @description Re-run a job and its dependent jobs in a workflow run. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-job-for-workflow-run"]; delete?: never; @@ -5627,15 +5954,15 @@ export interface paths { /** * Get the customization template for an OIDC subject claim for a repository * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-custom-oidc-sub-claim-for-repo"]; /** * Set the customization template for an OIDC subject claim for a repository * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-custom-oidc-sub-claim-for-repo"]; post?: never; @@ -5657,9 +5984,9 @@ export interface paths { * @description Lists all organization secrets shared with a repository without revealing their encrypted * values. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-organization-secrets"]; put?: never; @@ -5679,11 +6006,11 @@ export interface paths { }; /** * List repository organization variables - * @description Lists all organiation variables shared with a repository. + * @description Lists all organization variables shared with a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-organization-variables"]; put?: never; @@ -5705,14 +6032,14 @@ export interface paths { * Get GitHub Actions permissions for a repository * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-github-actions-permissions-repository"]; /** * Set GitHub Actions permissions for a repository * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-github-actions-permissions-repository"]; post?: never; @@ -5735,8 +6062,7 @@ export interface paths { * This endpoint only applies to private repositories. * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - * repository `administration` permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-workflow-access-to-repository"]; /** @@ -5745,8 +6071,7 @@ export interface paths { * This endpoint only applies to private repositories. * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - * repository `administration` permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-workflow-access-to-repository"]; post?: never; @@ -5767,14 +6092,14 @@ export interface paths { * Get allowed actions and reusable workflows for a repository * @description Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-allowed-actions-repository"]; /** * Set allowed actions and reusable workflows for a repository * @description Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-allowed-actions-repository"]; post?: never; @@ -5797,7 +6122,7 @@ export interface paths { * as well as if GitHub Actions can submit approving pull request reviews. * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-repository"]; /** @@ -5806,7 +6131,7 @@ export interface paths { * can submit approving pull request reviews. * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-repository"]; post?: never; @@ -5827,9 +6152,9 @@ export interface paths { * List self-hosted runners for a repository * @description Lists all self-hosted runners configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runners-for-repo"]; put?: never; @@ -5851,9 +6176,9 @@ export interface paths { * List runner applications for a repository * @description Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-runner-applications-for-repo"]; put?: never; @@ -5877,9 +6202,9 @@ export interface paths { * Create configuration for a just-in-time runner for a repository * @description Generates a configuration that can be passed to the runner application at startup. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * The authenticated user must have admin access to the repository. + * + * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-repo"]; delete?: never; @@ -5899,19 +6224,17 @@ export interface paths { put?: never; /** * Create a registration token for a repository - * @description Returns a token that you can pass to the `config` script. The token - * expires after one hour. + * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * Example using registration token: + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided - * by this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-registration-token-for-repo"]; delete?: never; @@ -5931,19 +6254,17 @@ export interface paths { put?: never; /** * Create a remove token for a repository - * @description Returns a token that you can pass to remove a self-hosted runner from - * a repository. The token expires after one hour. + * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * Example using remove token: + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * To remove your self-hosted runner from a repository, replace TOKEN with - * the remove token provided by this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * ```config.sh remove --token TOKEN``` + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-remove-token-for-repo"]; delete?: never; @@ -5963,9 +6284,9 @@ export interface paths { * Get a self-hosted runner for a repository * @description Gets a specific self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-self-hosted-runner-for-repo"]; put?: never; @@ -5974,9 +6295,9 @@ export interface paths { * Delete a self-hosted runner from a repository * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-from-repo"]; options?: never; @@ -5995,9 +6316,9 @@ export interface paths { * List labels for a self-hosted runner for a repository * @description Lists all labels for a self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; /** @@ -6005,18 +6326,18 @@ export interface paths { * @description Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; /** * Add custom labels to a self-hosted runner for a repository - * @description Add custom labels to a self-hosted runner configured in a repository. + * @description Adds custom labels to a self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; /** @@ -6024,9 +6345,9 @@ export interface paths { * @description Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; options?: never; @@ -6052,9 +6373,9 @@ export interface paths { * This endpoint returns a `404 Not Found` status if the custom label is not * present on the runner. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; options?: never; @@ -6071,9 +6392,13 @@ export interface paths { }; /** * List workflow runs for a repository - * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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 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`. */ get: operations["actions/list-workflow-runs-for-repo"]; put?: never; @@ -6093,16 +6418,22 @@ export interface paths { }; /** * Get a workflow run - * @description Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific workflow run. + * + * 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. */ get: operations["actions/get-workflow-run"]; put?: never; post?: never; /** * Delete a workflow run - * @description Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is - * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use - * this endpoint. + * @description Deletes a specific workflow run. + * + * Anyone with write access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-workflow-run"]; options?: never; @@ -6119,7 +6450,9 @@ export interface paths { }; /** * Get the review history for a workflow run - * @description Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description 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. */ get: operations["actions/get-reviews-for-run"]; put?: never; @@ -6143,7 +6476,7 @@ export interface paths { * Approve a workflow run for a fork pull request * @description Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/approve-workflow-run"]; delete?: never; @@ -6161,7 +6494,11 @@ export interface paths { }; /** * List workflow run artifacts - * @description Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Lists artifacts for a workflow run. + * + * 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. */ get: operations["actions/list-workflow-run-artifacts"]; put?: never; @@ -6181,10 +6518,11 @@ export interface paths { }; /** * Get a workflow run attempt - * @description Gets a specific workflow run attempt. Anyone with read access to the repository - * can use this endpoint. If the repository is private you must use an access token - * with the `repo` scope. GitHub Apps must have the `actions:read` permission to - * use this endpoint. + * @description Gets a specific workflow run attempt. + * + * 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. */ get: operations["actions/get-workflow-run-attempt"]; put?: never; @@ -6204,7 +6542,12 @@ export interface paths { }; /** * List jobs for a workflow run attempt - * @description Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information + * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + * + * 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. */ get: operations["actions/list-jobs-for-workflow-run-attempt"]; put?: never; @@ -6225,9 +6568,11 @@ export interface paths { /** * Download workflow run attempt logs * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to - * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * 1 minute. Look for `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-workflow-run-attempt-logs"]; put?: never; @@ -6251,8 +6596,7 @@ export interface paths { * Cancel a workflow run * @description Cancels a workflow run using its `id`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/cancel-workflow-run"]; delete?: never; @@ -6277,8 +6621,7 @@ export interface paths { * **Note:** GitHub Apps can only review their own custom deployment protection rules. * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have read and write permission for **Deployments** to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ post: operations["actions/review-custom-gates-for-run"]; delete?: never; @@ -6301,8 +6644,7 @@ export interface paths { * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/force-cancel-workflow-run"]; delete?: never; @@ -6320,7 +6662,12 @@ export interface paths { }; /** * List jobs for a workflow run - * @description Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information + * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + * + * 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. */ get: operations["actions/list-jobs-for-workflow-run"]; put?: never; @@ -6341,16 +6688,20 @@ export interface paths { /** * Download workflow run logs * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use - * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have - * the `actions:read` permission to use this endpoint. + * `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-workflow-run-logs"]; put?: never; post?: never; /** * Delete workflow run logs - * @description Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * @description Deletes all logs for a workflow run. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-workflow-run-logs"]; options?: never; @@ -6369,7 +6720,9 @@ export interface paths { * Get pending deployments for a workflow run * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-pending-deployments-for-run"]; put?: never; @@ -6377,7 +6730,9 @@ export interface paths { * Review pending deployments for a workflow run * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint. + * Required reviewers with read access to the repository contents and deployments can use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/review-pending-deployments-for-run"]; delete?: never; @@ -6397,7 +6752,9 @@ export interface paths { put?: never; /** * Re-run a workflow - * @description Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * @description Re-runs your workflow run using its `id`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-workflow"]; delete?: never; @@ -6417,7 +6774,9 @@ export interface paths { put?: never; /** * Re-run failed jobs from a workflow run - * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. + * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-workflow-failed-jobs"]; delete?: never; @@ -6437,7 +6796,9 @@ export interface paths { * Get workflow run usage * @description Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ get: operations["actions/get-workflow-run-usage"]; put?: never; @@ -6460,9 +6821,9 @@ export interface paths { * @description Lists all secrets available in a repository without revealing their encrypted * values. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-secrets"]; put?: never; @@ -6486,9 +6847,8 @@ export interface paths { * encrypt a secret before you can create or update secrets. * * Anyone with read access to the repository can use this endpoint. - * If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-public-key"]; put?: never; @@ -6510,9 +6870,9 @@ export interface paths { * Get a repository secret * @description Gets a single repository secret without revealing its encrypted value. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-secret"]; /** @@ -6520,9 +6880,9 @@ export interface paths { * @description Creates or updates a repository secret with an encrypted value. 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)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/create-or-update-repo-secret"]; post?: never; @@ -6530,9 +6890,9 @@ export interface paths { * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-repo-secret"]; options?: never; @@ -6550,9 +6910,10 @@ export interface paths { /** * List repository variables * @description Lists all repository variables. - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + * * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-variables"]; put?: never; @@ -6560,9 +6921,9 @@ export interface paths { * Create a repository variable * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-repo-variable"]; delete?: never; @@ -6582,9 +6943,9 @@ export interface paths { * Get a repository variable * @description Gets a specific variable in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-variable"]; put?: never; @@ -6593,9 +6954,9 @@ export interface paths { * Delete a repository variable * @description Deletes a repository variable using the variable name. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-repo-variable"]; options?: never; @@ -6604,9 +6965,9 @@ export interface paths { * Update a repository variable * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/update-repo-variable"]; trace?: never; @@ -6620,7 +6981,11 @@ export interface paths { }; /** * List repository workflows - * @description Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Lists the workflows in a repository. + * + * 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. */ get: operations["actions/list-repo-workflows"]; put?: never; @@ -6640,7 +7005,12 @@ export interface paths { }; /** * Get a workflow - * @description Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific workflow. You can replace `workflow_id` with the workflow + * file name. For example, you could use `main.yaml`. + * + * 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. */ get: operations["actions/get-workflow"]; put?: never; @@ -6663,7 +7033,7 @@ export interface paths { * Disable a workflow * @description Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/disable-workflow"]; post?: never; @@ -6688,7 +7058,7 @@ export interface paths { * * You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-workflow-dispatch"]; delete?: never; @@ -6709,7 +7079,7 @@ export interface paths { * Enable a workflow * @description Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/enable-workflow"]; post?: never; @@ -6728,9 +7098,11 @@ export interface paths { }; /** * List workflow runs for a workflow - * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + * 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. */ get: operations["actions/list-workflow-runs"]; put?: never; @@ -6752,7 +7124,11 @@ export interface paths { * Get workflow usage * @description Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * 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. */ get: operations["actions/get-workflow-usage"]; put?: never; @@ -6838,8 +7214,8 @@ export interface paths { cookie?: never; }; /** - * List all autolinks of a repository - * @description This returns a list of autolinks configured for the given repository. + * Get all autolinks of a repository + * @description Gets all autolinks that are configured for a repository. * * Information about autolinks are only available to repository administrators. */ @@ -7183,28 +7559,28 @@ export interface paths { * Get apps with access to the protected branch * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * Set app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ put: operations["repos/set-app-access-restrictions"]; /** * Add app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ post: operations["repos/add-app-access-restrictions"]; /** * Remove app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ delete: operations["repos/remove-app-access-restrictions"]; options?: never; @@ -7319,17 +7695,9 @@ export interface paths { * * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". * - * The permissions required to use this endpoint depends on whether you are renaming the default branch. - * - * To rename a non-default branch: - * - * * Users must have push access. - * * GitHub Apps must have the `contents:write` repository permission. + * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * - * To rename the default branch: - * - * * Users must have admin or owner permissions. - * * GitHub Apps must have the `administration:write` repository permission. + * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. */ post: operations["repos/rename-branch"]; delete?: never; @@ -7349,11 +7717,13 @@ export interface paths { put?: never; /** * Create a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Creates a new check run for a specific commit in a repository. * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + * + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ post: operations["checks/create"]; delete?: never; @@ -7371,9 +7741,11 @@ export interface paths { }; /** * Get a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Gets a single check run using its `id`. * - * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/get"]; put?: never; @@ -7383,9 +7755,11 @@ export interface paths { head?: never; /** * Update a check run - * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * @description Updates a check run for a specific commit in a repository. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ patch: operations["checks/update"]; trace?: never; @@ -7399,7 +7773,9 @@ export interface paths { }; /** * List check run annotations - * @description Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. + * @description Lists annotations for a check run using the annotation `id`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-annotations"]; put?: never; @@ -7423,9 +7799,9 @@ export interface paths { * Rerequest a check run * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. - * * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-run"]; delete?: never; @@ -7445,9 +7821,11 @@ export interface paths { put?: never; /** * Create a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/create-suite"]; delete?: never; @@ -7471,7 +7849,8 @@ export interface paths { head?: never; /** * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. + * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). + * You must have admin permissions in the repository to set preferences for check suites. */ patch: operations["checks/set-suites-preferences"]; trace?: never; @@ -7485,9 +7864,11 @@ export interface paths { }; /** * Get a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Gets a single check suite using its `id`. + * + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/get-suite"]; put?: never; @@ -7507,9 +7888,11 @@ export interface paths { }; /** * List check runs in a check suite - * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * @description Lists check runs for a check suite using its `id`. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-for-suite"]; put?: never; @@ -7533,7 +7916,7 @@ export interface paths { * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-suite"]; delete?: never; @@ -7553,11 +7936,11 @@ export interface paths { * List code scanning alerts for a repository * @description Lists code scanning alerts. * - * To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. - * * The response includes a `most_recent_instance` object. * This provides details of the most recent instance of this alert * for the default branch (or for the specified Git reference if you used `ref` in the request). + * + * 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/list-alerts-for-repo"]; put?: never; @@ -7577,7 +7960,9 @@ export interface paths { }; /** * Get a code scanning alert - * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. + * @description Gets a single 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-alert"]; put?: never; @@ -7587,7 +7972,8 @@ export interface paths { head?: never; /** * Update a code scanning alert - * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. + * @description Updates the status of a single 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. */ patch: operations["code-scanning/update-alert"]; trace?: never; @@ -7602,8 +7988,8 @@ export interface paths { /** * List instances of a code scanning alert * @description Lists all instances of the specified code scanning alert. - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. + * + * 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/list-alert-instances"]; put?: never; @@ -7634,11 +8020,10 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. - * * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * + * 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/list-recent-analyses"]; put?: never; @@ -7659,8 +8044,6 @@ export interface paths { /** * Get a code scanning analysis for a repository * @description Gets a specified code scanning analysis for a repository. - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. * * The default JSON response contains fields that describe the analysis. * This includes the Git reference and commit SHA to which the analysis relates, @@ -7672,20 +8055,18 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * If you use the Accept header `application/sarif+json`, - * the response contains the analysis data that was uploaded. - * This is formatted as - * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + * 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/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + * + * 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-analysis"]; put?: never; post?: never; /** * Delete a code scanning analysis from a repository - * @description Deletes a specified code scanning analysis from a repository. For - * private repositories, you must use an access token with the `repo` scope. For public repositories, - * you must use an access token with `public_repo` scope. - * GitHub Apps must have the `security_events` write permission to use this endpoint. + * @description Deletes a specified code scanning analysis from a repository. * * You can delete one analysis at a time. * To delete a series of analyses, start with the most recent analysis and work backwards. @@ -7747,6 +8128,8 @@ export interface paths { * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + * + * 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. */ delete: operations["code-scanning/delete-analysis"]; options?: never; @@ -7765,8 +8148,7 @@ export interface paths { * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * For private repositories, you must use an access token with the `security_events` scope. - * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + * 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/list-codeql-databases"]; put?: never; @@ -7794,8 +8176,7 @@ export interface paths { * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * For private repositories, you must use an access token with the `security_events` scope. - * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + * 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-codeql-database"]; put?: never; @@ -7816,8 +8197,8 @@ export interface paths { /** * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. - * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. + * + * 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. */ get: operations["code-scanning/get-default-setup"]; put?: never; @@ -7828,8 +8209,8 @@ export interface paths { /** * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. - * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. + * + * 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. */ patch: operations["code-scanning/update-default-setup"]; trace?: never; @@ -7845,7 +8226,7 @@ export interface paths { put?: never; /** * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." + * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -7856,7 +8237,7 @@ export interface paths { * ``` * gzip -c analysis-data.sarif | base64 -w0 * ``` - *
+ * * SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * @@ -7875,6 +8256,8 @@ export interface paths { * The `202 Accepted` response includes an `id` value. * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." + * + * 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/upload-sarif"]; delete?: never; @@ -7892,7 +8275,8 @@ export interface paths { }; /** * Get information about a SARIF upload - * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. + * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." + * 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-sarif"]; put?: never; @@ -7938,9 +8322,7 @@ export interface paths { * List codespaces in a repository for the authenticated user * @description Lists the codespaces associated to a specified repository and the authenticated user. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/list-in-repository-for-authenticated-user"]; put?: never; @@ -7948,9 +8330,7 @@ export interface paths { * Create a codespace in a repository * @description Creates a codespace owned by the authenticated user in the specified repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/create-with-repo-for-authenticated-user"]; delete?: never; @@ -7971,9 +8351,7 @@ export interface paths { * @description Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files * specify launchpoint configurations for codespaces created within the repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/list-devcontainers-in-repository-for-authenticated-user"]; put?: never; @@ -7995,9 +8373,7 @@ export interface paths { * List available machine types for a repository * @description List the machine types available for a given repository based on its configuration. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/repo-machines-for-authenticated-user"]; put?: never; @@ -8019,9 +8395,7 @@ export interface paths { * Get default attributes for a codespace * @description Gets the default attributes for codespaces created by the user with the repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"]; put?: never; @@ -8043,9 +8417,7 @@ export interface paths { * Check if permissions defined by a devcontainer have been accepted by the authenticated user * @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/check-permissions-for-devcontainer"]; put?: never; @@ -8065,7 +8437,10 @@ export interface paths { }; /** * List repository secrets - * @description Lists all development environment secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Lists all development environment secrets available in a repository without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/list-repo-secrets"]; put?: never; @@ -8085,7 +8460,12 @@ export interface paths { }; /** * Get a repository public key - * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/get-repo-public-key"]; put?: never; @@ -8105,7 +8485,9 @@ export interface paths { }; /** * Get a repository secret - * @description Gets a single repository development environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Gets a single repository development environment secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/get-repo-secret"]; /** @@ -8113,15 +8495,15 @@ export interface paths { * @description Creates or updates a repository development environment secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - * repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["codespaces/create-or-update-repo-secret"]; post?: never; /** * Delete a repository secret - * @description Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Deletes a development environment secret in a repository using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["codespaces/delete-repo-secret"]; options?: never; @@ -8143,9 +8525,9 @@ export interface paths { * * Team members will include the members of child teams. * - * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - * endpoint. + * The authenticated user must have push access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/list-collaborators"]; put?: never; @@ -8169,9 +8551,9 @@ export interface paths { * * Team members will include the members of child teams. * - * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - * endpoint. + * The authenticated user must have push access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/check-collaborator"]; /** @@ -8186,7 +8568,7 @@ export interface paths { * Cannot assign {member} permission of {role name} * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * @@ -8265,9 +8647,14 @@ export interface paths { }; /** * List commit comments for a repository - * @description Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. + * + * 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)." * - * Comments are ordered by ascending ID. + * - **`application/vnd.github-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-commit-comments-for-repo"]; put?: never; @@ -8285,7 +8672,17 @@ export interface paths { path?: never; cookie?: never; }; - /** Get a commit comment */ + /** + * Get a commit comment + * @description Gets a specified commit comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ get: operations["repos/get-commit-comment"]; put?: never; post?: never; @@ -8293,7 +8690,17 @@ export interface paths { delete: operations["repos/delete-commit-comment"]; options?: never; head?: never; - /** Update a commit comment */ + /** + * Update a commit comment + * @description Updates the contents of a specified commit comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ patch: operations["repos/update-commit-comment"]; trace?: never; }; @@ -8421,7 +8828,14 @@ export interface paths { }; /** * List commit comments - * @description Use the `:commit_sha` to specify the commit that will have its comments listed. + * @description Lists the comments for a specified commit. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-comments-for-commit"]; put?: never; @@ -8430,6 +8844,13 @@ export interface paths { * @description Create a comment for a commit using its `:commit_sha`. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["repos/create-commit-comment"]; delete?: never; @@ -8471,11 +8892,13 @@ export interface paths { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property. + * 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)." Pagination query parameters are not supported for these media types. * - * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. * * **Signature verification object** * @@ -8524,11 +8947,13 @@ export interface paths { }; /** * List check runs for a Git reference - * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-for-ref"]; put?: never; @@ -8548,9 +8973,11 @@ export interface paths { }; /** * List check suites for a Git reference - * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-suites-for-ref"]; put?: never; @@ -8649,9 +9076,14 @@ export interface paths { }; /** * Compare two commits - * @description Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * + * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. + * + * 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)." * - * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. * * The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. * @@ -8713,50 +9145,40 @@ export interface paths { }; /** * Get repository content - * @description Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit - * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. + * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. + * + * 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 file contents for files and symlinks. + * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + * + * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". * - * Files and symlinks support [a custom media type](https://docs.github.com/rest/overview/media-types) for - * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media - * type](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent - * object format. + * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + * + * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. * * **Notes**: - * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). - * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees - * API](https://docs.github.com/rest/git/trees#get-a-tree). - * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * Size limits: - * If the requested file's size is: - * * 1 MB or smaller: All features of this endpoint are supported. - * * Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * * Greater than 100 MB: This endpoint is not supported. - * - * If the content is a directory: - * The response will be an array of objects, one object for each item in the directory. - * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value - * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). - * In the next major version of the API, the type will be returned as "submodule". - * - * If the content is a symlink: - * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the - * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object - * describing the symlink itself. - * - * If the content is a submodule: - * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific - * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out - * the submodule at that specific commit. - * - * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the - * github.com URLs (`html_url` and `_links["html"]`) will have null values. + * + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). + * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve + * more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). + * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + * - If the requested file's size is: + * - 1 MB or smaller: All features of this endpoint are supported. + * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + * - Greater than 100 MB: This endpoint is not supported. */ get: operations["repos/get-content"]; /** * Create or update file contents - * @description Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. + * @description Creates a new file or replaces an existing file in a repository. * * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ put: operations["repos/create-or-update-file-contents"]; post?: never; @@ -8809,9 +9231,7 @@ export interface paths { }; /** * List Dependabot alerts for a repository - * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * @description OAuth app tokens and personal access tokens (classic) need the `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["dependabot/list-alerts-for-repo"]; put?: never; @@ -8831,9 +9251,7 @@ export interface paths { }; /** * Get a Dependabot alert - * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * @description OAuth app tokens and personal access tokens (classic) need the `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["dependabot/get-alert"]; put?: never; @@ -8843,11 +9261,9 @@ export interface paths { head?: never; /** * Update a Dependabot alert - * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** write permission to use this endpoint. + * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * - * To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + * OAuth app tokens and personal access tokens (classic) need the `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. */ patch: operations["dependabot/update-alert"]; trace?: never; @@ -8861,7 +9277,10 @@ export interface paths { }; /** * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Lists all secrets available in a repository without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["dependabot/list-repo-secrets"]; put?: never; @@ -8881,7 +9300,11 @@ export interface paths { }; /** * Get a repository public key - * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. 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 if the repository is private. */ get: operations["dependabot/get-repo-public-key"]; put?: never; @@ -8901,7 +9324,9 @@ export interface paths { }; /** * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Gets a single repository secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["dependabot/get-repo-secret"]; /** @@ -8909,15 +9334,15 @@ export interface paths { * @description Creates or updates a repository secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository - * permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["dependabot/create-or-update-repo-secret"]; post?: never; /** * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Deletes a secret in a repository using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["dependabot/delete-repo-secret"]; options?: never; @@ -8976,7 +9401,11 @@ export interface paths { put?: never; /** * Create a snapshot of dependencies for a repository - * @description Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to. + * @description Create a new snapshot of a repository's dependencies. + * + * The authenticated user must have access to the repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["dependency-graph/create-repository-snapshot"]; delete?: never; @@ -9026,8 +9455,6 @@ export interface paths { * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an * application with debugging enabled. * - * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. - * * Merged branch response: * * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating @@ -9048,6 +9475,8 @@ export interface paths { * * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ post: operations["repos/create-deployment"]; delete?: never; @@ -9069,7 +9498,7 @@ export interface paths { post?: never; /** * Delete a deployment - * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. + * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. * * To set a deployment as inactive, you must: * @@ -9077,6 +9506,8 @@ export interface paths { * * Mark the active deployment as inactive by adding any non-successful deployment status. * * For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ delete: operations["repos/delete-deployment"]; options?: never; @@ -9101,7 +9532,7 @@ export interface paths { * Create a deployment status * @description Users with `push` access can create deployment statuses for a given deployment. * - * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. */ post: operations["repos/create-deployment-status"]; delete?: never; @@ -9145,12 +9576,9 @@ export interface paths { * * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * - * This endpoint requires write access to the repository by providing either: - * - * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. - * * This input example shows how you can use the `client_payload` as a test to debug your workflow. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-dispatch-event"]; delete?: never; @@ -9170,7 +9598,9 @@ export interface paths { * List environments * @description Lists the environments for a repository. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ get: operations["repos/get-all-environments"]; put?: never; @@ -9192,9 +9622,9 @@ export interface paths { * Get an environment * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * - * Anyone with read access to the repository can use this endpoint. If the - * repository is private, you must use an access token with the `repo` scope. GitHub - * Apps must have the `actions:read` permission to use this endpoint. + * 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. */ get: operations["repos/get-environment"]; /** @@ -9205,13 +9635,13 @@ export interface paths { * * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/create-or-update-environment"]; post?: never; /** * Delete an environment - * @description You must authenticate using an access token with the repo scope to use this endpoint. + * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-an-environment"]; options?: never; @@ -9230,7 +9660,9 @@ export interface paths { * List deployment branch policies * @description Lists the deployment branch policies for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ get: operations["repos/list-deployment-branch-policies"]; put?: never; @@ -9238,7 +9670,7 @@ export interface paths { * Create a deployment branch policy * @description Creates a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-deployment-branch-policy"]; delete?: never; @@ -9258,14 +9690,16 @@ export interface paths { * Get a deployment branch policy * @description Gets a deployment branch or tag policy for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy * @description Updates a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/update-deployment-branch-policy"]; post?: never; @@ -9273,7 +9707,7 @@ export interface paths { * Delete a deployment branch policy * @description Deletes a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-deployment-branch-policy"]; options?: never; @@ -9290,9 +9724,11 @@ export interface paths { }; /** * Get all deployment protection rules for an environment - * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-all-deployment-protection-rules"]; put?: never; @@ -9300,9 +9736,11 @@ export interface paths { * Create a custom deployment protection rule on an environment * @description Enable a custom deployment protection rule for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-deployment-protection-rule"]; delete?: never; @@ -9320,11 +9758,13 @@ export interface paths { }; /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-custom-deployment-rule-integrations"]; put?: never; @@ -9344,9 +9784,11 @@ export interface paths { }; /** * Get a custom deployment protection rule - * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-custom-deployment-protection-rule"]; put?: never; @@ -9355,7 +9797,9 @@ export interface paths { * Disable a custom protection rule for an environment * @description Disables a custom deployment protection rule for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)". + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/disable-deployment-protection-rule"]; options?: never; @@ -9363,6 +9807,169 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-secret"]; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. 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)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/create-or-update-environment-secret"]; + post?: never; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-variables"]; + put?: never; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["actions/create-environment-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-variable"]; + put?: never; + post?: never; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-variable"]; + options?: never; + head?: never; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + patch: operations["actions/update-environment-variable"]; + trace?: never; + }; "/repos/{owner}/{repo}/events": { parameters: { query?: never; @@ -9437,7 +10044,12 @@ export interface paths { * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * _Note_: This API supports blobs up to 100 megabytes in size. + * 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 blob data. + * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + * + * **Note** This endpoint supports blobs up to 100 megabytes in size. */ get: operations["git/get-blob"]; put?: never; @@ -9626,11 +10238,17 @@ export interface paths { get?: never; put?: never; post?: never; - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ delete: operations["git/delete-ref"]; options?: never; head?: never; - /** Update a reference */ + /** + * Update a reference + * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + */ patch: operations["git/update-ref"]; trace?: never; }; @@ -9840,7 +10458,7 @@ export interface paths { * Get a webhook configuration for a repository * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * - * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. */ get: operations["repos/get-webhook-config-for-repo"]; put?: never; @@ -9852,7 +10470,7 @@ export interface paths { * Update a webhook configuration for a repository * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * - * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. */ patch: operations["repos/update-webhook-config-for-repo"]; trace?: never; @@ -10250,6 +10868,13 @@ export interface paths { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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-for-repo"]; put?: never; @@ -10259,6 +10884,13 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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/create"]; delete?: never; @@ -10279,6 +10911,13 @@ export interface paths { * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. * * By default, issue comments are ordered by ascending ID. + * + * 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-comments-for-repo"]; put?: never; @@ -10299,6 +10938,13 @@ export interface paths { /** * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + * + * 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/get-comment"]; put?: never; @@ -10313,6 +10959,13 @@ export interface paths { /** * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + * + * 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`. */ patch: operations["issues/update-comment"]; trace?: never; @@ -10412,7 +11065,7 @@ export interface paths { }; /** * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was + * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read @@ -10423,6 +11076,13 @@ export interface paths { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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/get"]; put?: never; @@ -10433,6 +11093,13 @@ export interface paths { /** * Update an issue * @description Issue owners and users with push access can edit 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`. */ patch: operations["issues/update"]; trace?: never; @@ -10497,18 +11164,31 @@ export interface paths { * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * * Issue comments are ordered by ascending ID. + * + * 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-comments"]; put?: never; /** * Create an issue comment - * @description - * You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). * 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/overview/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/create-comment"]; delete?: never; @@ -10601,7 +11281,7 @@ export interface paths { * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["issues/lock"]; post?: never; @@ -10806,7 +11486,10 @@ export interface paths { * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. + * 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 contents of the license. + * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["licenses/get-for-repo"]; put?: never; @@ -10958,28 +11641,34 @@ export interface paths { * Get a GitHub Pages site * @description Gets information about a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages"]; /** * Update information about a GitHub Pages site * @description Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/update-information-about-pages-site"]; /** * Create a GitHub Pages site * @description Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-pages-site"]; /** * Delete a GitHub Pages site * @description Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-pages-site"]; options?: never; @@ -10998,7 +11687,7 @@ export interface paths { * List GitHub Pages builds * @description Lists builts of a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/list-pages-builds"]; put?: never; @@ -11026,7 +11715,7 @@ export interface paths { * Get latest Pages build * @description Gets information about the single most recent build of a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-latest-pages-build"]; put?: never; @@ -11048,7 +11737,7 @@ export interface paths { * Get GitHub Pages build * @description Gets information about a GitHub Pages build. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages-build"]; put?: never; @@ -11059,7 +11748,7 @@ export interface paths { patch?: never; trace?: never; }; - "/repos/{owner}/{repo}/pages/deployment": { + "/repos/{owner}/{repo}/pages/deployments": { parameters: { query?: never; header?: never; @@ -11072,7 +11761,7 @@ export interface paths { * Create a GitHub Pages deployment * @description Create a GitHub Pages deployment for a repository. * - * Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint. + * The authenticated user must have write permission to the repository. */ post: operations["repos/create-pages-deployment"]; delete?: never; @@ -11081,6 +11770,50 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the status of a GitHub Pages deployment + * @description Gets the current status of a GitHub Pages deployment. + * + * The authenticated user must have read permission for the GitHub Pages site. + */ + get: operations["repos/get-pages-deployment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Cancel a GitHub Pages deployment + * @description Cancels a GitHub Pages deployment. + * + * The authenticated user must have write permissions for the GitHub Pages site. + */ + post: operations["repos/cancel-pages-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/pages/health": { parameters: { query?: never; @@ -11094,7 +11827,9 @@ export interface paths { * * The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages-health-check"]; put?: never; @@ -11112,7 +11847,11 @@ export interface paths { path?: never; cookie?: never; }; - get?: never; + /** + * Check if private vulnerability reporting is enabled for a repository + * @description Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + */ + get: operations["repos/check-private-vulnerability-reporting"]; /** * Enable private vulnerability reporting for a repository * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." @@ -11171,7 +11910,14 @@ export interface paths { delete?: never; options?: never; head?: never; - patch?: never; + /** + * Create or update custom property values for a repository + * @description Create new or update existing custom property values for a repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + */ + patch: operations["repos/create-or-update-custom-properties-values"]; trace?: never; }; "/repos/{owner}/{repo}/pulls": { @@ -11183,7 +11929,20 @@ export interface paths { }; /** * List pull requests - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Lists pull requests in a specified repository. + * + * Draft pull requests are available in public repositories with GitHub + * Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing + * plans, and in public and private repositories with GitHub Team and GitHub Enterprise + * Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) + * in the GitHub Help documentation. + * + * 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["pulls/list"]; put?: never; @@ -11194,6 +11953,13 @@ export interface paths { * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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["pulls/create"]; delete?: never; @@ -11211,7 +11977,15 @@ export interface paths { }; /** * List review comments in a repository - * @description Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. + * @description Lists review comments for all pull requests in a repository. By default, + * review comments are in ascending order by ID. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments-for-repo"]; put?: never; @@ -11231,7 +12005,14 @@ export interface paths { }; /** * Get a review comment for a pull request - * @description Provides details for a review comment. + * @description Provides details for a specified review comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review-comment"]; put?: never; @@ -11245,7 +12026,14 @@ export interface paths { head?: never; /** * Update a review comment for a pull request - * @description Enables you to edit a review comment. + * @description Edits the content of a specified review comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["pulls/update-review-comment"]; trace?: never; @@ -11320,6 +12108,14 @@ export interface paths { * * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * + * 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`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ get: operations["pulls/get"]; put?: never; @@ -11332,6 +12128,13 @@ export interface paths { * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + * + * 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`. */ patch: operations["pulls/update"]; trace?: never; @@ -11349,9 +12152,7 @@ export interface paths { * Create a codespace from a pull request * @description Creates a codespace owned by the authenticated user for the specified pull request. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/create-with-pr-for-authenticated-user"]; delete?: never; @@ -11369,21 +12170,35 @@ export interface paths { }; /** * List review comments on a pull request - * @description Lists all review comments for a pull request. By default, review comments are in ascending order by ID. + * @description Lists all review comments for a specified pull request. By default, review comments + * are in ascending order by ID. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments"]; put?: never; /** * Create a review comment for a pull request - * @description - * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. + * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review-comment"]; delete?: never; @@ -11407,6 +12222,13 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-reply-for-review-comment"]; delete?: never; @@ -11424,7 +12246,16 @@ export interface paths { }; /** * List commits on a pull request - * @description Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. + * @description Lists a maximum of 250 commits for a pull request. To receive a complete + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) + * endpoint. + * + * 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["pulls/list-commits"]; put?: never; @@ -11444,7 +12275,17 @@ export interface paths { }; /** * List pull requests files - * @description **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. + * @description Lists the files in a specified pull request. + * + * **Note:** Responses include a maximum of 3000 files. The paginated response + * returns 30 files per page by default. + * + * 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["pulls/list-files"]; put?: never; @@ -11518,19 +12359,35 @@ export interface paths { }; /** * List reviews for a pull request - * @description The list of reviews returns in chronological order. + * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-reviews"]; put?: never; /** * Create a review for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + * @description Creates a review on a specified pull request. + * + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review"]; delete?: never; @@ -11549,17 +12406,38 @@ export interface paths { /** * Get a review for a pull request * @description Retrieves a pull request review by its ID. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review"]; /** * Update a review for a pull request - * @description Update the review summary comment with new text. + * @description Updates the contents of a specified review summary comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/update-review"]; post?: never; /** * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ delete: operations["pulls/delete-pending-review"]; options?: never; @@ -11576,7 +12454,14 @@ export interface paths { }; /** * List comments for a pull request review - * @description List comments for a specific pull request review. + * @description Lists comments for a specific pull request review. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-comments-for-review"]; put?: never; @@ -11597,7 +12482,18 @@ export interface paths { get?: never; /** * Dismiss a review for a pull request - * @description **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + * @description Dismisses a specified review on a pull request. + * + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), + * you must be a repository administrator or be included in the list of people or teams + * who can dismiss pull request reviews. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/dismiss-review"]; post?: never; @@ -11619,6 +12515,13 @@ export interface paths { /** * Submit a review for a pull request * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/submit-review"]; delete?: never; @@ -11658,7 +12561,10 @@ export interface paths { * Get a repository README * @description Gets the preferred README for a repository. * - * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + * 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 file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme"]; put?: never; @@ -11680,7 +12586,10 @@ export interface paths { * Get a repository README for a directory * @description Gets the README from a repository directory. * - * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + * 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 file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme-in-directory"]; put?: never; @@ -11815,7 +12724,11 @@ export interface paths { }; /** * Get a release - * @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). + * @description Gets a public release with the specified release ID. + * + * **Note:** This returns an `upload_url` key corresponding to the endpoint + * for uploading release assets. This key is a hypermedia resource. For more information, see + * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; put?: never; @@ -11846,7 +12759,7 @@ export interface paths { put?: never; /** * Upload a release asset - * @description This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in + * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset. * * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. @@ -12046,10 +12959,10 @@ export interface paths { /** * List secret scanning alerts for a repository * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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/list-alerts-for-repo"]; put?: never; @@ -12070,10 +12983,10 @@ export interface paths { /** * Get a secret scanning alert * @description Gets a single secret scanning alert detected in an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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-alert"]; put?: never; @@ -12084,10 +12997,10 @@ export interface paths { /** * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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. */ patch: operations["secret-scanning/update-alert"]; trace?: never; @@ -12102,10 +13015,10 @@ export interface paths { /** * List locations for a secret scanning alert * @description Lists all locations for a given secret scanning alert for an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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/list-locations-for-alert"]; put?: never; @@ -12126,19 +13039,20 @@ export interface paths { /** * List repository security advisories * @description Lists security advisories in a repository. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - * in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to. * - * You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory. + * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ get: operations["security-advisories/list-repository-advisories"]; put?: never; /** * Create a repository security advisory * @description Creates a new repository security advisory. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. * - * In order to create a draft repository security advisory, you must be a security manager or administrator of that repository. + * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ post: operations["security-advisories/create-repository-advisory"]; delete?: never; @@ -12178,12 +13092,13 @@ export interface paths { /** * Get a repository security advisory * @description Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - * You can access any published security advisory on a public repository. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - * in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to. * - * You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a + * Anyone can access any published security advisory on a public repository. + * + * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a * collaborator on the security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ get: operations["security-advisories/get-repository-advisory"]; put?: never; @@ -12194,10 +13109,11 @@ export interface paths { /** * Update a repository security advisory * @description Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. * - * In order to update any security advisory, you must be a security manager or administrator of that repository, + * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, * or a collaborator on the repository security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ patch: operations["security-advisories/update-repository-advisory"]; trace?: never; @@ -12217,9 +13133,9 @@ export interface paths { * * You may request a CVE for public repositories, but cannot do so for private repositories. * - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + * In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. * - * In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ post: operations["security-advisories/create-repository-advisory-cve-request"]; delete?: never; @@ -12228,6 +13144,28 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a temporary private fork + * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. + * + * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + */ + post: operations["security-advisories/create-fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/stargazers": { parameters: { query?: never; @@ -12239,7 +13177,9 @@ export interface paths { * List stargazers * @description Lists the people that have starred the repository. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * 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.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-stargazers-for-repo"]; put?: never; @@ -12259,7 +13199,12 @@ export interface paths { }; /** * Get the weekly commit activity - * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * @description + * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * + * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains + * 10,000 or more commits, a 422 status code will be returned. + * */ get: operations["repos/get-code-frequency-stats"]; put?: never; @@ -12302,10 +13247,12 @@ export interface paths { * @description * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * - * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). * * `a` - Number of additions * * `d` - Number of deletions * * `c` - Number of commits + * + * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ get: operations["repos/get-contributors-stats"]; put?: never; @@ -12537,11 +13484,7 @@ export interface paths { * * For a public repository, a team is listed only if that team added the public repository explicitly. * - * Personal access tokens require the following scopes: - * * `public_repo` to call this endpoint on a public repository - * * `repo` to call this endpoint on a private repository (this scope also includes public repositories) - * - * This endpoint is not compatible with fine-grained personal access tokens. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-teams"]; put?: never; @@ -12662,7 +13605,6 @@ export interface paths { /** * Transfer a repository * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). - * You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. */ post: operations["repos/transfer"]; delete?: never; @@ -12738,12 +13680,7 @@ export interface paths { * Create a repository using a template * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-using-template"]; delete?: never; @@ -12776,170 +13713,6 @@ export interface paths { patch?: never; trace?: never; }; - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - get: operations["actions/list-environment-secrets"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - get: operations["actions/get-environment-public-key"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - get: operations["actions/get-environment-secret"]; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. 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)." - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - put: operations["actions/create-or-update-environment-secret"]; - post?: never; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - delete: operations["actions/delete-environment-secret"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List environment variables - * @description Lists all environment variables. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environments:read` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - get: operations["actions/list-environment-variables"]; - put?: never; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - post: operations["actions/create-environment-variable"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environments:read` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - get: operations["actions/get-environment-variable"]; - put?: never; - post?: never; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - delete: operations["actions/delete-environment-variable"]; - options?: never; - head?: never; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - patch: operations["actions/update-environment-variable"]; - trace?: never; - }; "/search/code": { parameters: { query?: never; @@ -13202,7 +13975,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * - * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List all discussions on a team's page. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussions-legacy"]; put?: never; @@ -13211,9 +13986,11 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * - * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Creates a new discussion post on a team's page. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-legacy"]; delete?: never; @@ -13234,7 +14011,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * - * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Get a specific discussion on a team's page. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-legacy"]; put?: never; @@ -13244,7 +14023,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * - * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a discussion from a team's page. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-legacy"]; options?: never; @@ -13254,7 +14035,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-legacy"]; trace?: never; @@ -13271,7 +14054,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * - * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List all comments on a team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussion-comments-legacy"]; put?: never; @@ -13280,9 +14065,11 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * - * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Creates a new comment on a team discussion. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-comment-legacy"]; delete?: never; @@ -13303,7 +14090,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * - * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Get a specific comment on a team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-comment-legacy"]; put?: never; @@ -13313,7 +14102,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * - * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Deletes a comment on a team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-comment-legacy"]; options?: never; @@ -13323,7 +14114,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * - * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Edits the body text of a discussion comment. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-comment-legacy"]; trace?: never; @@ -13340,7 +14133,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-legacy"]; put?: never; @@ -13349,7 +14144,11 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-comment-legacy"]; delete?: never; @@ -13370,7 +14169,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-legacy"]; put?: never; @@ -13379,7 +14180,11 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-legacy"]; delete?: never; @@ -13464,7 +14269,7 @@ export interface paths { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-member-legacy"]; post?: never; @@ -13648,7 +14453,7 @@ export interface paths { * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-or-update-repo-permissions-legacy"]; post?: never; @@ -13695,9 +14500,7 @@ export interface paths { }; /** * Get the authenticated user - * @description If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information. - * - * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. */ get: operations["users/get-authenticated"]; put?: never; @@ -13771,9 +14574,7 @@ export interface paths { * List codespaces for the authenticated user * @description Lists the authenticated user's codespaces. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/list-for-authenticated-user"]; put?: never; @@ -13783,9 +14584,7 @@ export interface paths { * * This endpoint requires either a `repository_id` OR a `pull_request` but not both. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/create-for-authenticated-user"]; delete?: never; @@ -13806,9 +14605,9 @@ export interface paths { * @description Lists all development environment secrets available for a user's codespaces without revealing their * encrypted values. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/list-secrets-for-authenticated-user"]; put?: never; @@ -13830,9 +14629,9 @@ export interface paths { * Get public key for the authenticated user * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/get-public-key-for-authenticated-user"]; put?: never; @@ -13854,9 +14653,9 @@ export interface paths { * Get a secret for the authenticated user * @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/get-secret-for-authenticated-user"]; /** @@ -13864,9 +14663,9 @@ export interface paths { * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. 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)." * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; post?: never; @@ -13874,9 +14673,9 @@ export interface paths { * Delete a secret for the authenticated user * @description Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ delete: operations["codespaces/delete-secret-for-authenticated-user"]; options?: never; @@ -13895,18 +14694,18 @@ export interface paths { * List selected repositories for a user secret * @description List the repositories that have been granted the ability to use a user's development environment secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; /** * Set selected repositories for a user secret * @description Select the repositories that will use a user's development environment secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; post?: never; @@ -13927,16 +14726,20 @@ export interface paths { /** * Add a selected repository to a user secret * @description Adds a repository to the selected repositories for a user's development environment secret. - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. + * + * The authenticated user must have Codespaces access to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; post?: never; /** * Remove a selected repository from a user secret * @description Removes a repository from the selected repositories for a user's development environment secret. - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + * + * The authenticated user must have Codespaces access to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; options?: never; @@ -13955,9 +14758,7 @@ export interface paths { * Get a codespace for the authenticated user * @description Gets information about a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/get-for-authenticated-user"]; put?: never; @@ -13966,9 +14767,7 @@ export interface paths { * Delete a codespace for the authenticated user * @description Deletes a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ delete: operations["codespaces/delete-for-authenticated-user"]; options?: never; @@ -13979,9 +14778,7 @@ export interface paths { * * If you specify a new machine type it will be applied the next time your codespace is started. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ patch: operations["codespaces/update-for-authenticated-user"]; trace?: never; @@ -14001,9 +14798,7 @@ export interface paths { * * If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/export-for-authenticated-user"]; delete?: never; @@ -14023,9 +14818,7 @@ export interface paths { * Get details about a codespace export * @description Gets information about an export of a codespace. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/get-export-details-for-authenticated-user"]; put?: never; @@ -14047,9 +14840,7 @@ export interface paths { * List machine types for a codespace * @description List the machine types a codespace can transition to use. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/codespace-machines-for-authenticated-user"]; put?: never; @@ -14077,9 +14868,7 @@ export interface paths { * * This will fail for a codespace that is already published, meaning it has an associated repository. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/publish-for-authenticated-user"]; delete?: never; @@ -14101,9 +14890,7 @@ export interface paths { * Start a codespace for the authenticated user * @description Starts a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/start-for-authenticated-user"]; delete?: never; @@ -14125,9 +14912,7 @@ export interface paths { * Stop a codespace for the authenticated user * @description Stops a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/stop-for-authenticated-user"]; delete?: never; @@ -14146,7 +14931,8 @@ export interface paths { /** * Get list of conflicting packages during Docker migration for authenticated-user * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"]; put?: never; @@ -14186,18 +14972,21 @@ export interface paths { }; /** * List email addresses for the authenticated user - * @description Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. + * @description Lists all of your email addresses, and specifies which one is visible + * to the public. + * + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ get: operations["users/list-emails-for-authenticated-user"]; put?: never; /** * Add an email address for the authenticated user - * @description This endpoint is accessible with the `user` scope. + * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ post: operations["users/add-email-for-authenticated-user"]; /** * Delete an email address for the authenticated user - * @description This endpoint is accessible with the `user` scope. + * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ delete: operations["users/delete-email-for-authenticated-user"]; options?: never; @@ -14256,15 +15045,15 @@ export interface paths { get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ put: operations["users/follow"]; post?: never; /** * Unfollow a user - * @description Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ delete: operations["users/unfollow"]; options?: never; @@ -14281,13 +15070,17 @@ export interface paths { }; /** * List GPG keys for the authenticated user - * @description Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Lists the current user's GPG keys. + * + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ get: operations["users/list-gpg-keys-for-authenticated-user"]; put?: never; /** * Create a GPG key for the authenticated user - * @description Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Adds a GPG key to the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ post: operations["users/create-gpg-key-for-authenticated-user"]; delete?: never; @@ -14305,14 +15098,18 @@ export interface paths { }; /** * Get a GPG key for the authenticated user - * @description View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description View extended details for a single GPG key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ get: operations["users/get-gpg-key-for-authenticated-user"]; put?: never; post?: never; /** * Delete a GPG key for the authenticated user - * @description Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Removes a GPG key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. */ delete: operations["users/delete-gpg-key-for-authenticated-user"]; options?: never; @@ -14331,8 +15128,6 @@ export interface paths { * List app installations accessible to the user access token * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * * You can find the permissions for the installation under the `permissions` key. @@ -14359,8 +15154,6 @@ export interface paths { * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - * * The access the user has to each repository is included in the hash under the `permissions` key. */ get: operations["apps/list-installation-repos-for-authenticated-user"]; @@ -14383,16 +15176,12 @@ export interface paths { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; post?: never; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; options?: never; @@ -14443,6 +15232,13 @@ export interface paths { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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-for-authenticated-user"]; put?: never; @@ -14462,13 +15258,17 @@ export interface paths { }; /** * List public SSH keys for the authenticated user - * @description Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Lists the public SSH keys for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ get: operations["users/list-public-ssh-keys-for-authenticated-user"]; put?: never; /** * Create a public SSH key for the authenticated user - * @description Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Adds a public SSH key to the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ post: operations["users/create-public-ssh-key-for-authenticated-user"]; delete?: never; @@ -14486,14 +15286,18 @@ export interface paths { }; /** * Get a public SSH key for the authenticated user - * @description View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description View extended details for a single public SSH key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ get: operations["users/get-public-ssh-key-for-authenticated-user"]; put?: never; post?: never; /** * Delete a public SSH key for the authenticated user - * @description Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Removes a public SSH key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. */ delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; options?: never; @@ -14510,7 +15314,7 @@ export interface paths { }; /** * List subscriptions for the authenticated user - * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + * @description Lists the active subscriptions for the authenticated user. */ get: operations["apps/list-subscriptions-for-authenticated-user"]; put?: never; @@ -14530,7 +15334,7 @@ export interface paths { }; /** * List subscriptions for the authenticated user (stubbed) - * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + * @description Lists the active subscriptions for the authenticated user. */ get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; put?: never; @@ -14731,9 +15535,7 @@ export interface paths { * List organizations for the authenticated user * @description List organizations for the authenticated user. * - * **OAuth scope requirements** - * - * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. */ get: operations["orgs/list-for-authenticated-user"]; put?: never; @@ -14755,7 +15557,7 @@ export interface paths { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; put?: never; @@ -14777,7 +15579,7 @@ export interface paths { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; put?: never; @@ -14786,8 +15588,7 @@ export interface paths { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; options?: never; @@ -14812,7 +15613,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; delete?: never; @@ -14832,7 +15633,7 @@ export interface paths { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; put?: never; @@ -14854,7 +15655,7 @@ export interface paths { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; put?: never; @@ -14863,8 +15664,9 @@ export interface paths { * Delete a package version for the authenticated user * @description Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; options?: never; @@ -14889,7 +15691,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; delete?: never; @@ -14927,7 +15729,11 @@ export interface paths { }; /** * List public email addresses for the authenticated user - * @description Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + * @description Lists your publicly visible email address, which you can set with the + * [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ get: operations["users/list-public-emails-for-authenticated-user"]; put?: never; @@ -14957,12 +15763,7 @@ export interface paths { * Create a repository for the authenticated user * @description Creates a new repository for the authenticated user. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-for-authenticated-user"]; delete?: never; @@ -15024,12 +15825,16 @@ export interface paths { put?: never; /** * Add social accounts for the authenticated user - * @description Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope. + * @description Add one or more social accounts to the authenticated user's profile. + * + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ post: operations["users/add-social-account-for-authenticated-user"]; /** * Delete social accounts for the authenticated user - * @description Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope. + * @description Deletes one or more social accounts from the authenticated user's profile. + * + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ delete: operations["users/delete-social-account-for-authenticated-user"]; options?: never; @@ -15046,13 +15851,17 @@ export interface paths { }; /** * List SSH signing keys for the authenticated user - * @description Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Lists the SSH signing keys for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ get: operations["users/list-ssh-signing-keys-for-authenticated-user"]; put?: never; /** * Create a SSH signing key for the authenticated user - * @description Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Creates an SSH signing key for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. */ post: operations["users/create-ssh-signing-key-for-authenticated-user"]; delete?: never; @@ -15070,14 +15879,18 @@ export interface paths { }; /** * Get an SSH signing key for the authenticated user - * @description Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Gets extended details for an SSH signing key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ get: operations["users/get-ssh-signing-key-for-authenticated-user"]; put?: never; post?: never; /** * Delete an SSH signing key for the authenticated user - * @description Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Deletes an SSH signing key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. */ delete: operations["users/delete-ssh-signing-key-for-authenticated-user"]; options?: never; @@ -15096,7 +15909,9 @@ export interface paths { * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * 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.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-authenticated-user"]; put?: never; @@ -15121,7 +15936,7 @@ export interface paths { get: operations["activity/check-repo-is-starred-by-authenticated-user"]; /** * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["activity/star-repo-for-authenticated-user"]; post?: never; @@ -15164,7 +15979,12 @@ export interface paths { }; /** * List teams for the authenticated user - * @description List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token. + * @description List all of the teams across all of the organizations to which the authenticated + * user belongs. + * + * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + * + * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. */ get: operations["teams/list-for-authenticated-user"]; put?: never; @@ -15208,9 +16028,7 @@ export interface paths { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" - * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". */ @@ -15233,7 +16051,8 @@ export interface paths { /** * Get list of conflicting packages during Docker migration for user * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-user"]; put?: never; @@ -15407,14 +16226,11 @@ export interface paths { }; /** * Get contextual information for a user - * @description Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["users/get-context-for-user"]; put?: never; @@ -15500,7 +16316,7 @@ export interface paths { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; put?: never; @@ -15522,7 +16338,7 @@ export interface paths { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; put?: never; @@ -15531,9 +16347,9 @@ export interface paths { * Delete a package for a user * @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; options?: never; @@ -15558,9 +16374,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; delete?: never; @@ -15580,7 +16396,7 @@ export interface paths { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; put?: never; @@ -15602,7 +16418,7 @@ export interface paths { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; put?: never; @@ -15611,9 +16427,9 @@ export interface paths { * Delete package version for a user * @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; options?: never; @@ -15638,9 +16454,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; delete?: never; @@ -15678,7 +16494,7 @@ export interface paths { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ get: operations["activity/list-received-events-for-user"]; put?: never; @@ -15715,7 +16531,7 @@ export interface paths { }; /** * List repositories for a user - * @description Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. + * @description Lists public repositories for the specified user. */ get: operations["repos/list-for-user"]; put?: never; @@ -15739,7 +16555,7 @@ export interface paths { * * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ get: operations["billing/get-github-actions-billing-user"]; put?: never; @@ -15763,7 +16579,7 @@ export interface paths { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ get: operations["billing/get-github-packages-billing-user"]; put?: never; @@ -15787,7 +16603,7 @@ export interface paths { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ get: operations["billing/get-shared-storage-billing-user"]; put?: never; @@ -15849,7 +16665,9 @@ export interface paths { * List repositories starred by a user * @description Lists repositories a user has starred. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * 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.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-user"]; put?: never; @@ -16546,7 +17364,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. - * @description A Dependabot alert was automatically closed. + * @description A Dependabot alert was automatically closed by a Dependabot auto-triage rule. */ post: operations["dependabot-alert/auto-dismissed"]; delete?: never; @@ -16572,7 +17390,7 @@ export interface webhooks { * To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. * * **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. - * @description A Dependabot alert was automatically reopened. + * @description A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed. */ post: operations["dependabot-alert/auto-reopened"]; delete?: never; @@ -18883,12 +19701,14 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * + * For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. * - * For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + * This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - * @description A note in a classic project was converted to an issue. + * @description A note in a project (classic) was converted to an issue. */ post: operations["project-card/converted"]; delete?: never; @@ -18907,12 +19727,14 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * + * For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. * - * For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + * This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - * @description A card was added to a classic project. + * @description A card was added to a project (classic). */ post: operations["project-card/created"]; delete?: never; @@ -18931,12 +19753,14 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. * - * For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + * For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. + * + * This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - * @description A card on a classic project was deleted. + * @description A card on a project (classic) was deleted. */ post: operations["project-card/deleted"]; delete?: never; @@ -18955,12 +19779,14 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * + * For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. * - * For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + * This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - * @description A note on a classic project was edited. + * @description A note on a project (classic) was edited. */ post: operations["project-card/edited"]; delete?: never; @@ -18979,12 +19805,14 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. * - * For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + * For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. + * + * This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - * @description A card on a classic project was moved to another column or to another position in its column. + * @description A card on a project (classic) was moved to another column or to another position in its column. */ post: operations["project-card/moved"]; delete?: never; @@ -19003,12 +19831,14 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * + * For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. * - * For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + * This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - * @description A classic project was closed. + * @description A project (classic) was closed. */ post: operations["project/closed"]; delete?: never; @@ -19027,12 +19857,14 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a column on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * + * For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. * - * For activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + * This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - * @description A column was added to a classic project. + * @description A column was added to a project (classic). */ post: operations["project-column/created"]; delete?: never; @@ -19051,12 +19883,14 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a column on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. * - * For activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + * For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + * + * This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - * @description A column was deleted from a classic project. + * @description A column was deleted from a project (classic). */ post: operations["project-column/deleted"]; delete?: never; @@ -19075,12 +19909,14 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a column on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * + * For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. * - * For activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + * This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - * @description The name of a column on a classic project was changed. + * @description The name of a column on a project (classic) was changed. */ post: operations["project-column/edited"]; delete?: never; @@ -19099,12 +19935,14 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a column on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. * - * For activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + * For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + * + * This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - * @description A column was moved to a new position on a classic project. + * @description A column was moved to a new position on a project (classic). */ post: operations["project-column/moved"]; delete?: never; @@ -19123,12 +19961,14 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * + * For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. * - * For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + * This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - * @description A classic project was created. + * @description A project (classic) was created. */ post: operations["project/created"]; delete?: never; @@ -19147,12 +19987,14 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * + * For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. * - * For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + * This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - * @description A classic project was deleted. + * @description A project (classic) was deleted. */ post: operations["project/deleted"]; delete?: never; @@ -19171,12 +20013,14 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. * - * For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + * For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + * + * This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - * @description The name or description of a classic project was changed. + * @description The name or description of a project (classic) was changed. */ post: operations["project/edited"]; delete?: never; @@ -19195,12 +20039,14 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + * + * For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. * - * For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + * This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. * * To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - * @description A classic project was closed. + * @description A project (classic) was closed. */ post: operations["project/reopened"]; delete?: never; @@ -20580,12 +21426,9 @@ export interface webhooks { }; get?: never; put?: never; - /** - * This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). + /** This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. * - * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - * @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - */ + * To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. */ post: operations["repository-dispatch/sample.collected"]; delete?: never; options?: never; @@ -21024,6 +21867,30 @@ export interface webhooks { patch?: never; trace?: never; }; + "secret-scanning-alert-validated": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. + * + * For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + * + * 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 alert was validated. + */ + post: operations["secret-scanning-alert/validated"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "security-advisory-published": { parameters: { query?: never; @@ -21034,7 +21901,7 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + * This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). * * GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." * @description A security advisory was published to the GitHub community. @@ -21056,10 +21923,10 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + * This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). * * GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - * @description The metadata or description of a security advisory was changed, or the security advisory was withdrawn. + * @description The metadata or description of a security advisory was changed. */ post: operations["security-advisory/updated"]; delete?: never; @@ -21078,7 +21945,7 @@ export interface webhooks { get?: never; put?: never; /** - * This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + * This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). * * GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." * @description A previously published security advisory was withdrawn. @@ -21684,8 +22551,11 @@ export interface components { following_url: string; /** Format: uri-template */ gists_url: string; - /** Format: uri-template */ - hub_url: string; + /** + * Format: uri-template + * @deprecated + */ + hub_url?: string; /** Format: uri-template */ issue_search_url: string; /** Format: uri-template */ @@ -21732,6 +22602,21 @@ export interface components { * @enum {string} */ "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift"; + /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ + vulnerability: { + /** @description The name of the package affected by the vulnerability. */ + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + name: string | null; + } | null; + /** @description The range of the package versions affected by the vulnerability. */ + vulnerable_version_range: string | null; + /** @description The package version that resolves the vulnerability. */ + first_patched_version: string | null; + /** @description The functions in the package that are affected by the vulnerability. */ + readonly vulnerable_functions: string[] | null; + }; /** * Simple User * @description A GitHub user. @@ -21846,20 +22731,7 @@ export interface components { */ readonly withdrawn_at: string | null; /** @description The products and respective version ranges affected by the advisory. */ - vulnerabilities: { - /** @description The name of the package affected by the vulnerability. */ - package: { - ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ - name: string | null; - } | null; - /** @description The range of the package versions affected by the vulnerability. */ - vulnerable_version_range: string | null; - /** @description The package version that resolve the vulnerability. */ - first_patched_version: string | null; - /** @description The functions in the package that are affected by the vulnerability. */ - readonly vulnerable_functions: string[] | null; - }[] | null; + vulnerabilities: components["schemas"]["vulnerability"][] | null; cvss: { /** @description The CVSS vector. */ vector_string: string | null; @@ -21942,7 +22814,7 @@ export interface components { client_secret?: string; webhook_secret?: string | null; pem?: string; - }; + } | null; /** * Format: uri * @description The URL to which the payloads will be delivered. @@ -22140,11 +23012,21 @@ export interface components { * @enum {string} */ checks?: "read" | "write"; + /** + * @description The level of permission to grant the access token to create, edit, delete, and list Codespaces. + * @enum {string} + */ + codespaces?: "read" | "write"; /** * @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. * @enum {string} */ contents?: "read" | "write"; + /** + * @description The leve of permission to grant the access token to manage Dependabot secrets. + * @enum {string} + */ + dependabot_secrets?: "read" | "write"; /** * @description The level of permission to grant the access token for deployments and deployment statuses. * @enum {string} @@ -22180,6 +23062,11 @@ export interface components { * @enum {string} */ pull_requests?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. + * @enum {string} + */ + repository_custom_properties?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. * @enum {string} @@ -22236,20 +23123,35 @@ export interface components { */ organization_administration?: "read" | "write"; /** - * @description The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for custom repository roles management. * @enum {string} */ organization_custom_roles?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom organization roles management. + * @enum {string} + */ + organization_custom_org_roles?: "read" | "write"; /** * @description The level of permission to grant the access token for custom property management. * @enum {string} */ organization_custom_properties?: "read" | "write" | "admin"; + /** + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @enum {string} + */ + organization_copilot_seat_management?: "write"; /** * @description The level of permission to grant the access token to view and manage announcement banners for an organization. * @enum {string} */ organization_announcement_banners?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view events triggered by an activity in an organization. + * @enum {string} + */ + organization_events?: "read"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for an organization. * @enum {string} @@ -22300,6 +23202,41 @@ export interface components { * @enum {string} */ team_discussions?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the email addresses belonging to a user. + * @enum {string} + */ + email_addresses?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the followers belonging to a user. + * @enum {string} + */ + followers?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage git SSH keys. + * @enum {string} + */ + git_ssh_keys?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and manage GPG keys belonging to a user. + * @enum {string} + */ + gpg_keys?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and manage interaction limits on a repository. + * @enum {string} + */ + interaction_limits?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the profile settings belonging to a user. + * @enum {string} + */ + profile?: "write"; + /** + * @description The level of permission to grant the access token to list and manage repositories a user is starring. + * @enum {string} + */ + starring?: "read" | "write"; }; /** * Installation @@ -22365,7 +23302,6 @@ export interface components { name: string; full_name: string; license: null | components["schemas"]["license-simple"]; - organization?: null | components["schemas"]["simple-user"]; forks: number; permissions?: { admin: boolean; @@ -22448,7 +23384,7 @@ export interface components { forks_count: number; stargazers_count: number; watchers_count: number; - /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */ + /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */ size: number; /** @description The default branch of the repository. */ default_branch: string; @@ -22509,150 +23445,6 @@ export interface components { * @default true */ allow_rebase_merge: boolean; - template_repository?: { - id?: number; - node_id?: string; - name?: string; - full_name?: string; - owner?: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - }; - private?: boolean; - html_url?: string; - description?: string; - fork?: boolean; - url?: string; - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - downloads_url?: string; - events_url?: string; - forks_url?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - git_url?: string; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - notifications_url?: string; - pulls_url?: string; - releases_url?: string; - ssh_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - clone_url?: string; - mirror_url?: string; - hooks_url?: string; - svn_url?: string; - homepage?: string; - language?: string; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; - pushed_at?: string; - created_at?: string; - updated_at?: string; - permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; - allow_rebase_merge?: boolean; - temp_clone_token?: string; - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_update_branch?: boolean; - use_squash_pr_title_as_default?: boolean; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - allow_merge_commit?: boolean; - subscribers_count?: number; - network_count?: number; - } | null; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. @@ -22726,8 +23518,6 @@ export interface components { * @default false */ web_commit_signoff_required: boolean; - subscribers_count?: number; - network_count?: number; open_issues: number; watchers: number; master_branch?: string; @@ -23027,6 +23817,51 @@ export interface components { /** Format: uri */ html_url: string | null; }; + /** + * 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; + }; /** @description The security alert number. */ "alert-number": number; /** @description Details for the vulnerable package. */ @@ -23996,6 +24831,7 @@ export interface components { codespaces?: string[]; copilot?: string[]; packages?: string[]; + actions?: string[]; }; }; "security-and-analysis": { @@ -24096,7 +24932,7 @@ export interface components { forks_count?: number; stargazers_count?: number; watchers_count?: number; - /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */ + /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */ size?: number; default_branch?: string; open_issues_count?: number; @@ -24540,11 +25376,13 @@ export interface components { "code-scanning-alert-dismissed-reason": null | "false positive" | "won't fix" | "used in tests"; /** @description The dismissal comment associated with the dismissal of the alert. */ "code-scanning-alert-dismissed-comment": string | null; - "code-scanning-alert-rule": { + "code-scanning-alert-rule-summary": { /** @description A unique identifier for the rule used to detect the alert. */ id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -24557,14 +25395,6 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical" | null; /** @description A short description of the rule used to detect the alert. */ description?: string; - /** @description description of the rule used to detect the alert. */ - full_description?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -24624,7 +25454,7 @@ export interface components { dismissed_at: components["schemas"]["alert-dismissed-at"]; dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - rule: components["schemas"]["code-scanning-alert-rule"]; + rule: components["schemas"]["code-scanning-alert-rule-summary"]; tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; @@ -24837,7 +25667,17 @@ export interface components { * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. * @enum {string} */ - copilot_chat?: "enabled" | "disabled" | "unconfigured"; + 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} @@ -25376,11 +26216,17 @@ export interface components { /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ - default_value?: string | null; + default_value?: (null | unknown[]) & (string | string[]); /** @description Short description of the property */ description?: string | null; - /** @description Ordered list of allowed values of the property */ + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors" | null; }; /** * Custom Property Value @@ -25390,7 +26236,7 @@ export interface components { /** @description The name of the property */ property_name: string; /** @description The value assigned to the property */ - value: string | null; + value: (null | unknown[]) & (string | string[]); }; /** * Organization Repository Custom Property Values @@ -25403,6 +26249,194 @@ export interface components { /** @description List of custom property names and associated values */ properties: components["schemas"]["custom-property-value"][]; }; + /** + * Code Of Conduct Simple + * @description Code of Conduct Simple + */ + "code-of-conduct-simple": { + /** Format: uri */ + url: string; + key: string; + name: string; + /** Format: uri */ + html_url: string | null; + }; + /** + * Full Repository + * @description Full Repository + */ + "full-repository": { + id: number; + node_id: string; + name: string; + full_name: string; + owner: components["schemas"]["simple-user"]; + private: boolean; + /** Format: uri */ + html_url: string; + description: string | null; + fork: boolean; + /** Format: uri */ + url: string; + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + /** Format: uri */ + contributors_url: string; + /** Format: uri */ + deployments_url: string; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + /** Format: uri */ + forks_url: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + /** Format: uri */ + languages_url: string; + /** Format: uri */ + merges_url: string; + milestones_url: string; + notifications_url: string; + pulls_url: string; + releases_url: string; + ssh_url: string; + /** Format: uri */ + stargazers_url: string; + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + trees_url: string; + clone_url: string; + /** Format: uri */ + mirror_url: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + homepage: string | null; + language: string | null; + forks_count: number; + stargazers_count: number; + watchers_count: number; + /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */ + size: number; + default_branch: string; + open_issues_count: number; + is_template?: boolean; + topics?: string[]; + has_issues: boolean; + has_projects: boolean; + has_wiki: boolean; + has_pages: boolean; + has_downloads?: boolean; + has_discussions: boolean; + archived: boolean; + /** @description Returns whether or not this repository disabled. */ + disabled: boolean; + /** @description The repository visibility: public, private, or internal. */ + visibility?: string; + /** Format: date-time */ + pushed_at: string; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + permissions?: { + admin: boolean; + maintain?: boolean; + push: boolean; + triage?: boolean; + pull: boolean; + }; + allow_rebase_merge?: boolean; + template_repository?: null | components["schemas"]["repository"]; + temp_clone_token?: string | null; + allow_squash_merge?: boolean; + allow_auto_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_merge_commit?: boolean; + allow_update_branch?: boolean; + use_squash_pr_title_as_default?: boolean; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + allow_forking?: boolean; + web_commit_signoff_required?: boolean; + subscribers_count: number; + network_count: number; + license: null | components["schemas"]["license-simple"]; + organization?: null | components["schemas"]["simple-user"]; + parent?: components["schemas"]["repository"]; + source?: components["schemas"]["repository"]; + forks: number; + master_branch?: string; + open_issues: number; + watchers: number; + /** + * @description Whether anonymous git access is allowed. + * @default true + */ + anonymous_access_enabled: boolean; + code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; + security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; + }; /** * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). * @enum {string} @@ -25413,15 +26447,18 @@ export interface components { * @description An actor that can bypass rules in a ruleset */ "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. */ - actor_id: number; + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. + * */ + actor_id?: number | null; /** - * @description The type of actor that can bypass a ruleset + * @description The type of actor that can bypass a ruleset. + * * @enum {string} */ - actor_type: "RepositoryRole" | "Team" | "Integration" | "OrganizationAdmin"; + actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. + * * @enum {string} */ bypass_mode: "always" | "pull_request"; @@ -25462,12 +26499,34 @@ export interface components { repository_ids?: number[]; }; }; + /** + * Repository ruleset property targeting definition + * @description Parameters for a targeting a repository property + */ + "repository-ruleset-conditions-repository-property-spec": { + /** @description The name of the repository property to target */ + name: string; + /** @description The values to match for the repository property */ + property_values: string[]; + }; + /** + * Repository ruleset conditions for repository properties + * @description Parameters for a repository property condition + */ + "repository-ruleset-conditions-repository-property-target": { + repository_property: { + /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */ + include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */ + exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + }; + }; /** * Organization ruleset conditions * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. * */ - "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"]); + "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"]); /** * creation * @description Only allow users with bypass permission to create matching refs. @@ -25681,6 +26740,16 @@ export interface components { pattern: string; }; }; + /** + * RestrictedCommits + * @description Restricted commit + */ + "repository-rule-params-restricted-commits": { + /** @description Full or abbreviated commit hash to reject */ + oid: string; + /** @description Reason for restriction */ + reason?: string; + }; /** * WorkflowFileReference * @description A workflow that must run for this rule to pass @@ -25707,11 +26776,57 @@ export interface components { workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; }; }; + /** + * CodeScanningTool + * @description A tool that must provide code scanning results for this rule to pass. + */ + "repository-rule-params-code-scanning-tool": { + /** + * @description The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + * @enum {string} + */ + alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; + /** + * @description The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + * @enum {string} + */ + security_alerts_threshold: "none" | "critical" | "high_or_higher" | "medium_or_higher" | "all"; + /** @description The name of a code scanning tool */ + tool: string; + }; /** * Repository Rule * @description A repository rule. */ - "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-workflows"]; + "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { + /** @enum {string} */ + type: "file_path_restriction"; + parameters?: { + /** @description The file paths that are restricted from being pushed to the commit graph. */ + restricted_file_paths: string[]; + }; + } | { + /** @enum {string} */ + type: "max_file_path_length"; + parameters?: { + /** @description The maximum amount of characters allowed in file paths */ + max_file_path_length: number; + }; + } | { + /** @enum {string} */ + type: "file_extension_restriction"; + parameters?: { + /** @description The file extensions that are restricted from being pushed to the commit graph. */ + restricted_file_extensions: string[]; + }; + } | { + /** @enum {string} */ + type: "max_file_size"; + parameters?: { + /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ + max_file_size: number; + }; + } | components["schemas"]["repository-rule-workflows"]; /** * Repository ruleset * @description A set of rules to apply when specified conditions are met. @@ -25723,9 +26838,11 @@ export interface components { name: string; /** * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag"; + target?: "branch" | "tag" | "push"; /** * @description The type of the source of the ruleset * @enum {string} @@ -25753,7 +26870,7 @@ export interface components { href?: string; }; }; - conditions?: components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]; + conditions?: (null | (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"])) | components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]; rules?: components["schemas"]["repository-rule"][]; /** Format: date-time */ created_at?: string; @@ -25802,9 +26919,9 @@ export interface components { /** @description The unique identifier of the rule insight. */ id?: number; /** @description The number that identifies the user. */ - actor_id?: number; + actor_id?: number | null; /** @description The handle for the GitHub user account. */ - actor_name?: string; + actor_name?: string | null; /** @description The first commit sha before the push evaluation. */ before_sha?: string; /** @description The last commit sha in the push evaluation. */ @@ -26546,190 +27663,6 @@ export interface components { }; rate: components["schemas"]["rate-limit"]; }; - /** - * Code Of Conduct Simple - * @description Code of Conduct Simple - */ - "code-of-conduct-simple": { - /** Format: uri */ - url: string; - key: string; - name: string; - /** Format: uri */ - html_url: string | null; - }; - /** - * Full Repository - * @description Full Repository - */ - "full-repository": { - id: number; - node_id: string; - name: string; - full_name: string; - owner: components["schemas"]["simple-user"]; - private: boolean; - /** Format: uri */ - html_url: string; - description: string | null; - fork: boolean; - /** Format: uri */ - url: string; - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - /** Format: uri */ - contributors_url: string; - /** Format: uri */ - deployments_url: string; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - /** Format: uri */ - forks_url: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - /** Format: uri */ - languages_url: string; - /** Format: uri */ - merges_url: string; - milestones_url: string; - notifications_url: string; - pulls_url: string; - releases_url: string; - ssh_url: string; - /** Format: uri */ - stargazers_url: string; - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - trees_url: string; - clone_url: string; - /** Format: uri */ - mirror_url: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - homepage: string | null; - language: string | null; - forks_count: number; - stargazers_count: number; - watchers_count: number; - /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */ - size: number; - default_branch: string; - open_issues_count: number; - is_template?: boolean; - topics?: string[]; - has_issues: boolean; - has_projects: boolean; - has_wiki: boolean; - has_pages: boolean; - has_downloads?: boolean; - has_discussions: boolean; - archived: boolean; - /** @description Returns whether or not this repository disabled. */ - disabled: boolean; - /** @description The repository visibility: public, private, or internal. */ - visibility?: string; - /** Format: date-time */ - pushed_at: string; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ - updated_at: string; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - allow_rebase_merge?: boolean; - template_repository?: null | components["schemas"]["repository"]; - temp_clone_token?: string | null; - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_merge_commit?: boolean; - allow_update_branch?: boolean; - use_squash_pr_title_as_default?: boolean; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - allow_forking?: boolean; - web_commit_signoff_required?: boolean; - subscribers_count: number; - network_count: number; - license: null | components["schemas"]["license-simple"]; - organization?: null | components["schemas"]["simple-user"]; - parent?: components["schemas"]["repository"]; - source?: components["schemas"]["repository"]; - forks: number; - master_branch?: string; - open_issues: number; - watchers: number; - /** - * @description Whether anonymous git access is allowed. - * @default true - */ - anonymous_access_enabled: boolean; - code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; - security_and_analysis?: components["schemas"]["security-and-analysis"]; - }; /** * Artifact * @description An artifact @@ -26800,7 +27733,7 @@ export interface components { * @description The phase of the lifecycle that the job is currently in. * @enum {string} */ - status: "queued" | "in_progress" | "completed" | "waiting"; + status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @description The outcome of the job. * @enum {string|null} @@ -26913,7 +27846,7 @@ export interface components { * @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the * repository. * - * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization. + * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. * @enum {string} */ access_level: "none" | "user" | "organization"; @@ -27742,10 +28675,10 @@ export interface components { html_url: string | null; details_url: string | null; /** - * @description The phase of the lifecycle that the check is currently in. + * @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | null; /** Format: date-time */ @@ -27796,8 +28729,11 @@ export interface components { head_branch: string | null; /** @description The SHA of the head commit that is being checked. */ head_sha: string; - /** @enum {string|null} */ - status: "queued" | "in_progress" | "completed" | null; + /** + * @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. + * @enum {string|null} + */ + status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending" | null; /** @enum {string|null} */ conclusion: "success" | "failure" | "neutral" | "cancelled" | "skipped" | "timed_out" | "action_required" | "startup_failure" | "stale" | null; url: string | null; @@ -27829,21 +28765,6 @@ export interface components { }; repository: components["schemas"]["minimal-repository"]; }; - "code-scanning-alert-rule-summary": { - /** @description A unique identifier for the rule used to detect the alert. */ - id?: string | null; - /** @description The name of the rule used to detect the alert. */ - name?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity?: "none" | "note" | "warning" | "error" | null; - /** @description A short description of the rule used to detect the alert. */ - description?: string; - }; "code-scanning-alert-items": { number: components["schemas"]["alert-number"]; created_at: components["schemas"]["alert-created-at"]; @@ -27861,6 +28782,32 @@ export interface components { tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; }; + "code-scanning-alert-rule": { + /** @description A unique identifier for the rule used to detect the alert. */ + id?: string | null; + /** @description The name of the rule used to detect the alert. */ + name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity?: "none" | "note" | "warning" | "error" | null; + /** + * @description The security severity of the alert. + * @enum {string|null} + */ + security_severity_level?: "low" | "medium" | "high" | "critical" | null; + /** @description A short description of the rule used to detect the alert. */ + description?: string; + /** @description description of the rule used to detect the alert. */ + full_description?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; + }; "code-scanning-alert": { number: components["schemas"]["alert-number"]; created_at: components["schemas"]["alert-created-at"]; @@ -28019,7 +28966,7 @@ export interface components { run_url?: string; }; /** @description The full Git reference, formatted as `refs/heads/`, - * `refs/pull//merge`, or `refs/pull//head`. */ + * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. */ "code-scanning-ref-full": string; /** @description A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see "[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning)." */ "code-scanning-analysis-sarif-file": string; @@ -29218,18 +30165,7 @@ export interface components { active: boolean; /** @description Determines what events the hook is triggered for. Default: ['push']. */ events: string[]; - config: { - email?: string; - password?: string; - room?: string; - subdomain?: string; - url?: components["schemas"]["webhook-config-url"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - digest?: string; - secret?: components["schemas"]["webhook-config-secret"]; - token?: string; - }; + config: components["schemas"]["webhook-config"]; /** Format: date-time */ updated_at: string; /** Format: date-time */ @@ -30168,6 +31104,8 @@ export interface components { * @description The GitHub Pages deployment status. */ "page-deployment": { + /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ + id: number | string; /** * Format: uri * @description The URI to monitor GitHub Pages deployment status. @@ -30184,6 +31122,14 @@ export interface components { */ preview_url?: string; }; + /** GitHub Pages deployment status */ + "pages-deployment-status": { + /** + * @description The current status of the deployment. + * @enum {string} + */ + status?: "deployment_in_progress" | "syncing_files" | "finished_file_sync" | "updating_pages" | "purging_cdn" | "deployment_cancelled" | "deployment_failed" | "deployment_content_failed" | "deployment_attempt_error" | "deployment_lost" | "succeed"; + }; /** * Pages Health Check Status * @description Pages Health Check Status @@ -30971,6 +31917,27 @@ export interface components { /** @description The API URL to get the associated commit resource */ commit_url: string; }; + /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ + "secret-scanning-location-wiki-commit": { + /** @description The file path of the wiki page */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ + end_column: number; + /** @description SHA-1 hash ID of the associated blob */ + blob_sha: string; + /** @description The GitHub URL to get the associated wiki page */ + page_url: string; + /** @description SHA-1 hash ID of the associated commit */ + commit_sha: string; + /** @description The GitHub URL to get the associated wiki commit */ + commit_url: string; + }; /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ "secret-scanning-location-issue-title": { /** @@ -30995,13 +31962,77 @@ export interface components { */ issue_comment_url: string; }; + /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ + "secret-scanning-location-discussion-title": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + */ + discussion_title_url: string; + }; + /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ + "secret-scanning-location-discussion-body": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + */ + discussion_body_url: string; + }; + /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ + "secret-scanning-location-discussion-comment": { + /** + * Format: uri + * @description The API URL to get the discussion comment where the secret was detected. + */ + discussion_comment_url: string; + }; + /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ + "secret-scanning-location-pull-request-title": { + /** + * Format: uri + * @description The API URL to get the pull request where the secret was detected. + */ + pull_request_title_url: string; + }; + /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ + "secret-scanning-location-pull-request-body": { + /** + * Format: uri + * @description The API URL to get the pull request where the secret was detected. + */ + pull_request_body_url: string; + }; + /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ + "secret-scanning-location-pull-request-comment": { + /** + * Format: uri + * @description The API URL to get the pull request comment where the secret was detected. + */ + pull_request_comment_url: string; + }; + /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ + "secret-scanning-location-pull-request-review": { + /** + * Format: uri + * @description The API URL to get the pull request review where the secret was detected. + */ + pull_request_review_url: string; + }; + /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ + "secret-scanning-location-pull-request-review-comment": { + /** + * Format: uri + * @description The API URL to get the pull request review comment where the secret was detected. + */ + pull_request_review_comment_url: string; + }; "secret-scanning-location": { /** - * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found. + * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. * @enum {string} */ - type: "commit" | "issue_title" | "issue_body" | "issue_comment"; - details: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"]; + type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; + details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; "repository-advisory-create": { /** @description A short summary of the advisory. */ @@ -31040,6 +32071,11 @@ export interface components { severity?: "critical" | "high" | "medium" | "low" | null; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ cvss_vector_string?: string | null; + /** + * @description Whether to create a temporary private fork of the repository to collaborate on a fix. + * @default false + */ + start_private_fork: boolean; }; "private-vulnerability-report-create": { /** @description A short summary of the advisory. */ @@ -31070,6 +32106,11 @@ export interface components { severity?: "critical" | "high" | "medium" | "low" | null; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ cvss_vector_string?: string | null; + /** + * @description Whether to create a temporary private fork of the repository to collaborate on a fix. + * @default false + */ + start_private_fork: boolean; }; "repository-advisory-update": { /** @description A short summary of the advisory. */ @@ -32175,7 +33216,7 @@ export interface components { forks_count: number; stargazers_count: number; watchers_count: number; - /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */ + /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */ size: number; /** @description The default branch of the repository. */ default_branch: string; @@ -32500,6 +33541,50 @@ export interface components { site_admin: boolean; starred_at?: string; }; + /** + * branch protection rule + * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + */ + webhooks_rule: { + admin_enforced: boolean; + /** @enum {string} */ + allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; + authorized_actor_names: string[]; + authorized_actors_only: boolean; + authorized_dismissal_actors_only: boolean; + create_protected?: boolean; + /** Format: date-time */ + created_at: string; + dismiss_stale_reviews_on_push: boolean; + id: number; + ignore_approvals_from_contributors: boolean; + /** @enum {string} */ + linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + name: string; + /** @enum {string} */ + pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; + repository_id: number; + require_code_owner_review: boolean; + /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ + require_last_push_approval?: boolean; + required_approving_review_count: number; + /** @enum {string} */ + required_conversation_resolution_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; + required_status_checks: string[]; + /** @enum {string} */ + required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + strict_required_status_checks_policy: boolean; + /** Format: date-time */ + updated_at: string; + }; /** @description A suite of checks performed on the code of a given code change */ "simple-check-suite": { after?: string | null; @@ -32562,6 +33647,224 @@ export interface components { status: "queued" | "in_progress" | "completed" | "pending"; url: string; }; + /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + webhooks_code_scanning_commit_oid: string; + /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + webhooks_code_scanning_ref: string; + /** @description The pusher type for the event. Can be either `user` or a deploy key. */ + webhooks_deploy_pusher_type: string; + /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ + webhooks_ref_0: string; + /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ + webhooks_deploy_key: { + added_by?: string | null; + created_at: string; + id: number; + key: string; + last_used?: string | null; + read_only: boolean; + title: string; + /** Format: uri */ + url: string; + verified: boolean; + }; + /** Workflow */ + webhooks_workflow: { + /** Format: uri */ + badge_url: string; + /** Format: date-time */ + created_at: string; + /** Format: uri */ + html_url: string; + id: number; + name: string; + node_id: string; + path: string; + state: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; + webhooks_approver: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + webhooks_reviewers: { + /** User */ + reviewer?: { + /** 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; + /** @enum {string} */ + type?: "User"; + }[]; + webhooks_workflow_job_run: { + conclusion: null; + created_at: string; + environment: string; + html_url: string; + id: number; + name: null; + status: string; + updated_at: string; + }; + /** User */ + webhooks_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; + 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; + webhooks_answer: { + /** + * 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"; + body: string; + child_comment_count: number; + /** Format: date-time */ + created_at: string; + discussion_id: number; + html_url: string; + id: number; + node_id: string; + parent_id: null; + /** 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; + }; + repository_url: string; + /** Format: date-time */ + updated_at: 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; + 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; + }; /** * Discussion * @description A Discussion in a repository. @@ -32704,1203 +34007,905 @@ export interface components { url?: string; } | null; }; - /** - * Merge Group - * @description A group of pull requests that the merge queue has grouped together to be merged. - * - */ - "merge-group": { - /** @description The SHA of the merge group. */ - head_sha: string; - /** @description The full ref of the merge group. */ - head_ref: string; - /** @description The SHA of the merge group's parent commit. */ - base_sha: string; - /** @description The full ref of the branch the merge group will be merged into. */ - base_ref: string; - head_commit: components["schemas"]["simple-commit"]; - }; - /** - * Personal Access Token Request - * @description Details of a Personal Access Token Request. - */ - "personal-access-token-request": { - /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */ - id: number; - owner: components["schemas"]["simple-user"]; - /** @description New requested permissions, categorized by type of permission. */ - permissions_added: { - organization?: { - [key: string]: string | undefined; - }; - repository?: { - [key: string]: string | undefined; - }; - other?: { - [key: string]: string | undefined; - }; - }; - /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ - permissions_upgraded: { - organization?: { - [key: string]: string | undefined; - }; - repository?: { - [key: string]: string | undefined; - }; - other?: { - [key: string]: string | undefined; - }; - }; - /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ - permissions_result: { - organization?: { - [key: string]: string | undefined; - }; - repository?: { - [key: string]: string | undefined; - }; - other?: { - [key: string]: string | undefined; - }; - }; + webhooks_comment: { /** - * @description Type of repository selection requested. + * AuthorAssociation + * @description How the author is associated with the repository. * @enum {string} */ - repository_selection: "none" | "all" | "subset"; - /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ - repository_count: number | null; - /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ - repositories: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[] | null; - /** @description Date and time when the request for access was created. */ + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + body: string; + child_comment_count: number; created_at: string; - /** @description Whether the associated fine-grained personal access token has expired. */ - token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ - token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ - token_last_used_at: string | null; - }; - /** - * Projects v2 Project - * @description A projects v2 project - */ - "projects-v2": { + discussion_id: number; + html_url: string; id: number; node_id: string; - owner: components["schemas"]["simple-user"]; - creator: components["schemas"]["simple-user"]; - title: string; - description: string | null; - public: boolean; - /** Format: date-time */ - closed_at: string | null; - /** Format: date-time */ - created_at: string; - /** Format: date-time */ + parent_id: number | null; + /** 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; + }; + repository_url: string; updated_at: string; - number: number; - short_description: string | null; - /** Format: date-time */ - deleted_at: string | null; - deleted_by: null | components["schemas"]["simple-user"]; + /** 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; + 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; + }; + /** Label */ + webhooks_label: { + /** @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; }; + /** @description An array of repository objects that the installation can access. */ + webhooks_repositories: { + full_name: string; + /** @description Unique identifier of the repository */ + id: number; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** @description Whether the repository is private or public. */ + private: boolean; + }[]; + /** @description An array of repository objects, which were added to the installation. */ + webhooks_repositories_added: { + full_name: string; + /** @description Unique identifier of the repository */ + id: number; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** @description Whether the repository is private or public. */ + private: boolean; + }[]; /** - * Projects v2 Item Content Type - * @description The type of content tracked in a project item + * @description Describe whether all repositories have been selected or there's a selection involved * @enum {string} */ - "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; + webhooks_repository_selection: "all" | "selected"; /** - * Projects v2 Item - * @description An item belonging to a project + * issue comment + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. */ - "projects-v2-item": { - id: number; - node_id?: string; - project_node_id?: string; - content_node_id: string; - content_type: components["schemas"]["projects-v2-item-content-type"]; - creator?: components["schemas"]["simple-user"]; + webhooks_issue_comment: { + /** + * 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 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"]["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: date-time */ - archived_at: string | null; - }; - /** - * @description The reason for resolving the alert. - * @enum {string|null} - */ - "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited" | null; - "secret-scanning-alert-webhook": { - number?: components["schemas"]["alert-number"]; - created_at?: components["schemas"]["alert-created-at"]; - updated_at?: null | components["schemas"]["alert-updated-at"]; - url?: components["schemas"]["alert-url"]; - html_url?: components["schemas"]["alert-html-url"]; /** * Format: uri - * @description The REST API URL of the code locations for this alert. - */ - locations_url?: string; - resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; - /** - * Format: date-time - * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - resolved_at?: string | null; - resolved_by?: null | components["schemas"]["simple-user"]; - /** @description An optional comment to resolve an alert. */ - resolution_comment?: string | null; - /** @description The type of secret that secret scanning detected. */ - secret_type?: string; - /** @description Whether push protection was bypassed for the detected secret. */ - push_protection_bypassed?: boolean | null; - push_protection_bypassed_by?: null | components["schemas"]["simple-user"]; - /** - * Format: date-time - * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + * @description URL for the issue comment */ - push_protection_bypassed_at?: string | null; - }; - /** branch protection configuration disabled event */ - "webhook-branch-protection-configuration-disabled": { - /** @enum {string} */ - action: "disabled"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection configuration enabled event */ - "webhook-branch-protection-configuration-enabled": { - /** @enum {string} */ - action: "enabled"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection rule created event */ - "webhook-branch-protection-rule-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; + 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; + 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} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + } | null; + }; + /** @description The changes to the comment. */ + webhooks_changes: { + body?: { + /** @description The previous version of the body. */ + from: string; + }; + }; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + webhooks_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; - ignore_approvals_from_contributors: boolean; + 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} */ - linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** 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} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** 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; - /** @enum {string} */ - pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection rule deleted event */ - "webhook-branch-protection-rule-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + /** Format: uri-template */ + labels_url: string; + locked?: boolean; /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + * Milestone + * @description A collection of related issues and pull requests. */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; /** Format: date-time */ created_at: string; - dismiss_stale_reviews_on_push: boolean; + /** 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; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - strict_required_status_checks_policy: boolean; + /** 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; - }; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection rule edited event */ - "webhook-branch-protection-rule-edited": { - /** @enum {string} */ - action: "edited"; - /** @description If the action was `edited`, the changes to the rule. */ - changes?: { - admin_enforced?: { - from: boolean | null; - }; - authorized_actor_names?: { - from: string[]; - }; - authorized_actors_only?: { - from: boolean | null; - }; - authorized_dismissal_actors_only?: { - from: boolean | null; - }; - linear_history_requirement_enforcement_level?: { + /** 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" | "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} */ - from: "off" | "non_admins" | "everyone"; - }; - required_status_checks?: { - from: string[]; - }; - required_status_checks_enforcement_level?: { + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + /** @description The set of permissions for the GitHub app */ + permissions?: { /** @enum {string} */ - from: "off" | "non_admins" | "everyone"; + 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; }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; + /** 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; /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + * @description State of the issue; either 'open' or 'closed' + * @enum {string} */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; + 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; id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; + 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} */ - signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Check Run Completed Event */ - "webhook-check-run-completed": { - /** @enum {string} */ - action?: "completed"; - check_run: components["schemas"]["check-run-with-simple-check-suite"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** - * Check Run Completed Event - * @description The check_run.completed webhook encoded with URL encoding - */ - "webhook-check-run-completed-form-encoded": { - /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */ - payload: string; - }; - /** Check Run Created Event */ - "webhook-check-run-created": { - /** @enum {string} */ - action?: "created"; - check_run: components["schemas"]["check-run-with-simple-check-suite"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + } | null; }; /** - * Check Run Created Event - * @description The check_run.created webhook encoded with URL encoding + * Milestone + * @description A collection of related issues and pull requests. */ - "webhook-check-run-created-form-encoded": { - /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */ - payload: string; - }; - /** Check Run Requested Action Event */ - "webhook-check-run-requested-action": { - /** @enum {string} */ - action: "requested_action"; - check_run: components["schemas"]["check-run-with-simple-check-suite"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - /** @description The action requested by the user. */ - requested_action?: { - /** @description The integrator reference of the action requested by the user. */ - identifier?: string; - }; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** - * Check Run Requested Action Event - * @description The check_run.requested_action webhook encoded with URL encoding - */ - "webhook-check-run-requested-action-form-encoded": { - /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */ - payload: string; - }; - /** Check Run Re-Requested Event */ - "webhook-check-run-rerequested": { - /** @enum {string} */ - action?: "rerequested"; - check_run: components["schemas"]["check-run-with-simple-check-suite"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + webhooks_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; + } | 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; }; /** - * Check Run Re-Requested Event - * @description The check_run.rerequested webhook encoded with URL encoding + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - "webhook-check-run-rerequested-form-encoded": { - /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */ - payload: string; - }; - /** check_suite completed event */ - "webhook-check-suite-completed": { - /** @enum {string} */ - action: "completed"; - /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - check_suite: { - after: string | null; - /** - * 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. - */ - 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" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; - /** 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; - } | 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; - }; - before: string | null; + webhooks_issue_2: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + /** User */ + assignee?: { /** Format: uri */ - check_runs_url: string; + 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; /** - * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. - * @enum {string|null} + * Format: uri + * @description URL for the label */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; + url: string; + }[]; + /** 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; - /** @description The head branch name the changes are on. */ - head_branch: string | null; - /** SimpleCommit */ - head_commit: { - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - author: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - committer: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - id: string; - message: string; - timestamp: string; - tree_id: string; - }; - /** @description The SHA of the head commit that is being checked. */ - head_sha: string; - id: number; - latest_check_runs_count: number; - node_id: string; - /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: 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; - number: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - url: string; - }[]; - rerequestable?: boolean; - runs_rerequestable?: boolean; + 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; + 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 summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - * @enum {string|null} + * @description The state of the milestone. + * @enum {string} */ - status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; /** Format: date-time */ updated_at: string; - /** - * Format: uri - * @description URL that points to the check suite API resource. - */ + /** Format: uri */ url: string; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** check_suite requested event */ - "webhook-check-suite-requested": { - /** @enum {string} */ - action: "requested"; - /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - check_suite: { - after: string | null; - /** - * 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. - */ - 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" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; - /** 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; - } | 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; - }; - before: string | null; - /** Format: uri */ - check_runs_url: string; - /** - * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. - * @enum {string|null} - */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; - /** Format: date-time */ - created_at: string; - /** @description The head branch name the changes are on. */ - head_branch: string | null; - /** SimpleCommit */ - head_commit: { - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - author: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - committer: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - id: string; - message: string; - timestamp: string; - tree_id: string; - }; - /** @description The SHA of the head commit that is being checked. */ - head_sha: string; - id: number; - latest_check_runs_count: number; - node_id: string; - /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - id: number; - number: number; - /** Format: uri */ - url: string; - }[]; - rerequestable?: boolean; - runs_rerequestable?: boolean; - /** - * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - * @enum {string|null} - */ - status: "requested" | "in_progress" | "completed" | "queued" | null; + } | 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 */ - updated_at: string; - /** - * Format: uri - * @description URL that points to the check suite API resource. - */ - url: string; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** check_suite rerequested event */ - "webhook-check-suite-rerequested": { - /** @enum {string} */ - action: "rerequested"; - /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - check_suite: { - after: string | null; - /** - * 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. - */ - 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" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[]; - /** 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; - } | 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; - }; - before: string | null; + 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")[]; /** Format: uri */ - check_runs_url: string; - /** - * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. - * @enum {string|null} - */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - created_at: string; - /** @description The head branch name the changes are on. */ - head_branch: string | null; - /** SimpleCommit */ - head_commit: { - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - author: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - committer: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - id: string; - message: string; - timestamp: string; - tree_id: string; - }; - /** @description The SHA of the head commit that is being checked. */ - head_sha: string; - id: number; - latest_check_runs_count: number; + 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; - /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - id: number; - number: number; - /** Format: uri */ - url: string; - }[]; - rerequestable?: boolean; - runs_rerequestable?: boolean; - /** - * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - * @enum {string|null} - */ - status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL that points to the check suite API resource. - */ - url: string; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert appeared_in_branch event */ - "webhook-code-scanning-alert-appeared-in-branch": { - /** @enum {string} */ - action: "appeared_in_branch"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - dismissed_at: string | null; /** User */ - dismissed_by: { + owner: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -33936,695 +34941,929 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** - * @description The reason for dismissing or closing the alert. - * @enum {string|null} - */ - dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - html_url: string; - /** Alert Instance */ - most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - number: number; - rule: { - /** @description A short description of the rule used to detect the alert. */ - description: string; - /** @description A unique identifier for the rule used to detect the alert. */ - id: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity: "none" | "note" | "warning" | "error" | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - tool: { - /** @description The name of the tool used to generate the code scanning analysis alert. */ - name: string; - /** @description The version of the tool used to detect the alert. */ - version: 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"; + /** @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; + }; + /** 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; }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - commit_oid: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - ref: string; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + /** 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; + 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; }; - /** code_scanning_alert closed_by_user event */ - "webhook-code-scanning-alert-closed-by-user": { + /** User */ + webhooks_user_mannequin: { + /** 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} */ - action: "closed_by_user"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - dismissed_at: string; - /** User */ - dismissed_by: { - /** 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; - /** - * @description The reason for dismissing or closing the alert. - * @enum {string|null} - */ - dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + } | null; + /** Marketplace Purchase */ + webhooks_marketplace_purchase: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: string | null; + next_billing_date: string | null; + on_free_trial: boolean; + plan: { + bullets: (string | null)[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; + /** @enum {string} */ + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; + }; + unit_count: number; + }; + /** Marketplace Purchase */ + webhooks_previous_marketplace_purchase: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: null; + next_billing_date?: string | null; + on_free_trial: boolean; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; + /** @enum {string} */ + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; + }; + unit_count: number; + }; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + webhooks_team: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ html_url: string; - /** Alert Instance */ - most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - number: number; - rule: { - /** @description A short description of the rule used to detect the alert. */ - description: string; - full_description?: string; - help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - id: string; - name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity: "none" | "note" | "warning" | "error" | null; - tags?: string[] | null; - }; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; /** - * @description State of a code scanning alert. + * @description Whether team members will receive notifications when their team is @mentioned * @enum {string} */ - state: "dismissed" | "fixed"; - tool: { - guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - name: string; - /** @description The version of the tool used to detect the alert. */ - version: string | null; - }; + notification_setting: "notifications_enabled" | "notifications_disabled"; /** Format: uri */ - url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - commit_oid: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - ref: string; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert created event */ - "webhook-code-scanning-alert-created": { - /** @enum {string} */ - action: "created"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string | null; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - dismissed_at: null; - dismissed_by: null; - dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - dismissed_reason: null; - fixed_at?: null; + repositories_url: string; + slug: string; /** * Format: uri - * @description The GitHub URL of the alert resource. - */ - html_url: string; - instances_url?: string; - /** Alert Instance */ - most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - number: number; - rule: { - /** @description A short description of the rule used to detect the alert. */ - description: string; - full_description?: string; - help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - id: string; - name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity: "none" | "note" | "warning" | "error" | null; - tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} + * @description URL for the team */ - state: "open" | "dismissed"; - tool: { - guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - name: string; - /** @description The version of the tool used to detect the alert. */ - version: string | null; - } | null; - updated_at?: string | null; - /** Format: uri */ url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - commit_oid: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - ref: string; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert fixed event */ - "webhook-code-scanning-alert-fixed": { + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; /** @enum {string} */ - action: "fixed"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - dismissed_at: string | null; - /** User */ - dismissed_by: { - /** 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; - /** - * @description The reason for dismissing or closing the alert. - * @enum {string|null} - */ - dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - html_url: string; + privacy?: "open" | "closed" | "secret"; + /** @enum {string} */ + notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; + }; + /** + * Merge Group + * @description A group of pull requests that the merge queue has grouped together to be merged. + * + */ + "merge-group": { + /** @description The SHA of the merge group. */ + head_sha: string; + /** @description The full ref of the merge group. */ + head_ref: string; + /** @description The SHA of the merge group's parent commit. */ + base_sha: string; + /** @description The full ref of the branch the merge group will be merged into. */ + base_ref: string; + head_commit: components["schemas"]["simple-commit"]; + }; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + webhooks_milestone_3: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { /** Format: uri */ - instances_url?: string; - /** Alert Instance */ - most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - number: number; - rule: { - /** @description A short description of the rule used to detect the alert. */ - description: string; - full_description?: string; - help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - id: string; - name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity: "none" | "note" | "warning" | "error" | null; - tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "fixed"; - tool: { - guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - name: string; - /** @description The version of the tool used to detect the alert. */ - version: string | null; - }; + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; /** Format: uri */ - url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - commit_oid: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - ref: string; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + 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; + 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; }; - /** code_scanning_alert reopened event */ - "webhook-code-scanning-alert-reopened": { - /** @enum {string} */ - action: "reopened"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - dismissed_at: string | null; - dismissed_by: Record | null; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - dismissed_reason: string | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - html_url: string; - /** Alert Instance */ - most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - number: number; - rule: { - /** @description A short description of the rule used to detect the alert. */ - description: string; - full_description?: string; - help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - id: string; - name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity: "none" | "note" | "warning" | "error" | null; - tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - tool: { - guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - name: string; - /** @description The version of the tool used to detect the alert. */ - version: string | null; - }; + /** + * Membership + * @description The membership between the user and the organization. Not present when the action is `member_invited`. + */ + webhooks_membership: { + /** Format: uri */ + organization_url: string; + role: string; + state: string; + /** Format: uri */ + url: string; + /** User */ + user: { /** Format: uri */ - url: string; + 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; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - commit_oid: string | null; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - ref: string | null; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; }; - /** code_scanning_alert reopened_by_user event */ - "webhook-code-scanning-alert-reopened-by-user": { - /** @enum {string} */ - action: "reopened_by_user"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - dismissed_at: null; - dismissed_by: null; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - dismissed_reason: null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - html_url: string; - /** Alert Instance */ - most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - number: number; - rule: { - /** @description A short description of the rule used to detect the alert. */ - description: string; - /** @description A unique identifier for the rule used to detect the alert. */ - id: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity: "none" | "note" | "warning" | "error" | null; + /** + * Personal Access Token Request + * @description Details of a Personal Access Token Request. + */ + "personal-access-token-request": { + /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */ + id: number; + owner: components["schemas"]["simple-user"]; + /** @description New requested permissions, categorized by type of permission. */ + permissions_added: { + organization?: { + [key: string]: string | undefined; }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "fixed"; - tool: { - /** @description The name of the tool used to generate the code scanning analysis alert. */ - name: string; - /** @description The version of the tool used to detect the alert. */ - version: string | null; + repository?: { + [key: string]: string | undefined; + }; + other?: { + [key: string]: string | undefined; + }; + }; + /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ + permissions_upgraded: { + organization?: { + [key: string]: string | undefined; + }; + repository?: { + [key: string]: string | undefined; + }; + other?: { + [key: string]: string | undefined; + }; + }; + /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ + permissions_result: { + organization?: { + [key: string]: string | undefined; + }; + repository?: { + [key: string]: string | undefined; + }; + other?: { + [key: string]: string | undefined; }; - /** Format: uri */ - url: string; }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - commit_oid: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - ref: string; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** commit_comment created event */ - "webhook-commit-comment-created": { /** - * @description The action performed. Can be `created`. + * @description Type of repository selection requested. * @enum {string} */ - action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ - comment: { - /** - * 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 The text of the comment. */ - body: string; - /** @description The SHA of the commit to which the comment applies. */ - commit_id: string; - created_at: string; - /** Format: uri */ - html_url: string; - /** @description The ID of the commit comment. */ + repository_selection: "none" | "all" | "subset"; + /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + repository_count: number | null; + /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + repositories: { + full_name: string; + /** @description Unique identifier of the repository */ id: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - line: number | null; - /** @description The node ID of the commit comment. */ + /** @description The name of the repository. */ + name: string; node_id: string; - /** @description The relative path of the file to which the comment applies. */ - path: string | null; - /** @description The line index in the diff to which the comment applies. */ - position: number | null; - /** 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; - }; - updated_at: string; - /** Format: uri */ - 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; + /** @description Whether the repository is private or public. */ + private: boolean; + }[] | null; + /** @description Date and time when the request for access was created. */ + created_at: string; + /** @description Whether the associated fine-grained personal access token has expired. */ + token_expired: boolean; + /** @description Date and time when the associated fine-grained personal access token expires. */ + token_expires_at: string | null; + /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + token_last_used_at: string | null; + }; + /** Project Card */ + webhooks_project_card: { + after_id?: number | null; + /** @description Whether or not the card is archived */ + archived: boolean; + column_id: number; + /** Format: uri */ + column_url: string; + /** Format: uri */ + content_url?: string; + /** 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"; + /** Format: uri */ + url?: string; + } | null; + /** @description The project card's ID */ + id: number; + node_id: string; + note: string | null; + /** Format: uri */ + project_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + }; + /** Project */ + webhooks_project: { + /** @description Body of the project */ + body: string | null; + /** Format: uri */ + columns_url: string; + /** 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"; + /** Format: uri */ + url?: string; + } | null; + /** Format: uri */ + html_url: string; + id: number; + /** @description Name of the project */ + name: string; + node_id: string; + number: number; + /** Format: uri */ + owner_url: string; + /** + * @description State of the project; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + }; + /** Project Column */ + webhooks_project_column: { + after_id?: number | null; + /** Format: uri */ + cards_url: string; + /** Format: date-time */ + created_at: string; + /** @description The unique identifier of the project column */ + id: number; + /** @description Name of the project column */ + name: string; + node_id: string; + /** Format: uri */ + project_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + }; + /** + * Projects v2 Project + * @description A projects v2 project + */ + "projects-v2": { + id: number; + node_id: string; + owner: components["schemas"]["simple-user"]; + creator: components["schemas"]["simple-user"]; + title: string; + description: string | null; + public: boolean; + /** Format: date-time */ + closed_at: string | null; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + number: number; + short_description: string | null; + /** Format: date-time */ + deleted_at: string | null; + deleted_by: null | components["schemas"]["simple-user"]; + }; + webhooks_project_changes: { + archived_at?: { + /** Format: date-time */ + from?: string | null; + /** Format: date-time */ + to?: string | null; + }; + }; + /** + * Projects v2 Item Content Type + * @description The type of content tracked in a project item + * @enum {string} + */ + "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + "projects-v2-item": { + id: number; + node_id?: string; + project_node_id?: string; + content_node_id: string; + content_type: components["schemas"]["projects-v2-item-content-type"]; + creator?: components["schemas"]["simple-user"]; + /** Format: date-time */ + created_at: string; + /** Format: date-time */ + updated_at: string; + /** Format: date-time */ + archived_at: string | null; + }; + /** @description The pull request number. */ + webhooks_number: number; + "pull-request-webhook": components["schemas"]["pull-request"] & { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow updating the pull request's branch. */ + allow_update_branch?: boolean; + /** + * @description Whether to delete head branches when pull requests are merged. + * @default false + */ + delete_branch_on_merge: boolean; + /** + * @description The default value for a merge commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** + * @description The default value for a squash merge commit message: + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @default false + */ + use_squash_pr_title_as_default: boolean; + }; + /** Pull Request */ + webhooks_pull_request_5: { + _links: { + /** Link */ + comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + commits: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + issue: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comment: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + statuses: { + /** Format: uri-template */ + href: string; + }; + }; + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; + /** 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; + } | 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; + } | 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"; + /** + * PullRequestAutoMerge + * @description The status of auto merging a pull request. + */ + auto_merge: { + /** @description Commit message for the merge commit. */ + commit_message: string | null; + /** @description Title for the merge commit message. */ + commit_title: string | null; + /** User */ + enabled_by: { + /** 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; @@ -34645,293 +35884,189 @@ export interface components { /** Format: uri */ url?: string; } | null; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** create event */ - "webhook-create": { - /** @description The repository's current description. */ - description: string | null; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The name of the repository's default branch (usually `main`). */ - master_branch: string; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The pusher type for the event. Can be either `user` or a deploy key. */ - pusher_type: string; - /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ - ref: string; - /** - * @description The type of Git ref object created in the repository. - * @enum {string} - */ - ref_type: "tag" | "branch"; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** custom property created event */ - "webhook-custom-property-created": { - /** @enum {string} */ - action: "created"; - definition: components["schemas"]["org-custom-property"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** custom property deleted event */ - "webhook-custom-property-deleted": { - /** @enum {string} */ - action: "deleted"; - definition: { - /** @description The name of the property that was deleted. */ - property_name: string; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** custom property updated event */ - "webhook-custom-property-updated": { - /** @enum {string} */ - action: "updated"; - definition: components["schemas"]["org-custom-property"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** Custom property values updated event */ - "webhook-custom-property-values-updated": { - /** @enum {string} */ - action: "updated"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - repository: components["schemas"]["repository-webhooks"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - /** @description The new custom property values for the repository. */ - new_property_values: components["schemas"]["custom-property-value"][]; - /** @description The old custom property values for the repository. */ - old_property_values: components["schemas"]["custom-property-value"][]; - }; - /** delete event */ - "webhook-delete": { - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The pusher type for the event. Can be either `user` or a deploy key. */ - pusher_type: string; - /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ - ref: string; - /** - * @description The type of Git ref object deleted in the repository. - * @enum {string} - */ - ref_type: "tag" | "branch"; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert auto-dismissed event */ - "webhook-dependabot-alert-auto-dismissed": { - /** @enum {string} */ - action: "auto_dismissed"; - alert: components["schemas"]["dependabot-alert"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert auto-reopened event */ - "webhook-dependabot-alert-auto-reopened": { - /** @enum {string} */ - action: "auto_reopened"; - alert: components["schemas"]["dependabot-alert"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert created event */ - "webhook-dependabot-alert-created": { - /** @enum {string} */ - action: "created"; - alert: components["schemas"]["dependabot-alert"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert dismissed event */ - "webhook-dependabot-alert-dismissed": { - /** @enum {string} */ - action: "dismissed"; - alert: components["schemas"]["dependabot-alert"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert fixed event */ - "webhook-dependabot-alert-fixed": { - /** @enum {string} */ - action: "fixed"; - alert: components["schemas"]["dependabot-alert"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert reintroduced event */ - "webhook-dependabot-alert-reintroduced": { - /** @enum {string} */ - action: "reintroduced"; - alert: components["schemas"]["dependabot-alert"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert reopened event */ - "webhook-dependabot-alert-reopened": { - /** @enum {string} */ - action: "reopened"; - alert: components["schemas"]["dependabot-alert"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** deploy_key created event */ - "webhook-deploy-key-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ - key: { - added_by?: string | null; - created_at: string; - id: number; - key: string; - last_used?: string | null; - read_only: boolean; - title: string; - /** Format: uri */ - url: string; - verified: boolean; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** deploy_key deleted event */ - "webhook-deploy-key-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ - key: { - added_by?: string | null; - created_at: string; - id: number; - key: string; - last_used?: string | null; - read_only: boolean; - title: string; - /** Format: uri */ - url: string; - verified: boolean; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** deployment created event */ - "webhook-deployment-created": { - /** @enum {string} */ - action: "created"; - /** - * Deployment - * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). - */ - deployment: { - created_at: string; - /** User */ - creator: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; + /** + * @description The merge method to use. + * @enum {string} + */ + merge_method: "merge" | "squash" | "rebase"; + } | null; + base: { + label: string; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - events_url?: string; + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; /** Format: uri */ - followers_url?: string; + clone_url: string; /** Format: uri-template */ - following_url?: string; + collaborators_url: string; /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; /** Format: uri */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; /** Format: uri */ - organizations_url?: string; + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; /** Format: uri */ - received_events_url?: string; + downloads_url: string; /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; + events_url: string; + fork: boolean; + forks: number; + forks_count: number; /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; /** Format: uri */ - url?: string; - } | null; - description: string | null; - environment: string; - id: number; - node_id: string; - original_environment: string; - payload: Record | string; - /** - * 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" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; /** Format: uri */ - external_url: string | null; + hooks_url: string; /** Format: uri */ html_url: string; - /** @description Unique identifier of the GitHub app */ - id: number | null; - /** @description The name of the GitHub app */ + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ name: string; node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ owner: { /** Format: uri */ @@ -34969,124 +36104,79 @@ export interface components { /** Format: uri */ url?: 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"; - /** @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"; + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; - /** @description The slug name of the GitHub app */ - slug?: string; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: null | number | string; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; /** Format: date-time */ - updated_at: string | null; - } | null; - production_environment?: boolean; - ref: string; - /** Format: uri */ - repository_url: string; + updated_at: string; + /** Format: uri */ + url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. + * @default false + */ + use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + }; sha: string; - /** Format: uri */ - statuses_url: string; - task: string; - transient_environment?: boolean; - updated_at: string; - /** Format: uri */ - url: string; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - workflow: { - /** Format: uri */ - badge_url: string; - /** Format: date-time */ - created_at: string; - /** Format: uri */ - html_url: string; - id: number; - name: string; - node_id: string; - path: string; - state: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - } | null; - /** Deployment Workflow Run */ - workflow_run: { /** User */ - actor: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -35122,205 +36212,311 @@ export interface components { /** Format: uri */ url?: string; } | null; - artifacts_url?: string; - cancel_url?: string; - check_suite_id: number; - check_suite_node_id: string; - check_suite_url?: string; - /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - created_at: string; - display_title: string; - event: string; - head_branch: string; - head_commit?: null; - head_repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - head_sha: string; - /** Format: uri */ - html_url: string; - id: number; - jobs_url?: string; - logs_url?: string; - name: string; - node_id: string; - path: string; - previous_attempt_url?: null; - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; + }; + body: string | null; + changed_files?: number; + /** Format: date-time */ + closed_at: string | null; + comments?: number; + /** Format: uri */ + comments_url: string; + commits?: number; + /** Format: uri */ + commits_url: string; + /** Format: date-time */ + created_at: string; + deletions?: number; + /** Format: uri */ + diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ + draft: boolean; + head: { + label: string; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ id: number; - number: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; /** Format: uri */ - url: string; - }[]; - referenced_workflows?: { - path: string; - ref?: string; - sha: string; - }[] | null; - repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: 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; + 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; - type?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ url?: string; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: null | number | string; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. + * @default false + */ + use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; }; - rerun_url?: string; - run_attempt: number; - run_number: number; - /** Format: date-time */ - run_started_at: string; - /** @enum {string} */ - status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + sha: string; /** User */ - triggering_actor?: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -35356,65 +36552,85 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ + }; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + issue_url: string; + 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; - workflow_id: number; - workflow_url?: string; - } | null; - }; - /** deployment protection rule requested event */ - "webhook-deployment-protection-rule-requested": { - /** @enum {string} */ - action?: "requested"; - /** @description The name of the environment that has the deployment protection rule. */ - environment?: string; - /** @description The event that triggered the deployment protection rule. */ - event?: string; - /** - * Format: uri - * @description The URL to review the deployment protection rule. - */ - deployment_callback_url?: string; - deployment?: components["schemas"]["deployment"]; - pull_requests?: components["schemas"]["pull-request"][]; - repository?: components["schemas"]["repository-webhooks"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - "webhook-deployment-review-approved": { - /** @enum {string} */ - action: "approved"; - approver?: { + }[]; + locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ + merged_at: string | null; + /** User */ + merged_by?: { + /** 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; + 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; - type?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ url?: string; - }; - comment?: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - reviewers?: { + } | null; + /** + * 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 */ - reviewer?: { + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -35446,39 +36662,478 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - /** @enum {string} */ - type?: "User"; - }[]; - sender: components["schemas"]["simple-user-webhooks"]; - since: string; - workflow_job_run?: { - conclusion: null; - created_at: string; - environment: string; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ html_url: string; id: number; - name: null; - status: string; - updated_at: string; - }; - workflow_job_runs?: { - conclusion?: null; - created_at?: string; - environment?: string; + /** 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; + /** @description Number uniquely identifying the pull request within its repository. */ + number: number; + /** Format: uri */ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ + /** 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; - name?: string | null; - status?: string; - updated_at?: 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) | { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; + })[]; + requested_teams: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; }[]; - /** Deployment Workflow Run */ - workflow_run: { + /** Format: uri-template */ + review_comment_url: string; + review_comments?: number; + /** Format: uri */ + review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + state: "open" | "closed"; + /** Format: uri */ + statuses_url: string; + /** @description The title of the pull request. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + 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; + 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; + } | null; + }; + /** + * Pull Request Review Comment + * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. + */ + webhooks_review_comment: { + _links: { + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + pull_request: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + }; + /** + * 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 The text of the comment. */ + body: string; + /** @description The SHA of the commit to which the comment applies. */ + commit_id: string; + /** Format: date-time */ + created_at: string; + /** @description The diff of the line that the comment refers to. */ + diff_hunk: string; + /** + * Format: uri + * @description HTML URL for the pull request review comment. + */ + html_url: string; + /** @description The ID of the pull request review comment. */ + id: number; + /** @description The comment ID to reply to. */ + in_reply_to_id?: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + line: number | null; + /** @description The node ID of the pull request review comment. */ + node_id: string; + /** @description The SHA of the original commit to which the comment applies. */ + original_commit_id: string; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + original_line: number; + /** @description The index of the original line in the diff to which the comment applies. */ + original_position: number; + /** @description The first line of the range for a multi-line comment. */ + original_start_line: number | null; + /** @description The relative path of the file to which the comment applies. */ + path: string; + /** @description The line index in the diff to which the comment applies. */ + position: number | null; + /** @description The ID of the pull request review to which the comment belongs. */ + pull_request_review_id: number | null; + /** + * Format: uri + * @description URL for the pull request that the review comment belongs to. + */ + pull_request_url: string; + /** 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; + }; + /** + * @description The side of the first line of the range for a multi-line comment. + * @enum {string} + */ + side: "LEFT" | "RIGHT"; + /** @description The first line of the range for a multi-line comment. */ + start_line: number | null; + /** + * @description The side of the first line of the range for a multi-line comment. + * @default RIGHT + * @enum {string|null} + */ + start_side: "LEFT" | "RIGHT" | null; + /** + * @description The level at which the comment is targeted, can be a diff line or a file. + * @enum {string} + */ + subject_type?: "line" | "file"; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the pull request review 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; + 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; + }; + /** @description The review that was affected. */ + webhooks_review: { + _links: { + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + pull_request: { + /** Format: uri-template */ + href: string; + }; + }; + /** + * 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 The text of the review. */ + body: string | null; + /** @description A commit SHA for the review. */ + commit_id: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the review */ + id: number; + node_id: string; + /** Format: uri */ + pull_request_url: string; + state: string; + /** Format: date-time */ + submitted_at: string | null; + /** 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; + 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; + }; + webhooks_nullable_string: string | null; + /** + * Release + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. + */ + webhooks_release: { + assets: { + /** Format: uri */ + browser_download_url: string; + content_type: string; + /** Format: date-time */ + created_at: string; + download_count: number; + id: number; + label: string | null; + /** @description The file name of the asset. */ + name: string; + node_id: string; + size: number; + /** + * @description State of the release asset. + * @enum {string} + */ + state: "uploaded"; + /** Format: date-time */ + updated_at: string; /** User */ - actor: { + uploader?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -35514,205 +37169,118 @@ export interface components { /** Format: uri */ url?: string; } | null; - artifacts_url?: string; - cancel_url?: string; - check_suite_id: number; - check_suite_node_id: string; - check_suite_url?: string; - /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - created_at: string; - display_title: string; - event: string; - head_branch: string; - head_commit?: Record | null; - head_repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - head_sha: string; /** Format: uri */ - html_url: string; + url: string; + }[]; + /** Format: uri */ + assets_url: string; + /** User */ + author: { + /** 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; - jobs_url?: string; - logs_url?: string; + 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; + body: string | null; + /** Format: date-time */ + created_at: string | null; + /** Format: uri */ + discussion_url?: string; + /** @description Whether the release is a draft or published */ + draft: boolean; + /** Format: uri */ + html_url: string; + id: number; + name: string | null; + node_id: string; + /** @description Whether the release is identified as a prerelease or a full release. */ + prerelease: boolean; + /** Format: date-time */ + published_at: string | null; + /** 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; + }; + /** @description The name of the tag. */ + tag_name: string; + /** Format: uri */ + tarball_url: string | null; + /** @description Specifies the commitish value that determines where the Git tag is created from. */ + target_commitish: string; + /** Format: uri-template */ + upload_url: string; + /** Format: uri */ + url: string; + /** Format: uri */ + zipball_url: string | null; + }; + /** + * Release + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. + */ + webhooks_release_1: { + assets: ({ + /** Format: uri */ + browser_download_url: string; + content_type: string; + /** Format: date-time */ + created_at: string; + download_count: number; + id: number; + label: string | null; + /** @description The file name of the asset. */ name: string; node_id: string; - path: string; - previous_attempt_url?: string | null; - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - id: number; - number: number; - /** Format: uri */ - url: string; - }[]; - referenced_workflows?: { - path: string; - ref?: string; - sha: string; - }[] | null; - repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - rerun_url?: string; - run_attempt: number; - run_number: number; + size: number; + /** + * @description State of the release asset. + * @enum {string} + */ + state: "uploaded"; /** Format: date-time */ - run_started_at: string; - /** @enum {string} */ - status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + updated_at: string; /** User */ - triggering_actor: { + uploader?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -35748,18 +37316,234 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** Format: date-time */ - updated_at: string; /** Format: uri */ url: string; - workflow_id: number; - workflow_url?: string; + } | null)[]; + /** Format: uri */ + assets_url: string; + /** User */ + author: { + /** 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; + body: string | null; + /** Format: date-time */ + created_at: string | null; + /** Format: uri */ + discussion_url?: string; + /** @description Whether the release is a draft or published */ + draft: boolean; + /** Format: uri */ + html_url: string; + id: number; + name: string | null; + node_id: string; + /** @description Whether the release is identified as a prerelease or a full release. */ + prerelease: boolean; + /** Format: date-time */ + published_at: string | null; + /** 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; + }; + /** @description The name of the tag. */ + tag_name: string; + /** Format: uri */ + tarball_url: string | null; + /** @description Specifies the commitish value that determines where the Git tag is created from. */ + target_commitish: string; + /** Format: uri-template */ + upload_url: string; + /** Format: uri */ + url: string; + /** Format: uri */ + zipball_url: string | null; }; - "webhook-deployment-review-rejected": { + /** + * Repository Vulnerability Alert Alert + * @description The security alert of the vulnerable dependency. + */ + webhooks_alert: { + affected_package_name: string; + affected_range: string; + created_at: string; + dismiss_reason?: string; + dismissed_at?: string; + /** User */ + dismisser?: { + /** 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; + external_identifier: string; + /** Format: uri */ + external_reference: string | null; + fix_reason?: string; + /** Format: date-time */ + fixed_at?: string; + fixed_in?: string; + ghsa_id: string; + id: number; + node_id: string; + number: number; + severity: string; /** @enum {string} */ - action: "rejected"; - approver?: { + state: "open"; + }; + /** + * @description The reason for resolving the alert. + * @enum {string|null} + */ + "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited" | null; + "secret-scanning-alert-webhook": { + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + updated_at?: null | components["schemas"]["alert-updated-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; + /** + * Format: uri + * @description The REST API URL of the code locations for this alert. + */ + locations_url?: string; + resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + resolved_at?: string | null; + resolved_by?: null | components["schemas"]["simple-user"]; + /** @description An optional comment to resolve an alert. */ + resolution_comment?: string | null; + /** @description The type of secret that secret scanning detected. */ + secret_type?: string; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + validity?: "active" | "inactive" | "unknown"; + /** @description Whether push protection was bypassed for the detected secret. */ + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: null | components["schemas"]["simple-user"]; + /** + * Format: date-time + * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + push_protection_bypassed_at?: string | null; + }; + /** @description The details of the security advisory, including summary, description, and severity. */ + webhooks_security_advisory: { + cvss: { + score: number; + vector_string: string | null; + }; + cwes: { + cwe_id: string; + name: string; + }[]; + description: string; + ghsa_id: string; + identifiers: { + type: string; + value: string; + }[]; + published_at: string; + references: { + /** Format: uri */ + url: string; + }[]; + severity: string; + summary: string; + updated_at: string; + vulnerabilities: { + first_patched_version: { + identifier: string; + } | null; + package: { + ecosystem: string; + name: string; + }; + severity: string; + vulnerable_version_range: string; + }[]; + withdrawn_at: string | null; + }; + webhooks_sponsorship: { + created_at: string; + maintainer?: { avatar_url?: string; events_url?: string; followers_url?: string; @@ -35779,380 +37563,62 @@ export interface components { type?: string; url?: string; }; - comment?: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - reviewers?: { - /** User */ - reviewer?: { - /** 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; + node_id: string; + privacy_level: string; + /** User */ + sponsor: { + /** 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?: "User"; - }[]; - sender: components["schemas"]["simple-user-webhooks"]; - since: string; - workflow_job_run?: { - conclusion: null; - created_at: string; - environment: string; - html_url: string; - id: number; - name: null; - status: string; - updated_at: string; - }; - workflow_job_runs?: { - conclusion?: string | null; - created_at?: string; - environment?: string; - html_url?: string; - id?: number; - name?: string | null; - status?: string; - updated_at?: string; - }[]; - /** Deployment Workflow Run */ - workflow_run: { - /** User */ - actor: { - /** 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; - artifacts_url?: string; - cancel_url?: string; - check_suite_id: number; - check_suite_node_id: string; - check_suite_url?: string; - /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - created_at: string; - event: string; - head_branch: string; - head_commit?: Record | null; - head_repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - head_sha: string; - /** Format: uri */ - html_url: string; - id: number; - jobs_url?: string; - logs_url?: string; - name: string; - node_id: string; - path: string; - previous_attempt_url?: string | null; - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - id: number; - number: number; - /** Format: uri */ - url: string; - }[]; - referenced_workflows?: { - path: string; - ref?: string; - sha: string; - }[] | null; - repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - rerun_url?: string; - run_attempt: number; - run_number: number; - /** Format: date-time */ - run_started_at: string; - /** @enum {string} */ - status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; - /** User */ - triggering_actor: { - /** 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; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - workflow_id: number; - workflow_url?: string; - display_title: string; - } | null; - }; - "webhook-deployment-review-requested": { - /** @enum {string} */ - action: "requested"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - environment: string; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - /** User */ - requestor: { - /** 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; + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + /** User */ + sponsorable: { + /** 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; @@ -36173,433 +37639,281 @@ export interface components { /** Format: uri */ url?: string; } | null; - reviewers: { - /** User */ - reviewer?: { - /** 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; - /** @enum {string} */ - type?: "User" | "Team"; - }[]; - sender: components["schemas"]["simple-user-webhooks"]; - since: string; - workflow_job_run: { - conclusion: null; + /** + * Sponsorship Tier + * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. + */ + tier: { created_at: string; - environment: string; + description: string; + is_custom_ammount?: boolean; + is_custom_amount?: boolean; + is_one_time: boolean; + monthly_price_in_cents: number; + monthly_price_in_dollars: number; + name: string; + node_id: string; + }; + }; + /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ + webhooks_effective_date: string; + webhooks_changes_8: { + tier: { + /** + * Sponsorship Tier + * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. + */ + from: { + created_at: string; + description: string; + is_custom_ammount?: boolean; + is_custom_amount?: boolean; + is_one_time: boolean; + monthly_price_in_cents: number; + monthly_price_in_dollars: number; + name: string; + node_id: string; + }; + }; + }; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + webhooks_team_1: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ html_url: string; + /** @description Unique identifier of the team */ id: number; - name: string | null; - status: string; - updated_at: string; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** + * @description Whether team members will receive notifications when their team is @mentioned + * @enum {string} + */ + notification_setting: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** + * @description Whether team members will receive notifications when their team is @mentioned + * @enum {string} + */ + notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; + }; + /** branch protection configuration disabled event */ + "webhook-branch-protection-configuration-disabled": { + /** @enum {string} */ + action: "disabled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection configuration enabled event */ + "webhook-branch-protection-configuration-enabled": { + /** @enum {string} */ + action: "enabled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection rule created event */ + "webhook-branch-protection-rule-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + rule: components["schemas"]["webhooks_rule"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection rule deleted event */ + "webhook-branch-protection-rule-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + rule: components["schemas"]["webhooks_rule"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection rule edited event */ + "webhook-branch-protection-rule-edited": { + /** @enum {string} */ + action: "edited"; + /** @description If the action was `edited`, the changes to the rule. */ + changes?: { + admin_enforced?: { + from: boolean | null; + }; + authorized_actor_names?: { + from: string[]; + }; + authorized_actors_only?: { + from: boolean | null; + }; + authorized_dismissal_actors_only?: { + from: boolean | null; + }; + linear_history_requirement_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + required_status_checks?: { + from: string[]; + }; + required_status_checks_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; }; - /** Deployment Workflow Run */ - workflow_run: { - /** User */ - actor: { - /** 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; - artifacts_url?: string; - cancel_url?: string; - check_suite_id: number; - check_suite_node_id: string; - check_suite_url?: string; - /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - created_at: string; - event: string; - head_branch: string; - head_commit?: Record | null; - head_repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - head_sha: string; - /** Format: uri */ - html_url: string; - id: number; - jobs_url?: string; - logs_url?: string; - name: string; - node_id: string; - path: string; - previous_attempt_url?: string | null; - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - id: number; - number: number; - /** Format: uri */ - url: string; - }[]; - referenced_workflows?: { - path: string; - ref?: string; - sha: string; - }[] | null; - repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - rerun_url?: string; - run_attempt: number; - run_number: number; - /** Format: date-time */ - run_started_at: string; - /** @enum {string} */ - status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ - triggering_actor: { - /** 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; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - workflow_id: number; - workflow_url?: string; - display_title: string; - } | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + rule: components["schemas"]["webhooks_rule"]; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** deployment_status created event */ - "webhook-deployment-status-created": { + /** Check Run Completed Event */ + "webhook-check-run-completed": { /** @enum {string} */ - action: "created"; - check_run?: { - /** Format: date-time */ - completed_at: string | null; - /** - * @description The result of the completed check run. This value will be `null` until the check run has completed. - * @enum {string|null} - */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; - /** Format: uri */ - details_url: string; - external_id: string; - /** @description The SHA of the commit that is being checked. */ - head_sha: string; - /** Format: uri */ - html_url: string; - /** @description The id of the check. */ - id: number; - /** @description The name of the check run. */ - name: string; - node_id: string; - /** Format: date-time */ - started_at: string; - /** - * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. - * @enum {string} - */ - status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; - /** Format: uri */ - url: string; - } | null; - /** - * Deployment - * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). - */ - deployment: { - 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"; - /** Format: uri */ - url?: string; - } | null; - description: string | null; - environment: string; - id: number; - node_id: string; - original_environment: string; - payload: (null | Record) & (string | Record); + action?: "completed"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Completed Event + * @description The check_run.completed webhook encoded with URL encoding + */ + "webhook-check-run-completed-form-encoded": { + /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */ + payload: string; + }; + /** Check Run Created Event */ + "webhook-check-run-created": { + /** @enum {string} */ + action?: "created"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Created Event + * @description The check_run.created webhook encoded with URL encoding + */ + "webhook-check-run-created-form-encoded": { + /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */ + payload: string; + }; + /** Check Run Requested Action Event */ + "webhook-check-run-requested-action": { + /** @enum {string} */ + action: "requested_action"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + /** @description The action requested by the user. */ + requested_action?: { + /** @description The integrator reference of the action requested by the user. */ + identifier?: string; + }; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Requested Action Event + * @description The check_run.requested_action webhook encoded with URL encoding + */ + "webhook-check-run-requested-action-form-encoded": { + /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */ + payload: string; + }; + /** Check Run Re-Requested Event */ + "webhook-check-run-rerequested": { + /** @enum {string} */ + action?: "rerequested"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Re-Requested Event + * @description The check_run.rerequested webhook encoded with URL encoding + */ + "webhook-check-run-rerequested-form-encoded": { + /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */ + payload: string; + }; + /** check_suite completed event */ + "webhook-check-suite-completed": { + /** @enum {string} */ + action: "completed"; + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ + check_suite: { + after: string | null; /** * 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?: { + 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" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; + 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" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -36683,7 +37997,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} */ @@ -36699,7 +38013,7 @@ export interface components { /** @enum {string} */ repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects?: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ @@ -36723,81 +38037,124 @@ export interface components { slug?: string; /** Format: date-time */ updated_at: string | null; - } | null; - production_environment?: boolean; - ref: string; - /** Format: uri */ - repository_url: string; - sha: string; - /** Format: uri */ - statuses_url: string; - task: string; - transient_environment?: boolean; - updated_at: string; + }; + before: string | null; /** Format: uri */ - url: string; - }; - /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ - deployment_status: { + check_runs_url: string; + /** + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. + * @enum {string|null} + */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; + /** 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"; - /** Format: uri */ - url?: string; - } | null; - /** Format: uri */ - deployment_url: string; - /** @description The optional human-readable description added to the status. */ - description: string; - environment: string; - /** Format: uri */ - environment_url?: string; + /** @description The head branch name the changes are on. */ + head_branch: string | null; + /** SimpleCommit */ + head_commit: { + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + author: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + committer: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + id: string; + message: string; + timestamp: string; + tree_id: string; + }; + /** @description The SHA of the head commit that is being checked. */ + head_sha: string; id: number; - /** Format: uri */ - log_url?: string; + latest_check_runs_count: number; node_id: string; + /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; + /** Format: uri */ + url: string; + }[]; + rerequestable?: boolean; + runs_rerequestable?: boolean; + /** + * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + * @enum {string|null} + */ + status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL that points to the check suite API resource. + */ + url: string; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** check_suite requested event */ + "webhook-check-suite-requested": { + /** @enum {string} */ + action: "requested"; + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ + check_suite: { + after: string | null; /** * 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?: { + 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" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; + 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" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -36881,7 +38238,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} */ @@ -36897,7 +38254,7 @@ export interface components { /** @enum {string} */ repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects?: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ @@ -36921,15 +38278,99 @@ export interface components { slug?: string; /** Format: date-time */ updated_at: string | null; - } | null; + }; + before: string | null; /** Format: uri */ - repository_url: string; - /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ - state: string; - /** @description The optional link added to the status. */ - target_url: string; + check_runs_url: string; + /** + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. + * @enum {string|null} + */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; + /** Format: date-time */ + created_at: string; + /** @description The head branch name the changes are on. */ + head_branch: string | null; + /** SimpleCommit */ + head_commit: { + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + author: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + committer: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + id: string; + message: string; + timestamp: string; + tree_id: string; + }; + /** @description The SHA of the head commit that is being checked. */ + head_sha: string; + id: number; + latest_check_runs_count: number; + node_id: string; + /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; + /** Format: uri */ + url: string; + }[]; + rerequestable?: boolean; + runs_rerequestable?: boolean; + /** + * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + * @enum {string|null} + */ + status: "requested" | "in_progress" | "completed" | "queued" | null; + /** Format: date-time */ updated_at: string; - /** Format: uri */ + /** + * Format: uri + * @description URL that points to the check suite API resource. + */ url: string; }; enterprise?: components["schemas"]["enterprise-webhooks"]; @@ -36937,153 +38378,199 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - workflow?: { - /** Format: uri */ - badge_url: string; - /** Format: date-time */ - created_at: string; - /** Format: uri */ - html_url: string; - id: number; - name: string; - node_id: string; - path: string; - state: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - } | null; - /** Deployment Workflow Run */ - workflow_run?: { - /** User */ - actor: { - /** 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; + }; + /** check_suite rerequested event */ + "webhook-check-suite-rerequested": { + /** @enum {string} */ + action: "rerequested"; + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ + check_suite: { + after: string | null; + /** + * 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. + */ + 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" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[]; /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + external_url: string | null; /** Format: uri */ - url?: string; - } | null; - artifacts_url?: string; - cancel_url?: string; - check_suite_id: number; - check_suite_node_id: string; - check_suite_url?: string; - /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; - /** Format: date-time */ - created_at: string; - display_title: string; - event: string; - head_branch: string; - head_commit?: null; - head_repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { + 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; + 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; - type?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ url?: 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"; }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; }; - head_sha: string; + before: string | null; /** Format: uri */ - html_url: string; + check_runs_url: string; + /** + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. + * @enum {string|null} + */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + created_at: string; + /** @description The head branch name the changes are on. */ + head_branch: string | null; + /** SimpleCommit */ + head_commit: { + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + author: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + committer: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + id: string; + message: string; + timestamp: string; + tree_id: string; + }; + /** @description The SHA of the head commit that is being checked. */ + head_sha: string; id: number; - jobs_url?: string; - logs_url?: string; - name: string; + latest_check_runs_count: number; node_id: string; - path: string; - previous_attempt_url?: null; + /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ pull_requests: { base: { ref: string; @@ -37112,87 +38599,45 @@ export interface components { /** Format: uri */ url: string; }[]; - referenced_workflows?: { - path: string; - ref?: string; - sha: string; - }[] | null; - repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - rerun_url?: string; - run_attempt: number; - run_number: number; + rerequestable?: boolean; + runs_rerequestable?: boolean; + /** + * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + * @enum {string|null} + */ + status: "requested" | "in_progress" | "completed" | "queued" | null; /** Format: date-time */ - run_started_at: string; - /** @enum {string} */ - status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + updated_at: string; + /** + * Format: uri + * @description URL that points to the check suite API resource. + */ + url: string; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert appeared_in_branch event */ + "webhook-code-scanning-alert-appeared-in-branch": { + /** @enum {string} */ + action: "appeared_in_branch"; + /** @description The code scanning alert involved in the event. */ + alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string | null; /** User */ - triggering_actor: { + dismissed_by: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -37228,53 +38673,97 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** Format: date-time */ - updated_at: string; + /** + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + tool: { + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + }; /** Format: uri */ url: string; - workflow_id: number; - workflow_url?: string; - } | null; + }; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** discussion answered event */ - "webhook-discussion-answered": { + /** code_scanning_alert closed_by_user event */ + "webhook-code-scanning-alert-closed-by-user": { /** @enum {string} */ - action: "answered"; - answer: { + action: "closed_by_user"; + /** @description The code scanning alert involved in the event. */ + alert: { /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - body: string; - child_comment_count: number; - /** Format: date-time */ created_at: string; - discussion_id: number; - html_url: string; - id: number; - node_id: string; - parent_id: null; - /** 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; - }; - repository_url: string; - /** Format: date-time */ - updated_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string; /** User */ - user: { + dismissed_by: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -37310,90 +38799,199 @@ export interface components { /** Format: uri */ url?: string; } | null; + /** + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + full_description?: string; + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; + }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "dismissed" | "fixed"; + tool: { + guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + }; + /** Format: uri */ + url: string; }; - discussion: components["schemas"]["discussion"]; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** discussion category changed event */ - "webhook-discussion-category-changed": { + /** code_scanning_alert created event */ + "webhook-code-scanning-alert-created": { /** @enum {string} */ - action: "category_changed"; - changes: { - category: { - from: { - /** Format: date-time */ - created_at: string; - description: string; - emoji: string; - id: number; - is_answerable: boolean; - name: string; - node_id?: string; - repository_id: number; - slug: string; - updated_at: string; + action: "created"; + /** @description The code scanning alert involved in the event. */ + alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string | null; + /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + dismissed_at: null; + dismissed_by: null; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + dismissed_reason: null; + fixed_at?: null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + instances_url?: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + full_description?: string; + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed"; + tool: { + guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + } | null; + updated_at?: string | null; + /** Format: uri */ + url: string; }; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion closed event */ - "webhook-discussion-closed": { - /** @enum {string} */ - action: "closed"; - discussion: components["schemas"]["discussion"]; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** discussion_comment created event */ - "webhook-discussion-comment-created": { + /** code_scanning_alert fixed event */ + "webhook-code-scanning-alert-fixed": { /** @enum {string} */ - action: "created"; - comment: { + action: "fixed"; + /** @description The code scanning alert involved in the event. */ + alert: { /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - body: string; - child_comment_count: number; created_at: string; - discussion_id: number; - html_url: string; - id: number; - node_id: string; - parent_id: number | null; - /** 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; - }; - repository_url: string; - updated_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string | null; /** User */ - user: { + dismissed_by: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -37429,103 +39027,273 @@ export interface components { /** Format: uri */ url?: string; } | null; - }; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion_comment deleted event */ - "webhook-discussion-comment-deleted": { - /** @enum {string} */ - action: "deleted"; - comment: { /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - body: string; - child_comment_count: number; - created_at: string; - discussion_id: number; html_url: string; - id: number; - node_id: string; - parent_id: number | null; - /** 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; - }; - repository_url: string; - updated_at: 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; - 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; + /** Format: uri */ + instances_url?: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + full_description?: string; + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; + }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "fixed"; + tool: { + guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + }; + /** Format: uri */ + url: string; }; - discussion: components["schemas"]["discussion"]; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** discussion_comment edited event */ - "webhook-discussion-comment-edited": { + /** code_scanning_alert reopened event */ + "webhook-code-scanning-alert-reopened": { /** @enum {string} */ - action: "edited"; - changes: { - body: { - from: string; + action: "reopened"; + /** @description The code scanning alert involved in the event. */ + alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + dismissed_at: string | null; + dismissed_by: Record | null; + /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + dismissed_reason: string | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + full_description?: string; + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; + }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + tool: { + guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + }; + /** Format: uri */ + url: string; + } | null; + /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + commit_oid: string | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + ref: string | null; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert reopened_by_user event */ + "webhook-code-scanning-alert-reopened-by-user": { + /** @enum {string} */ + action: "reopened_by_user"; + /** @description The code scanning alert involved in the event. */ + alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + dismissed_at: null; + dismissed_by: null; + /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + dismissed_reason: null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "fixed"; + tool: { + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; }; + /** Format: uri */ + url: string; }; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** commit_comment created event */ + "webhook-commit-comment-created": { + /** + * @description The action performed. Can be `created`. + * @enum {string} + */ + action: "created"; + /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ comment: { /** * AuthorAssociation @@ -37533,16 +39301,25 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description The text of the comment. */ body: string; - child_comment_count: number; + /** @description The SHA of the commit to which the comment applies. */ + commit_id: string; created_at: string; - discussion_id: number; + /** Format: uri */ html_url: string; + /** @description The ID of the commit comment. */ id: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + line: number | null; + /** @description The node ID of the commit comment. */ node_id: string; - parent_id: number | null; + /** @description The relative path of the file to which the comment applies. */ + path: string | null; + /** @description The line index in the diff to which the comment applies. */ + position: number | null; /** Reactions */ - reactions: { + reactions?: { "+1": number; "-1": number; confused: number; @@ -37555,8 +39332,9 @@ export interface components { /** Format: uri */ url: string; }; - repository_url: string; updated_at: string; + /** Format: uri */ + url: string; /** User */ user: { /** Format: uri */ @@ -37595,22 +39373,204 @@ export interface components { url?: string; } | null; }; - discussion: components["schemas"]["discussion"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** discussion created event */ - "webhook-discussion-created": { + /** create event */ + "webhook-create": { + /** @description The repository's current description. */ + description: string | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The name of the repository's default branch (usually `main`). */ + master_branch: string; + organization?: components["schemas"]["organization-simple-webhooks"]; + pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; + ref: components["schemas"]["webhooks_ref_0"]; + /** + * @description The type of Git ref object created in the repository. + * @enum {string} + */ + ref_type: "tag" | "branch"; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** custom property created event */ + "webhook-custom-property-created": { + /** @enum {string} */ + action: "created"; + definition: components["schemas"]["org-custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** custom property deleted event */ + "webhook-custom-property-deleted": { + /** @enum {string} */ + action: "deleted"; + definition: { + /** @description The name of the property that was deleted. */ + property_name: string; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** custom property updated event */ + "webhook-custom-property-updated": { + /** @enum {string} */ + action: "updated"; + definition: components["schemas"]["org-custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Custom property values updated event */ + "webhook-custom-property-values-updated": { + /** @enum {string} */ + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + repository: components["schemas"]["repository-webhooks"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + /** @description The new custom property values for the repository. */ + new_property_values: components["schemas"]["custom-property-value"][]; + /** @description The old custom property values for the repository. */ + old_property_values: components["schemas"]["custom-property-value"][]; + }; + /** delete event */ + "webhook-delete": { + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; + ref: components["schemas"]["webhooks_ref_0"]; + /** + * @description The type of Git ref object deleted in the repository. + * @enum {string} + */ + ref_type: "tag" | "branch"; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert auto-dismissed event */ + "webhook-dependabot-alert-auto-dismissed": { + /** @enum {string} */ + action: "auto_dismissed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert auto-reopened event */ + "webhook-dependabot-alert-auto-reopened": { + /** @enum {string} */ + action: "auto_reopened"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert created event */ + "webhook-dependabot-alert-created": { + /** @enum {string} */ + action: "created"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert dismissed event */ + "webhook-dependabot-alert-dismissed": { + /** @enum {string} */ + action: "dismissed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert fixed event */ + "webhook-dependabot-alert-fixed": { + /** @enum {string} */ + action: "fixed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert reintroduced event */ + "webhook-dependabot-alert-reintroduced": { + /** @enum {string} */ + action: "reintroduced"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert reopened event */ + "webhook-dependabot-alert-reopened": { + /** @enum {string} */ + action: "reopened"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** deploy_key created event */ + "webhook-deploy-key-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + key: components["schemas"]["webhooks_deploy_key"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** deploy_key deleted event */ + "webhook-deploy-key-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + key: components["schemas"]["webhooks_deploy_key"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** deployment created event */ + "webhook-deployment-created": { /** @enum {string} */ action: "created"; - discussion: { - active_lock_reason: string | null; - answer_chosen_at: string | null; + /** + * Deployment + * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). + */ + deployment: { + created_at: string; /** User */ - answer_chosen_by: { + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -37646,58 +39606,169 @@ export interface components { /** Format: uri */ url?: string; } | null; - answer_html_url: string | null; + description: string | null; + environment: string; + id: number; + node_id: string; + original_environment: string; + payload: Record | string; /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} + * 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. */ - author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - body: string | null; - category: { + performed_via_github_app?: { /** Format: date-time */ - created_at: string; - description: string; - emoji: string; - id: number; - is_answerable: boolean; + 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" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; + /** 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; - repository_id: number; - slug: string; - updated_at: string; - }; - comments: number; - /** Format: date-time */ - created_at: string; - html_url: string; - id: number; - locked: boolean; - node_id: string; - number: 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; - }; + 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; + } | 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"; + /** @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; + production_environment?: boolean; + ref: string; + /** Format: uri */ repository_url: string; - /** @enum {string} */ - state: "open" | "locked" | "converting" | "transferring"; - timeline_url?: string; - title: string; - /** Format: date-time */ + sha: string; + /** Format: uri */ + statuses_url: string; + task: string; + transient_environment?: boolean; updated_at: string; + /** Format: uri */ + url: string; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + workflow: components["schemas"]["webhooks_workflow"]; + /** Deployment Workflow Run */ + workflow_run: { /** User */ - user: { + actor: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -37733,223 +39804,529 @@ export interface components { /** Format: uri */ url?: string; } | null; - } & { - active_lock_reason?: null; - answer_chosen_at: null; - answer_chosen_by: null; - answer_html_url: string | null; - author_association?: string; - body?: string | null; - category?: { - created_at?: string; - description?: string; - emoji?: string; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + created_at: string; + display_title: string; + event: string; + head_branch: string; + head_commit?: null; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; id?: number; - is_answerable?: boolean; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; name?: string; node_id?: string; - repository_id?: number; - slug?: string; - updated_at?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; - comments?: number; - created_at?: string; - html_url?: string; - id?: number; - /** @enum {boolean} */ - locked: false; - node_id?: string; - number?: number; - reactions?: { - "+1"?: number; - "-1"?: number; - confused?: number; - eyes?: number; - heart?: number; - hooray?: number; - laugh?: number; - rocket?: number; - total_count?: number; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: null; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; + /** Format: uri */ + url: string; + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; url?: string; }; - repository_url?: string; + rerun_url?: string; + run_attempt: number; + run_number: number; + /** Format: date-time */ + run_started_at: string; /** @enum {string} */ - state: "open" | "converting" | "transferring"; - timeline_url?: string; - title?: string; - updated_at?: string; - user?: { + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + /** User */ + triggering_actor?: { + /** 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; + 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; - type?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ url?: string; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion deleted event */ - "webhook-discussion-deleted": { - /** @enum {string} */ - action: "deleted"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion edited event */ - "webhook-discussion-edited": { - /** @enum {string} */ - action: "edited"; - changes?: { - body?: { - from: string; - }; - title?: { - from: string; - }; - }; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion labeled event */ - "webhook-discussion-labeled": { - /** @enum {string} */ - action: "labeled"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** Label */ - label: { - /** @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 - */ + } | null; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ url: string; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + workflow_id: number; + workflow_url?: string; + } | null; }; - /** discussion locked event */ - "webhook-discussion-locked": { + /** deployment protection rule requested event */ + "webhook-deployment-protection-rule-requested": { /** @enum {string} */ - action: "locked"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; + action?: "requested"; + /** @description The name of the environment that has the deployment protection rule. */ + environment?: string; + /** @description The event that triggered the deployment protection rule. */ + event?: string; + /** + * Format: uri + * @description The URL to review the deployment protection rule. + */ + deployment_callback_url?: string; + deployment?: components["schemas"]["deployment"]; + pull_requests?: components["schemas"]["pull-request"][]; + repository?: components["schemas"]["repository-webhooks"]; organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion pinned event */ - "webhook-discussion-pinned": { - /** @enum {string} */ - action: "pinned"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; }; - /** discussion reopened event */ - "webhook-discussion-reopened": { + "webhook-deployment-review-approved": { /** @enum {string} */ - action: "reopened"; - discussion: components["schemas"]["discussion"]; + action: "approved"; + approver?: components["schemas"]["webhooks_approver"]; + comment?: string; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; + organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; + reviewers?: components["schemas"]["webhooks_reviewers"]; sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion transferred event */ - "webhook-discussion-transferred": { - /** @enum {string} */ - action: "transferred"; - changes: { - new_discussion: components["schemas"]["discussion"]; - new_repository: components["schemas"]["repository-webhooks"]; - }; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unanswered event */ - "webhook-discussion-unanswered": { - /** @enum {string} */ - action: "unanswered"; - discussion: components["schemas"]["discussion"]; - old_answer: { - /** - * 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"; - body: string; - child_comment_count: number; + since: string; + workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; + workflow_job_runs?: { + conclusion?: null; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; + }[]; + /** Deployment Workflow Run */ + workflow_run: { + /** User */ + actor: { + /** 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; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** Format: date-time */ created_at: string; - discussion_id: number; + display_title: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ html_url: string; id: number; + jobs_url?: string; + logs_url?: string; + name: string; node_id: string; - parent_id: null; - /** Reactions */ - reactions?: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; /** Format: uri */ url: string; + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; - repository_url: string; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - updated_at: string; + run_started_at: string; + /** @enum {string} */ + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - user: { + triggering_actor: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -37985,221 +40362,41 @@ export interface components { /** Format: uri */ url?: string; } | null; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unlabeled event */ - "webhook-discussion-unlabeled": { - /** @enum {string} */ - action: "unlabeled"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** Label */ - label: { - /** @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 - */ + /** Format: date-time */ + updated_at: string; + /** Format: uri */ url: string; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unlocked event */ - "webhook-discussion-unlocked": { - /** @enum {string} */ - action: "unlocked"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + workflow_id: number; + workflow_url?: string; + } | null; }; - /** discussion unpinned event */ - "webhook-discussion-unpinned": { + "webhook-deployment-review-rejected": { /** @enum {string} */ - action: "unpinned"; - discussion: components["schemas"]["discussion"]; + action: "rejected"; + approver?: components["schemas"]["webhooks_approver"]; + comment?: string; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; + organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; + reviewers?: components["schemas"]["webhooks_reviewers"]; sender: components["schemas"]["simple-user-webhooks"]; - }; - /** - * fork event - * @description A user forks a repository. - */ - "webhook-fork": { - enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */ - forkee: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; + since: string; + workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; + workflow_job_runs?: { + conclusion?: string | null; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; + }[]; + /** Deployment Workflow Run */ + workflow_run: { /** User */ - owner: { + actor: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -38235,599 +40432,314 @@ export interface components { /** Format: uri */ url?: string; } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + created_at: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: null | number | string; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; + head_sha: string; /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; + /** Format: uri */ + url: string; + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; + run_started_at: string; /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - } & { - allow_forking?: boolean; - archive_url?: string; - archived?: boolean; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - clone_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - created_at?: string; - default_branch?: string; - deployments_url?: string; - description?: string | null; - disabled?: boolean; - downloads_url?: string; - events_url?: string; - /** @enum {boolean} */ - fork?: true; - forks?: number; - forks_count?: number; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - git_url?: string; - has_downloads?: boolean; - has_issues?: boolean; - has_pages?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - homepage?: string | null; - hooks_url?: string; - html_url?: string; - id?: number; - is_template?: boolean; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - language?: null; - languages_url?: string; - license?: Record | null; - merges_url?: string; - milestones_url?: string; - mirror_url?: null; - name?: string; - node_id?: string; - notifications_url?: string; - open_issues?: number; - open_issues_count?: number; - owner?: { + status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; + /** User */ + triggering_actor: { + /** 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; + 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; - type?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ url?: string; - }; - private?: boolean; - public?: boolean; - pulls_url?: string; - pushed_at?: string; - releases_url?: string; - size?: number; - ssh_url?: string; - stargazers_count?: number; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - svn_url?: string; - tags_url?: string; - teams_url?: string; - topics?: null[]; - trees_url?: string; - updated_at?: string; - url?: string; - visibility?: string; - watchers?: number; - watchers_count?: number; - }; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + } | null; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + workflow_url?: string; + display_title: string; + } | null; }; - /** github_app_authorization revoked event */ - "webhook-github-app-authorization-revoked": { + "webhook-deployment-review-requested": { /** @enum {string} */ - action: "revoked"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** gollum event */ - "webhook-gollum": { + action: "requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; + environment: string; installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The pages that were updated. */ - pages: { - /** - * @description The action that was performed on the page. Can be `created` or `edited`. - * @enum {string} - */ - action: "created" | "edited"; - /** - * Format: uri - * @description Points to the HTML wiki page. - */ - html_url: string; - /** @description The name of the page. */ - page_name: string; - /** @description The latest commit SHA of the page. */ - sha: string; - summary: string | null; - /** @description The current page title. */ - title: string; - }[]; + organization: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation created event */ - "webhook-installation-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - repositories?: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - repository?: components["schemas"]["repository-webhooks"]; - /** User */ - requester?: { - /** 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; + requestor: components["schemas"]["webhooks_user"]; + reviewers: { + /** User */ + reviewer?: { + /** 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; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation deleted event */ - "webhook-installation-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - repositories?: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; + type?: "User" | "Team"; }[]; - repository?: components["schemas"]["repository-webhooks"]; - requester?: null; sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation new_permissions_accepted event */ - "webhook-installation-new-permissions-accepted": { - /** @enum {string} */ - action: "new_permissions_accepted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - repositories?: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - repository?: components["schemas"]["repository-webhooks"]; - requester?: null; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation_repositories added event */ - "webhook-installation-repositories-added": { - /** @enum {string} */ - action: "added"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects, which were added to the installation. */ - repositories_added: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - /** @description An array of repository objects, which were removed from the installation. */ - repositories_removed: { - full_name?: string; - /** @description Unique identifier of the repository */ - id?: number; - /** @description The name of the repository. */ - name?: string; - node_id?: string; - /** @description Whether the repository is private or public. */ - private?: boolean; - }[]; - repository?: components["schemas"]["repository-webhooks"]; - /** - * @description Describe whether all repositories have been selected or there's a selection involved - * @enum {string} - */ - repository_selection: "all" | "selected"; - /** User */ - requester: { - /** 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; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation_repositories removed event */ - "webhook-installation-repositories-removed": { - /** @enum {string} */ - action: "removed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects, which were added to the installation. */ - repositories_added: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - /** @description An array of repository objects, which were removed from the installation. */ - repositories_removed: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - repository?: components["schemas"]["repository-webhooks"]; - /** - * @description Describe whether all repositories have been selected or there's a selection involved - * @enum {string} - */ - repository_selection: "all" | "selected"; - /** User */ - requester: { - /** 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; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation suspend event */ - "webhook-installation-suspend": { - /** @enum {string} */ - action: "suspend"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - repositories?: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - repository?: components["schemas"]["repository-webhooks"]; - requester?: null; - sender: components["schemas"]["simple-user-webhooks"]; - }; - "webhook-installation-target-renamed": { - account: { - archived_at?: string | null; - avatar_url: string; - created_at?: string; - description?: null; - events_url?: string; - followers?: number; - followers_url?: string; - following?: number; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - has_organization_projects?: boolean; - has_repository_projects?: boolean; - hooks_url?: string; - html_url: string; - id: number; - is_verified?: boolean; - issues_url?: string; - login?: string; - members_url?: string; - name?: string; - node_id: string; - organizations_url?: string; - public_gists?: number; - public_members_url?: string; - public_repos?: number; - received_events_url?: string; - repos_url?: string; - site_admin?: boolean; - slug?: string; - starred_url?: string; - subscriptions_url?: string; - type?: string; - updated_at?: string; - url?: string; - website_url?: null; - }; - /** @enum {string} */ - action: "renamed"; - changes: { - login?: { - from: string; - }; - slug?: { - from: string; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - target_type: string; - }; - /** installation unsuspend event */ - "webhook-installation-unsuspend": { - /** @enum {string} */ - action: "unsuspend"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - repositories?: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - repository?: components["schemas"]["repository-webhooks"]; - requester?: null; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issue_comment created event */ - "webhook-issue-comment-created": { - /** @enum {string} */ - action: "created"; - /** - * issue comment - * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. - */ - comment: { - /** - * 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 comment */ - body: string; - /** Format: date-time */ + since: string; + workflow_job_run: { + conclusion: null; created_at: string; - /** Format: uri */ + environment: string; 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: null | components["schemas"]["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 */ + name: string | null; + status: string; updated_at: string; - /** - * Format: uri - * @description URL for the issue comment - */ - url: string; + }; + /** Deployment Workflow Run */ + workflow_run: { /** User */ - user: { + actor: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -38863,15 +40775,204 @@ export interface components { /** Format: uri */ url?: 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: { + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + created_at: string; + event: string; + head_branch: string; + head_commit?: Record | null; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; + /** Format: uri */ + url: string; + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; + /** Format: date-time */ + run_started_at: string; + /** @enum {string} */ + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - assignee?: { + triggering_actor: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -38903,11 +41004,61 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; - assignees: ({ + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + workflow_url?: string; + display_title: string; + } | null; + }; + /** deployment_status created event */ + "webhook-deployment-status-created": { + /** @enum {string} */ + action: "created"; + check_run?: { + /** Format: date-time */ + completed_at: string | null; + /** + * @description The result of the completed check run. This value will be `null` until the check run has completed. + * @enum {string|null} + */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; + /** Format: uri */ + details_url: string; + external_id: string; + /** @description The SHA of the commit that is being checked. */ + head_sha: string; + /** Format: uri */ + html_url: string; + /** @description The id of the check. */ + id: number; + /** @description The name of the check run. */ + name: string; + node_id: string; + /** Format: date-time */ + started_at: string; + /** + * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. + * @enum {string} + */ + status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; + /** Format: uri */ + url: string; + } | null; + /** + * Deployment + * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). + */ + deployment: { + created_at: string; + /** User */ + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -38939,62 +41090,37 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null)[]; + } | null; + description: string | null; + environment: string; + id: number; + node_id: string; + original_environment: string; + payload: (null | Record) & (string | Record); /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} + * 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. */ - 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; + performed_via_github_app?: { + /** Format: date-time */ + created_at: string | null; description: string | null; - id: number; - /** @description The name of the label. */ + /** @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" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; + /** 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; - /** - * Format: uri - * @description URL for the label - */ - url: string; - }[]; - /** 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: { + owner: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -39026,36 +41152,152 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; - description: 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"; + /** @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 */ - due_on: string | null; + updated_at: string | null; + } | null; + production_environment?: boolean; + ref: string; + /** Format: uri */ + repository_url: string; + sha: string; + /** Format: uri */ + statuses_url: string; + task: string; + transient_environment?: boolean; + updated_at: string; + /** Format: uri */ + url: string; + }; + /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ + deployment_status: { + created_at: string; + /** User */ + creator: { /** Format: uri */ - html_url: string; + 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 */ - 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; + organizations_url?: string; /** Format: uri */ - url: string; + 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; + /** Format: uri */ + deployment_url: string; + /** @description The optional human-readable description added to the status. */ + description: string; + environment: string; + /** Format: uri */ + environment_url?: string; + id: number; + /** Format: uri */ + log_url?: string; 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. @@ -39065,7 +41307,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" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -39149,7 +41391,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} */ @@ -39165,7 +41407,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} */ @@ -39190,53 +41432,26 @@ export interface components { /** 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; - "-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} - */ - state?: "open" | "closed"; - state_reason?: string | null; - /** Format: uri */ - timeline_url?: string; - /** @description Title of the issue */ - title: string; - /** Format: date-time */ + /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ + state: string; + /** @description The optional link added to the status. */ + target_url: string; updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ + /** Format: uri */ url: string; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + workflow?: components["schemas"]["webhooks_workflow"]; + /** Deployment Workflow Run */ + workflow_run?: { /** User */ - user: { + actor: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -39268,180 +41483,209 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; - } & { - active_lock_reason?: string | null; - /** User */ - assignee: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; + /** Format: date-time */ + created_at: string; + display_title: string; + event: string; + head_branch: string; + head_commit?: null; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: null; + downloads_url?: string; 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 */ + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; html_url?: string; - id: number; - login: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: 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 */ + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; url?: string; - } | null; - assignees?: (Record | null)[]; - 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; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: null; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; id: number; - /** @description The name of the label. */ - name: string; - node_id: string; - /** - * Format: uri - * @description URL for the label - */ + number: number; + /** Format: uri */ url: string; }[]; - labels_url?: string; - locked: boolean; - milestone?: Record | null; - node_id?: string; - number?: number; - performed_via_github_app?: Record | null; - 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; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: null; + downloads_url?: string; events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; html_url?: string; id?: number; - login?: string; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: 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; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; url?: string; }; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issue_comment deleted event */ - "webhook-issue-comment-deleted": { - /** @enum {string} */ - action: "deleted"; - /** - * issue comment - * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. - */ - comment: { - /** - * 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 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: null | components["schemas"]["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; - }; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the issue comment - */ - url: string; + run_started_at: string; + /** @enum {string} */ + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - user: { + triggering_actor: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -39473,423 +41717,416 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + workflow_url?: string; + } | null; + }; + /** discussion answered event */ + "webhook-discussion-answered": { + /** @enum {string} */ + action: "answered"; + answer: components["schemas"]["webhooks_answer"]; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion category changed event */ + "webhook-discussion-category-changed": { + /** @enum {string} */ + action: "category_changed"; + changes: { + category: { + from: { + /** Format: date-time */ + created_at: string; + description: string; + emoji: string; + id: number; + is_answerable: boolean; + name: string; + node_id?: string; + repository_id: number; + slug: string; + updated_at: string; + }; + }; }; + discussion: components["schemas"]["discussion"]; 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; - } | 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; - } | null)[]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion closed event */ + "webhook-discussion-closed": { + /** @enum {string} */ + action: "closed"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion_comment created event */ + "webhook-discussion-comment-created": { + /** @enum {string} */ + action: "created"; + comment: components["schemas"]["webhooks_comment"]; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion_comment deleted event */ + "webhook-discussion-comment-deleted": { + /** @enum {string} */ + action: "deleted"; + comment: components["schemas"]["webhooks_comment"]; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion_comment edited event */ + "webhook-discussion-comment-edited": { + /** @enum {string} */ + action: "edited"; + changes: { + body: { + from: string; + }; + }; + comment: components["schemas"]["webhooks_comment"]; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion created event */ + "webhook-discussion-created": { + /** @enum {string} */ + action: "created"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion deleted event */ + "webhook-discussion-deleted": { + /** @enum {string} */ + action: "deleted"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion edited event */ + "webhook-discussion-edited": { + /** @enum {string} */ + action: "edited"; + changes?: { + body?: { + from: string; + }; + title?: { + from: string; + }; + }; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion labeled event */ + "webhook-discussion-labeled": { + /** @enum {string} */ + action: "labeled"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion locked event */ + "webhook-discussion-locked": { + /** @enum {string} */ + action: "locked"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion pinned event */ + "webhook-discussion-pinned": { + /** @enum {string} */ + action: "pinned"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion reopened event */ + "webhook-discussion-reopened": { + /** @enum {string} */ + action: "reopened"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion transferred event */ + "webhook-discussion-transferred": { + /** @enum {string} */ + action: "transferred"; + changes: { + new_discussion: components["schemas"]["discussion"]; + new_repository: components["schemas"]["repository-webhooks"]; + }; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion unanswered event */ + "webhook-discussion-unanswered": { + /** @enum {string} */ + action: "unanswered"; + discussion: components["schemas"]["discussion"]; + old_answer: components["schemas"]["webhooks_answer"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion unlabeled event */ + "webhook-discussion-unlabeled": { + /** @enum {string} */ + action: "unlabeled"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion unlocked event */ + "webhook-discussion-unlocked": { + /** @enum {string} */ + action: "unlocked"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion unpinned event */ + "webhook-discussion-unpinned": { + /** @enum {string} */ + action: "unpinned"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * fork event + * @description A user forks a repository. + */ + "webhook-fork": { + enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */ + forkee: { /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} + * @description Whether to allow auto-merge for pull requests. + * @default false */ - 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; + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; /** - * Milestone - * @description A collection of related issues and pull requests. + * @description Whether to allow merge commits for pull requests. + * @default true */ - 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; - } | 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; + allow_merge_commit: boolean; /** - * 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. + * @description Whether to allow rebase merges for pull requests. + * @default true */ - 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")[]; - /** 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; - } | 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"; - /** @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; - }; - /** 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; - }; + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; /** Format: uri */ - repository_url: string; + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; + /** @description The default branch of the repository. */ + default_branch: string; /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} + * @description Whether to delete head branches when pull requests are merged + * @default false */ - state?: "open" | "closed"; - state_reason?: string | null; + delete_branch_on_merge: boolean; /** Format: uri */ - timeline_url?: string; - /** @description Title of the issue */ - title: string; - /** Format: date-time */ - updated_at: string; + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; /** - * Format: uri - * @description URL for the issue + * @description Whether downloads are enabled. + * @default true */ - 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; - 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"; + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - url?: string; + url: string | null; } | null; - } & { - active_lock_reason?: string | null; + master_branch?: string; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - assignee: { + owner: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -39921,64 +42158,115 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; - assignees?: (Record | null)[]; - author_association?: string; - body?: string | null; - closed_at?: string | null; - comments?: number; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: null | number | string; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + } & { + allow_forking?: boolean; + archive_url?: string; + archived?: boolean; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + clone_url?: string; + collaborators_url?: string; comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; created_at?: string; + default_branch?: string; + deployments_url?: string; + description?: string | null; + disabled?: boolean; + downloads_url?: 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; - }[]; + /** @enum {boolean} */ + fork?: true; + forks?: number; + forks_count?: number; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + has_downloads?: boolean; + has_issues?: boolean; + has_pages?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + homepage?: string | null; + hooks_url?: string; + html_url?: string; + id?: number; + is_template?: boolean; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; labels_url?: string; - locked: boolean; - milestone?: Record | null; + language?: null; + languages_url?: string; + license?: Record | null; + merges_url?: string; + milestones_url?: string; + mirror_url?: null; + name?: string; node_id?: string; - number?: number; - performed_via_github_app?: Record | null; - 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?: { + notifications_url?: string; + open_issues?: number; + open_issues_count?: number; + owner?: { avatar_url?: string; events_url?: string; followers_url?: string; @@ -39998,22 +42286,236 @@ export interface components { type?: string; url?: string; }; + private?: boolean; + public?: boolean; + pulls_url?: string; + pushed_at?: string; + releases_url?: string; + size?: number; + ssh_url?: string; + stargazers_count?: number; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + svn_url?: string; + tags_url?: string; + teams_url?: string; + topics?: null[]; + trees_url?: string; + updated_at?: string; + url?: string; + visibility?: string; + watchers?: number; + watchers_count?: number; }; + installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** issue_comment edited event */ - "webhook-issue-comment-edited": { + /** github_app_authorization revoked event */ + "webhook-github-app-authorization-revoked": { /** @enum {string} */ - action: "edited"; - /** @description The changes to the comment. */ + action: "revoked"; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** gollum event */ + "webhook-gollum": { + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description The pages that were updated. */ + pages: { + /** + * @description The action that was performed on the page. Can be `created` or `edited`. + * @enum {string} + */ + action: "created" | "edited"; + /** + * Format: uri + * @description Points to the HTML wiki page. + */ + html_url: string; + /** @description The name of the page. */ + page_name: string; + /** @description The latest commit SHA of the page. */ + sha: string; + summary: string | null; + /** @description The current page title. */ + title: string; + }[]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** installation created event */ + "webhook-installation-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: components["schemas"]["webhooks_user"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** installation deleted event */ + "webhook-installation-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: null; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** installation new_permissions_accepted event */ + "webhook-installation-new-permissions-accepted": { + /** @enum {string} */ + action: "new_permissions_accepted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: null; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** installation_repositories added event */ + "webhook-installation-repositories-added": { + /** @enum {string} */ + action: "added"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories_added: components["schemas"]["webhooks_repositories_added"]; + /** @description An array of repository objects, which were removed from the installation. */ + repositories_removed: { + full_name?: string; + /** @description Unique identifier of the repository */ + id?: number; + /** @description The name of the repository. */ + name?: string; + node_id?: string; + /** @description Whether the repository is private or public. */ + private?: boolean; + }[]; + repository?: components["schemas"]["repository-webhooks"]; + repository_selection: components["schemas"]["webhooks_repository_selection"]; + requester: components["schemas"]["webhooks_user"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** installation_repositories removed event */ + "webhook-installation-repositories-removed": { + /** @enum {string} */ + action: "removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories_added: components["schemas"]["webhooks_repositories_added"]; + /** @description An array of repository objects, which were removed from the installation. */ + repositories_removed: { + full_name: string; + /** @description Unique identifier of the repository */ + id: number; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** @description Whether the repository is private or public. */ + private: boolean; + }[]; + repository?: components["schemas"]["repository-webhooks"]; + repository_selection: components["schemas"]["webhooks_repository_selection"]; + requester: components["schemas"]["webhooks_user"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** installation suspend event */ + "webhook-installation-suspend": { + /** @enum {string} */ + action: "suspend"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: null; + sender: components["schemas"]["simple-user-webhooks"]; + }; + "webhook-installation-target-renamed": { + account: { + archived_at?: string | null; + avatar_url: string; + created_at?: string; + description?: null; + events_url?: string; + followers?: number; + followers_url?: string; + following?: number; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + has_organization_projects?: boolean; + has_repository_projects?: boolean; + hooks_url?: string; + html_url: string; + id: number; + is_verified?: boolean; + issues_url?: string; + login?: string; + members_url?: string; + name?: string; + node_id: string; + organizations_url?: string; + public_gists?: number; + public_members_url?: string; + public_repos?: number; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + slug?: string; + starred_url?: string; + subscriptions_url?: string; + type?: string; + updated_at?: string; + url?: string; + website_url?: null; + }; + /** @enum {string} */ + action: "renamed"; changes: { - body?: { - /** @description The previous version of the body. */ + login?: { + from: string; + }; + slug?: { from: string; }; }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + target_type: string; + }; + /** installation unsuspend event */ + "webhook-installation-unsuspend": { + /** @enum {string} */ + action: "unsuspend"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: null; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issue_comment created event */ + "webhook-issue-comment-created": { + /** @enum {string} */ + action: "created"; /** * issue comment * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -40094,7 +42596,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -40400,7 +42902,7 @@ export interface components { /** @enum {string} */ repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects?: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ @@ -40624,56 +43126,14 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** issues assigned event */ - "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "assigned"; - /** 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; + /** 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"]; - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ + /** @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; @@ -40872,7 +43332,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 */ @@ -40956,7 +43416,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} */ @@ -41079,21 +43539,132 @@ export interface components { /** Format: uri */ url?: 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; + } | null; + assignees?: (Record | null)[]; + 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 | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + 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; + 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-webhooks"]; }; - /** issues closed event */ - "webhook-issues-closed": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "closed"; + /** issue_comment edited event */ + "webhook-issue-comment-edited": { + /** @enum {string} */ + action: "edited"; + changes: components["schemas"]["webhooks_changes"]; + 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) itself. */ + /** @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; @@ -41292,7 +43863,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" | "pull_request_review_thread")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -41501,83 +44072,8 @@ export interface components { } | null; } & { active_lock_reason?: string | null; - assignee?: Record | null; - assignees?: (Record | null)[]; - 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 | null)[]; - labels_url?: string; - locked?: boolean; - milestone?: Record | null; - node_id?: string; - number?: number; - performed_via_github_app?: Record | null; - 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; - 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-webhooks"]; - }; - /** issues deleted event */ - "webhook-issues-deleted": { - /** @enum {string} */ - action: "deleted"; - 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?: { + assignee: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -41609,7 +44105,150 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + } | null; + assignees?: (Record | null)[]; + 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 | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + 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; + 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-webhooks"]; + }; + /** 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"]; + issue: components["schemas"]["webhooks_issue"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** 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; + /** 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; } | null; @@ -41645,7 +44284,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)[]; @@ -41732,7 +44371,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; @@ -41771,7 +44410,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" | "security_and_analysis" | "reminder" | "pull_request_review_thread")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -41855,7 +44494,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} */ @@ -41974,21 +44613,84 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; + } & { + active_lock_reason?: string | null; + assignee?: Record | null; + assignees?: (Record | null)[]; + 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 | null)[]; + labels_url?: string; + locked?: boolean; + milestone?: Record | null; + node_id?: string; + number?: number; + performed_via_github_app?: Record | null; + 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; + 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-webhooks"]; }; - /** issues demilestoned event */ - "webhook-issues-demilestoned": { + /** issues deleted event */ + "webhook-issues-deleted": { /** @enum {string} */ - action: "demilestoned"; + action: "deleted"; 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; @@ -42025,7 +44727,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -42061,7 +44763,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -42148,7 +44850,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -42187,7 +44889,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")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -42271,7 +44973,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} */ @@ -42359,6 +45061,61 @@ export interface components { 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; + 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; + }; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues demilestoned event */ + "webhook-issues-demilestoned": { + /** @enum {string} */ + action: "demilestoned"; + 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; @@ -42394,21 +45151,81 @@ export interface components { /** Format: uri */ url?: string; } | null; - } & { - active_lock_reason?: string | null; - assignee?: Record | null; - assignees?: (Record | null)[]; - 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 | null)[]; - labels_url?: string; + 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; + } | 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 @@ -42481,60 +45298,189 @@ export interface components { /** Format: uri */ url: string; } | null; - node_id?: string; - number?: number; - performed_via_github_app?: Record | null; - 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; - state?: string; - 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; + 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")[]; + /** 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; + } | 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; - 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; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ url?: string; }; - }; - /** - * Milestone - * @description A collection of related issues and pull requests. - */ - milestone?: { - /** Format: date-time */ - closed_at: string | null; - closed_issues: 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} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + /** @description Title of the issue */ + title: string; /** Format: date-time */ - created_at: string; + updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + url: string; /** User */ - creator: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -42570,30 +45516,8 @@ export interface components { /** Format: uri */ url?: 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; }; + milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; @@ -43025,22 +45949,7 @@ export interface components { url?: string; } | null; }; - /** Label */ - label?: { - /** @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; - }; + label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; @@ -43461,22 +46370,7 @@ export interface components { url?: string; } | null; }; - /** Label */ - label?: { - /** @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; - }; + label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; @@ -43487,6 +46381,10 @@ export interface components { action: "locked"; 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; @@ -43585,7 +46483,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; @@ -43599,10 +46497,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. @@ -43892,66 +46791,6 @@ export interface components { /** Format: uri */ url?: string; } | null; - } & { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - assignee?: Record | null; - assignees?: (Record | null)[]; - 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 | null)[]; - labels_url?: string; - /** @enum {boolean} */ - locked: true; - milestone?: Record | null; - node_id?: string; - number?: number; - performed_via_github_app?: Record | null; - 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; - state?: string; - 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; - 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"]; @@ -43963,6 +46802,10 @@ export interface components { 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; @@ -44061,7 +46904,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; @@ -44075,7 +46918,7 @@ export interface components { * @description URL for the label */ url: string; - }[]; + } | null)[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -44368,206 +47211,8 @@ export interface components { /** Format: uri */ url?: string; } | null; - } & { - active_lock_reason?: string | null; - assignee?: Record | null; - assignees?: (Record | null)[]; - 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 | null)[]; - 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; - } | 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; - }; - node_id?: string; - number?: number; - performed_via_github_app?: Record | null; - 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; - state?: string; - 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; - 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; - }; - }; - /** - * 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; - } | 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; }; + milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; @@ -45653,416 +48298,7 @@ export interface components { action: "pinned"; 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; - }[]; - /** 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"; - /** Format: uri */ - url?: 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")[]; - /** 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; - } | 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"; - /** @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; - }; - /** 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} - */ - 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; - 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; - }; + issue: components["schemas"]["webhooks_issue_2"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; @@ -46073,6 +48309,10 @@ export interface components { action: "reopened"; 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; @@ -46171,7 +48411,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; @@ -46185,7 +48425,7 @@ export interface components { * @description URL for the label */ url: string; - }[]; + } | null)[]; /** Format: uri-template */ labels_url: string; locked?: boolean; @@ -46428,7 +48668,7 @@ export interface components { * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - state?: "open" | "closed"; + state: "open" | "closed"; state_reason?: string | null; /** Format: uri */ timeline_url?: string; @@ -46478,65 +48718,6 @@ export interface components { /** Format: uri */ url?: string; } | null; - } & { - active_lock_reason?: string | null; - assignee?: Record | null; - assignees?: (Record | null)[]; - 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 | null)[]; - labels_url?: string; - locked?: boolean; - milestone?: Record | null; - node_id?: string; - number?: number; - performed_via_github_app?: Record | null; - 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: "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; - 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"]; @@ -47206,6 +49387,44 @@ export interface components { }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue_2"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues unassigned event */ + "webhook-issues-unassigned": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "unassigned"; + assignee?: components["schemas"]["webhooks_user_mannequin"]; + 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-webhooks"]; + }; + /** issues unlabeled event */ + "webhook-issues-unlabeled": { + /** @enum {string} */ + action: "unlabeled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + label?: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues unlocked event */ + "webhook-issues-unlocked": { + /** @enum {string} */ + action: "unlocked"; + 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. @@ -47308,7 +49527,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; @@ -47322,10 +49541,11 @@ export interface components { * @description URL for the label */ url: string; - }[]; + } | null)[]; /** Format: uri-template */ labels_url: string; - locked?: boolean; + /** @enum {boolean} */ + locked: false; /** * Milestone * @description A collection of related issues and pull requests. @@ -47620,15 +49840,282 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** issues unassigned event */ - "webhook-issues-unassigned": { + /** issues unpinned event */ + "webhook-issues-unpinned": { + /** @enum {string} */ + action: "unpinned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue_2"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** label created event */ + "webhook-label-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** label deleted event */ + "webhook-label-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** label edited event */ + "webhook-label-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the label if the action was `edited`. */ + changes?: { + color?: { + /** @description The previous version of the color if the action was `edited`. */ + from: string; + }; + description?: { + /** @description The previous version of the description if the action was `edited`. */ + from: string; + }; + name?: { + /** @description The previous version of the name if the action was `edited`. */ + from: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase cancelled event */ + "webhook-marketplace-purchase-cancelled": { + /** @enum {string} */ + action: "cancelled"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase changed event */ + "webhook-marketplace-purchase-changed": { + /** @enum {string} */ + action: "changed"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** Marketplace Purchase */ + previous_marketplace_purchase?: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: string | null; + next_billing_date?: string | null; + on_free_trial: boolean | null; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; + /** @enum {string} */ + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; + }; + unit_count: number; + }; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase pending_change event */ + "webhook-marketplace-purchase-pending-change": { + /** @enum {string} */ + action: "pending_change"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** Marketplace Purchase */ + previous_marketplace_purchase?: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: string | null; + next_billing_date?: string | null; + on_free_trial: boolean; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; + /** @enum {string} */ + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; + }; + unit_count: number; + }; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase pending_change_cancelled event */ + "webhook-marketplace-purchase-pending-change-cancelled": { + /** @enum {string} */ + action: "pending_change_cancelled"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** Marketplace Purchase */ + marketplace_purchase: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: null; + next_billing_date: string | null; + on_free_trial: boolean; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; + /** @enum {string} */ + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; + }; + unit_count: number; + }; + organization?: components["schemas"]["organization-simple-webhooks"]; + previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase purchased event */ + "webhook-marketplace-purchase-purchased": { + /** @enum {string} */ + action: "purchased"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member added event */ + "webhook-member-added": { + /** @enum {string} */ + action: "added"; + changes?: { + /** @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. */ + permission?: { + /** @enum {string} */ + to: "write" | "admin" | "read"; + }; + /** @description The role assigned to the collaborator. */ + role_name?: { + to: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member edited event */ + "webhook-member-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the collaborator permissions */ + changes: { + old_permission?: { + /** @description The previous permissions of the collaborator if the action was edited. */ + from: string; + }; + permission?: { + from?: string | null; + to?: string | null; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member removed event */ + "webhook-member-removed": { + /** @enum {string} */ + action: "removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** membership added event */ + "webhook-membership-added": { + /** @enum {string} */ + action: "added"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; /** - * @description The action that was performed. + * @description The scope of the membership. Currently, can only be `team`. * @enum {string} */ - action: "unassigned"; + scope: "team"; /** User */ - assignee?: { + sender: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47660,386 +50147,251 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; + team: components["schemas"]["webhooks_team"]; + }; + /** membership removed event */ + "webhook-membership-removed": { + /** @enum {string} */ + action: "removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + * @description The scope of the membership. Currently, can only be `team`. + * @enum {string} */ - 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; - } | 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; - } | 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; + scope: "team" | "organization"; + /** User */ + sender: { /** Format: uri */ - comments_url: string; - /** Format: date-time */ - created_at: string; - draft?: boolean; + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; /** Format: uri */ - events_url: string; + 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 */ + 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; - }[]; + 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 */ - 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; - } | 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" | "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; - } | 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; - }; - /** Reactions */ - reactions: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + team: components["schemas"]["webhooks_team"]; + }; + "webhook-merge-group-checks-requested": { + /** @enum {string} */ + action: "checks_requested"; + installation?: components["schemas"]["simple-installation"]; + merge_group: components["schemas"]["merge-group"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + "webhook-merge-group-destroyed": { + /** @enum {string} */ + action: "destroyed"; + /** + * @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated). + * @enum {string} + */ + reason?: "merged" | "invalidated" | "dequeued"; + installation?: components["schemas"]["simple-installation"]; + merge_group: components["schemas"]["merge-group"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** meta deleted event */ + "webhook-meta-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ + hook: { + active: boolean; + config: { + /** @enum {string} */ + content_type: "json" | "form"; + insecure_ssl: string; + secret?: string; /** Format: uri */ url: string; }; - /** 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 */ + created_at: string; + events: ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[]; + id: number; + name: string; + type: string; updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - url: string; + }; + /** @description The id of the modified webhook. */ + hook_id: number; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: null | components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** milestone closed event */ + "webhook-milestone-closed": { + /** @enum {string} */ + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** milestone created event */ + "webhook-milestone-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone_3"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** milestone deleted event */ + "webhook-milestone-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** milestone edited event */ + "webhook-milestone-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the milestone if the action was `edited`. */ + changes: { + description?: { + /** @description The previous version of the description if the action was `edited`. */ + from: string; + }; + due_on?: { + /** @description The previous version of the due date if the action was `edited`. */ + from: string; + }; + title?: { + /** @description The previous version of the title if the action was `edited`. */ + from: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** milestone opened event */ + "webhook-milestone-opened": { + /** @enum {string} */ + action: "opened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone_3"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** org_block blocked event */ + "webhook-org-block-blocked": { + /** @enum {string} */ + action: "blocked"; + blocked_user: components["schemas"]["webhooks_user"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** org_block unblocked event */ + "webhook-org-block-unblocked": { + /** @enum {string} */ + action: "unblocked"; + blocked_user: components["schemas"]["webhooks_user"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization deleted event */ + "webhook-organization-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership?: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization member_added event */ + "webhook-organization-member-added": { + /** @enum {string} */ + action: "member_added"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization member_invited event */ + "webhook-organization-member-invited": { + /** @enum {string} */ + action: "member_invited"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The invitation for the user or email if the action is `member_invited`. */ + invitation: { + /** Format: date-time */ + created_at: string; + email: string | null; + /** Format: date-time */ + failed_at: string | null; + failed_reason: string | null; + id: number; + /** Format: uri */ + invitation_teams_url: string; /** User */ - user: { + inviter: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -48071,30 +50423,86 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; + login: string | null; + node_id: string; + role: string; + team_count: number; + invitation_source?: string; }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; + user?: components["schemas"]["webhooks_user"]; }; - /** issues unlabeled event */ - "webhook-issues-unlabeled": { + /** organization member_removed event */ + "webhook-organization-member-removed": { /** @enum {string} */ - action: "unlabeled"; + action: "member_removed"; 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; + membership: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization renamed event */ + "webhook-organization-renamed": { + /** @enum {string} */ + action: "renamed"; + changes?: { + login?: { + from?: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership?: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Ruby Gems metadata */ + "webhook-rubygems-metadata": { + name?: string; + description?: string; + readme?: string; + homepage?: string; + version_info?: { + version?: string; + }; + platform?: string; + metadata?: { + [key: string]: string | undefined; + }; + repo?: string; + dependencies?: { + [key: string]: string | undefined; + }[]; + commit_oid?: string; + }; + /** package published event */ + "webhook-package-published": { + /** @enum {string} */ + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description Information about the package. */ + package: { + created_at: string | null; + description: string | null; + ecosystem: string; + /** Format: uri */ + html_url: string; + id: number; + name: string; + namespace: string; /** User */ - assignee?: { + owner: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -48126,24 +50534,245 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + 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; + package_type: string; + package_version: { + /** User */ + author?: { + /** 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; + body?: string | Record; + body_html?: string; + container_metadata?: { + labels?: Record | null; + manifest?: Record | null; + tag?: { + digest?: string; + name?: string; + }; + } | null; + created_at?: string; + description: string; + docker_metadata?: { + tags?: string[]; + }[]; + draft?: boolean; /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; + html_url: string; + id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; + }[]; + name: string; + npm_metadata?: { + name?: string; + version?: string; + npm_user?: string; + author?: Record | null; + bugs?: Record | null; + dependencies?: Record; + dev_dependencies?: Record; + peer_dependencies?: Record; + optional_dependencies?: Record; + description?: string; + dist?: Record | null; + git_head?: string; + homepage?: string; + license?: string; + main?: string; + repository?: Record | null; + scripts?: Record; + id?: string; + node_version?: string; + npm_version?: string; + has_shrinkwrap?: boolean; + maintainers?: Record[]; + contributors?: Record[]; + engines?: Record; + keywords?: string[]; + files?: string[]; + bin?: Record; + man?: Record; + directories?: Record | null; + os?: string[]; + cpu?: string[]; + readme?: string; + installation_command?: string; + release_id?: number; + commit_oid?: string; + published_via_actions?: boolean; + deleted_by_id?: number; + } | null; + nuget_metadata?: { + id?: number | string; + name?: string; + value?: boolean | string | number | { + url?: string; + branch?: string; + commit?: string; + type?: string; + }; + }[] | null; + package_files: { + content_type: string; + created_at: string; + /** Format: uri */ + download_url: string; + id: number; + md5: string | null; + name: string; + sha1: string | null; + sha256: string | null; + size: number; + state: string | null; + updated_at: string; + }[]; + package_url?: string; + prerelease?: boolean; + release?: { + /** User */ + author: { + /** 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; + created_at: string; + draft: boolean; + /** Format: uri */ + html_url: string; + id: number; + name: string | null; + prerelease: boolean; + published_at: string; + tag_name: string; + target_commitish: string; + /** Format: uri */ + url: string; + }; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + source_url?: string; + summary: string; + tag_name?: string; + target_commitish?: string; + target_oid?: string; + updated_at?: string; + version: string; + } | null; + registry: { + /** Format: uri */ + about_url: string; + name: string; + type: string; + /** Format: uri */ + url: string; + vendor: string; + } | null; + updated_at: string | null; + }; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** package updated event */ + "webhook-package-updated": { + /** @enum {string} */ + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description Information about the package. */ + package: { + created_at: string; + description: string | null; + ecosystem: string; + /** Format: uri */ + html_url: string; + id: number; + name: string; + namespace: 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; @@ -48162,62 +50791,14 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + 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; - }[]; - /** 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; + } | null; + package_type: string; + package_version: { /** User */ - creator: { + author: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -48249,217 +50830,130 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; - description: string | null; - /** Format: date-time */ - due_on: string | null; + body: string; + body_html: string; + created_at: string; + description: string; + docker_metadata?: { + tags?: string[]; + }[]; + draft?: boolean; /** 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" | "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 */ + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; + }[]; 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; + package_files: { + content_type: string; + created_at: string; /** Format: uri */ - html_url?: string; + download_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; + md5: string | null; + name: string; + sha1: string | null; + sha256: string; + size: number; + state: string; + updated_at: string; + }[]; + package_url?: string; + prerelease?: boolean; + release?: { + /** User */ + author: { + /** 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; + created_at: string; + draft: boolean; /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + html_url: string; + id: number; + name: string; + prerelease: boolean; + published_at: string; + tag_name: string; + target_commitish: string; /** Format: uri */ - url?: 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"; + url: string; }; - /** @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; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; /** Format: uri */ - url?: string; + source_url?: string; + summary: string; + tag_name?: string; + target_commitish: string; + target_oid: string; + updated_at: string; + version: string; }; - /** Reactions */ - reactions: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; + registry: { + /** Format: uri */ + about_url: string; + name: string; + type: string; /** Format: uri */ url: string; - }; - /** 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 */ + vendor: string; + } | null; updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - url: string; + }; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** page_build event */ + "webhook-page-build": { + /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ + build: { + commit: string | null; + created_at: string; + duration: number; + error: { + message: string | null; + }; /** User */ - user: { + pusher: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -48491,42 +50985,159 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; + status: string; + updated_at: string; + /** Format: uri */ + url: string; }; - /** Label */ - label?: { - /** @description 6-character hex code, without the leading #, identifying the color */ - color: string; - default: boolean; - description: string | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; + id: number; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** personal_access_token_request approved event */ + "webhook-personal-access-token-request-approved": { + /** @enum {string} */ + action: "approved"; + personal_access_token_request: components["schemas"]["personal-access-token-request"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + installation: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request cancelled event */ + "webhook-personal-access-token-request-cancelled": { + /** @enum {string} */ + action: "cancelled"; + personal_access_token_request: components["schemas"]["personal-access-token-request"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + installation: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request created event */ + "webhook-personal-access-token-request-created": { + /** @enum {string} */ + action: "created"; + personal_access_token_request: components["schemas"]["personal-access-token-request"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + installation: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request denied event */ + "webhook-personal-access-token-request-denied": { + /** @enum {string} */ + action: "denied"; + personal_access_token_request: components["schemas"]["personal-access-token-request"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + installation: components["schemas"]["simple-installation"]; + }; + "webhook-ping": { + /** + * Webhook + * @description The webhook that is being pinged + */ + hook?: { + /** @description Determines whether the hook is actually triggered for the events it subscribes to. */ + active: boolean; + /** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */ + app_id?: number; + config: { + content_type?: components["schemas"]["webhook-config-content-type"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + secret?: components["schemas"]["webhook-config-secret"]; + url?: components["schemas"]["webhook-config-url"]; + }; + /** Format: date-time */ + created_at: string; + /** Format: uri */ + deliveries_url?: string; + /** @description Determines what events the hook is triggered for. Default: ['push']. */ + events: string[]; + /** @description Unique identifier of the webhook. */ id: number; - /** @description The name of the label. */ - name: string; - node_id: string; + last_response?: components["schemas"]["hook-response"]; /** - * Format: uri - * @description URL for the label + * @description The type of webhook. The only valid value is 'web'. + * @enum {string} */ - url: string; + name: "web"; + /** Format: uri */ + ping_url?: string; + /** Format: uri */ + test_url?: string; + type: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url?: string; }; + /** @description The ID of the webhook that triggered the ping. */ + hook_id?: number; organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + /** @description Random string of GitHub zen. */ + zen?: string; + }; + /** @description The webhooks ping payload encoded with URL encoding. */ + "webhook-ping-form-encoded": { + /** @description A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. */ + payload: string; + }; + /** project_card converted event */ + "webhook-project-card-converted": { + /** @enum {string} */ + action: "converted"; + changes: { + note: { + from: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: components["schemas"]["webhooks_project_card"]; + repository?: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** issues unlocked event */ - "webhook-issues-unlocked": { + /** project_card created event */ + "webhook-project-card-created": { /** @enum {string} */ - action: "unlocked"; + action: "created"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: components["schemas"]["webhooks_project_card"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card deleted event */ + "webhook-project-card-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** Project Card */ + project_card: { + after_id?: number | null; + /** @description Whether or not the card is archived */ + archived: boolean; + column_id: number | null; + /** Format: uri */ + column_url: string; + /** Format: uri */ + content_url?: string; + /** Format: date-time */ + created_at: string; /** User */ - assignee?: { + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -48558,11 +51169,65 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - assignees: ({ + /** @description The project card's ID */ + id: number; + node_id: string; + note: string | null; + /** Format: uri */ + project_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + }; + repository?: null | components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card edited event */ + "webhook-project-card-edited": { + /** @enum {string} */ + action: "edited"; + changes: { + note: { + from: string | null; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: components["schemas"]["webhooks_project_card"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card moved event */ + "webhook-project-card-moved": { + /** @enum {string} */ + action: "moved"; + changes?: { + column_id: { + from: number; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: { + after_id?: number | null; + /** @description Whether or not the card is archived */ + archived: boolean; + column_id: number; + /** Format: uri */ + column_url: string; + /** Format: uri */ + content_url?: string; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -48594,418 +51259,388 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** 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; + } | null; + /** @description The project card's ID */ + id: number; + node_id: string; + note: string | null; /** Format: uri */ - comments_url: string; + project_url: string; /** Format: date-time */ - created_at: string; - draft?: boolean; - /** Format: uri */ - events_url: string; + updated_at: 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; - /** - * 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"; - /** Format: uri */ - url?: 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")[]; - /** 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; - } | 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"; - /** @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 */ + url: string; + } & { + after_id: number | null; + archived?: boolean; + column_id?: number; + column_url?: string; + created_at?: string; + creator?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; html_url?: string; - /** Format: date-time */ - merged_at?: string | null; - /** Format: uri */ - patch_url?: string; - /** Format: uri */ - url?: string; - }; - /** 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} - */ - 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; - id: number; - login: string; - name?: string; + id?: number; + login?: 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 */ + type?: string; url?: string; } | null; - } & { - active_lock_reason: null; - assignee?: Record | null; - assignees?: (Record | null)[]; - 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 | null)[]; - labels_url?: string; - /** @enum {boolean} */ - locked: false; - milestone?: Record | null; node_id?: string; - number?: number; - performed_via_github_app?: null; - 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; - state?: string; - timeline_url?: string; - title?: string; + note?: string | null; + project_url?: 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; - 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; + }; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project closed event */ + "webhook-project-closed": { + /** @enum {string} */ + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_column created event */ + "webhook-project-column-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project_column deleted event */ + "webhook-project-column-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: null | components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project_column edited event */ + "webhook-project-column-edited": { + /** @enum {string} */ + action: "edited"; + changes: { + name?: { + from: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project_column moved event */ + "webhook-project-column-moved": { + /** @enum {string} */ + action: "moved"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project created event */ + "webhook-project-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project deleted event */ + "webhook-project-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: null | components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project edited event */ + "webhook-project-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the project if the action was `edited`. */ + changes?: { + body?: { + /** @description The previous version of the body if the action was `edited`. */ + from: string; + }; + name?: { + /** @description The changes to the project if the action was `edited`. */ + from: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project reopened event */ + "webhook-project-reopened": { + /** @enum {string} */ + action: "reopened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Closed Event */ + "webhook-projects-v2-project-closed": { + /** @enum {string} */ + action: "closed"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** @description A project was created */ + "webhook-projects-v2-project-created": { + /** @enum {string} */ + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Deleted Event */ + "webhook-projects-v2-project-deleted": { + /** @enum {string} */ + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Edited Event */ + "webhook-projects-v2-project-edited": { + /** @enum {string} */ + action: "edited"; + changes: { + description?: { + from?: string | null; + to?: string | null; + }; + public?: { + from?: boolean; + to?: boolean; + }; + short_description?: { + from?: string | null; + to?: string | null; + }; + title?: { + from?: string; + to?: string; + }; + }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Archived Event */ + "webhook-projects-v2-item-archived": { + /** @enum {string} */ + action: "archived"; + changes: components["schemas"]["webhooks_project_changes"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Converted Event */ + "webhook-projects-v2-item-converted": { + /** @enum {string} */ + action: "converted"; + changes: { + content_type?: { + from?: string | null; + to?: string; + }; + }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Created Event */ + "webhook-projects-v2-item-created": { + /** @enum {string} */ + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Deleted Event */ + "webhook-projects-v2-item-deleted": { + /** @enum {string} */ + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Edited Event */ + "webhook-projects-v2-item-edited": { + /** @enum {string} */ + action: "edited"; + changes?: { + field_value: { + field_node_id?: string; + field_type?: string; + }; + } | { + body: { + from?: string | null; + to?: string | null; + }; + }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Reordered Event */ + "webhook-projects-v2-item-reordered": { + /** @enum {string} */ + action: "reordered"; + changes: { + previous_projects_v2_item_node_id?: { + from?: string | null; + to?: string | null; }; }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Restored Event */ + "webhook-projects-v2-item-restored": { + /** @enum {string} */ + action: "restored"; + changes: components["schemas"]["webhooks_project_changes"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Reopened Event */ + "webhook-projects-v2-project-reopened": { + /** @enum {string} */ + action: "reopened"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** public event */ + "webhook-public": { + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** issues unpinned event */ - "webhook-issues-unpinned": { + /** pull_request assigned event */ + "webhook-pull-request-assigned": { /** @enum {string} */ - action: "unpinned"; + action: "assigned"; + assignee: components["schemas"]["webhooks_user"]; 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: { + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** Pull Request */ + pull_request: { + _links: { + /** Link */ + comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + commits: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + issue: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comment: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + statuses: { + /** Format: uri-template */ + href: string; + }; + }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - assignee?: { + assignee: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -49037,7 +51672,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; @@ -49073,7 +51708,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)[]; @@ -49083,52 +51718,17 @@ export interface components { * @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; /** - * Milestone - * @description A collection of related issues and pull requests. + * PullRequestAutoMerge + * @description The status of auto merging a pull request. */ - milestone: { - /** Format: date-time */ - closed_at: string | null; - closed_issues: number; - /** Format: date-time */ - created_at: string; + auto_merge: { + /** @description Commit message for the merge commit. */ + commit_message: string | null; + /** @description Title for the merge commit message. */ + commit_title: string | null; /** User */ - creator: { + enabled_by: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -49164,53 +51764,299 @@ export interface components { /** Format: uri */ url?: 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. + * @description The merge method to use. * @enum {string} */ - state: "open" | "closed"; - /** @description The title of the milestone. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; + merge_method: "merge" | "squash" | "rebase"; } | 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")[]; - /** 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; + base: { + label: string; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: 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; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: null | number | string; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + }; + sha: string; /** User */ - owner: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -49246,9183 +52092,17 @@ export interface components { /** Format: uri */ url?: 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"; - /** @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; - }; - /** 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; }; + body: string | null; + changed_files?: number; + /** Format: date-time */ + closed_at: string | null; + comments?: number; /** Format: uri */ - repository_url: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - state?: "open" | "closed"; - state_reason?: string | null; + comments_url: string; + commits?: number; /** 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; - 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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** label created event */ - "webhook-label-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** Label */ - label: { - /** @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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** label deleted event */ - "webhook-label-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** Label */ - label: { - /** @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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** label edited event */ - "webhook-label-edited": { - /** @enum {string} */ - action: "edited"; - /** @description The changes to the label if the action was `edited`. */ - changes?: { - color?: { - /** @description The previous version of the color if the action was `edited`. */ - from: string; - }; - description?: { - /** @description The previous version of the description if the action was `edited`. */ - from: string; - }; - name?: { - /** @description The previous version of the name if the action was `edited`. */ - from: string; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** Label */ - label: { - /** @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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** marketplace_purchase cancelled event */ - "webhook-marketplace-purchase-cancelled": { - /** @enum {string} */ - action: "cancelled"; - effective_date: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - marketplace_purchase: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: string | null; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - } & { - account?: { - id?: number; - login?: string; - node_id?: string; - organization_billing_email?: string | null; - type?: string; - }; - billing_cycle?: string; - free_trial_ends_on?: string | null; - next_billing_date: string | null; - on_free_trial?: boolean; - plan?: { - bullets?: (string | null)[]; - description?: string; - has_free_trial?: boolean; - id?: number; - monthly_price_in_cents?: number; - name?: string; - /** @enum {string} */ - price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name?: string | null; - yearly_price_in_cents?: number; - }; - unit_count?: number; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - previous_marketplace_purchase?: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: null; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** marketplace_purchase changed event */ - "webhook-marketplace-purchase-changed": { - /** @enum {string} */ - action: "changed"; - effective_date: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - marketplace_purchase: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: string | null; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - } & { - account?: { - id?: number; - login?: string; - node_id?: string; - organization_billing_email?: string | null; - type?: string; - }; - billing_cycle?: string; - free_trial_ends_on?: string | null; - next_billing_date: string | null; - on_free_trial?: boolean; - plan?: { - bullets?: (string | null)[]; - description?: string; - has_free_trial?: boolean; - id?: number; - monthly_price_in_cents?: number; - name?: string; - /** @enum {string} */ - price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name?: string | null; - yearly_price_in_cents?: number; - }; - unit_count?: number; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - previous_marketplace_purchase?: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: string | null; - next_billing_date?: string | null; - on_free_trial: boolean | null; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** marketplace_purchase pending_change event */ - "webhook-marketplace-purchase-pending-change": { - /** @enum {string} */ - action: "pending_change"; - effective_date: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - marketplace_purchase: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: string | null; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - } & { - account?: { - id?: number; - login?: string; - node_id?: string; - organization_billing_email?: string | null; - type?: string; - }; - billing_cycle?: string; - free_trial_ends_on?: string | null; - next_billing_date: string | null; - on_free_trial?: boolean; - plan?: { - bullets?: (string | null)[]; - description?: string; - has_free_trial?: boolean; - id?: number; - monthly_price_in_cents?: number; - name?: string; - /** @enum {string} */ - price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name?: string | null; - yearly_price_in_cents?: number; - }; - unit_count?: number; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - previous_marketplace_purchase?: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: string | null; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** marketplace_purchase pending_change_cancelled event */ - "webhook-marketplace-purchase-pending-change-cancelled": { - /** @enum {string} */ - action: "pending_change_cancelled"; - effective_date: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - marketplace_purchase: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: null; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - } & { - next_billing_date: string; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - previous_marketplace_purchase?: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: null; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** marketplace_purchase purchased event */ - "webhook-marketplace-purchase-purchased": { - /** @enum {string} */ - action: "purchased"; - effective_date: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - marketplace_purchase: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: string | null; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - } & { - account?: { - id?: number; - login?: string; - node_id?: string; - organization_billing_email?: string | null; - type?: string; - }; - billing_cycle?: string; - free_trial_ends_on?: string | null; - next_billing_date: string | null; - on_free_trial?: boolean; - plan?: { - bullets?: (string | null)[]; - description?: string; - has_free_trial?: boolean; - id?: number; - monthly_price_in_cents?: number; - name?: string; - /** @enum {string} */ - price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name?: string | null; - yearly_price_in_cents?: number; - }; - unit_count?: number; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - previous_marketplace_purchase?: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: null; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** member added event */ - "webhook-member-added": { - /** @enum {string} */ - action: "added"; - changes?: { - permission?: { - /** @enum {string} */ - to: "write" | "admin" | "read"; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** 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; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** member edited event */ - "webhook-member-edited": { - /** @enum {string} */ - action: "edited"; - /** @description The changes to the collaborator permissions */ - changes: { - old_permission?: { - /** @description The previous permissions of the collaborator if the action was edited. */ - from: string; - }; - permission?: { - from?: string | null; - to?: string | null; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** 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; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** member removed event */ - "webhook-member-removed": { - /** @enum {string} */ - action: "removed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** 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; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** membership added event */ - "webhook-membership-added": { - /** @enum {string} */ - action: "added"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** 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; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - /** - * @description The scope of the membership. Currently, can only be `team`. - * @enum {string} - */ - scope: "team"; - /** User */ - sender: { - /** 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; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** @enum {string} */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; - }; - /** membership removed event */ - "webhook-membership-removed": { - /** @enum {string} */ - action: "removed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** 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; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - /** - * @description The scope of the membership. Currently, can only be `team`. - * @enum {string} - */ - scope: "team" | "organization"; - /** User */ - sender: { - /** 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; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** @enum {string} */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; - }; - "webhook-merge-group-checks-requested": { - /** @enum {string} */ - action: "checks_requested"; - installation?: components["schemas"]["simple-installation"]; - merge_group: components["schemas"]["merge-group"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - "webhook-merge-group-destroyed": { - /** @enum {string} */ - action: "destroyed"; - /** - * @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated). - * @enum {string} - */ - reason?: "merged" | "invalidated" | "dequeued"; - installation?: components["schemas"]["simple-installation"]; - merge_group: components["schemas"]["merge-group"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** meta deleted event */ - "webhook-meta-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ - hook: { - active: boolean; - config: { - /** @enum {string} */ - content_type: "json" | "form"; - insecure_ssl: string; - secret?: string; - /** Format: uri */ - url: string; - }; - created_at: string; - events: ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[]; - id: number; - name: string; - type: string; - updated_at: string; - }; - /** @description The id of the modified webhook. */ - hook_id: number; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: null | components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone closed event */ - "webhook-milestone-closed": { - /** @enum {string} */ - action: "closed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * 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; - } | 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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone created event */ - "webhook-milestone-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * 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"; - /** Format: uri */ - url?: 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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone deleted event */ - "webhook-milestone-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * 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; - } | 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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone edited event */ - "webhook-milestone-edited": { - /** @enum {string} */ - action: "edited"; - /** @description The changes to the milestone if the action was `edited`. */ - changes: { - description?: { - /** @description The previous version of the description if the action was `edited`. */ - from: string; - }; - due_on?: { - /** @description The previous version of the due date if the action was `edited`. */ - from: string; - }; - title?: { - /** @description The previous version of the title if the action was `edited`. */ - from: string; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * 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; - } | 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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone opened event */ - "webhook-milestone-opened": { - /** @enum {string} */ - action: "opened"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * 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"; - /** Format: uri */ - url?: 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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** org_block blocked event */ - "webhook-org-block-blocked": { - /** @enum {string} */ - action: "blocked"; - /** User */ - blocked_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; - 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; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** org_block unblocked event */ - "webhook-org-block-unblocked": { - /** @enum {string} */ - action: "unblocked"; - /** User */ - blocked_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; - 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; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** organization deleted event */ - "webhook-organization-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - membership?: { - /** Format: uri */ - organization_url: string; - role: string; - state: string; - /** Format: uri */ - 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; - 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; - }; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** organization member_added event */ - "webhook-organization-member-added": { - /** @enum {string} */ - action: "member_added"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - membership: { - /** Format: uri */ - organization_url: string; - role: string; - state: string; - /** Format: uri */ - 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; - 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; - }; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** organization member_invited event */ - "webhook-organization-member-invited": { - /** @enum {string} */ - action: "member_invited"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The invitation for the user or email if the action is `member_invited`. */ - invitation: { - /** Format: date-time */ - created_at: string; - email: string | null; - /** Format: date-time */ - failed_at: string | null; - failed_reason: string | null; - id: number; - /** Format: uri */ - invitation_teams_url: string; - /** User */ - inviter: { - /** 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; - login: string | null; - node_id: string; - role: string; - team_count: number; - invitation_source?: string; - }; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - /** 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; - 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; - }; - /** organization member_removed event */ - "webhook-organization-member-removed": { - /** @enum {string} */ - action: "member_removed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - membership: { - /** Format: uri */ - organization_url: string; - role: string; - state: string; - /** Format: uri */ - 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; - 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; - }; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** organization renamed event */ - "webhook-organization-renamed": { - /** @enum {string} */ - action: "renamed"; - changes?: { - login?: { - from?: string; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - membership?: { - /** Format: uri */ - organization_url: string; - role: string; - state: string; - /** Format: uri */ - 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; - 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; - }; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Ruby Gems metadata */ - "webhook-rubygems-metadata": { - name?: string; - description?: string; - readme?: string; - homepage?: string; - version_info?: { - version?: string; - }; - platform?: string; - metadata?: { - [key: string]: string | undefined; - }; - repo?: string; - dependencies?: { - [key: string]: string | undefined; - }[]; - commit_oid?: string; - }; - /** package published event */ - "webhook-package-published": { - /** @enum {string} */ - action: "published"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description Information about the package. */ - package: { - created_at: string | null; - description: string | null; - ecosystem: string; - /** Format: uri */ - html_url: string; - id: number; - name: string; - namespace: 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; - } | null; - package_type: string; - package_version: { - /** User */ - author?: { - /** 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; - body?: string | Record; - body_html?: string; - container_metadata?: { - labels?: Record | null; - manifest?: Record | null; - tag?: { - digest?: string; - name?: string; - }; - } | null; - created_at?: string; - description: string; - docker_metadata?: { - tags?: string[]; - }[]; - draft?: boolean; - /** Format: uri */ - html_url: string; - id: number; - installation_command: string; - manifest?: string; - metadata: { - [key: string]: unknown; - }[]; - name: string; - npm_metadata?: { - name?: string; - version?: string; - npm_user?: string; - author?: Record | null; - bugs?: Record | null; - dependencies?: Record; - dev_dependencies?: Record; - peer_dependencies?: Record; - optional_dependencies?: Record; - description?: string; - dist?: Record | null; - git_head?: string; - homepage?: string; - license?: string; - main?: string; - repository?: Record | null; - scripts?: Record; - id?: string; - node_version?: string; - npm_version?: string; - has_shrinkwrap?: boolean; - maintainers?: Record[]; - contributors?: Record[]; - engines?: Record; - keywords?: string[]; - files?: string[]; - bin?: Record; - man?: Record; - directories?: Record | null; - os?: string[]; - cpu?: string[]; - readme?: string; - installation_command?: string; - release_id?: number; - commit_oid?: string; - published_via_actions?: boolean; - deleted_by_id?: number; - } | null; - nuget_metadata?: { - id?: number | string; - name?: string; - value?: boolean | string | number | { - url?: string; - branch?: string; - commit?: string; - type?: string; - }; - }[] | null; - package_files: { - content_type: string; - created_at: string; - /** Format: uri */ - download_url: string; - id: number; - md5: string | null; - name: string; - sha1: string | null; - sha256: string | null; - size: number; - state: string | null; - updated_at: string; - }[]; - package_url?: string; - prerelease?: boolean; - release?: { - /** User */ - author: { - /** 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; - created_at: string; - draft: boolean; - /** Format: uri */ - html_url: string; - id: number; - name: string | null; - prerelease: boolean; - published_at: string; - tag_name: string; - target_commitish: string; - /** Format: uri */ - url: string; - }; - rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - source_url?: string; - summary: string; - tag_name?: string; - target_commitish?: string; - target_oid?: string; - updated_at?: string; - version: string; - } | null; - registry: { - /** Format: uri */ - about_url: string; - name: string; - type: string; - /** Format: uri */ - url: string; - vendor: string; - } | null; - updated_at: string | null; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** package updated event */ - "webhook-package-updated": { - /** @enum {string} */ - action: "updated"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description Information about the package. */ - package: { - created_at: string; - description: string | null; - ecosystem: string; - /** Format: uri */ - html_url: string; - id: number; - name: string; - namespace: 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; - } | null; - package_type: string; - package_version: { - /** User */ - author: { - /** 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; - body: string; - body_html: string; - created_at: string; - description: string; - docker_metadata?: { - tags?: string[]; - }[]; - draft?: boolean; - /** Format: uri */ - html_url: string; - id: number; - installation_command: string; - manifest?: string; - metadata: { - [key: string]: unknown; - }[]; - name: string; - package_files: { - content_type: string; - created_at: string; - /** Format: uri */ - download_url: string; - id: number; - md5: string | null; - name: string; - sha1: string | null; - sha256: string; - size: number; - state: string; - updated_at: string; - }[]; - package_url?: string; - prerelease?: boolean; - release?: { - /** User */ - author: { - /** 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; - created_at: string; - draft: boolean; - /** Format: uri */ - html_url: string; - id: number; - name: string; - prerelease: boolean; - published_at: string; - tag_name: string; - target_commitish: string; - /** Format: uri */ - url: string; - }; - rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - /** Format: uri */ - source_url?: string; - summary: string; - tag_name?: string; - target_commitish: string; - target_oid: string; - updated_at: string; - version: string; - }; - registry: { - /** Format: uri */ - about_url: string; - name: string; - type: string; - /** Format: uri */ - url: string; - vendor: string; - } | null; - updated_at: string; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** page_build event */ - "webhook-page-build": { - /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ - build: { - commit: string | null; - created_at: string; - duration: number; - error: { - message: string | null; - }; - /** User */ - pusher: { - /** 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; - status: string; - updated_at: string; - /** Format: uri */ - url: string; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - id: number; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** personal_access_token_request approved event */ - "webhook-personal-access-token-request-approved": { - /** @enum {string} */ - action: "approved"; - personal_access_token_request: components["schemas"]["personal-access-token-request"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; - }; - /** personal_access_token_request cancelled event */ - "webhook-personal-access-token-request-cancelled": { - /** @enum {string} */ - action: "cancelled"; - personal_access_token_request: components["schemas"]["personal-access-token-request"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; - }; - /** personal_access_token_request created event */ - "webhook-personal-access-token-request-created": { - /** @enum {string} */ - action: "created"; - personal_access_token_request: components["schemas"]["personal-access-token-request"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; - }; - /** personal_access_token_request denied event */ - "webhook-personal-access-token-request-denied": { - /** @enum {string} */ - action: "denied"; - personal_access_token_request: components["schemas"]["personal-access-token-request"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; - }; - "webhook-ping": { - /** - * Webhook - * @description The webhook that is being pinged - */ - hook?: { - /** @description Determines whether the hook is actually triggered for the events it subscribes to. */ - active: boolean; - /** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */ - app_id?: number; - config: { - content_type?: components["schemas"]["webhook-config-content-type"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - secret?: components["schemas"]["webhook-config-secret"]; - url?: components["schemas"]["webhook-config-url"]; - }; - /** Format: date-time */ - created_at: string; - /** Format: uri */ - deliveries_url?: string; - /** @description Determines what events the hook is triggered for. Default: ['push']. */ - events: string[]; - /** @description Unique identifier of the webhook. */ - id: number; - last_response?: components["schemas"]["hook-response"]; - /** - * @description The type of webhook. The only valid value is 'web'. - * @enum {string} - */ - name: "web"; - /** Format: uri */ - ping_url?: string; - /** Format: uri */ - test_url?: string; - type: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url?: string; - }; - /** @description The ID of the webhook that triggered the ping. */ - hook_id?: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - /** @description Random string of GitHub zen. */ - zen?: string; - }; - /** @description The webhooks ping payload encoded with URL encoding. */ - "webhook-ping-form-encoded": { - /** @description A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. */ - payload: string; - }; - /** project_card converted event */ - "webhook-project-card-converted": { - /** @enum {string} */ - action: "converted"; - changes: { - note: { - from: string; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - project_card: { - after_id?: number | null; - /** @description Whether or not the card is archived */ - archived: boolean; - column_id: number; - /** Format: uri */ - column_url: string; - /** Format: uri */ - content_url?: string; - /** 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"; - /** Format: uri */ - url?: string; - } | null; - /** @description The project card's ID */ - id: number; - node_id: string; - note: string | null; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_card created event */ - "webhook-project-card-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - project_card: { - after_id?: number | null; - /** @description Whether or not the card is archived */ - archived: boolean; - column_id: number; - /** Format: uri */ - column_url: string; - /** Format: uri */ - content_url?: string; - /** 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"; - /** Format: uri */ - url?: string; - } | null; - /** @description The project card's ID */ - id: number; - node_id: string; - note: string | null; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_card deleted event */ - "webhook-project-card-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - project_card: { - after_id?: number | null; - /** @description Whether or not the card is archived */ - archived: boolean; - column_id: number | null; - /** Format: uri */ - column_url: string; - /** Format: uri */ - content_url?: string; - /** 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; - } | null; - /** @description The project card's ID */ - id: number; - node_id: string; - note: string | null; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: null | components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_card edited event */ - "webhook-project-card-edited": { - /** @enum {string} */ - action: "edited"; - changes: { - note: { - from: string | null; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - project_card: { - after_id?: number | null; - /** @description Whether or not the card is archived */ - archived: boolean; - column_id: number; - /** Format: uri */ - column_url: string; - /** Format: uri */ - content_url?: string; - /** 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"; - /** Format: uri */ - url?: string; - } | null; - /** @description The project card's ID */ - id: number; - node_id: string; - note: string | null; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_card moved event */ - "webhook-project-card-moved": { - /** @enum {string} */ - action: "moved"; - changes?: { - column_id: { - from: number; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - project_card: { - after_id?: number | null; - /** @description Whether or not the card is archived */ - archived: boolean; - column_id: number; - /** Format: uri */ - column_url: string; - /** Format: uri */ - content_url?: string; - /** 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; - } | null; - /** @description The project card's ID */ - id: number; - node_id: string; - note: string | null; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - } & { - after_id: number | null; - archived?: boolean; - column_id?: number; - column_url?: string; - created_at?: string; - creator?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - } | null; - id?: number; - node_id?: string; - note?: string | null; - project_url?: string; - updated_at?: string; - url?: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project closed event */ - "webhook-project-closed": { - /** @enum {string} */ - action: "closed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - project: { - /** @description Body of the project */ - body: string | null; - /** Format: uri */ - columns_url: string; - /** 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"; - /** Format: uri */ - url?: string; - } | null; - /** Format: uri */ - html_url: string; - id: number; - /** @description Name of the project */ - name: string; - node_id: string; - number: number; - /** Format: uri */ - owner_url: string; - /** - * @description State of the project; either 'open' or 'closed' - * @enum {string} - */ - state: "open" | "closed"; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_column created event */ - "webhook-project-column-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - project_column: { - after_id?: number | null; - /** Format: uri */ - cards_url: string; - /** Format: date-time */ - created_at: string; - /** @description The unique identifier of the project column */ - id: number; - /** @description Name of the project column */ - name: string; - node_id: string; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** project_column deleted event */ - "webhook-project-column-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - project_column: { - after_id?: number | null; - /** Format: uri */ - cards_url: string; - /** Format: date-time */ - created_at: string; - /** @description The unique identifier of the project column */ - id: number; - /** @description Name of the project column */ - name: string; - node_id: string; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: null | components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** project_column edited event */ - "webhook-project-column-edited": { - /** @enum {string} */ - action: "edited"; - changes: { - name?: { - from: string; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - project_column: { - after_id?: number | null; - /** Format: uri */ - cards_url: string; - /** Format: date-time */ - created_at: string; - /** @description The unique identifier of the project column */ - id: number; - /** @description Name of the project column */ - name: string; - node_id: string; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** project_column moved event */ - "webhook-project-column-moved": { - /** @enum {string} */ - action: "moved"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - project_column: { - after_id?: number | null; - /** Format: uri */ - cards_url: string; - /** Format: date-time */ - created_at: string; - /** @description The unique identifier of the project column */ - id: number; - /** @description Name of the project column */ - name: string; - node_id: string; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project created event */ - "webhook-project-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - project: { - /** @description Body of the project */ - body: string | null; - /** Format: uri */ - columns_url: string; - /** 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"; - /** Format: uri */ - url?: string; - } | null; - /** Format: uri */ - html_url: string; - id: number; - /** @description Name of the project */ - name: string; - node_id: string; - number: number; - /** Format: uri */ - owner_url: string; - /** - * @description State of the project; either 'open' or 'closed' - * @enum {string} - */ - state: "open" | "closed"; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project deleted event */ - "webhook-project-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - project: { - /** @description Body of the project */ - body: string | null; - /** Format: uri */ - columns_url: string; - /** 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"; - /** Format: uri */ - url?: string; - } | null; - /** Format: uri */ - html_url: string; - id: number; - /** @description Name of the project */ - name: string; - node_id: string; - number: number; - /** Format: uri */ - owner_url: string; - /** - * @description State of the project; either 'open' or 'closed' - * @enum {string} - */ - state: "open" | "closed"; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: null | components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** project edited event */ - "webhook-project-edited": { - /** @enum {string} */ - action: "edited"; - /** @description The changes to the project if the action was `edited`. */ - changes?: { - body?: { - /** @description The previous version of the body if the action was `edited`. */ - from: string; - }; - name?: { - /** @description The changes to the project if the action was `edited`. */ - from: string; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - project: { - /** @description Body of the project */ - body: string | null; - /** Format: uri */ - columns_url: string; - /** 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"; - /** Format: uri */ - url?: string; - } | null; - /** Format: uri */ - html_url: string; - id: number; - /** @description Name of the project */ - name: string; - node_id: string; - number: number; - /** Format: uri */ - owner_url: string; - /** - * @description State of the project; either 'open' or 'closed' - * @enum {string} - */ - state: "open" | "closed"; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** project reopened event */ - "webhook-project-reopened": { - /** @enum {string} */ - action: "reopened"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - project: { - /** @description Body of the project */ - body: string | null; - /** Format: uri */ - columns_url: string; - /** 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"; - /** Format: uri */ - url?: string; - } | null; - /** Format: uri */ - html_url: string; - id: number; - /** @description Name of the project */ - name: string; - node_id: string; - number: number; - /** Format: uri */ - owner_url: string; - /** - * @description State of the project; either 'open' or 'closed' - * @enum {string} - */ - state: "open" | "closed"; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Closed Event */ - "webhook-projects-v2-project-closed": { - /** @enum {string} */ - action: "closed"; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** @description A project was created */ - "webhook-projects-v2-project-created": { - /** @enum {string} */ - action: "created"; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Deleted Event */ - "webhook-projects-v2-project-deleted": { - /** @enum {string} */ - action: "deleted"; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Edited Event */ - "webhook-projects-v2-project-edited": { - /** @enum {string} */ - action: "edited"; - changes: { - description?: { - from?: string | null; - to?: string | null; - }; - public?: { - from?: boolean; - to?: boolean; - }; - short_description?: { - from?: string | null; - to?: string | null; - }; - title?: { - from?: string; - to?: string; - }; - }; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Archived Event */ - "webhook-projects-v2-item-archived": { - /** @enum {string} */ - action: "archived"; - changes: { - archived_at?: { - /** Format: date-time */ - from?: string | null; - /** Format: date-time */ - to?: string | null; - }; - }; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Converted Event */ - "webhook-projects-v2-item-converted": { - /** @enum {string} */ - action: "converted"; - changes: { - content_type?: { - from?: string | null; - to?: string; - }; - }; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Created Event */ - "webhook-projects-v2-item-created": { - /** @enum {string} */ - action: "created"; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Deleted Event */ - "webhook-projects-v2-item-deleted": { - /** @enum {string} */ - action: "deleted"; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Edited Event */ - "webhook-projects-v2-item-edited": { - /** @enum {string} */ - action: "edited"; - changes?: { - field_value: { - field_node_id?: string; - field_type?: string; - }; - } | { - body: { - from?: string | null; - to?: string | null; - }; - }; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Reordered Event */ - "webhook-projects-v2-item-reordered": { - /** @enum {string} */ - action: "reordered"; - changes: { - previous_projects_v2_item_node_id?: { - from?: string | null; - to?: string | null; - }; - }; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Restored Event */ - "webhook-projects-v2-item-restored": { - /** @enum {string} */ - action: "restored"; - changes: { - archived_at?: { - /** Format: date-time */ - from?: string | null; - /** Format: date-time */ - to?: string | null; - }; - }; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Reopened Event */ - "webhook-projects-v2-project-reopened": { - /** @enum {string} */ - action: "reopened"; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** public event */ - "webhook-public": { - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request assigned event */ - "webhook-pull-request-assigned": { - /** @enum {string} */ - action: "assigned"; - /** 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; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; - }; - }; - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; - /** 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; - } | 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; - } | 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"; - /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. - */ - auto_merge: { - /** @description Commit message for the merge commit. */ - commit_message: string | null; - /** @description Title for the merge commit message. */ - commit_title: string | null; - /** User */ - enabled_by: { - /** 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; - /** - * @description The merge method to use. - * @enum {string} - */ - merge_method: "merge" | "squash" | "rebase"; - } | null; - base: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: null | number | string; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: 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; - 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; - }; - body: string | null; - changed_files?: number; - /** Format: date-time */ - closed_at: string | null; - comments?: number; - /** Format: uri */ - comments_url: string; - commits?: number; - /** Format: uri */ - commits_url: string; - /** Format: date-time */ - created_at: string; - deletions?: number; - /** Format: uri */ - diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - draft: boolean; - head: { - label: string | null; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: null | number | string; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - } | null; - sha: 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; - 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; - }; - /** Format: uri */ - html_url: string; - id: number; - /** Format: uri */ - issue_url: string; - 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; - }[]; - locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; - merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ - merged_at: string | null; - /** User */ - merged_by?: { - /** 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; - /** - * 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; - } | 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; - /** @description Number uniquely identifying the pull request within its repository. */ - number: number; - /** Format: uri */ - patch_url: string; - rebaseable?: boolean | null; - requested_reviewers: (({ - /** 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; - } | null) | { - deleted?: boolean; - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - })[]; - requested_teams: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }[]; - /** Format: uri-template */ - review_comment_url: string; - review_comments?: number; - /** Format: uri */ - review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - state: "open" | "closed"; - /** Format: uri */ - statuses_url: string; - /** @description The title of the pull request. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - 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; - 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; - } | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request auto_merge_disabled event */ - "webhook-pull-request-auto-merge-disabled": { - /** @enum {string} */ - action: "auto_merge_disabled"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; - }; - }; - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; - /** 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"; - /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. - */ - auto_merge: { - /** @description Commit message for the merge commit. */ - commit_message: string | null; - /** @description Title for the merge commit message. */ - commit_title: string | null; - /** User */ - enabled_by: { - /** 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; - /** - * @description The merge method to use. - * @enum {string} - */ - merge_method: "merge" | "squash" | "rebase"; - } | null; - base: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: null | number | string; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: 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; - 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; - }; - body: string | null; - changed_files?: number; - /** Format: date-time */ - closed_at: string | null; - comments?: number; - /** Format: uri */ - comments_url: string; - commits?: number; - /** Format: uri */ - commits_url: string; - /** Format: date-time */ - created_at: string; - deletions?: number; - /** Format: uri */ - diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - draft: boolean; - head: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: null | number | string; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: 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; - 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; - }; - /** Format: uri */ - html_url: string; - id: number; - /** Format: uri */ - issue_url: string; - 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; - }[]; - locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; - merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ - merged_at: string | null; - /** User */ - merged_by?: { - /** 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; - /** - * 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"; - /** Format: uri */ - url?: 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; - /** @description Number uniquely identifying the pull request within its repository. */ - number: number; - /** Format: uri */ - patch_url: string; - rebaseable?: boolean | null; - requested_reviewers: (({ - /** 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; - } | null) | { - deleted?: boolean; - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - })[]; - requested_teams: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }[]; - /** Format: uri-template */ - review_comment_url: string; - review_comments?: number; - /** Format: uri */ - review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - state: "open" | "closed"; - /** Format: uri */ - statuses_url: string; - /** @description The title of the pull request. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - 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; - 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; - } | null; - }; - reason: string; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request auto_merge_enabled event */ - "webhook-pull-request-auto-merge-enabled": { - /** @enum {string} */ - action: "auto_merge_enabled"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; - }; - }; - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; - /** 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"; - /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. - */ - auto_merge: { - /** @description Commit message for the merge commit. */ - commit_message: string | null; - /** @description Title for the merge commit message. */ - commit_title: string | null; - /** User */ - enabled_by: { - /** 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; - /** - * @description The merge method to use. - * @enum {string} - */ - merge_method: "merge" | "squash" | "rebase"; - } | null; - base: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: null | number | string; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: 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; - 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; - }; - body: string | null; - changed_files?: number; - /** Format: date-time */ - closed_at: string | null; - comments?: number; - /** Format: uri */ - comments_url: string; - commits?: number; - /** Format: uri */ - commits_url: string; - /** Format: date-time */ - created_at: string; - deletions?: number; - /** Format: uri */ - diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - draft: boolean; - head: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: null | number | string; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: 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; - 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; - }; - /** Format: uri */ - html_url: string; - id: number; - /** Format: uri */ - issue_url: string; - 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; - }[]; - locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; - merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ - merged_at: string | null; - /** User */ - merged_by?: { - /** 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; - /** - * 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; - } | 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; - /** @description Number uniquely identifying the pull request within its repository. */ - number: number; - /** Format: uri */ - patch_url: string; - rebaseable?: boolean | null; - requested_reviewers: (({ - /** 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; - } | null) | { - deleted?: boolean; - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - })[]; - requested_teams: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }[]; - /** Format: uri-template */ - review_comment_url: string; - review_comments?: number; - /** Format: uri */ - review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - state: "open" | "closed"; - /** Format: uri */ - statuses_url: string; - /** @description The title of the pull request. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - 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; - 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; - } | null; - }; - reason?: string; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request closed event */ - "webhook-pull-request-closed": { - /** @enum {string} */ - action: "closed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - use_squash_pr_title_as_default: boolean; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request converted_to_draft event */ - "webhook-pull-request-converted-to-draft": { - /** @enum {string} */ - action: "converted_to_draft"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - use_squash_pr_title_as_default: boolean; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request demilestoned event */ - "webhook-pull-request-demilestoned": { - /** @enum {string} */ - action: "demilestoned"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - milestone?: components["schemas"]["milestone"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; - }; - }; - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; - /** 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; - } | 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; - } | 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"; - /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. - */ - auto_merge: { - /** @description Commit message for the merge commit. */ - commit_message: string | null; - /** @description Title for the merge commit message. */ - commit_title: string | null; - /** User */ - enabled_by: { - /** 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; - /** - * @description The merge method to use. - * @enum {string} - */ - merge_method: "merge" | "squash" | "rebase"; - } | null; - base: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: null | number | string; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: 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; - 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; - }; - body: string | null; - changed_files?: number; - /** Format: date-time */ - closed_at: string | null; - comments?: number; - /** Format: uri */ - comments_url: string; - commits?: number; - /** Format: uri */ - commits_url: string; - /** Format: date-time */ - created_at: string; - deletions?: number; - /** Format: uri */ - diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - draft: boolean; - head: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: null | number | string; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: 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; - 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; - }; - /** Format: uri */ - html_url: string; - id: number; - /** Format: uri */ - issue_url: string; - 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; - }[]; - locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; - merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ - merged_at: string | null; - /** User */ - merged_by?: { - /** 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; - } | null; - /** - * 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; - } | 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; - /** @description Number uniquely identifying the pull request within its repository. */ - number: number; - /** Format: uri */ - patch_url: string; - rebaseable?: boolean | null; - requested_reviewers: (({ - /** 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) | { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - })[]; - requested_teams: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }[]; - /** Format: uri-template */ - review_comment_url: string; - review_comments?: number; - /** Format: uri */ - review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - state: "open" | "closed"; - /** Format: uri */ - statuses_url: string; - /** @description The title of the pull request. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - 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; - 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; - } | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request dequeued event */ - "webhook-pull-request-dequeued": { - /** @enum {string} */ - action: "dequeued"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; - }; - }; - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; - /** 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"; - /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. - */ - auto_merge: { - /** @description Commit message for the merge commit. */ - commit_message: string | null; - /** @description Title for the merge commit message. */ - commit_title: string | null; - /** User */ - enabled_by: { - /** 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; - /** - * @description The merge method to use. - * @enum {string} - */ - merge_method: "merge" | "squash" | "rebase"; - } | null; - base: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: null | number | string; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: 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; - 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; - }; - body: string | null; - changed_files?: number; - /** Format: date-time */ - closed_at: string | null; - comments?: number; - /** Format: uri */ - comments_url: string; - commits?: number; - /** Format: uri */ - commits_url: string; + commits_url: string; /** Format: date-time */ created_at: string; deletions?: number; @@ -58431,7 +52111,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string; + label: string | null; ref: string; /** * Repository @@ -58713,7 +52393,7 @@ export interface components { watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - }; + } | null; sha: string; /** User */ user: { @@ -58928,22 +52608,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -58970,17 +52650,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; })[]; requested_teams: { deleted?: boolean; @@ -59089,94 +52769,13 @@ export interface components { url?: string; } | null; }; - reason: string; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request edited event */ - "webhook-pull-request-edited": { - /** @enum {string} */ - action: "edited"; - /** @description The changes to the comment if the action was `edited`. */ - changes: { - base?: { - ref: { - from: string; - }; - sha: { - from: string; - }; - }; - body?: { - /** @description The previous version of the body if the action was `edited`. */ - from: string; - }; - title?: { - /** @description The previous version of the title if the action was `edited`. */ - from: string; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request enqueued event */ - "webhook-pull-request-enqueued": { + /** pull_request auto_merge_disabled event */ + "webhook-pull-request-auto-merge-disabled": { /** @enum {string} */ - action: "enqueued"; + action: "auto_merge_disabled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; number: number; @@ -59458,6 +53057,11 @@ export interface components { * @default true */ has_issues: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; has_pages: boolean; /** * @description Whether projects are enabled. @@ -59469,11 +53073,6 @@ export interface components { * @default true */ has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -60131,7 +53730,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -60197,22 +53796,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -60239,17 +53838,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; })[]; requested_teams: { deleted?: boolean; @@ -60358,32 +53957,16 @@ export interface components { url?: string; } | null; }; + reason: string; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request labeled event */ - "webhook-pull-request-labeled": { + /** pull_request auto_merge_enabled event */ + "webhook-pull-request-auto-merge-enabled": { /** @enum {string} */ - action: "labeled"; + action: "auto_merge_enabled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** Label */ - label?: { - /** @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; - }; - /** @description The pull request number. */ number: number; organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ @@ -60466,7 +54049,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -60502,7 +54085,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -60905,7 +54488,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string | null; + label: string; ref: string; /** * Repository @@ -61187,7 +54770,7 @@ export interface components { watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - } | null; + }; sha: string; /** User */ user: { @@ -61289,7 +54872,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -61563,16 +55146,52 @@ export interface components { url?: string; } | null; }; + reason?: string; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request locked event */ - "webhook-pull-request-locked": { + /** pull_request closed event */ + "webhook-pull-request-closed": { /** @enum {string} */ - action: "locked"; + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request converted_to_draft event */ + "webhook-pull-request-converted-to-draft": { + /** @enum {string} */ + action: "converted_to_draft"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request demilestoned event */ + "webhook-pull-request-demilestoned": { + /** @enum {string} */ + action: "demilestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + milestone?: components["schemas"]["milestone"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["webhooks_pull_request_5"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request dequeued event */ + "webhook-pull-request-dequeued": { + /** @enum {string} */ + action: "dequeued"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ number: number; organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ @@ -61691,7 +55310,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -62094,7 +55713,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string | null; + label: string; ref: string; /** * Repository @@ -62376,7 +55995,7 @@ export interface components { watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - } | null; + }; sha: string; /** User */ user: { @@ -62478,7 +56097,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -62525,7 +56144,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; @@ -62591,22 +56210,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description: string | null; + description?: string | null; /** Format: uri */ - html_url: string; + html_url?: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url: string; + members_url?: string; /** @description Name of the team */ name: string; - node_id: string; + node_id?: string; parent?: { /** @description Description of the team */ description: string | null; @@ -62633,17 +56252,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission: string; + permission?: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url: string; - slug: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - url: string; + url?: string; })[]; requested_teams: { deleted?: boolean; @@ -62752,16 +56371,47 @@ export interface components { url?: string; } | null; }; + reason: string; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request milestoned event */ - "webhook-pull-request-milestoned": { + /** pull_request edited event */ + "webhook-pull-request-edited": { /** @enum {string} */ - action: "milestoned"; + action: "edited"; + /** @description The changes to the comment if the action was `edited`. */ + changes: { + base?: { + ref: { + from: string; + }; + sha: { + from: string; + }; + }; + body?: { + /** @description The previous version of the body if the action was `edited`. */ + from: string; + }; + title?: { + /** @description The previous version of the title if the action was `edited`. */ + from: string; + }; + }; enterprise?: components["schemas"]["enterprise-webhooks"]; - milestone?: components["schemas"]["milestone"]; - /** @description The pull request number. */ + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request enqueued event */ + "webhook-pull-request-enqueued": { + /** @enum {string} */ + action: "enqueued"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; number: number; organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ @@ -62844,7 +56494,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -62880,7 +56530,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -63215,7 +56865,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -63555,7 +57205,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -63667,7 +57317,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -63783,502 +57433,177 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null) | { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - })[]; - requested_teams: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }[]; - /** Format: uri-template */ - review_comment_url: string; - review_comments?: number; - /** Format: uri */ - review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - state: "open" | "closed"; - /** Format: uri */ - statuses_url: string; - /** @description The title of the pull request. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - 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; - 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; - } | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request opened event */ - "webhook-pull-request-opened": { - /** @enum {string} */ - action: "opened"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - use_squash_pr_title_as_default: boolean; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request ready_for_review event */ - "webhook-pull-request-ready-for-review": { - /** @enum {string} */ - action: "ready_for_review"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - use_squash_pr_title_as_default: boolean; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request reopened event */ - "webhook-pull-request-reopened": { - /** @enum {string} */ - action: "reopened"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - use_squash_pr_title_as_default: boolean; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request_review_comment created event */ - "webhook-pull-request-review-comment-created": { - /** @enum {string} */ - action: "created"; - /** - * Pull Request Review Comment - * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. - */ - comment: { - _links: { - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - pull_request: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - }; - /** - * 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 The text of the comment. */ - body: string; - /** @description The SHA of the commit to which the comment applies. */ - commit_id: string; - /** Format: date-time */ - created_at: string; - /** @description The diff of the line that the comment refers to. */ - diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ - html_url: string; - /** @description The ID of the pull request review comment. */ - id: number; - /** @description The comment ID to reply to. */ - in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - line: number | null; - /** @description The node ID of the pull request review comment. */ - node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - original_line: number | null; - /** @description The index of the original line in the diff to which the comment applies. */ - original_position: number; - /** @description The first line of the range for a multi-line comment. */ - original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - path: string; - /** @description The line index in the diff to which the comment applies. */ - position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - subject_type?: "line" | "file"; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the pull request review 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; - 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) | { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; + })[]; + requested_teams: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; + }[]; + /** Format: uri-template */ + review_comment_url: string; + review_comments?: number; + /** Format: uri */ + review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + state: "open" | "closed"; + /** Format: uri */ + statuses_url: string; + /** @description The title of the pull request. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + 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; + 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; } | null; }; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request labeled event */ + "webhook-pull-request-labeled": { + /** @enum {string} */ + action: "labeled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; + label?: components["schemas"]["webhooks_label"]; + number: components["schemas"]["webhooks_number"]; organization?: components["schemas"]["organization-simple-webhooks"]; + /** Pull Request */ pull_request: { _links: { /** Link */ @@ -64324,6 +57649,7 @@ export interface components { }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ assignee: { /** Format: uri */ @@ -64407,7 +57733,7 @@ export interface components { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - auto_merge?: { + auto_merge: { /** @description Commit message for the merge commit. */ commit_message: string | null; /** @description Title for the merge commit message. */ @@ -64779,17 +58105,24 @@ export interface components { } | null; }; body: string | null; + changed_files?: number; + /** Format: date-time */ closed_at: string | null; + comments?: number; /** Format: uri */ comments_url: string; + commits?: number; /** Format: uri */ commits_url: string; + /** Format: date-time */ created_at: string; + deletions?: number; /** Format: uri */ diff_url: string; - draft?: boolean; + /** @description Indicates whether or not the pull request is a draft. */ + draft: boolean; head: { - label: string; + label: string | null; ref: string; /** * Repository @@ -65132,8 +58465,51 @@ export interface components { url: string; }[]; locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ merged_at: string | null; + /** User */ + merged_by?: { + /** 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; + } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -65206,9 +58582,11 @@ export interface components { url: string; } | null; node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; + rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -65348,13 +58726,19 @@ export interface components { }[]; /** Format: uri-template */ review_comment_url: string; + review_comments?: number; /** Format: uri */ review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; + /** @description The title of the pull request. */ title: string; + /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -65399,158 +58783,15 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review_comment deleted event */ - "webhook-pull-request-review-comment-deleted": { + /** pull_request locked event */ + "webhook-pull-request-locked": { /** @enum {string} */ - action: "deleted"; - /** - * Pull Request Review Comment - * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. - */ - comment: { - _links: { - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - pull_request: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - }; - /** - * 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 The text of the comment. */ - body: string; - /** @description The SHA of the commit to which the comment applies. */ - commit_id: string; - /** Format: date-time */ - created_at: string; - /** @description The diff of the line that the comment refers to. */ - diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ - html_url: string; - /** @description The ID of the pull request review comment. */ - id: number; - /** @description The comment ID to reply to. */ - in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - line: number | null; - /** @description The node ID of the pull request review comment. */ - node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - original_line: number; - /** @description The index of the original line in the diff to which the comment applies. */ - original_position: number; - /** @description The first line of the range for a multi-line comment. */ - original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - path: string; - /** @description The line index in the diff to which the comment applies. */ - position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - subject_type?: "line" | "file"; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the pull request review 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; - 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; - }; + action: "locked"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; organization?: components["schemas"]["organization-simple-webhooks"]; + /** Pull Request */ pull_request: { _links: { /** Link */ @@ -65596,6 +58837,7 @@ export interface components { }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ assignee: { /** Format: uri */ @@ -65665,7 +58907,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)[]; @@ -65679,7 +58921,7 @@ export interface components { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - auto_merge?: { + auto_merge: { /** @description Commit message for the merge commit. */ commit_message: string | null; /** @description Title for the merge commit message. */ @@ -66051,17 +59293,24 @@ export interface components { } | null; }; body: string | null; + changed_files?: number; + /** Format: date-time */ closed_at: string | null; + comments?: number; /** Format: uri */ comments_url: string; + commits?: number; /** Format: uri */ commits_url: string; + /** Format: date-time */ created_at: string; + deletions?: number; /** Format: uri */ diff_url: string; - draft?: boolean; + /** @description Indicates whether or not the pull request is a draft. */ + draft: boolean; head: { - label: string; + label: string | null; ref: string; /** * Repository @@ -66404,8 +59653,51 @@ export interface components { url: string; }[]; locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ merged_at: string | null; + /** User */ + merged_by?: { + /** 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; + } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -66478,9 +59770,11 @@ export interface components { url: string; } | null; node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; + rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -66513,22 +59807,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -66555,17 +59849,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; })[]; requested_teams: { deleted?: boolean; @@ -66620,13 +59914,19 @@ export interface components { }[]; /** Format: uri-template */ review_comment_url: string; + review_comments?: number; /** Format: uri */ review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; + /** @description The title of the pull request. */ title: string; + /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -66671,17 +59971,58 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review_comment edited event */ - "webhook-pull-request-review-comment-edited": { + /** pull_request milestoned event */ + "webhook-pull-request-milestoned": { /** @enum {string} */ - action: "edited"; - /** @description The changes to the comment. */ - changes: { - body?: { - /** @description The previous version of the body. */ - from: string; - }; - }; + action: "milestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + milestone?: components["schemas"]["milestone"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["webhooks_pull_request_5"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request opened event */ + "webhook-pull-request-opened": { + /** @enum {string} */ + action: "opened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request ready_for_review event */ + "webhook-pull-request-ready-for-review": { + /** @enum {string} */ + action: "ready_for_review"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request reopened event */ + "webhook-pull-request-reopened": { + /** @enum {string} */ + action: "reopened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request_review_comment created event */ + "webhook-pull-request-review-comment-created": { + /** @enum {string} */ + action: "created"; /** * Pull Request Review Comment * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -66734,7 +60075,7 @@ export interface components { /** @description The SHA of the original commit to which the comment applies. */ original_commit_id: string; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - original_line: number; + original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; /** @description The first line of the range for a multi-line comment. */ @@ -66908,7 +60249,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; @@ -66944,7 +60285,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)[]; @@ -67792,22 +61133,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -67834,17 +61175,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; })[]; requested_teams: { deleted?: boolean; @@ -67946,100 +61287,100 @@ export interface components { /** Format: uri */ url?: string; } | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request_review dismissed event */ - "webhook-pull-request-review-dismissed": { - /** @enum {string} */ - action: "dismissed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; - }; - }; - /** @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; - } | null; + }; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request_review_comment deleted event */ + "webhook-pull-request-review-comment-deleted": { + /** @enum {string} */ + action: "deleted"; + comment: components["schemas"]["webhooks_review_comment"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: { + _links: { + /** Link */ + comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + commits: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + issue: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comment: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + statuses: { + /** Format: uri-template */ + href: string; + }; + }; + /** @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; @@ -68072,7 +61413,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -68086,7 +61427,7 @@ export interface components { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - auto_merge: { + auto_merge?: { /** @description Commit message for the merge commit. */ commit_message: string | null; /** @description Title for the merge commit message. */ @@ -68466,7 +61807,7 @@ export interface components { created_at: string; /** Format: uri */ diff_url: string; - draft: boolean; + draft?: boolean; head: { label: string; ref: string; @@ -68920,22 +62261,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description: string | null; + description?: string | null; /** Format: uri */ - html_url: string; + html_url?: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url: string; + members_url?: string; /** @description Name of the team */ name: string; - node_id: string; + node_id?: string; parent?: { /** @description Description of the team */ description: string | null; @@ -68962,17 +62303,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission: string; + permission?: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url: string; - slug: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - url: string; + url?: string; })[]; requested_teams: { deleted?: boolean; @@ -69076,95 +62417,17 @@ export interface components { } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** @description The review that was affected. */ - review: { - _links: { - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - pull_request: { - /** Format: uri-template */ - href: string; - }; - }; - /** - * 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 The text of the review. */ - body: string | null; - /** @description A commit SHA for the review. */ - commit_id: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the review */ - id: number; - node_id: string; - /** Format: uri */ - pull_request_url: string; - /** @enum {string} */ - state: "dismissed" | "approved" | "changes_requested"; - /** Format: date-time */ - submitted_at: 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; - 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; - } | null; - }; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review edited event */ - "webhook-pull-request-review-edited": { + /** pull_request_review_comment edited event */ + "webhook-pull-request-review-comment-edited": { /** @enum {string} */ action: "edited"; - changes: { - body?: { - /** @description The previous version of the body if the action was `edited`. */ - from: string; - }; - }; + changes: components["schemas"]["webhooks_changes"]; + comment: components["schemas"]["webhooks_review_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ pull_request: { _links: { /** Link */ @@ -69243,7 +62506,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -69279,7 +62542,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -69293,7 +62556,7 @@ export interface components { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - auto_merge: { + auto_merge?: { /** @description Commit message for the merge commit. */ commit_message: string | null; /** @description Title for the merge commit message. */ @@ -69451,6 +62714,11 @@ export interface components { * @default true */ has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -69482,6 +62750,23 @@ export interface components { url: string | null; } | null; master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -69550,6 +62835,23 @@ export interface components { releases_url: string; role_name?: string | null; size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -69574,10 +62876,17 @@ export interface components { updated_at: string; /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; }; sha: string; /** User */ @@ -69627,7 +62936,7 @@ export interface components { created_at: string; /** Format: uri */ diff_url: string; - draft: boolean; + draft?: boolean; head: { label: string; ref: string; @@ -69738,6 +63047,11 @@ export interface components { * @default true */ has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -69769,6 +63083,23 @@ export interface components { url: string | null; } | null; master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -69837,6 +63168,23 @@ export interface components { releases_url: string; role_name?: string | null; size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -69861,10 +63209,17 @@ export interface components { updated_at: string; /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; } | null; sha: string; /** User */ @@ -70035,22 +63390,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description: string | null; + description?: string | null; /** Format: uri */ - html_url: string; + html_url?: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url: string; + members_url?: string; /** @description Name of the team */ name: string; - node_id: string; + node_id?: string; parent?: { /** @description Description of the team */ description: string | null; @@ -70077,17 +63432,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission: string; + permission?: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url: string; - slug: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - url: string; + url?: string; })[]; requested_teams: { deleted?: boolean; @@ -70191,90 +63546,16 @@ export interface components { } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** @description The review that was affected. */ - review: { - _links: { - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - pull_request: { - /** Format: uri-template */ - href: string; - }; - }; - /** - * 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 The text of the review. */ - body: string | null; - /** @description A commit SHA for the review. */ - commit_id: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the review */ - id: number; - node_id: string; - /** Format: uri */ - pull_request_url: string; - state: string; - /** Format: date-time */ - submitted_at: string | null; - /** 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; - 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; - }; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request review_request_removed event */ - "webhook-pull-request-review-request-removed": { + /** pull_request_review dismissed event */ + "webhook-pull-request-review-dismissed": { /** @enum {string} */ - action: "review_request_removed"; + action: "dismissed"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ + /** Simple Pull Request */ pull_request: { _links: { /** Link */ @@ -70320,7 +63601,6 @@ export interface components { }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; /** User */ assignee: { /** Format: uri */ @@ -70354,7 +63634,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; @@ -70390,7 +63670,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)[]; @@ -70684,12 +63964,19 @@ export interface components { role_name?: string | null; size: number; /** - * @description The default value for a squash merge commit message. + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a squash merge commit title. + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -70769,21 +64056,14 @@ export interface components { } | null; }; body: string | null; - changed_files?: number; - /** Format: date-time */ closed_at: string | null; - comments?: number; /** Format: uri */ comments_url: string; - commits?: number; /** Format: uri */ commits_url: string; - /** Format: date-time */ created_at: string; - deletions?: number; /** Format: uri */ diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { label: string; @@ -71068,7 +64348,7 @@ export interface components { watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - }; + } | null; sha: string; /** User */ user: { @@ -71129,51 +64409,8 @@ export interface components { url: string; }[]; locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ merged_at: string | null; - /** User */ - merged_by?: { - /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -71246,11 +64483,9 @@ export interface components { url: string; } | null; node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; - rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -71283,7 +64518,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) | { @@ -71336,73 +64571,67 @@ export interface components { * @description URL for the team */ url: string; - })[]; - requested_teams: { - deleted?: boolean; - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; + })[]; + requested_teams: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; }[]; /** Format: uri-template */ review_comment_url: string; - review_comments?: number; /** Format: uri */ review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; - /** @description The title of the pull request. */ title: string; - /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -71439,59 +64668,101 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** User */ - requested_reviewer: { - /** 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; + /** @description The review that was affected. */ + review: { + _links: { + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + pull_request: { + /** Format: uri-template */ + href: string; + }; + }; + /** + * 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 The text of the review. */ + body: string | null; + /** @description A commit SHA for the review. */ + commit_id: string; /** Format: uri */ - html_url?: string; + html_url: string; + /** @description Unique identifier of the review */ 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; + node_id: string; /** Format: uri */ - subscriptions_url?: string; + pull_request_url: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; + state: "dismissed" | "approved" | "changes_requested"; + /** Format: date-time */ + submitted_at: 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; + 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; + } | null; + }; sender: components["schemas"]["simple-user-webhooks"]; - } | { + }; + /** pull_request_review edited event */ + "webhook-pull-request-review-edited": { /** @enum {string} */ - action: "review_request_removed"; + action: "edited"; + changes: { + body?: { + /** @description The previous version of the body if the action was `edited`. */ + from: string; + }; + }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ + /** Simple Pull Request */ pull_request: { _links: { /** Link */ @@ -71537,7 +64808,6 @@ export interface components { }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; /** User */ assignee: { /** Format: uri */ @@ -71571,7 +64841,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; @@ -71607,7 +64877,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)[]; @@ -71779,11 +65049,6 @@ export interface components { * @default true */ has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -71815,23 +65080,6 @@ export interface components { url: string | null; } | null; master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -71900,23 +65148,6 @@ export interface components { releases_url: string; role_name?: string | null; size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -71941,17 +65172,10 @@ export interface components { updated_at: string; /** Format: uri */ url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; }; sha: string; /** User */ @@ -71993,21 +65217,14 @@ export interface components { } | null; }; body: string | null; - changed_files?: number; - /** Format: date-time */ closed_at: string | null; - comments?: number; /** Format: uri */ comments_url: string; - commits?: number; /** Format: uri */ commits_url: string; - /** Format: date-time */ created_at: string; - deletions?: number; /** Format: uri */ diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { label: string; @@ -72119,11 +65336,6 @@ export interface components { * @default true */ has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -72155,23 +65367,6 @@ export interface components { url: string | null; } | null; master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -72240,23 +65435,6 @@ export interface components { releases_url: string; role_name?: string | null; size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -72281,18 +65459,11 @@ export interface components { updated_at: string; /** Format: uri */ url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; + } | null; sha: string; /** User */ user: { @@ -72353,51 +65524,8 @@ export interface components { url: string; }[]; locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ merged_at: string | null; - /** User */ - merged_by?: { - /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -72441,7 +65569,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; @@ -72470,11 +65598,9 @@ export interface components { url: string; } | null; node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; - rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -72507,7 +65633,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) | { @@ -72564,16 +65690,16 @@ export interface components { requested_teams: { deleted?: boolean; /** @description Description of the team */ - description: string | null; + description?: string | null; /** Format: uri */ - html_url: string; + html_url?: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url: string; + members_url?: string; /** @description Name of the team */ name: string; - node_id: string; + node_id?: string; parent?: { /** @description Description of the team */ description: string | null; @@ -72600,33 +65726,27 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission: string; + permission?: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url: string; - slug: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - url: string; + url?: string; }[]; /** Format: uri-template */ review_comment_url: string; - review_comments?: number; /** Format: uri */ review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; - /** @description The title of the pull request. */ title: string; - /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -72663,73 +65783,19 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - requested_team: { - deleted?: boolean; - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - }; + review: components["schemas"]["webhooks_review"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request review_requested event */ - "webhook-pull-request-review-requested": { + /** pull_request review_request_removed event */ + "webhook-pull-request-review-request-removed": { /** @enum {string} */ - action: "review_requested"; + action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ @@ -72815,7 +65881,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -72851,7 +65917,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -73145,19 +66211,12 @@ export interface components { role_name?: string | null; size: number; /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * @description The default value for a squash merge commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @description The default value for a squash merge commit title. * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -73685,7 +66744,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -73808,16 +66867,16 @@ export interface components { requested_teams: { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -73844,17 +66903,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; }[]; /** Format: uri-template */ review_comment_url: string; @@ -73907,7 +66966,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -73946,14 +67005,14 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; sender: components["schemas"]["simple-user-webhooks"]; } | { /** @enum {string} */ - action: "review_requested"; + action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ @@ -74039,7 +67098,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -74075,7 +67134,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -74909,7 +67968,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -74981,16 +68040,16 @@ export interface components { } | null) | { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -75017,31 +68076,31 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; })[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -75068,17 +68127,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; }[]; /** Format: uri-template */ review_comment_url: string; @@ -75131,7 +68190,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -75144,16 +68203,16 @@ export interface components { requested_team: { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -75180,28 +68239,30 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; }; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review submitted event */ - "webhook-pull-request-review-submitted": { + /** pull_request review_requested event */ + "webhook-pull-request-review-requested": { /** @enum {string} */ - action: "submitted"; + action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; + /** @description The pull request number. */ + number: number; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ + /** Pull Request */ pull_request: { _links: { /** Link */ @@ -75247,6 +68308,7 @@ export interface components { }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ assignee: { /** Format: uri */ @@ -75702,17 +68764,24 @@ export interface components { } | null; }; body: string | null; + changed_files?: number; + /** Format: date-time */ closed_at: string | null; + comments?: number; /** Format: uri */ comments_url: string; + commits?: number; /** Format: uri */ commits_url: string; + /** Format: date-time */ created_at: string; + deletions?: number; /** Format: uri */ diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string | null; + label: string; ref: string; /** * Repository @@ -75994,7 +69063,7 @@ export interface components { watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - } | null; + }; sha: string; /** User */ user: { @@ -76055,8 +69124,51 @@ export interface components { url: string; }[]; locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ merged_at: string | null; + /** User */ + merged_by?: { + /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -76129,9 +69241,11 @@ export interface components { url: string; } | null; node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; + rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -76164,7 +69278,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null) | { @@ -76271,13 +69385,19 @@ export interface components { }[]; /** Format: uri-template */ review_comment_url: string; + review_comments?: number; /** Format: uri */ review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; + /** @description The title of the pull request. */ title: string; + /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -76320,88 +69440,53 @@ export interface components { } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** @description The review that was affected. */ - review: { - _links: { - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - pull_request: { - /** Format: uri-template */ - href: string; - }; - }; - /** - * 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 The text of the review. */ - body: string | null; - /** @description A commit SHA for the review. */ - commit_id: string; + /** User */ + requested_reviewer: { /** Format: uri */ - html_url: string; - /** @description Unique identifier of the review */ + 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; - node_id: string; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - pull_request_url: string; - state: string; - /** Format: date-time */ - submitted_at: string | null; - /** 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; - 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; - }; + 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; + } | null; sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request_review_thread resolved event */ - "webhook-pull-request-review-thread-resolved": { + } | { /** @enum {string} */ - action: "resolved"; + action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; + /** @description The pull request number. */ + number: number; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ + /** Pull Request */ pull_request: { _links: { /** Link */ @@ -76447,6 +69532,7 @@ export interface components { }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ assignee: { /** Format: uri */ @@ -76480,7 +69566,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; @@ -76516,7 +69602,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)[]; @@ -76724,6 +69810,23 @@ export interface components { url: string | null; } | null; master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -76792,6 +69895,23 @@ export interface components { releases_url: string; role_name?: string | null; size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -76816,6 +69936,11 @@ export interface components { updated_at: string; /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -76863,17 +69988,24 @@ export interface components { } | null; }; body: string | null; + changed_files?: number; + /** Format: date-time */ closed_at: string | null; + comments?: number; /** Format: uri */ comments_url: string; + commits?: number; /** Format: uri */ commits_url: string; + /** Format: date-time */ created_at: string; + deletions?: number; /** Format: uri */ diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string | null; + label: string; ref: string; /** * Repository @@ -77018,6 +70150,23 @@ export interface components { url: string | null; } | null; master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -77086,6 +70235,23 @@ export interface components { releases_url: string; role_name?: string | null; size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -77110,13 +70276,18 @@ export interface components { updated_at: string; /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - } | null; + }; sha: string; /** User */ user: { @@ -77177,8 +70348,51 @@ export interface components { url: string; }[]; locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ merged_at: string | null; + /** User */ + merged_by?: { + /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -77222,7 +70436,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; @@ -77251,9 +70465,11 @@ export interface components { url: string; } | null; node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; + rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -77286,22 +70502,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description: string | null; + description?: string | null; /** Format: uri */ - html_url: string; + html_url?: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url: string; + members_url?: string; /** @description Name of the team */ name: string; - node_id: string; + node_id?: string; parent?: { /** @description Description of the team */ description: string | null; @@ -77328,17 +70544,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission: string; + permission?: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url: string; - slug: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - url: string; + url?: string; })[]; requested_teams: { deleted?: boolean; @@ -77393,13 +70609,19 @@ export interface components { }[]; /** Format: uri-template */ review_comment_url: string; + review_comments?: number; /** Format: uri */ review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; + /** @description The title of the pull request. */ title: string; + /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -77442,156 +70664,67 @@ export interface components { } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - thread: { - comments: { - _links: { - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - pull_request: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - }; - /** - * 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 The text of the comment. */ - body: string; - /** @description The SHA of the commit to which the comment applies. */ - commit_id: string; - /** Format: date-time */ - created_at: string; - /** @description The diff of the line that the comment refers to. */ - diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + requested_team: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ html_url: string; - /** @description The ID of the pull request review comment. */ + /** @description Unique identifier of the team */ id: number; - /** @description The comment ID to reply to. */ - in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - line: number | null; - /** @description The node ID of the pull request review comment. */ + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - original_line: number | null; - /** @description The index of the original line in the diff to which the comment applies. */ - original_position: number; - /** @description The first line of the range for a multi-line comment. */ - original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - path: string; - /** @description The line index in the diff to which the comment applies. */ - position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - subject_type?: "line" | "file"; - /** Format: date-time */ - updated_at: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; /** * Format: uri - * @description URL for the pull request review comment + * @description URL for the team */ 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; - 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; - } | null; - }[]; - node_id: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; }; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review_thread unresolved event */ - "webhook-pull-request-review-thread-unresolved": { + /** pull_request_review submitted event */ + "webhook-pull-request-review-submitted": { /** @enum {string} */ - action: "unresolved"; + action: "submitted"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -77674,7 +70807,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; @@ -77710,7 +70843,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)[]; @@ -77728,7 +70861,7 @@ export interface components { /** @description Commit message for the merge commit. */ commit_message: string | null; /** @description Title for the merge commit message. */ - commit_title: string; + commit_title: string | null; /** User */ enabled_by: { /** Format: uri */ @@ -77918,6 +71051,23 @@ export interface components { url: string | null; } | null; master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -77986,6 +71136,23 @@ export interface components { releases_url: string; role_name?: string | null; size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -78010,6 +71177,11 @@ export interface components { updated_at: string; /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -78067,7 +71239,7 @@ export interface components { diff_url: string; draft: boolean; head: { - label: string; + label: string | null; ref: string; /** * Repository @@ -78212,6 +71384,23 @@ export interface components { url: string | null; } | null; master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -78280,6 +71469,23 @@ export interface components { releases_url: string; role_name?: string | null; size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -78304,13 +71510,18 @@ export interface components { updated_at: string; /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - }; + } | null; sha: string; /** User */ user: { @@ -78416,7 +71627,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; @@ -78480,22 +71691,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -78522,17 +71733,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; })[]; requested_teams: { deleted?: boolean; @@ -78599,285 +71810,6 @@ export interface components { 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; - 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; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - thread: { - comments: { - _links: { - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - pull_request: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - }; - /** - * 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 The text of the comment. */ - body: string; - /** @description The SHA of the commit to which the comment applies. */ - commit_id: string; - /** Format: date-time */ - created_at: string; - /** @description The diff of the line that the comment refers to. */ - diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ - html_url: string; - /** @description The ID of the pull request review comment. */ - id: number; - /** @description The comment ID to reply to. */ - in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - line: number | null; - /** @description The node ID of the pull request review comment. */ - node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - original_line: number; - /** @description The index of the original line in the diff to which the comment applies. */ - original_position: number; - /** @description The first line of the range for a multi-line comment. */ - original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - path: string; - /** @description The line index in the diff to which the comment applies. */ - position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - subject_type?: "line" | "file"; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the pull request review 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; - 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; - }[]; - node_id: string; - }; - }; - /** pull_request synchronize event */ - "webhook-pull-request-synchronize": { - /** @enum {string} */ - action: "synchronize"; - after: string; - before: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; - }; - }; - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; - /** 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; - } | null; - assignees: ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -78912,6 +71844,137 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + } | null; + }; + repository: components["schemas"]["repository-webhooks"]; + review: components["schemas"]["webhooks_review"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request_review_thread resolved event */ + "webhook-pull-request-review-thread-resolved": { + /** @enum {string} */ + action: "resolved"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** Simple Pull Request */ + pull_request: { + _links: { + /** Link */ + comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + commits: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + issue: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comment: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + statuses: { + /** Format: uri-template */ + href: string; + }; + }; + /** @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 @@ -79117,23 +72180,6 @@ export interface components { url: string | null; } | null; master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -79202,23 +72248,6 @@ export interface components { releases_url: string; role_name?: string | null; size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -79243,11 +72272,6 @@ export interface components { updated_at: string; /** Format: uri */ url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -79295,24 +72319,17 @@ export interface components { } | null; }; body: string | null; - changed_files?: number; - /** Format: date-time */ closed_at: string | null; - comments?: number; /** Format: uri */ comments_url: string; - commits?: number; /** Format: uri */ commits_url: string; - /** Format: date-time */ created_at: string; - deletions?: number; /** Format: uri */ diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string; + label: string | null; ref: string; /** * Repository @@ -79457,16 +72474,6 @@ export interface components { url: string | null; } | null; master_branch?: string; - /** - * @description The default value for a merge commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit message title. - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -79535,23 +72542,6 @@ export interface components { releases_url: string; role_name?: string | null; size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -79576,18 +72566,13 @@ export interface components { updated_at: string; /** Format: uri */ url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - }; + } | null; sha: string; /** User */ user: { @@ -79648,51 +72633,8 @@ export interface components { url: string; }[]; locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ merged_at: string | null; - /** User */ - merged_by?: { - /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -79736,7 +72678,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -79765,11 +72707,9 @@ export interface components { url: string; } | null; node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; - rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -79909,19 +72849,13 @@ export interface components { }[]; /** Format: uri-template */ review_comment_url: string; - review_comments?: number; /** Format: uri */ review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; - /** @description The title of the pull request. */ title: string; - /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -79964,55 +72898,160 @@ export interface components { } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + thread: { + comments: { + _links: { + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + pull_request: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + }; + /** + * 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 The text of the comment. */ + body: string; + /** @description The SHA of the commit to which the comment applies. */ + commit_id: string; + /** Format: date-time */ + created_at: string; + /** @description The diff of the line that the comment refers to. */ + diff_hunk: string; + /** + * Format: uri + * @description HTML URL for the pull request review comment. + */ + html_url: string; + /** @description The ID of the pull request review comment. */ + id: number; + /** @description The comment ID to reply to. */ + in_reply_to_id?: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + line: number | null; + /** @description The node ID of the pull request review comment. */ + node_id: string; + /** @description The SHA of the original commit to which the comment applies. */ + original_commit_id: string; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + original_line: number | null; + /** @description The index of the original line in the diff to which the comment applies. */ + original_position: number; + /** @description The first line of the range for a multi-line comment. */ + original_start_line: number | null; + /** @description The relative path of the file to which the comment applies. */ + path: string; + /** @description The line index in the diff to which the comment applies. */ + position: number | null; + /** @description The ID of the pull request review to which the comment belongs. */ + pull_request_review_id: number | null; + /** + * Format: uri + * @description URL for the pull request that the review comment belongs to. + */ + pull_request_url: string; + /** 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; + }; + /** + * @description The side of the first line of the range for a multi-line comment. + * @enum {string} + */ + side: "LEFT" | "RIGHT"; + /** @description The first line of the range for a multi-line comment. */ + start_line: number | null; + /** + * @description The side of the first line of the range for a multi-line comment. + * @default RIGHT + * @enum {string|null} + */ + start_side: "LEFT" | "RIGHT" | null; + /** + * @description The level at which the comment is targeted, can be a diff line or a file. + * @enum {string} + */ + subject_type?: "line" | "file"; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the pull request review 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; + 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; + } | null; + }[]; + node_id: string; + }; }; - /** pull_request unassigned event */ - "webhook-pull-request-unassigned": { + /** pull_request_review_thread unresolved event */ + "webhook-pull-request-review-thread-unresolved": { /** @enum {string} */ - action: "unassigned"; - /** 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; - } | null; + action: "unresolved"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ + /** Simple Pull Request */ pull_request: { _links: { /** Link */ @@ -80058,7 +73097,6 @@ export interface components { }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; /** User */ assignee: { /** Format: uri */ @@ -80092,7 +73130,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -80128,7 +73166,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -80146,7 +73184,7 @@ export interface components { /** @description Commit message for the merge commit. */ commit_message: string | null; /** @description Title for the merge commit message. */ - commit_title: string | null; + commit_title: string; /** User */ enabled_by: { /** Format: uri */ @@ -80191,7 +73229,7 @@ export interface components { merge_method: "merge" | "squash" | "rebase"; } | null; base: { - label: string | null; + label: string; ref: string; /** * Repository @@ -80336,23 +73374,6 @@ export interface components { url: string | null; } | null; master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -80421,23 +73442,6 @@ export interface components { releases_url: string; role_name?: string | null; size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -80462,11 +73466,6 @@ export interface components { updated_at: string; /** Format: uri */ url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -80514,24 +73513,17 @@ export interface components { } | null; }; body: string | null; - changed_files?: number; - /** Format: date-time */ closed_at: string | null; - comments?: number; /** Format: uri */ comments_url: string; - commits?: number; /** Format: uri */ commits_url: string; - /** Format: date-time */ created_at: string; - deletions?: number; /** Format: uri */ diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string | null; + label: string; ref: string; /** * Repository @@ -80676,23 +73668,6 @@ export interface components { url: string | null; } | null; master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -80761,23 +73736,6 @@ export interface components { releases_url: string; role_name?: string | null; size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -80802,18 +73760,13 @@ export interface components { updated_at: string; /** Format: uri */ url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - } | null; + }; sha: string; /** User */ user: { @@ -80874,51 +73827,8 @@ export interface components { url: string; }[]; locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ merged_at: string | null; - /** User */ - merged_by?: { - /** 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; - } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -80962,7 +73872,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -80991,11 +73901,9 @@ export interface components { url: string; } | null; node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; - rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -81028,22 +73936,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description: string | null; + description?: string | null; /** Format: uri */ - html_url: string; + html_url?: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url: string; + members_url?: string; /** @description Name of the team */ name: string; - node_id: string; + node_id?: string; parent?: { /** @description Description of the team */ description: string | null; @@ -81070,17 +73978,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission: string; + permission?: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url: string; - slug: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - url: string; + url?: string; })[]; requested_teams: { deleted?: boolean; @@ -81135,19 +74043,13 @@ export interface components { }[]; /** Format: uri-template */ review_comment_url: string; - review_comments?: number; /** Format: uri */ review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; - /** @description The title of the pull request. */ title: string; - /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -81184,38 +74086,167 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; sender?: components["schemas"]["simple-user-webhooks"]; + thread: { + comments: { + _links: { + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + pull_request: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + }; + /** + * 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 The text of the comment. */ + body: string; + /** @description The SHA of the commit to which the comment applies. */ + commit_id: string; + /** Format: date-time */ + created_at: string; + /** @description The diff of the line that the comment refers to. */ + diff_hunk: string; + /** + * Format: uri + * @description HTML URL for the pull request review comment. + */ + html_url: string; + /** @description The ID of the pull request review comment. */ + id: number; + /** @description The comment ID to reply to. */ + in_reply_to_id?: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + line: number | null; + /** @description The node ID of the pull request review comment. */ + node_id: string; + /** @description The SHA of the original commit to which the comment applies. */ + original_commit_id: string; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + original_line: number; + /** @description The index of the original line in the diff to which the comment applies. */ + original_position: number; + /** @description The first line of the range for a multi-line comment. */ + original_start_line: number | null; + /** @description The relative path of the file to which the comment applies. */ + path: string; + /** @description The line index in the diff to which the comment applies. */ + position: number | null; + /** @description The ID of the pull request review to which the comment belongs. */ + pull_request_review_id: number | null; + /** + * Format: uri + * @description URL for the pull request that the review comment belongs to. + */ + pull_request_url: string; + /** 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; + }; + /** + * @description The side of the first line of the range for a multi-line comment. + * @enum {string} + */ + side: "LEFT" | "RIGHT"; + /** @description The first line of the range for a multi-line comment. */ + start_line: number | null; + /** + * @description The side of the first line of the range for a multi-line comment. + * @default RIGHT + * @enum {string|null} + */ + start_side: "LEFT" | "RIGHT" | null; + /** + * @description The level at which the comment is targeted, can be a diff line or a file. + * @enum {string} + */ + subject_type?: "line" | "file"; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the pull request review 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; + 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; + }[]; + node_id: string; + }; }; - /** pull_request unlabeled event */ - "webhook-pull-request-unlabeled": { + /** pull_request synchronize event */ + "webhook-pull-request-synchronize": { /** @enum {string} */ - action: "unlabeled"; + action: "synchronize"; + after: string; + before: string; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** Label */ - label?: { - /** @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; - }; - /** @description The pull request number. */ - number: number; + number: components["schemas"]["webhooks_number"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ pull_request: { @@ -81736,7 +74767,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string | null; + label: string; ref: string; /** * Repository @@ -82011,7 +75042,7 @@ export interface components { watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - } | null; + }; sha: string; /** User */ user: { @@ -82386,103 +75417,103 @@ export interface components { /** Format: uri */ url?: string; } | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request unlocked event */ - "webhook-pull-request-unlocked": { - /** @enum {string} */ - action: "unlocked"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; - }; - }; - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; - /** 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; + }; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request unassigned event */ + "webhook-pull-request-unassigned": { + /** @enum {string} */ + action: "unassigned"; + assignee?: components["schemas"]["webhooks_user_mannequin"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** Pull Request */ + pull_request: { + _links: { + /** Link */ + comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + commits: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + issue: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comment: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + statuses: { + /** Format: uri-template */ + href: string; + }; + }; + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; + /** 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; + } | null; assignees: ({ /** Format: uri */ avatar_url?: string; @@ -82515,7 +75546,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)[]; @@ -82533,7 +75564,7 @@ export interface components { /** @description Commit message for the merge commit. */ commit_message: string | null; /** @description Title for the merge commit message. */ - commit_title: string; + commit_title: string | null; /** User */ enabled_by: { /** Format: uri */ @@ -82578,7 +75609,7 @@ export interface components { merge_method: "merge" | "squash" | "rebase"; } | null; base: { - label: string; + label: string | null; ref: string; /** * Repository @@ -82918,7 +75949,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string; + label: string | null; ref: string; /** * Repository @@ -83169,714 +76200,108 @@ export interface components { stargazers?: number; stargazers_count: number; /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - } | null; - sha: 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; - 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; - }; - /** Format: uri */ - html_url: string; - id: number; - /** Format: uri */ - issue_url: string; - 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; - }[]; - locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; - merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ - merged_at: string | null; - /** User */ - merged_by?: { - /** 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; - /** - * 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; + stargazers_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; + statuses_url: string; /** Format: uri */ - received_events_url?: string; + subscribers_url: string; /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; + subscription_url: string; /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + svn_url: string; /** Format: uri */ - url?: 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; - /** @description Number uniquely identifying the pull request within its repository. */ - number: number; - /** Format: uri */ - patch_url: string; - rebaseable?: boolean | null; - requested_reviewers: (({ - /** 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) | { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; + tags_url: string; /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; + teams_url: string; + topics: string[]; /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + trees_url: string; + /** Format: date-time */ + updated_at: string; /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - })[]; - requested_teams: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; /** - * Format: uri - * @description URL for the team + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }[]; - /** Format: uri-template */ - review_comment_url: string; - review_comments?: number; - /** Format: uri */ - review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - state: "open" | "closed"; - /** Format: uri */ - statuses_url: string; - /** @description The title of the pull request. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - 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; - 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; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** push event */ - "webhook-push": { - /** @description The SHA of the most recent commit on `ref` after the push. */ - after: string; - base_ref: string | null; - /** @description The SHA of the most recent commit on `ref` before the push. */ - before: string; - /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */ - commits: { - /** @description An array of files added in the commit. */ - added?: string[]; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - author: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - committer: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** @description Whether this commit is distinct from any that have been pushed before. */ - distinct: boolean; - id: string; - /** @description The commit message. */ - message: string; - /** @description An array of files modified by the commit. */ - modified?: string[]; - /** @description An array of files removed in the commit. */ - removed?: string[]; - /** - * Format: date-time - * @description The ISO 8601 timestamp of the commit. - */ - timestamp: string; - tree_id: string; - /** - * Format: uri - * @description URL that points to the commit API resource. - */ - url: string; - }[]; - /** @description URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. */ - compare: string; - /** @description Whether this push created the `ref`. */ - created: boolean; - /** @description Whether this push deleted the `ref`. */ - deleted: boolean; - enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description Whether this push was a force push of the `ref`. */ - forced: boolean; - /** Commit */ - head_commit: { - /** @description An array of files added in the commit. */ - added?: string[]; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - author: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - committer: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** @description Whether this commit is distinct from any that have been pushed before. */ - distinct: boolean; - id: string; - /** @description The commit message. */ - message: string; - /** @description An array of files modified by the commit. */ - modified?: string[]; - /** @description An array of files removed in the commit. */ - removed?: string[]; - /** - * Format: date-time - * @description The ISO 8601 timestamp of the commit. - */ - timestamp: string; - tree_id: string; - /** - * Format: uri - * @description URL that points to the commit API resource. - */ - url: string; - } | null; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - pusher: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email?: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** @description The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. */ - ref: string; - /** - * Repository - * @description A git repository - */ - repository: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; + use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + } | null; + sha: 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; + 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; + }; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; + issue_url: string; + 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; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ + merged_at: string | null; /** User */ - owner: { + merged_by?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -83908,423 +76333,757 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: null | number | string; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - "webhook-registry-package-published": { - /** @enum {string} */ - action: "published"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - registry_package: { - created_at: string | null; - description: string | null; - ecosystem: string; - html_url: string; - id: number; - name: string; - namespace: string; - owner: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; + /** + * 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; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ html_url: string; id: number; - login: string; + /** Format: uri */ + labels_url: 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; + /** @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; - }; - package_type: string; - package_version: { - author?: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; + } | null; + node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ + number: number; + /** Format: uri */ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ + /** 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; + } | null) | { + deleted?: boolean; + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ html_url: string; + /** @description Unique identifier of the team */ id: number; - login: string; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: 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; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ url: string; - }; - body?: string | Record; - body_html?: string; - container_metadata?: { - labels?: Record | null; - manifest?: Record | null; - tag?: { - digest?: string; - name?: string; - }; - }; - created_at?: string; - description: string; - docker_metadata?: { - tags?: string[]; - }[]; - draft?: boolean; - html_url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + })[]; + requested_teams: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ id: number; - installation_command: string; - manifest?: string; - metadata: { - [key: string]: unknown; - }[]; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ name: string; - npm_metadata?: { - name?: string; - version?: string; - npm_user?: string; - author?: (null | Record) & (string | Record); - bugs?: (null | Record) & (string | Record); - dependencies?: Record; - dev_dependencies?: Record; - peer_dependencies?: Record; - optional_dependencies?: Record; - description?: string; - dist?: (null | Record) & (string | Record); - git_head?: string; - homepage?: string; - license?: string; - main?: string; - repository?: (null | Record) & (string | Record); - scripts?: Record; - id?: string; - node_version?: string; - npm_version?: string; - has_shrinkwrap?: boolean; - maintainers?: string[]; - contributors?: string[]; - engines?: Record; - keywords?: string[]; - files?: string[]; - bin?: Record; - man?: Record; - directories?: (null | Record) & (string | Record); - os?: string[]; - cpu?: string[]; - readme?: string; - installation_command?: string; - release_id?: number; - commit_oid?: string; - published_via_actions?: boolean; - deleted_by_id?: number; - } | null; - nuget_metadata?: { - id?: (null | Record) & (string | Record | number); - name?: string; - value?: boolean | string | number | { - url?: string; - branch?: string; - commit?: string; - type?: string; - }; - }[] | null; - package_files: { - content_type: string; - created_at: string; - download_url: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ id: number; - md5: string | null; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ name: string; - sha1: string | null; - sha256: string | null; - size: number; - state: string | null; - updated_at: string; - }[]; - package_url: string; - prerelease?: boolean; - release?: { - author?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - created_at?: string; - draft?: boolean; - html_url?: string; - id?: number; - name?: string | null; - prerelease?: boolean; - published_at?: string; - tag_name?: string; - target_commitish?: string; - url?: string; - }; - rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - summary: string; - tag_name?: string; - target_commitish?: string; - target_oid?: string; - updated_at?: string; - version: string; - } | null; - registry: { - about_url?: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; + }[]; + /** Format: uri-template */ + review_comment_url: string; + review_comments?: number; + /** Format: uri */ + review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + state: "open" | "closed"; + /** Format: uri */ + statuses_url: string; + /** @description The title of the pull request. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + 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; + id: number; + login: string; name?: string; - type?: 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; - vendor?: string; } | null; - updated_at: string | null; }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; }; - "webhook-registry-package-updated": { + /** pull_request unlabeled event */ + "webhook-pull-request-unlabeled": { /** @enum {string} */ - action: "updated"; + action: "unlabeled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; + label?: components["schemas"]["webhooks_label"]; + number: components["schemas"]["webhooks_number"]; organization?: components["schemas"]["organization-simple-webhooks"]; - registry_package: { - created_at: string; - description: null; - ecosystem: string; - html_url: string; - id: number; - name: string; - namespace: string; - owner: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; + /** Pull Request */ + pull_request: { + _links: { + /** Link */ + comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + commits: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + issue: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comment: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + statuses: { + /** Format: uri-template */ + href: string; + }; + }; + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; + /** 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; - 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; - }; - package_type: string; - package_version: { - author: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: 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; + } | 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; + } | 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"; + /** + * PullRequestAutoMerge + * @description The status of auto merging a pull request. + */ + auto_merge: { + /** @description Commit message for the merge commit. */ + commit_message: string | null; + /** @description Title for the merge commit message. */ + commit_title: string | null; + /** User */ + enabled_by: { + /** 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; - 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; - }; - body: string; - body_html: string; - created_at: string; - description: string; - docker_metadata?: ({ - tags?: string[]; - } | null)[]; - draft?: boolean; - html_url: string; - id: number; - installation_command: string; - manifest?: string; - metadata: { - [key: string]: unknown; - }[]; - name: string; - package_files: { - content_type?: string; - created_at?: string; - download_url?: string; - id?: number; - md5?: string | null; name?: string; - sha1?: string | null; - sha256?: string; - size?: number; - state?: string; - updated_at?: string; - }[]; - package_url: string; - prerelease?: boolean; - release?: { - author: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: 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; + /** + * @description The merge method to use. + * @enum {string} + */ + merge_method: "merge" | "squash" | "rebase"; + } | null; + base: { + label: string; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: 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; - 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; + 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; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; - created_at: string; - draft: boolean; - html_url: string; - id: number; - name: string; - prerelease: boolean; - published_at: string; - tag_name: string; - target_commitish: string; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: null | number | string; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; }; - rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - summary: string; - tag_name?: string; - target_commitish: string; - target_oid: string; - updated_at: string; - version: string; - }; - registry: Record | null; - updated_at: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** release created event */ - "webhook-release-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - release: { - assets: { - /** Format: uri */ - browser_download_url: string; - content_type: string; - /** Format: date-time */ - created_at: string; - download_count: number; - id: number; - label: string | null; - /** @description The file name of the asset. */ - name: string; - node_id: string; - size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - state: "uploaded"; - /** Format: date-time */ - updated_at: string; + sha: string; /** User */ - uploader?: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -84360,128 +77119,304 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** Format: uri */ - url: string; - }[]; - /** Format: uri */ - assets_url: string; - /** User */ - author: { - /** 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; + }; body: string | null; + changed_files?: number; /** Format: date-time */ - created_at: string | null; + closed_at: string | null; + comments?: number; /** Format: uri */ - discussion_url?: string; - /** @description Whether the release is a draft or published */ - draft: boolean; + comments_url: string; + commits?: number; /** Format: uri */ - html_url: string; - id: number; - name: string | null; - node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - prerelease: boolean; + commits_url: string; /** Format: date-time */ - published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - tag_name: string; - /** Format: uri */ - tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - target_commitish: string; - /** Format: uri-template */ - upload_url: string; - /** Format: uri */ - url: string; + created_at: string; + deletions?: number; /** Format: uri */ - zipball_url: string | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** release deleted event */ - "webhook-release-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - release: { - assets: { - /** Format: uri */ - browser_download_url: string; - content_type: string; - /** Format: date-time */ - created_at: string; - download_count: number; - id: number; + diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ + draft: boolean; + head: { label: string | null; - /** @description The file name of the asset. */ - name: string; - node_id: string; - size: number; + ref: string; /** - * @description State of the release asset. - * @enum {string} + * Repository + * @description A git repository */ - state: "uploaded"; - /** Format: date-time */ - updated_at: string; + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** + * @description The default value for a merge commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit message title. + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: 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; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: null | number | string; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + } | null; + sha: string; /** User */ - uploader?: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -84517,13 +77452,38 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** Format: uri */ + }; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + issue_url: string; + 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 */ - assets_url: string; + locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ + merged_at: string | null; /** User */ - author: { + merged_by?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -84559,100 +77519,18 @@ export interface components { /** Format: uri */ url?: string; } | null; - body: string | null; - /** Format: date-time */ - created_at: string | null; - /** Format: uri */ - discussion_url?: string; - /** @description Whether the release is a draft or published */ - draft: boolean; - /** Format: uri */ - html_url: string; - id: number; - name: string | null; - node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - prerelease: boolean; - /** Format: date-time */ - published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - tag_name: string; - /** Format: uri */ - tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - target_commitish: string; - /** Format: uri-template */ - upload_url: string; - /** Format: uri */ - url: string; - /** Format: uri */ - zipball_url: string | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** release edited event */ - "webhook-release-edited": { - /** @enum {string} */ - action: "edited"; - changes: { - body?: { - /** @description The previous version of the body if the action was `edited`. */ - from: string; - }; - name?: { - /** @description The previous version of the name if the action was `edited`. */ - from: string; - }; - make_latest?: { - /** @description Whether this release was explicitly `edited` to be the latest. */ - to: boolean; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - release: { - assets: { - /** Format: uri */ - browser_download_url: string; - content_type: string; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + milestone: { /** Format: date-time */ - created_at: string; - download_count: number; - id: number; - label: string | null; - /** @description The file name of the asset. */ - name: string; - node_id: string; - size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - state: "uploaded"; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - updated_at: string; + created_at: string; /** User */ - uploader?: { + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -84684,17 +77562,41 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: 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; + /** @description Number uniquely identifying the pull request within its repository. */ + number: number; /** Format: uri */ - assets_url: string; - /** User */ - author: { + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -84726,128 +77628,131 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null; - body: string | null; - /** Format: date-time */ - created_at: string | null; - /** Format: uri */ - discussion_url?: string; - /** @description Whether the release is a draft or published */ - draft: boolean; - /** Format: uri */ - html_url: string; - id: number; - name: string | null; - node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - prerelease: boolean; - /** Format: date-time */ - published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - tag_name: string; - /** Format: uri */ - tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - target_commitish: string; - /** Format: uri-template */ - upload_url: string; - /** Format: uri */ - url: string; - /** Format: uri */ - zipball_url: string | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** release prereleased event */ - "webhook-release-prereleased": { - /** @enum {string} */ - action: "prereleased"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - release: { - assets: { + } | null) | { + deleted?: boolean; + /** @description Description of the team */ + description: string | null; /** Format: uri */ - browser_download_url: string; - content_type: string; - /** Format: date-time */ - created_at: string; - download_count: number; + html_url: string; + /** @description Unique identifier of the team */ id: number; - label: string | null; - /** @description The file name of the asset. */ + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ name: string; node_id: string; - size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - state: "uploaded"; - /** Format: date-time */ - updated_at: string; - /** User */ - uploader?: { + parent?: { + /** @description Description of the team */ + description: string | null; /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; + html_url: string; + /** @description Unique identifier of the team */ + id: number; /** Format: uri-template */ - events_url?: string; + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + })[]; + requested_teams: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; + /** @description Unique identifier of the team */ 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; + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - url?: string; + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - url: string; + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; }[]; + /** Format: uri-template */ + review_comment_url: string; + review_comments?: number; /** Format: uri */ - assets_url: string; + review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + state: "open" | "closed"; + /** Format: uri */ + statuses_url: string; + /** @description The title of the pull request. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; /** User */ - author: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -84879,170 +77784,71 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - body: string | null; - /** Format: date-time */ - created_at: string | null; - /** Format: uri */ - discussion_url?: string; - /** @description Whether the release is a draft or published */ - draft: boolean; - /** Format: uri */ - html_url: string; - id: number; - name: string | null; - node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - prerelease: boolean; - /** Format: date-time */ - published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - tag_name: string; - /** Format: uri */ - tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - target_commitish: string; - /** Format: uri-template */ - upload_url: string; - /** Format: uri */ - url: string; - /** Format: uri */ - zipball_url: string | null; - } & { - assets?: (Record | null)[]; - assets_url?: string; - author?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - body?: string | null; - created_at?: string; - draft?: boolean; - html_url?: string; - id?: number; - name?: string | null; - node_id?: string; - /** - * @description Whether the release is identified as a prerelease or a full release. - * @enum {boolean} - */ - prerelease: true; - published_at?: string | null; - tag_name?: string; - tarball_url?: string | null; - target_commitish?: string; - upload_url?: string; - url?: string; - zipball_url?: string | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** release published event */ - "webhook-release-published": { + /** pull_request unlocked event */ + "webhook-pull-request-unlocked": { /** @enum {string} */ - action: "published"; + action: "unlocked"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; organization?: components["schemas"]["organization-simple-webhooks"]; - release: { - assets: { - /** Format: uri */ - browser_download_url: string; - content_type: string; - /** Format: date-time */ - created_at: string; - download_count: number; - id: number; - label: string | null; - /** @description The file name of the asset. */ - name: string; - node_id: string; - size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - state: "uploaded"; - /** Format: date-time */ - updated_at: string; - /** User */ - uploader?: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; + /** Pull Request */ + pull_request: { + _links: { + /** Link */ + comments: { /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; + href: string; + }; + /** Link */ + commits: { /** Format: uri-template */ - following_url?: string; + href: string; + }; + /** Link */ + html: { /** 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; + href: string; + }; + /** Link */ + issue: { /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - /** Format: uri */ - url: string; - }[]; - /** Format: uri */ - assets_url: string; + href: string; + }; + /** Link */ + review_comment: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + statuses: { + /** Format: uri-template */ + href: string; + }; + }; + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - author: { + assignee: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -85078,125 +77884,59 @@ export interface components { /** Format: uri */ url?: string; } | null; - body: string | null; - /** Format: date-time */ - created_at: string | null; - /** Format: uri */ - discussion_url?: string; - /** @description Whether the release is a draft or published */ - draft: boolean; - /** Format: uri */ - html_url: string; - id: number; - name: string | null; - node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - prerelease: boolean; - /** Format: date-time */ - published_at: string | null; - /** Reactions */ - reactions?: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; + assignees: ({ /** Format: uri */ - url: string; - }; - /** @description The name of the tag. */ - tag_name: string; - /** Format: uri */ - tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - target_commitish: string; - /** Format: uri-template */ - upload_url: string; - /** Format: uri */ - url: string; - /** Format: uri */ - zipball_url: string | null; - } & { - assets?: (Record | null)[]; - assets_url?: string; - author?: { 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; + 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; - type?: string; - url?: string; - }; - body?: string | null; - created_at?: string; - draft?: boolean; - html_url?: string; - id?: number; - name?: string | null; - node_id?: string; - prerelease?: boolean; - /** Format: date-time */ - published_at: string | null; - tag_name?: string; - tarball_url?: string | null; - target_commitish?: string; - upload_url?: string; - url?: string; - zipball_url?: string | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** release released event */ - "webhook-release-released": { - /** @enum {string} */ - action: "released"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - release: { - assets: { + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - browser_download_url: string; - content_type: string; - /** Format: date-time */ - created_at: string; - download_count: number; - id: number; - label: string | null; - /** @description The file name of the asset. */ - name: string; - node_id: string; - size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - state: "uploaded"; - /** Format: date-time */ - updated_at: string; + 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"; + /** + * PullRequestAutoMerge + * @description The status of auto merging a pull request. + */ + auto_merge: { + /** @description Commit message for the merge commit. */ + commit_message: string | null; + /** @description Title for the merge commit message. */ + commit_title: string; /** User */ - uploader?: { + enabled_by: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -85226,130 +77966,305 @@ export interface components { /** Format: uri-template */ starred_url?: string; /** Format: uri */ - subscriptions_url?: string; + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + /** + * @description The merge method to use. + * @enum {string} + */ + merge_method: "merge" | "squash" | "rebase"; + } | null; + base: { + label: string; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: 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; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: null | number | string; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - /** Format: uri */ - url: string; - }[]; - /** Format: uri */ - assets_url: string; - /** User */ - author: { - /** 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; - body: string | null; - /** Format: date-time */ - created_at: string | null; - /** Format: uri */ - discussion_url?: string; - /** @description Whether the release is a draft or published */ - draft: boolean; - /** Format: uri */ - html_url: string; - id: number; - name: string | null; - node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - prerelease: boolean; - /** Format: date-time */ - published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - tag_name: string; - /** Format: uri */ - tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - target_commitish: string; - /** Format: uri-template */ - upload_url: string; - /** Format: uri */ - url: string; - /** Format: uri */ - zipball_url: string | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** release unpublished event */ - "webhook-release-unpublished": { - /** @enum {string} */ - action: "unpublished"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - release: { - assets: { - /** Format: uri */ - browser_download_url: string; - content_type: string; - /** Format: date-time */ - created_at: string; - download_count: number; - id: number; - label: string | null; - /** @description The file name of the asset. */ - name: string; - node_id: string; - size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - state: "uploaded"; - /** Format: date-time */ - updated_at: string; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + }; + sha: string; /** User */ - uploader?: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -85365,403 +78280,223 @@ export interface components { 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; - /** Format: uri */ - url: string; - }[]; - /** Format: uri */ - assets_url: string; - /** User */ - author: { - /** 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; - body: string | null; - /** Format: date-time */ - created_at: string | null; - /** Format: uri */ - discussion_url?: string; - /** @description Whether the release is a draft or published */ - draft: boolean; - /** Format: uri */ - html_url: string; - id: number; - name: string | null; - node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - prerelease: boolean; - /** Format: date-time */ - published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - tag_name: string; - /** Format: uri */ - tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - target_commitish: string; - /** Format: uri-template */ - upload_url: string; - /** Format: uri */ - url: string; - /** Format: uri */ - zipball_url: string | null; - } & { - assets?: (Record | null)[]; - assets_url?: string; - author?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - body?: string | null; - created_at?: string; - draft?: boolean; - html_url?: string; - id?: number; - name?: string | null; - node_id?: string; - prerelease?: boolean; - published_at: string | null; - tag_name?: string; - tarball_url?: string | null; - target_commitish?: string; - upload_url?: string; - url?: string; - zipball_url?: string | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** Repository advisory published event */ - "webhook-repository-advisory-published": { - /** @enum {string} */ - action: "published"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** Repository advisory reported event */ - "webhook-repository-advisory-reported": { - /** @enum {string} */ - action: "reported"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** repository archived event */ - "webhook-repository-archived": { - /** @enum {string} */ - action: "archived"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository created event */ - "webhook-repository-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository deleted event */ - "webhook-repository-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_dispatch event */ - "webhook-repository-dispatch-sample": { - /** @enum {string} */ - action: "sample.collected"; - branch: string; - client_payload: { - [key: string]: unknown; - } | null; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository edited event */ - "webhook-repository-edited": { - /** @enum {string} */ - action: "edited"; - changes: { - default_branch?: { - from: string; - }; - description?: { - from: string | null; - }; - homepage?: { - from: string | null; - }; - topics?: { - from?: string[] | null; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_import event */ - "webhook-repository-import": { - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - /** @enum {string} */ - status: "success" | "cancelled" | "failure"; - }; - /** repository privatized event */ - "webhook-repository-privatized": { - /** @enum {string} */ - action: "privatized"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository publicized event */ - "webhook-repository-publicized": { - /** @enum {string} */ - action: "publicized"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository renamed event */ - "webhook-repository-renamed": { - /** @enum {string} */ - action: "renamed"; - changes: { - repository: { - name: { - from: string; - }; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository ruleset created event */ - "webhook-repository-ruleset-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository ruleset deleted event */ - "webhook-repository-ruleset-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository ruleset edited event */ - "webhook-repository-ruleset-edited": { - /** @enum {string} */ - action: "edited"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - repository_ruleset: components["schemas"]["repository-ruleset"]; - changes?: { - name?: { - from?: string; - }; - enforcement?: { - from?: string; - }; - conditions?: { - added?: components["schemas"]["repository-ruleset-conditions"][]; - deleted?: components["schemas"]["repository-ruleset-conditions"][]; - updated?: { - condition?: components["schemas"]["repository-ruleset-conditions"]; - changes?: { - condition_type?: { - from?: string; - }; - target?: { - from?: string; - }; - include?: { - from?: string[]; - }; - exclude?: { - from?: string[]; - }; - }; - }[]; - }; - rules?: { - added?: components["schemas"]["repository-rule"][]; - deleted?: components["schemas"]["repository-rule"][]; - updated?: { - rule?: components["schemas"]["repository-rule"]; - changes?: { - configuration?: { - from?: string; - }; - rule_type?: { - from?: string; - }; - pattern?: { - from?: string; - }; - }; - }[]; - }; - }; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository transferred event */ - "webhook-repository-transferred": { - /** @enum {string} */ - action: "transferred"; - changes: { - owner: { - from: { - /** Organization */ - organization?: { - /** Format: uri */ - avatar_url: string; - description: string | null; - /** Format: uri */ - events_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url?: string; - id: number; - /** Format: uri */ - issues_url: string; - login: string; - /** Format: uri-template */ - members_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; + }; + body: string | null; + changed_files?: number; + /** Format: date-time */ + closed_at: string | null; + comments?: number; + /** Format: uri */ + comments_url: string; + commits?: number; + /** Format: uri */ + commits_url: string; + /** Format: date-time */ + created_at: string; + deletions?: number; + /** Format: uri */ + diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ + draft: boolean; + head: { + label: string; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; node_id: string; - /** Format: uri-template */ - public_members_url: string; - /** Format: uri */ - repos_url: string; + spdx_id: string; /** Format: uri */ - url: string; - }; + url: string | null; + } | null; + master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - user?: { + owner: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -85797,324 +78532,146 @@ export interface components { /** Format: uri */ url?: string; } | null; - }; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository unarchived event */ - "webhook-repository-unarchived": { - /** @enum {string} */ - action: "unarchived"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert create event */ - "webhook-repository-vulnerability-alert-create": { - /** @enum {string} */ - action: "create"; - alert: { - affected_package_name: string; - affected_range: string; - created_at: string; - dismiss_reason?: string; - dismissed_at?: string; - /** User */ - dismisser?: { - /** 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; - external_identifier: string; - /** Format: uri */ - external_reference: string | null; - fix_reason?: string; - /** Format: date-time */ - fixed_at?: string; - fixed_in?: string; - ghsa_id: string; - id: number; - node_id: string; - number: number; - severity: string; - /** @enum {string} */ - state: "open" | "dismissed" | "fixed"; - } & { - affected_package_name?: string; - affected_range?: string; - created_at?: string; - external_identifier?: string; - external_reference?: string | null; - fixed_in?: string; - ghsa_id?: string; - id?: number; - node_id?: string; - number?: number; - severity?: string; - /** @enum {string} */ - state: "open"; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert dismiss event */ - "webhook-repository-vulnerability-alert-dismiss": { - /** @enum {string} */ - action: "dismiss"; - alert: { - affected_package_name: string; - affected_range: string; - created_at: string; - dismiss_comment?: string | null; - dismiss_reason?: string; - dismissed_at?: string; - /** User */ - dismisser?: { - /** 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; - external_identifier: string; - /** Format: uri */ - external_reference: string | null; - fix_reason?: string; - /** Format: date-time */ - fixed_at?: string; - fixed_in?: string; - ghsa_id: string; - id: number; - node_id: string; - number: number; - severity: string; - /** @enum {string} */ - state: "open" | "dismissed" | "fixed"; - } & { - affected_package_name?: string; - affected_range?: string; - created_at?: string; - dismiss_comment?: string | null; - dismiss_reason: string; - dismissed_at: string; - /** User */ - dismisser: { - /** 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; - external_identifier?: string; - external_reference?: string | null; - fixed_in?: string; - ghsa_id?: string; - id?: number; - node_id?: string; - number?: number; - severity?: string; - /** @enum {string} */ - state: "dismissed"; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert reopen event */ - "webhook-repository-vulnerability-alert-reopen": { - /** @enum {string} */ - action: "reopen"; - alert: { - affected_package_name: string; - affected_range: string; - created_at: string; - dismiss_reason?: string; - dismissed_at?: string; - /** User */ - dismisser?: { - /** 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; - external_identifier: string; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: null | number | string; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + } | null; + sha: 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; + 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; + }; /** Format: uri */ - external_reference: string | null; - fix_reason?: string; - /** Format: date-time */ - fixed_at?: string; - fixed_in?: string; - ghsa_id: string; + html_url: string; id: number; - node_id: string; - number: number; - severity: string; - /** @enum {string} */ - state: "open" | "dismissed" | "fixed"; - } & { - affected_package_name?: string; - affected_range?: string; - created_at?: string; - external_identifier?: string; - external_reference?: string | null; - fixed_in?: string; - ghsa_id?: string; - id?: number; - node_id?: string; - number?: number; - severity?: string; - /** @enum {string} */ - state: "open"; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert resolve event */ - "webhook-repository-vulnerability-alert-resolve": { - /** @enum {string} */ - action: "resolve"; - alert: { - affected_package_name: string; - affected_range: string; - created_at: string; - dismiss_reason?: string; - dismissed_at?: string; + /** Format: uri */ + issue_url: string; + 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; + }[]; + locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ + merged_at: string | null; /** User */ - dismisser?: { + merged_by?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -86150,330 +78707,84 @@ export interface components { /** Format: uri */ url?: string; } | null; - external_identifier: string; - /** Format: uri */ - external_reference: string | null; - fix_reason?: string; - /** Format: date-time */ - fixed_at?: string; - fixed_in?: string; - ghsa_id: string; - id: number; - node_id: string; - number: number; - severity: string; - /** @enum {string} */ - state: "open" | "dismissed" | "fixed"; - } & { - affected_package_name?: string; - affected_range?: string; - created_at?: string; - external_identifier?: string; - external_reference?: string | null; - fix_reason?: string; - /** Format: date-time */ - fixed_at?: string; - fixed_in?: string; - ghsa_id?: string; - id?: number; - node_id?: string; - number?: number; - severity?: string; - /** @enum {string} */ - state: "fixed" | "open"; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** secret_scanning_alert created event */ - "webhook-secret-scanning-alert-created": { - /** @enum {string} */ - action: "created"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** Secret Scanning Alert Location Created Event */ - "webhook-secret-scanning-alert-location-created": { - /** @enum {string} */ - action?: "created"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; - installation?: components["schemas"]["simple-installation"]; - location: components["schemas"]["secret-scanning-location"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Secret Scanning Alert Location Created Event */ - "webhook-secret-scanning-alert-location-created-form-encoded": { - /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ - payload: string; - }; - /** secret_scanning_alert reopened event */ - "webhook-secret-scanning-alert-reopened": { - /** @enum {string} */ - action: "reopened"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** secret_scanning_alert resolved event */ - "webhook-secret-scanning-alert-resolved": { - /** @enum {string} */ - action: "resolved"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** secret_scanning_alert revoked event */ - "webhook-secret-scanning-alert-revoked": { - /** @enum {string} */ - action: "revoked"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_advisory published event */ - "webhook-security-advisory-published": { - /** @enum {string} */ - action: "published"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - /** @description The details of the security advisory, including summary, description, and severity. */ - security_advisory: { - cvss: { - score: number; - vector_string: string | null; - }; - cwes: { - cwe_id: string; - name: string; - }[]; - description: string; - ghsa_id: string; - identifiers: { - type: string; - value: string; - }[]; - published_at: string; - references: { - /** Format: uri */ - url: string; - }[]; - severity: string; - summary: string; - updated_at: string; - vulnerabilities: { - first_patched_version: { - identifier: string; - } | null; - package: { - ecosystem: string; - name: string; - }; - severity: string; - vulnerable_version_range: string; - }[]; - withdrawn_at: string | null; - }; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_advisory updated event */ - "webhook-security-advisory-updated": { - /** @enum {string} */ - action: "updated"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - /** @description The details of the security advisory, including summary, description, and severity. */ - security_advisory: { - cvss: { - score: number; - vector_string: string | null; - }; - cwes: { - cwe_id: string; - name: string; - }[]; - description: string; - ghsa_id: string; - identifiers: { - type: string; - value: string; - }[]; - published_at: string; - references: { - /** Format: uri */ - url: string; - }[]; - severity: string; - summary: string; - updated_at: string; - vulnerabilities: { - first_patched_version: { - identifier: string; - } | null; - package: { - ecosystem: string; - name: string; - }; - severity: string; - vulnerable_version_range: string; - }[]; - withdrawn_at: string | null; - }; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_advisory withdrawn event */ - "webhook-security-advisory-withdrawn": { - /** @enum {string} */ - action: "withdrawn"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - /** @description The details of the security advisory, including summary, description, and severity. */ - security_advisory: { - cvss: { - score: number; - vector_string: string | null; - }; - cwes: { - cwe_id: string; - name: string; - }[]; - description: string; - ghsa_id: string; - identifiers: { - type: string; - value: string; - }[]; - published_at: string; - references: { - /** Format: uri */ - url: string; - }[]; - severity: string; - summary: string; - updated_at: string; - vulnerabilities: { - first_patched_version: { - identifier: string; + /** + * 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"; + /** Format: uri */ + url?: string; } | null; - package: { - ecosystem: string; - name: string; - }; - severity: string; - vulnerable_version_range: string; - }[]; - withdrawn_at: string; - }; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_and_analysis event */ - "webhook-security-and-analysis": { - changes: { - from?: { - security_and_analysis?: components["schemas"]["security-and-analysis"]; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["full-repository"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** sponsorship cancelled event */ - "webhook-sponsorship-cancelled": { - /** @enum {string} */ - action: "cancelled"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - sponsorship: { - created_at: string; - maintainer?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - node_id: string; - privacy_level: string; - /** User */ - sponsor: { - /** 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; + description: string | null; + /** Format: date-time */ + due_on: string | null; /** Format: uri */ - html_url?: string; + 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"; + 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; + url: string; } | null; - /** User */ - sponsorable: { + node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ + number: number; + /** Format: uri */ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -86508,96 +78819,128 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - tier: { - created_at: string; - description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; - name: string; - node_id: string; - }; - }; - }; - /** sponsorship created event */ - "webhook-sponsorship-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - sponsorship: { - created_at: string; - maintainer?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - node_id: string; - privacy_level: string; - /** User */ - sponsor: { - /** Format: uri */ - avatar_url?: string; + } | null) | { 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; + /** @description Description of the team */ + description?: string | null; /** Format: uri */ html_url?: string; + /** @description Unique identifier of the team */ id: number; - login: string; - name?: string; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; + })[]; + requested_teams: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; /** Format: uri */ - repos_url?: string; - site_admin?: boolean; + html_url?: string; + /** @description Unique identifier of the team */ + id: number; /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ url?: string; - } | null; + }[]; + /** Format: uri-template */ + review_comment_url: string; + review_comments?: number; + /** Format: uri */ + review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + state: "open" | "closed"; + /** Format: uri */ + statuses_url: string; + /** @description The title of the pull request. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; /** User */ - sponsorable: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -86633,64 +78976,308 @@ export interface components { /** Format: uri */ url?: string; } | null; + }; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** push event */ + "webhook-push": { + /** @description The SHA of the most recent commit on `ref` after the push. */ + after: string; + base_ref: components["schemas"]["webhooks_nullable_string"]; + /** @description The SHA of the most recent commit on `ref` before the push. */ + before: string; + /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. */ + commits: { + /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ + added?: string[]; /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. + * Committer + * @description Metaproperties for Git author/committer information. */ - tier: { - created_at: string; - description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; + author: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ name: string; - node_id: string; + username?: string; }; - }; - }; - /** sponsorship edited event */ - "webhook-sponsorship-edited": { - /** @enum {string} */ - action: "edited"; - changes: { - privacy_level?: { - /** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */ - from: string; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + committer: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; }; - }; + /** @description Whether this commit is distinct from any that have been pushed before. */ + distinct: boolean; + id: string; + /** @description The commit message. */ + message: string; + /** @description An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit. */ + modified?: string[]; + /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */ + removed?: string[]; + /** + * Format: date-time + * @description The ISO 8601 timestamp of the commit. + */ + timestamp: string; + tree_id: string; + /** + * Format: uri + * @description URL that points to the commit API resource. + */ + url: string; + }[]; + /** @description URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. */ + compare: string; + /** @description Whether this push created the `ref`. */ + created: boolean; + /** @description Whether this push deleted the `ref`. */ + deleted: boolean; enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @description Whether this push was a force push of the `ref`. */ + forced: boolean; + /** Commit */ + head_commit: { + /** @description An array of files added in the commit. */ + added?: string[]; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + author: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + committer: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + /** @description Whether this commit is distinct from any that have been pushed before. */ + distinct: boolean; + id: string; + /** @description The commit message. */ + message: string; + /** @description An array of files modified by the commit. */ + modified?: string[]; + /** @description An array of files removed in the commit. */ + removed?: string[]; + /** + * Format: date-time + * @description The ISO 8601 timestamp of the commit. + */ + timestamp: string; + tree_id: string; + /** + * Format: uri + * @description URL that points to the commit API resource. + */ + url: string; + } | null; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - sponsorship: { - created_at: string; - maintainer?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + pusher: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email?: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + /** @description The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. */ + ref: string; + /** + * Repository + * @description A git repository + */ + repository: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; }; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; node_id: string; - privacy_level: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - sponsor: { + owner: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -86726,134 +79313,508 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** User */ - sponsorable: { - /** 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; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: null | number | string; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + }; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + "webhook-registry-package-published": { + /** @enum {string} */ + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + registry_package: { + created_at: string | null; + description: string | null; + ecosystem: string; + html_url: string; + id: number; + name: string; + namespace: string; + owner: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; 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; + }; + package_type: string; + package_version: { + author?: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + 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; + }; + body?: string | Record; + body_html?: string; + container_metadata?: { + labels?: Record | null; + manifest?: Record | null; + tag?: { + digest?: string; + name?: string; + }; + }; + created_at?: string; + description: string; + docker_metadata?: { + tags?: string[]; + }[]; + draft?: boolean; + html_url: string; + id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; + }[]; + name: string; + npm_metadata?: { + name?: string; + version?: string; + npm_user?: string; + author?: (null | Record) & (string | Record); + bugs?: (null | Record) & (string | Record); + dependencies?: Record; + dev_dependencies?: Record; + peer_dependencies?: Record; + optional_dependencies?: Record; + description?: string; + dist?: (null | Record) & (string | Record); + git_head?: string; + homepage?: string; + license?: string; + main?: string; + repository?: (null | Record) & (string | Record); + scripts?: Record; + id?: string; + node_version?: string; + npm_version?: string; + has_shrinkwrap?: boolean; + maintainers?: string[]; + contributors?: string[]; + engines?: Record; + keywords?: string[]; + files?: string[]; + bin?: Record; + man?: Record; + directories?: (null | Record) & (string | Record); + os?: string[]; + cpu?: string[]; + readme?: string; + installation_command?: string; + release_id?: number; + commit_oid?: string; + published_via_actions?: boolean; + deleted_by_id?: number; + } | null; + nuget_metadata?: { + id?: (null | Record) & (string | Record | number); + name?: string; + value?: boolean | string | number | { + url?: string; + branch?: string; + commit?: string; + type?: string; + }; + }[] | null; + package_files: { + content_type: string; + created_at: string; + download_url: string; + id: number; + md5: string | null; + name: string; + sha1: string | null; + sha256: string | null; + size: number; + state: string | null; + updated_at: string; + }[]; + package_url: string; + prerelease?: boolean; + release?: { + author?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + created_at?: string; + draft?: boolean; + html_url?: string; + id?: number; + name?: string | null; + prerelease?: boolean; + published_at?: string; + tag_name?: string; + target_commitish?: string; + url?: string; + }; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + summary: string; + tag_name?: string; + target_commitish?: string; + target_oid?: string; + updated_at?: string; + version: string; + } | null; + registry: { + about_url?: 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 */ + type?: string; url?: string; + vendor?: string; } | null; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - tier: { + updated_at: string | null; + }; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + "webhook-registry-package-updated": { + /** @enum {string} */ + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + registry_package: { + created_at: string; + description: null; + ecosystem: string; + html_url: string; + id: number; + name: string; + namespace: string; + owner: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + 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; + }; + package_type: string; + package_version: { + author: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + 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; + }; + body: string; + body_html: string; created_at: string; description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; + docker_metadata?: ({ + tags?: string[]; + } | null)[]; + draft?: boolean; + html_url: string; + id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; + }[]; name: string; - node_id: string; + package_files: { + content_type?: string; + created_at?: string; + download_url?: string; + id?: number; + md5?: string | null; + name?: string; + sha1?: string | null; + sha256?: string; + size?: number; + state?: string; + updated_at?: string; + }[]; + package_url: string; + prerelease?: boolean; + release?: { + author: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + 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; + }; + created_at: string; + draft: boolean; + html_url: string; + id: number; + name: string; + prerelease: boolean; + published_at: string; + tag_name: string; + target_commitish: string; + url: string; + }; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + summary: string; + tag_name?: string; + target_commitish: string; + target_oid: string; + updated_at: string; + version: string; }; + registry: Record | null; + updated_at: string; }; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** sponsorship pending_cancellation event */ - "webhook-sponsorship-pending-cancellation": { + /** release created event */ + "webhook-release-created": { /** @enum {string} */ - action: "pending_cancellation"; - /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ - effective_date?: string; + action: "created"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; - sponsorship: { - created_at: string; - maintainer?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; + }; + /** release deleted event */ + "webhook-release-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** release edited event */ + "webhook-release-edited": { + /** @enum {string} */ + action: "edited"; + changes: { + body?: { + /** @description The previous version of the body if the action was `edited`. */ + from: string; }; - node_id: string; - privacy_level: string; - /** User */ - sponsor: { - /** 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; + name?: { + /** @description The previous version of the name if the action was `edited`. */ + from: string; + }; + make_latest?: { + /** @description Whether this release was explicitly `edited` to be the latest. */ + to: boolean; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** release prereleased event */ + "webhook-release-prereleased": { + /** @enum {string} */ + action: "prereleased"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** + * Release + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. + */ + release: { + assets: ({ /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + browser_download_url: string; + content_type: string; + /** Format: date-time */ + created_at: string; + download_count: number; + id: number; + label: string | null; + /** @description The file name of the asset. */ + name: string; + node_id: string; + size: number; + /** + * @description State of the release asset. + * @enum {string} + */ + state: "uploaded"; + /** Format: date-time */ + updated_at: string; + /** User */ + uploader?: { + /** 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; /** Format: uri */ - url?: string; - } | null; + url: string; + } | null)[]; + /** Format: uri */ + assets_url: string; /** User */ - sponsorable: { + author: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -86889,222 +79850,422 @@ export interface components { /** Format: uri */ url?: string; } | null; + body: string | null; + /** Format: date-time */ + created_at: string | null; + /** Format: uri */ + discussion_url?: string; + /** @description Whether the release is a draft or published */ + draft: boolean; + /** Format: uri */ + html_url: string; + id: number; + name: string | null; + node_id: string; /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. + * @description Whether the release is identified as a prerelease or a full release. + * @enum {boolean} */ - tier: { - created_at: string; - description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; - name: string; - node_id: string; + prerelease: true; + /** Format: date-time */ + published_at: string | null; + /** 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; }; + /** @description The name of the tag. */ + tag_name: string; + /** Format: uri */ + tarball_url: string | null; + /** @description Specifies the commitish value that determines where the Git tag is created from. */ + target_commitish: string; + /** Format: uri-template */ + upload_url: string; + /** Format: uri */ + url: string; + /** Format: uri */ + zipball_url: string | null; }; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; }; - /** sponsorship pending_tier_change event */ - "webhook-sponsorship-pending-tier-change": { + /** release published event */ + "webhook-release-published": { /** @enum {string} */ - action: "pending_tier_change"; + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release_1"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** release released event */ + "webhook-release-released": { + /** @enum {string} */ + action: "released"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** release unpublished event */ + "webhook-release-unpublished": { + /** @enum {string} */ + action: "unpublished"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release_1"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Repository advisory published event */ + "webhook-repository-advisory-published": { + /** @enum {string} */ + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + repository_advisory: components["schemas"]["repository-advisory"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Repository advisory reported event */ + "webhook-repository-advisory-reported": { + /** @enum {string} */ + action: "reported"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + repository_advisory: components["schemas"]["repository-advisory"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** repository archived event */ + "webhook-repository-archived": { + /** @enum {string} */ + action: "archived"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository created event */ + "webhook-repository-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository deleted event */ + "webhook-repository-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_dispatch event */ + "webhook-repository-dispatch-sample": { + /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + action: string; + branch: string; + /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + client_payload: { + [key: string]: unknown; + } | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository edited event */ + "webhook-repository-edited": { + /** @enum {string} */ + action: "edited"; changes: { - tier: { - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - from: { - created_at: string; - description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; - name: string; - node_id: string; + default_branch?: { + from: string; + }; + description?: { + from: string | null; + }; + homepage?: { + from: string | null; + }; + topics?: { + from?: string[] | null; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_import event */ + "webhook-repository-import": { + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + /** @enum {string} */ + status: "success" | "cancelled" | "failure"; + }; + /** repository privatized event */ + "webhook-repository-privatized": { + /** @enum {string} */ + action: "privatized"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository publicized event */ + "webhook-repository-publicized": { + /** @enum {string} */ + action: "publicized"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository renamed event */ + "webhook-repository-renamed": { + /** @enum {string} */ + action: "renamed"; + changes: { + repository: { + name: { + from: string; }; }; }; - /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ - effective_date?: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository ruleset created event */ + "webhook-repository-ruleset-created": { + /** @enum {string} */ + action: "created"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; sender: components["schemas"]["simple-user-webhooks"]; - sponsorship: { - created_at: string; - maintainer?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; + }; + /** repository ruleset deleted event */ + "webhook-repository-ruleset-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository ruleset edited event */ + "webhook-repository-ruleset-edited": { + /** @enum {string} */ + action: "edited"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + changes?: { + name?: { + from?: string; }; - node_id: string; - privacy_level: string; - /** User */ - sponsor: { - /** 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; - /** User */ - sponsorable: { - /** 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; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - tier: { - created_at: string; - description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; - name: string; - node_id: string; + enforcement?: { + from?: string; + }; + conditions?: { + added?: components["schemas"]["repository-ruleset-conditions"][]; + deleted?: components["schemas"]["repository-ruleset-conditions"][]; + updated?: { + condition?: components["schemas"]["repository-ruleset-conditions"]; + changes?: { + condition_type?: { + from?: string; + }; + target?: { + from?: string; + }; + include?: { + from?: string[]; + }; + exclude?: { + from?: string[]; + }; + }; + }[]; + }; + rules?: { + added?: components["schemas"]["repository-rule"][]; + deleted?: components["schemas"]["repository-rule"][]; + updated?: { + rule?: components["schemas"]["repository-rule"]; + changes?: { + configuration?: { + from?: string; + }; + rule_type?: { + from?: string; + }; + pattern?: { + from?: string; + }; + }; + }[]; + }; + }; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository transferred event */ + "webhook-repository-transferred": { + /** @enum {string} */ + action: "transferred"; + changes: { + owner: { + from: { + /** Organization */ + organization?: { + /** Format: uri */ + avatar_url: string; + description: string | null; + /** Format: uri */ + events_url: string; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url?: string; + id: number; + /** Format: uri */ + issues_url: string; + login: string; + /** Format: uri-template */ + members_url: string; + node_id: string; + /** Format: uri-template */ + public_members_url: string; + /** Format: uri */ + repos_url: string; + /** Format: uri */ + 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; + 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; + }; }; }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** sponsorship tier_changed event */ - "webhook-sponsorship-tier-changed": { + /** repository unarchived event */ + "webhook-repository-unarchived": { /** @enum {string} */ - action: "tier_changed"; - changes: { - tier: { - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - from: { - created_at: string; - description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; - name: string; - node_id: string; - }; - }; - }; + action: "unarchived"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_vulnerability_alert create event */ + "webhook-repository-vulnerability-alert-create": { + /** @enum {string} */ + action: "create"; + alert: components["schemas"]["webhooks_alert"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; - sponsorship: { + }; + /** repository_vulnerability_alert dismiss event */ + "webhook-repository-vulnerability-alert-dismiss": { + /** @enum {string} */ + action: "dismiss"; + /** + * Repository Vulnerability Alert Alert + * @description The security alert of the vulnerable dependency. + */ + alert: { + affected_package_name: string; + affected_range: string; created_at: string; - maintainer?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - node_id: string; - privacy_level: string; + dismiss_comment?: string | null; + dismiss_reason: string; + dismissed_at: string; /** User */ - sponsor: { + dismisser: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -87140,8 +80301,54 @@ export interface components { /** Format: uri */ url?: string; } | null; + external_identifier: string; + /** Format: uri */ + external_reference: string | null; + fix_reason?: string; + /** Format: date-time */ + fixed_at?: string; + fixed_in?: string; + ghsa_id: string; + id: number; + node_id: string; + number: number; + severity: string; + /** @enum {string} */ + state: "dismissed"; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_vulnerability_alert reopen event */ + "webhook-repository-vulnerability-alert-reopen": { + /** @enum {string} */ + action: "reopen"; + alert: components["schemas"]["webhooks_alert"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_vulnerability_alert resolve event */ + "webhook-repository-vulnerability-alert-resolve": { + /** @enum {string} */ + action: "resolve"; + /** + * Repository Vulnerability Alert Alert + * @description The security alert of the vulnerable dependency. + */ + alert: { + affected_package_name: string; + affected_range: string; + created_at: string; + dismiss_reason?: string; + dismissed_at?: string; /** User */ - sponsorable: { + dismisser?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -87177,22 +80384,255 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - tier: { - created_at: string; - description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; + external_identifier: string; + /** Format: uri */ + external_reference: string | null; + fix_reason?: string; + /** Format: date-time */ + fixed_at?: string; + fixed_in?: string; + ghsa_id: string; + id: number; + node_id: string; + number: number; + severity: string; + /** @enum {string} */ + state: "fixed" | "open"; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert created event */ + "webhook-secret-scanning-alert-created": { + /** @enum {string} */ + action: "created"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Secret Scanning Alert Location Created Event */ + "webhook-secret-scanning-alert-location-created": { + /** @enum {string} */ + action?: "created"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + installation?: components["schemas"]["simple-installation"]; + location: components["schemas"]["secret-scanning-location"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Secret Scanning Alert Location Created Event */ + "webhook-secret-scanning-alert-location-created-form-encoded": { + /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ + payload: string; + }; + /** secret_scanning_alert reopened event */ + "webhook-secret-scanning-alert-reopened": { + /** @enum {string} */ + action: "reopened"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert resolved event */ + "webhook-secret-scanning-alert-resolved": { + /** @enum {string} */ + action: "resolved"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert revoked event */ + "webhook-secret-scanning-alert-revoked": { + /** @enum {string} */ + action: "revoked"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert validated event */ + "webhook-secret-scanning-alert-validated": { + /** @enum {string} */ + action: "validated"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_advisory published event */ + "webhook-security-advisory-published": { + /** @enum {string} */ + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + security_advisory: components["schemas"]["webhooks_security_advisory"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_advisory updated event */ + "webhook-security-advisory-updated": { + /** @enum {string} */ + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + security_advisory: components["schemas"]["webhooks_security_advisory"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_advisory withdrawn event */ + "webhook-security-advisory-withdrawn": { + /** @enum {string} */ + action: "withdrawn"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + /** @description The details of the security advisory, including summary, description, and severity. */ + security_advisory: { + cvss: { + score: number; + vector_string: string | null; + }; + cwes: { + cwe_id: string; name: string; - node_id: string; + }[]; + description: string; + ghsa_id: string; + identifiers: { + type: string; + value: string; + }[]; + published_at: string; + references: { + /** Format: uri */ + url: string; + }[]; + severity: string; + summary: string; + updated_at: string; + vulnerabilities: { + first_patched_version: { + identifier: string; + } | null; + package: { + ecosystem: string; + name: string; + }; + severity: string; + vulnerable_version_range: string; + }[]; + withdrawn_at: string; + }; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_and_analysis event */ + "webhook-security-and-analysis": { + changes: { + from?: { + security_and_analysis?: components["schemas"]["security-and-analysis"]; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["full-repository"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sponsorship cancelled event */ + "webhook-sponsorship-cancelled": { + /** @enum {string} */ + action: "cancelled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship created event */ + "webhook-sponsorship-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship edited event */ + "webhook-sponsorship-edited": { + /** @enum {string} */ + action: "edited"; + changes: { + privacy_level?: { + /** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */ + from: string; }; }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship pending_cancellation event */ + "webhook-sponsorship-pending-cancellation": { + /** @enum {string} */ + action: "pending_cancellation"; + effective_date?: components["schemas"]["webhooks_effective_date"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship pending_tier_change event */ + "webhook-sponsorship-pending-tier-change": { + /** @enum {string} */ + action: "pending_tier_change"; + changes: components["schemas"]["webhooks_changes_8"]; + effective_date?: components["schemas"]["webhooks_effective_date"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship tier_changed event */ + "webhook-sponsorship-tier-changed": { + /** @enum {string} */ + action: "tier_changed"; + changes: components["schemas"]["webhooks_changes_8"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ "webhook-star-created": { @@ -87397,71 +80837,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; + team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ "webhook-team-added-to-repository": { @@ -87710,71 +81086,7 @@ export interface components { watchers_count: number; }; sender?: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; + team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ "webhook-team-created": { @@ -88023,71 +81335,7 @@ export interface components { watchers_count: number; }; sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; + team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ "webhook-team-deleted": { @@ -88336,71 +81584,7 @@ export interface components { watchers_count: number; }; sender?: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; + team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ "webhook-team-edited": { @@ -88680,71 +81864,7 @@ export interface components { watchers_count: number; }; sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; + team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ "webhook-team-removed-from-repository": { @@ -88993,71 +82113,7 @@ export interface components { watchers_count: number; }; sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; + team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ "webhook-watch-started": { @@ -89303,66 +82359,12 @@ export interface components { runner_name: string | null; /** Format: date-time */ started_at: string; - /** @enum {string} */ - status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ - head_branch: string | null; - /** @description The name of the workflow. */ - workflow_name: string | null; - steps: { - completed_at: string | null; - /** @enum {string|null} */ - conclusion: "failure" | "skipped" | "success" | "cancelled" | null; - name: string; - number: number; - started_at: string | null; - /** @enum {string} */ - status: "completed" | "in_progress" | "queued" | "pending"; - }[]; - /** Format: uri */ - url: string; - }; - deployment?: components["schemas"]["deployment"]; - }; - /** workflow_job waiting event */ - "webhook-workflow-job-waiting": { - /** @enum {string} */ - action: "waiting"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - workflow_job: { - /** Format: uri */ - check_run_url: string; - completed_at: string | null; - conclusion: string | null; - /** @description The time that the job created. */ - created_at: string; - head_sha: string; - /** Format: uri */ - html_url: string; - id: number; - labels: string[]; - name: string; - node_id: string; - run_attempt: number; - run_id: number; - /** Format: uri */ - run_url: string; - runner_group_id: number | null; - runner_group_name: string | null; - runner_id: number | null; - runner_name: string | null; - /** Format: date-time */ - started_at: string; + /** @enum {string} */ + status: "queued" | "in_progress" | "completed" | "waiting"; /** @description The name of the current branch. */ head_branch: string | null; /** @description The name of the workflow. */ workflow_name: string | null; - /** @enum {string} */ - status: "queued" | "in_progress" | "completed" | "waiting"; steps: { completed_at: string | null; /** @enum {string|null} */ @@ -89371,40 +82373,78 @@ export interface components { number: number; started_at: string | null; /** @enum {string} */ - status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; + status: "completed" | "in_progress" | "queued" | "pending"; }[]; /** Format: uri */ url: string; }; deployment?: components["schemas"]["deployment"]; }; - /** workflow_run completed event */ - "webhook-workflow-run-completed": { + /** workflow_job waiting event */ + "webhook-workflow-job-waiting": { /** @enum {string} */ - action: "completed"; + action: "waiting"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - workflow: { + workflow_job: { /** Format: uri */ - badge_url: string; - /** Format: date-time */ + check_run_url: string; + completed_at: string | null; + conclusion: string | null; + /** @description The time that the job created. */ created_at: string; + head_sha: string; /** Format: uri */ html_url: string; id: number; + labels: string[]; name: string; node_id: string; - path: string; - state: string; + run_attempt: number; + run_id: number; + /** Format: uri */ + run_url: string; + runner_group_id: number | null; + runner_group_name: string | null; + runner_id: number | null; + runner_name: string | null; /** Format: date-time */ - updated_at: string; + started_at: string; + /** @description The name of the current branch. */ + head_branch: string | null; + /** @description The name of the workflow. */ + workflow_name: string | null; + /** @enum {string} */ + status: "queued" | "in_progress" | "completed" | "waiting"; + steps: { + completed_at: string | null; + /** @enum {string|null} */ + conclusion: "failure" | "skipped" | "success" | "cancelled" | null; + name: string; + number: number; + started_at: string | null; + /** @enum {string} */ + status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; + }[]; /** Format: uri */ url: string; - } | null; + }; + deployment?: components["schemas"]["deployment"]; + }; + /** workflow_run completed event */ + "webhook-workflow-run-completed": { + /** @enum {string} */ + action: "completed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + workflow: components["schemas"]["webhooks_workflow"]; + /** Workflow Run */ workflow_run: { /** User */ actor: { @@ -89452,7 +82492,7 @@ export interface components { /** Format: uri */ check_suite_url: string; /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; + conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; /** Format: date-time */ created_at: string; event: string; @@ -89629,7 +82669,7 @@ export interface components { path: string; /** Format: uri */ previous_attempt_url: string | null; - pull_requests: { + pull_requests: ({ base: { ref: string; /** Repo Ref */ @@ -89656,7 +82696,7 @@ export interface components { number: number; /** Format: uri */ url: string; - }[]; + } | null)[]; referenced_workflows?: { path: string; ref?: string; @@ -89840,229 +82880,8 @@ export interface components { workflow_id: number; /** Format: uri */ workflow_url: string; - } & { - actor?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - artifacts_url?: string; - cancel_url?: string; - check_suite_id?: number; - check_suite_node_id?: string; - check_suite_url?: string; - /** @enum {string} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped"; - created_at?: string; - event?: string; - head_branch?: string | null; - head_commit?: { - author?: { - email?: string; - name?: string; - }; - committer?: { - email?: string; - name?: string; - }; - id?: string; - message?: string; - timestamp?: string; - tree_id?: string; - }; - head_repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - head_sha?: string; - html_url?: string; - id?: number; - jobs_url?: string; - logs_url?: string; - name?: string | null; - node_id?: string; - path?: string; - previous_attempt_url?: string | null; - pull_requests?: (Record | null)[]; - referenced_workflows?: { - path: string; - ref?: string; - sha: string; - }[] | null; - repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - rerun_url?: string; - run_attempt?: number; - run_number?: number; - run_started_at?: string; - status?: string; - triggering_actor?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - } | null; - updated_at?: string; - url?: string; - workflow_id?: number; - workflow_url?: string; + /** @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. */ + display_title?: string; }; }; /** workflow_run in_progress event */ @@ -90074,24 +82893,8 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - workflow: { - /** Format: uri */ - badge_url: string; - /** Format: date-time */ - created_at: string; - /** Format: uri */ - html_url: string; - id: number; - name: string; - node_id: string; - path: string; - state: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - } | null; + workflow: components["schemas"]["webhooks_workflow"]; + /** Workflow Run */ workflow_run: { /** User */ actor: { @@ -90139,7 +82942,7 @@ export interface components { /** Format: uri */ check_suite_url: string; /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; + conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | null; /** Format: date-time */ created_at: string; event: string; @@ -90239,7 +83042,7 @@ export interface components { /** Format: uri-template */ milestones_url: string; /** @description The name of the repository. */ - name: string; + name: string | null; node_id: string; /** Format: uri-template */ notifications_url: string; @@ -90316,7 +83119,7 @@ export interface components { path: string; /** Format: uri */ previous_attempt_url: string | null; - pull_requests: { + pull_requests: ({ base: { ref: string; /** Repo Ref */ @@ -90343,7 +83146,7 @@ export interface components { number: number; /** Format: uri */ url: string; - }[]; + } | null)[]; referenced_workflows?: { path: string; ref?: string; @@ -90527,229 +83330,6 @@ export interface components { workflow_id: number; /** Format: uri */ workflow_url: string; - } & { - actor?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - artifacts_url?: string; - cancel_url?: string; - check_suite_id?: number; - check_suite_node_id?: string; - check_suite_url?: string; - /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "skipped" | "stale" | null; - created_at?: string; - event?: string; - head_branch?: string | null; - head_commit?: { - author?: { - email?: string; - name?: string; - }; - committer?: { - email?: string; - name?: string; - }; - id?: string; - message?: string; - timestamp?: string; - tree_id?: string; - }; - head_repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string | null; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - head_sha?: string; - html_url?: string; - id?: number; - jobs_url?: string; - logs_url?: string; - name?: string | null; - node_id?: string; - path?: string; - previous_attempt_url?: string | null; - pull_requests?: (Record | null)[]; - referenced_workflows?: { - path: string; - ref?: string; - sha: string; - }[] | null; - repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - rerun_url?: string; - run_attempt?: number; - run_number?: number; - run_started_at?: string; - status?: string; - triggering_actor?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - updated_at?: string; - url?: string; - workflow_id?: number; - workflow_url?: string; }; }; /** workflow_run requested event */ @@ -90761,24 +83341,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - workflow: { - /** Format: uri */ - badge_url: string; - /** Format: date-time */ - created_at: string; - /** Format: uri */ - html_url: string; - id: number; - name: string; - node_id: string; - path: string; - state: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - } | null; + workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { /** User */ @@ -91291,6 +83854,15 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Internal Error */ + internal_error: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Service unavailable */ service_unavailable: { headers: { @@ -91376,15 +83948,6 @@ export interface components { }; }; }; - /** @description Internal Error */ - internal_error: { - headers: { - [name: string]: unknown; - }; - 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: { headers: { @@ -91469,22 +84032,31 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Unacceptable */ + unacceptable: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; }; parameters: { - /** @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. */ + /** @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)." */ "pagination-before": string; - /** @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. */ + /** @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)." */ "pagination-after": string; /** @description The direction to sort the results by. */ direction: "asc" | "desc"; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: string; - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor: string; "delivery-id": number; - /** @description Page number of the results to fetch. */ + /** @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: number; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since: string; @@ -91575,7 +84147,7 @@ export interface components { "runner-label-name": string; /** @description The name of the secret. */ "secret-name": string; - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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)." */ "variables-per-page": number; /** @description The name of the variable. */ "variable-name": string; @@ -91686,7 +84258,7 @@ export interface components { "workflow-run-branch": string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event: string; - /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ + /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ "workflow-run-status": "completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting" | "pending"; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created: string; @@ -91733,12 +84305,17 @@ export interface components { "manifest-path": string; /** @description deployment_id parameter */ "deployment-id": number; - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ "environment-name": string; /** @description The unique identifier of the branch policy. */ "branch-policy-id": number; /** @description The unique identifier of the protection rule. */ "protection-rule-id": number; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + "git-ref-only": string; /** @description A user ID. Only return users with an ID greater than this ID. */ "since-user": number; /** @description The number that identifies the issue. */ @@ -91747,6 +84324,8 @@ export interface components { "key-id": number; /** @description The number that identifies the milestone. */ "milestone-number": number; + /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + "pages-deployment-id": number | string; /** @description The number that identifies the pull request. */ "pull-number": number; /** @description The unique identifier of the review. */ @@ -91833,7 +84412,7 @@ export interface operations { /** @description If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned. */ cve_id?: string; /** @description If specified, only advisories for these ecosystems will be returned. */ - ecosystem?: "actions" | "composer" | "erlang" | "go" | "maven" | "npm" | "nuget" | "other" | "pip" | "pub" | "rubygems" | "rust"; + ecosystem?: components["schemas"]["security-advisory-ecosystems"]; /** @description If specified, only advisories with these severities will be returned. */ severity?: "unknown" | "low" | "medium" | "high" | "critical"; /** @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. @@ -91859,13 +84438,13 @@ export interface operations { * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ modified?: string; - /** @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. */ + /** @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. */ + /** @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 The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 The property to sort the results by. */ sort?: "updated" | "published"; @@ -92023,7 +84602,7 @@ export interface operations { "apps/list-webhook-deliveries": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; @@ -92091,9 +84670,9 @@ export interface operations { "apps/list-installation-requests-for-authenticated-app": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92118,9 +84697,9 @@ export interface operations { "apps/list-installations": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -92486,9 +85065,9 @@ export interface operations { "classroom/list-accepted-assigments-for-an-assignment": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -92538,9 +85117,9 @@ export interface operations { "classroom/list-classrooms": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -92587,9 +85166,9 @@ export interface operations { "classroom/list-assignments-for-a-classroom": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -92680,6 +85259,42 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "copilot/usage-metrics-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; + }; + 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"]["copilot-usage-metrics"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "dependabot/list-alerts-for-enterprise": { parameters: { query?: { @@ -92705,9 +85320,9 @@ export interface operations { sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @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. */ + /** @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. */ + /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. @@ -92717,7 +85332,7 @@ export interface operations { * This parameter must not be used in combination with `first`. * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; header?: never; @@ -92759,11 +85374,11 @@ export interface operations { sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 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. */ + /** @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. */ + /** @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 validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; @@ -92794,9 +85409,9 @@ export interface operations { "activity/list-public-events": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92844,9 +85459,9 @@ export interface operations { query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92915,9 +85530,9 @@ export interface operations { query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92946,9 +85561,9 @@ export interface operations { query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93070,9 +85685,9 @@ export interface operations { "gists/list-comments": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93224,9 +85839,9 @@ export interface operations { "gists/list-commits": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93257,9 +85872,9 @@ export interface operations { "gists/list-forks": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93469,9 +86084,9 @@ export interface operations { "apps/list-repos-accessible-to-installation": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93536,9 +86151,9 @@ export interface operations { orgs?: boolean; owned?: boolean; pulls?: boolean; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93566,9 +86181,9 @@ export interface operations { parameters: { query?: { featured?: boolean; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93717,9 +86332,9 @@ export interface operations { "apps/list-plans": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93749,9 +86364,9 @@ export interface operations { sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93812,9 +86427,9 @@ export interface operations { "apps/list-plans-stubbed": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93843,9 +86458,9 @@ export interface operations { sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93894,9 +86509,9 @@ export interface operations { "activity/list-public-events-for-repo-network": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93936,9 +86551,9 @@ export interface operations { since?: components["parameters"]["since"]; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; - /** @description Page number of the results to fetch. */ + /** @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 50). */ + /** @description The number of results per page (max 50). 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; @@ -94033,6 +86648,27 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; + "activity/mark-thread-as-done": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ + thread_id: components["parameters"]["thread-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "activity/mark-thread-as-read": { parameters: { query?: never; @@ -94170,7 +86806,7 @@ export interface operations { query?: { /** @description An organization ID. Only return organizations with an ID greater than this ID. */ since?: components["parameters"]["since-org"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; header?: never; @@ -94259,7 +86895,7 @@ export interface operations { location?: string; /** @description The shorthand name of the company. */ name?: string; - /** @description The description of the company. */ + /** @description The description of the company. The maximum size is 160 characters. */ description?: string; /** @description Whether an organization can use organization projects. */ has_organization_projects?: boolean; @@ -94406,9 +87042,9 @@ export interface operations { "actions/get-actions-cache-usage-by-repo-for-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -94541,9 +87177,9 @@ export interface operations { "actions/list-selected-repositories-enabled-github-actions-organization": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -94744,9 +87380,9 @@ export interface operations { query?: { /** @description The name of a self-hosted runner. */ name?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95035,9 +87671,9 @@ export interface operations { "actions/list-org-secrets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95186,9 +87822,9 @@ export interface operations { "actions/list-selected-repos-for-org-secret": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -95311,9 +87947,9 @@ export interface operations { "actions/list-org-variables": { parameters: { query?: { - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ + /** @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; @@ -95469,9 +88105,9 @@ export interface operations { "actions/list-selected-repos-for-org-variable": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -95608,9 +88244,9 @@ export interface operations { "orgs/list-blocked-users": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95719,13 +88355,13 @@ export interface operations { tool_name?: components["parameters"]["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["parameters"]["tool-guid"]; - /** @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. */ + /** @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. */ + /** @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 Page number of the results to fetch. */ + /** @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). */ + /** @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 direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -95762,9 +88398,9 @@ export interface operations { "codespaces/list-in-organization": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95920,9 +88556,9 @@ export interface operations { "codespaces/list-org-secrets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96075,9 +88711,9 @@ export interface operations { "codespaces/list-selected-repos-for-org-secret": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -96234,15 +88870,22 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + /** @description There is a problem with your account's associated payment method. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; 500: components["responses"]["internal_error"]; }; }; "copilot/list-copilot-seats": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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; }; header?: never; @@ -96262,7 +88905,7 @@ export interface operations { }; content: { "application/json": { - /** @description Total number of Copilot For Business seats for the organization currently being billed. */ + /** @description Total number of Copilot seats for the organization currently being billed. */ total_seats?: number; seats?: components["schemas"]["copilot-seat-details"][]; }; @@ -96274,7 +88917,7 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - "copilot/add-copilot-for-business-seats-for-teams": { + "copilot/add-copilot-seats-for-teams": { parameters: { query?: never; header?: never; @@ -96307,7 +88950,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ 422: { headers: { [name: string]: unknown; @@ -96350,7 +88993,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ 422: { headers: { [name: string]: unknown; @@ -96360,7 +89003,7 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - "copilot/add-copilot-for-business-seats-for-users": { + "copilot/add-copilot-seats-for-users": { parameters: { query?: never; header?: never; @@ -96393,7 +89036,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ 422: { headers: { [name: string]: unknown; @@ -96436,7 +89079,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ 422: { headers: { [name: string]: unknown; @@ -96446,6 +89089,42 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "copilot/usage-metrics-for-org": { + 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 organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + 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"]; + }; + }; "dependabot/list-alerts-for-org": { parameters: { query?: { @@ -96471,9 +89150,9 @@ export interface operations { sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @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. */ + /** @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. */ + /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. @@ -96483,7 +89162,7 @@ export interface operations { * This parameter must not be used in combination with `first`. * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; header?: never; @@ -96514,9 +89193,9 @@ export interface operations { "dependabot/list-org-secrets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96665,9 +89344,9 @@ export interface operations { "dependabot/list-selected-repos-for-org-secret": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -96815,9 +89494,9 @@ export interface operations { "activity/list-public-org-events": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96843,9 +89522,9 @@ export interface operations { "orgs/list-failed-invitations": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96873,9 +89552,9 @@ export interface operations { "orgs/list-webhooks": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97119,7 +89798,7 @@ export interface operations { "orgs/list-webhook-deliveries": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; @@ -97247,9 +89926,9 @@ export interface operations { "orgs/list-app-installations": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97351,9 +90030,9 @@ export interface operations { "orgs/list-pending-invitations": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Filter invitations by their member role. */ role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager"; @@ -97404,10 +90083,11 @@ export interface operations { * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. * @default direct_member * @enum {string} */ - role: "admin" | "direct_member" | "billing_manager"; + role: "admin" | "direct_member" | "billing_manager" | "reinstate"; /** @description Specify IDs for the teams you want to invite new members to. */ team_ids?: number[]; }; @@ -97455,9 +90135,9 @@ export interface operations { "orgs/list-invitation-teams": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97499,9 +90179,9 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97533,9 +90213,9 @@ export interface operations { filter?: "2fa_disabled" | "all"; /** @description Filter members returned by their role. */ role?: "all" | "admin" | "member"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97626,9 +90306,9 @@ export interface operations { "codespaces/get-codespaces-for-user-in-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97743,7 +90423,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization or the user has a pending organization invitation. */ + /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */ 422: { headers: { [name: string]: unknown; @@ -97848,9 +90528,9 @@ export interface operations { "migrations/list-for-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Exclude attributes from the API response to improve performance */ exclude?: "repositories"[]; @@ -98054,9 +90734,9 @@ export interface operations { "migrations/list-repos-for-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98441,9 +91121,9 @@ export interface operations { "orgs/list-org-role-teams": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98486,9 +91166,9 @@ export interface operations { "orgs/list-org-role-users": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98533,9 +91213,9 @@ export interface operations { query?: { /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ filter?: "2fa_disabled" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98654,9 +91334,9 @@ export interface operations { * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; - /** @description Page number of the results to fetch. */ + /** @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?: number; - /** @description The number of results per page (max 100). */ + /** @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; }; header?: never; @@ -98771,9 +91451,9 @@ export interface operations { "packages/get-all-package-versions-for-package-owned-by-org": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 state of the package, either active or deleted. */ state?: "active" | "deleted"; @@ -98897,9 +91577,9 @@ export interface operations { "orgs/list-pat-grant-requests": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 property by which to sort the results. */ sort?: components["parameters"]["personal-access-token-sort"]; @@ -99010,9 +91690,9 @@ export interface operations { "orgs/list-pat-grant-request-repositories": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99044,9 +91724,9 @@ export interface operations { "orgs/list-pat-grants": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 property by which to sort the results. */ sort?: components["parameters"]["personal-access-token-sort"]; @@ -99153,9 +91833,9 @@ export interface operations { "orgs/list-pat-grant-repositories": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99189,9 +91869,9 @@ export interface operations { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99360,10 +92040,11 @@ export interface operations { /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ - default_value?: string | null; + default_value?: (null | unknown[]) & (string | string[]); /** @description Short description of the property */ description?: string | null; - /** @description Ordered list of allowed values of the property */ + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; }; }; @@ -99404,9 +92085,9 @@ export interface operations { "orgs/list-custom-properties-values-for-repos": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ repository_query?: string; @@ -99464,14 +92145,15 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; "orgs/list-public-members": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99581,9 +92263,9 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99753,7 +92435,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; 403: components["responses"]["forbidden"]; @@ -99763,9 +92445,9 @@ export interface operations { "repos/get-org-rulesets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99807,10 +92489,12 @@ export interface operations { /** @description The name of the ruleset. */ name: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag"; + target?: "branch" | "tag" | "push"; 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"][]; @@ -99847,9 +92531,9 @@ export interface operations { actor_name?: components["parameters"]["actor-name-in-query"]; /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ rule_suite_result?: components["parameters"]["rule-suite-result"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99950,10 +92634,12 @@ export interface operations { /** @description The name of the ruleset. */ name?: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag"; + target?: "branch" | "tag" | "push"; 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"][]; @@ -100017,9 +92703,9 @@ export interface operations { sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; @@ -100058,11 +92744,11 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: "created" | "updated" | "published"; - /** @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. */ + /** @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. */ + /** @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 The number of advisories to return per page. */ + /** @description The number of advisories to return per page. 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 Filter by the state of the repository advisories. Only advisories of this state will be returned. */ state?: "triage" | "draft" | "published" | "closed"; @@ -100234,12 +92920,50 @@ export interface operations { }; }; }; + "copilot/usage-metrics-for-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 organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @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"]; + }; + }; "teams/list": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100455,9 +93179,9 @@ export interface operations { query?: { /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Pinned discussions only filter */ pinned?: string; @@ -100617,9 +93341,9 @@ export interface operations { query?: { /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100778,9 +93502,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100892,9 +93616,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100998,9 +93722,9 @@ export interface operations { "teams/list-pending-invitations-in-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101031,9 +93755,9 @@ export interface operations { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101180,9 +93904,9 @@ export interface operations { "teams/list-projects-in-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101260,7 +93984,7 @@ export interface operations { content: { "application/json": { /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * @enum {string} */ permission?: "read" | "write" | "admin"; @@ -101317,9 +94041,9 @@ export interface operations { "teams/list-repos-in-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101455,9 +94179,9 @@ export interface operations { "teams/list-child-in-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101789,9 +94513,9 @@ export interface operations { query?: { /** @description Filters the project cards that are returned by the card's state. */ archived_state?: "all" | "archived" | "not_archived"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -102050,9 +94774,9 @@ export interface operations { query?: { /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ affiliation?: "outside" | "direct" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -102181,9 +94905,9 @@ export interface operations { "projects/list-columns": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -102520,9 +95244,9 @@ export interface operations { "actions/list-artifacts-for-repo": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; @@ -102661,9 +95385,9 @@ export interface operations { "actions/get-actions-cache-list": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["actions-cache-git-ref-full"]; @@ -102911,9 +95635,9 @@ export interface operations { "actions/list-repo-organization-secrets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -102945,9 +95669,9 @@ export interface operations { "actions/list-repo-organization-variables": { parameters: { query?: { - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ + /** @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; @@ -103199,9 +95923,9 @@ export interface operations { query?: { /** @description The name of a self-hosted runner. */ name?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -103520,11 +96244,11 @@ export interface operations { branch?: components["parameters"]["workflow-run-branch"]; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: components["parameters"]["event"]; - /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ + /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ status?: components["parameters"]["workflow-run-status"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: components["parameters"]["created"]; @@ -103675,9 +96399,9 @@ export interface operations { "actions/list-workflow-run-artifacts": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; @@ -103745,9 +96469,9 @@ export interface operations { "actions/list-jobs-for-workflow-run-attempt": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -103900,9 +96624,9 @@ export interface operations { query?: { /** @description Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run. */ filter?: "latest" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104159,9 +96883,9 @@ export interface operations { "actions/list-repo-secrets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104313,9 +97037,9 @@ export interface operations { "actions/list-repo-variables": { parameters: { query?: { - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ + /** @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; @@ -104467,9 +97191,9 @@ export interface operations { "actions/list-repo-workflows": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104620,11 +97344,11 @@ export interface operations { branch?: components["parameters"]["workflow-run-branch"]; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: components["parameters"]["event"]; - /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ + /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ status?: components["parameters"]["workflow-run-status"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: components["parameters"]["created"]; @@ -104695,11 +97419,11 @@ export interface operations { query?: { /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 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. */ + /** @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. */ + /** @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 The Git reference for the activities you want to list. * @@ -104743,9 +97467,9 @@ export interface operations { "issues/list-assignees": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104807,10 +97531,7 @@ export interface operations { }; "repos/list-autolinks": { parameters: { - query?: { - /** @description Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; path: { /** @description The account owner of the repository. The name is not case sensitive. */ @@ -105012,9 +97733,9 @@ export interface operations { query?: { /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -106269,11 +98990,11 @@ export interface operations { /** @description A reference for the run on the integrator's system. */ external_id?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @default queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. @@ -106420,10 +99141,10 @@ export interface operations { */ started_at?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. @@ -106512,9 +99233,9 @@ export interface operations { "checks/list-annotations": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -106705,9 +99426,9 @@ export interface operations { status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -106772,9 +99493,9 @@ export interface operations { tool_name?: components["parameters"]["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["parameters"]["tool-guid"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["git-ref"]; @@ -106885,9 +99606,9 @@ export interface operations { "code-scanning/list-alert-instances": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["git-ref"]; @@ -106926,9 +99647,9 @@ export interface operations { tool_name?: components["parameters"]["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["parameters"]["tool-guid"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["schemas"]["code-scanning-ref"]; @@ -107300,9 +100021,9 @@ export interface operations { "codespaces/list-in-repository-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107406,9 +100127,9 @@ export interface operations { "codespaces/list-devcontainers-in-repository-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107562,9 +100283,9 @@ export interface operations { "codespaces/list-repo-secrets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107720,9 +100441,9 @@ export interface operations { affiliation?: "outside" | "direct" | "all"; /** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */ permission?: "pull" | "triage" | "push" | "maintain" | "admin"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107888,9 +100609,9 @@ export interface operations { "repos/list-commit-comments-for-repo": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108010,9 +100731,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108130,9 +100851,9 @@ export interface operations { since?: components["parameters"]["since"]; /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ until?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108187,15 +100908,16 @@ export interface operations { "application/json": components["schemas"]["branch-short"][]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; "repos/list-comments-for-commit": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108270,9 +100992,9 @@ export interface operations { "repos/list-pull-requests-associated-with-commit": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108298,14 +101020,15 @@ export interface operations { "application/json": components["schemas"]["pull-request-simple"][]; }; }; + 409: components["responses"]["conflict"]; }; }; "repos/get-commit": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -108331,6 +101054,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; 503: components["responses"]["service_unavailable"]; @@ -108345,9 +101069,9 @@ export interface operations { status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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"]; app_id?: number; }; @@ -108389,9 +101113,9 @@ export interface operations { app_id?: number; /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108425,9 +101149,9 @@ export interface operations { "repos/get-combined-status-for-ref": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108458,9 +101182,9 @@ export interface operations { "repos/list-commit-statuses-for-ref": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108517,9 +101241,9 @@ export interface operations { "repos/compare-commits": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -108712,9 +101436,9 @@ export interface operations { query?: { /** @description Set to `1` or `true` to include anonymous contributors in results. */ anon?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108783,12 +101507,12 @@ export interface operations { page?: number; /** * @deprecated - * @description The number of results per page (max 100). + * @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. */ + /** @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. */ + /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. @@ -108915,9 +101639,9 @@ export interface operations { "dependabot/list-repo-secrets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109176,9 +101900,9 @@ export interface operations { task?: string; /** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */ environment?: string | null; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109345,9 +102069,9 @@ export interface operations { "repos/list-deployment-statuses": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109501,15 +102225,16 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; "repos/get-all-environments": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109547,7 +102272,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; cookie?: never; @@ -109574,7 +102299,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; cookie?: never; @@ -109624,7 +102349,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; cookie?: never; @@ -109643,9 +102368,9 @@ export interface operations { "repos/list-deployment-branch-policies": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109654,7 +102379,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; cookie?: never; @@ -109685,7 +102410,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; cookie?: never; @@ -109730,7 +102455,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; @@ -109759,7 +102484,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; @@ -109792,7 +102517,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; @@ -109815,7 +102540,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; @@ -109846,7 +102571,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; @@ -109878,14 +102603,14 @@ export interface operations { "repos/list-custom-deployment-rule-integrations": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; @@ -109920,7 +102645,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the protection rule. */ protection_rule_id: components["parameters"]["protection-rule-id"]; @@ -109945,7 +102670,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; @@ -109967,12 +102692,340 @@ export interface operations { }; }; }; + "actions/list-environment-secrets": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; + }; + }; + }; + }; + }; + "actions/get-environment-public-key": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + "actions/get-environment-secret": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-secret"]; + }; + }; + }; + }; + "actions/create-or-update-environment-secret": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + encrypted_value: string; + /** @description ID of the key you used to encrypt the secret. */ + key_id: string; + }; + }; + }; + responses: { + /** @description Response when creating a secret */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response when updating a secret */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/delete-environment-secret": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Default response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/list-environment-variables": { + parameters: { + query?: { + /** @description The number of results per page (max 30). 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"]["variables-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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; + }; + }; + }; + }; + }; + "actions/create-environment-variable": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name: string; + /** @description The value of the variable. */ + value: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + }; + }; + "actions/get-environment-variable": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + /** @description The name of the variable. */ + name: components["parameters"]["variable-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-variable"]; + }; + }; + }; + }; + "actions/delete-environment-variable": { + 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 name of the variable. */ + name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/update-environment-variable": { + 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 name of the variable. */ + name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name?: string; + /** @description The value of the variable. */ + value?: string; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "activity/list-repo-events": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -110002,9 +103055,9 @@ export interface operations { query?: { /** @description The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -110140,6 +103193,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -110206,6 +103260,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -110235,6 +103290,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; "git/list-matching-refs": { @@ -110246,8 +103302,11 @@ export interface operations { 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 commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - ref: components["parameters"]["commit-ref"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + ref: components["parameters"]["git-ref-only"]; }; cookie?: never; }; @@ -110263,6 +103322,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"][]; }; }; + 409: components["responses"]["conflict"]; }; }; "git/get-ref": { @@ -110274,8 +103334,11 @@ export interface operations { 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 commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - ref: components["parameters"]["commit-ref"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + ref: components["parameters"]["git-ref-only"]; }; cookie?: never; }; @@ -110291,6 +103354,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; "git/create-ref": { @@ -110327,6 +103391,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -110339,8 +103404,11 @@ export interface operations { 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 commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - ref: components["parameters"]["commit-ref"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + ref: components["parameters"]["git-ref-only"]; }; cookie?: never; }; @@ -110353,6 +103421,7 @@ export interface operations { }; content?: never; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -110366,10 +103435,10 @@ export interface operations { /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** - * @description The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. - * @example heads/featureA + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a */ - ref: string; + ref: components["parameters"]["git-ref-only"]; }; cookie?: never; }; @@ -110396,6 +103465,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -110452,6 +103522,7 @@ export interface operations { "application/json": components["schemas"]["git-tag"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -110480,6 +103551,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; "git/create-tree": { @@ -110541,6 +103613,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -110573,15 +103646,16 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; "repos/list-webhooks": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -110631,8 +103705,6 @@ export interface operations { content_type?: components["schemas"]["webhook-config-content-type"]; secret?: components["schemas"]["webhook-config-secret"]; insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - token?: string; - digest?: string; }; /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. @@ -110737,15 +103809,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Key/value pairs to provide settings for this webhook. */ - config?: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - address?: string; - room?: string; - }; + config?: components["schemas"]["webhook-config"]; /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ @@ -110845,7 +103909,7 @@ export interface operations { "repos/list-webhook-deliveries": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; @@ -111374,9 +104438,9 @@ export interface operations { "repos/list-invitations": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111485,9 +104549,9 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111579,9 +104643,9 @@ export interface operations { direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111702,9 +104766,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111810,9 +104874,9 @@ export interface operations { "issues/list-events-for-repo": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112071,9 +105135,9 @@ export interface operations { query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112146,9 +105210,9 @@ export interface operations { "issues/list-events": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112180,9 +105244,9 @@ export interface operations { "issues/list-labels-on-issue": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112435,9 +105499,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112544,9 +105608,9 @@ export interface operations { "issues/list-events-for-timeline": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112579,9 +105643,9 @@ export interface operations { "repos/list-deploy-keys": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112704,9 +105768,9 @@ export interface operations { "issues/list-labels-for-repo": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112888,7 +105952,10 @@ export interface operations { }; "licenses/get-for-repo": { parameters: { - query?: never; + query?: { + /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ + ref?: components["parameters"]["git-ref"]; + }; header?: never; path: { /** @description The account owner of the repository. The name is not case sensitive. */ @@ -113026,9 +106093,9 @@ export interface operations { sort?: "due_on" | "completeness"; /** @description The direction of the sort. Either `asc` or `desc`. */ direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113208,9 +106275,9 @@ export interface operations { "issues/list-labels-for-milestone": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113249,9 +106316,234 @@ export interface operations { since?: components["parameters"]["since"]; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; - /** @description The number of results per page (max 100). */ + /** @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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["thread"][]; + }; + }; + }; + }; + "activity/mark-repo-notifications-as-read": { + 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?: { + content: { + "application/json": { + /** + * Format: date-time + * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + last_read_at?: string; + }; + }; + }; + responses: { + /** @description Response */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + message?: string; + url?: string; + }; + }; + }; + /** @description Reset Content */ + 205: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "repos/get-pages": { + 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"]["page"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "repos/update-information-about-pages-site": { + 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: { + content: { + "application/json": { + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ + cname?: string | null; + /** @description Specify whether HTTPS should be enforced for the repository. */ + https_enforced?: boolean; + /** + * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + source?: ("gh-pages" | "master" | "master /docs") | { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. + * @enum {string} + */ + path: "/" | "/docs"; + }; + } | unknown | unknown | unknown | unknown | unknown; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/create-pages-site": { + 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: { + content: { + "application/json": (({ + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path: "/" | "/docs"; + }; + } | unknown | unknown) | null) | unknown | unknown; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["page"]; + }; + }; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/delete-pages-site": { + 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 */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/list-pages-builds": { + 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 Page number of the results to fetch. */ + /** @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; @@ -113272,12 +106564,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["thread"][]; + "application/json": components["schemas"]["page-build"][]; }; }; }; }; - "activity/mark-repo-notifications-as-read": { + "repos/request-pages-build": { parameters: { query?: never; header?: never; @@ -113289,40 +106581,20 @@ export interface operations { }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** - * Format: date-time - * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. - */ - last_read_at?: string; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ - 202: { + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": { - message?: string; - url?: string; - }; - }; - }; - /** @description Reset Content */ - 205: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["page-build-status"]; }; - content?: never; }; }; }; - "repos/get-pages": { + "repos/get-latest-pages-build": { parameters: { query?: never; header?: never; @@ -113342,13 +106614,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["page"]; + "application/json": components["schemas"]["page-build"]; }; }; - 404: components["responses"]["not_found"]; }; }; - "repos/update-information-about-pages-site": { + "repos/get-pages-build": { parameters: { query?: never; header?: never; @@ -113357,47 +106628,24 @@ export interface operations { owner: components["parameters"]["owner"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + build_id: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ - cname?: string | null; - /** @description Specify whether HTTPS should be enforced for the repository. */ - https_enforced?: boolean; - /** - * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - source?: ("gh-pages" | "master" | "master /docs") | { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. - * @enum {string} - */ - path: "/" | "/docs"; - }; - } | unknown | unknown | unknown | unknown | unknown; - }; - }; + requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["page-build"]; + }; }; - 400: components["responses"]["bad_request"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; }; }; - "repos/create-pages-site": { + "repos/create-pages-deployment": { parameters: { query?: never; header?: never; @@ -113411,80 +106659,52 @@ export interface operations { }; requestBody: { content: { - "application/json": (({ + "application/json": { + /** @description The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */ + artifact_id?: number; + /** @description The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */ + artifact_url?: string; /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} + * @description The target environment for this GitHub Pages deployment. + * @default github-pages */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path: "/" | "/docs"; - }; - } | unknown | unknown) | null) | unknown | unknown; + environment: string; + /** + * @description A unique string that represents the version of the build for this deployment. + * @default GITHUB_SHA + */ + pages_build_version: string; + /** @description The OIDC token issued by GitHub Actions certifying the origin of the deployment. */ + oidc_token: string; + }; }; }; responses: { /** @description Response */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["page"]; - }; - }; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/delete-pages-site": { - 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 */ - 204: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["page-deployment"]; }; - content?: never; }; + 400: components["responses"]["bad_request"]; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - "repos/list-pages-builds": { + "repos/get-pages-deployment": { parameters: { - query?: { - /** @description The number of results per page (max 100). */ - per_page?: components["parameters"]["per-page"]; - /** @description Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; + 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 ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; cookie?: never; }; @@ -113493,16 +106713,16 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["page-build"][]; + "application/json": components["schemas"]["pages-deployment-status"]; }; }; + 404: components["responses"]["not_found"]; }; }; - "repos/request-pages-build": { + "repos/cancel-pages-deployment": { parameters: { query?: never; header?: never; @@ -113511,23 +106731,18 @@ export interface operations { 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 ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["page-build-status"]; - }; - }; + 204: components["responses"]["no_content"]; + 404: components["responses"]["not_found"]; }; }; - "repos/get-latest-pages-build": { + "repos/get-pages-health-check": { parameters: { query?: never; header?: never; @@ -113547,85 +106762,36 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["page-build"]; + "application/json": components["schemas"]["pages-health-check"]; }; }; - }; - }; - "repos/get-pages-build": { - 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"]; - build_id: number; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { + /** @description Empty response */ + 202: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["page-build"]; + "application/json": components["schemas"]["empty-object"]; }; }; - }; - }; - "repos/create-pages-deployment": { - 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: { - content: { - "application/json": { - /** @description The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. */ - artifact_url: string; - /** - * @description The target environment for this GitHub Pages deployment. - * @default github-pages - */ - environment: string; - /** - * @description A unique string that represents the version of the build for this deployment. - * @default GITHUB_SHA - */ - pages_build_version: string; - /** @description The OIDC token issued by GitHub Actions certifying the origin of the deployment. */ - oidc_token: string; + /** @description Custom domains are not available for GitHub Pages */ + 400: { + headers: { + [name: string]: unknown; }; + content?: never; }; - }; - responses: { - /** @description Response */ - 200: { + 404: components["responses"]["not_found"]; + /** @description There isn't a CNAME for this page */ + 422: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["page-deployment"]; - }; + content?: never; }; - 400: components["responses"]["bad_request"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "repos/get-pages-health-check": { + "repos/check-private-vulnerability-reporting": { parameters: { query?: never; header?: never; @@ -113639,39 +106805,19 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response */ + /** @description Private vulnerability reporting status */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["pages-health-check"]; - }; - }; - /** @description Empty response */ - 202: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Custom domains are not available for GitHub Pages */ - 400: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 404: components["responses"]["not_found"]; - /** @description There isn't a CNAME for this page */ - 422: { - headers: { - [name: string]: unknown; + "application/json": { + /** @description Whether or not private vulnerability reporting is enabled for the repository. */ + enabled: boolean; + }; }; - content?: never; }; + 422: components["responses"]["bad_request"]; }; }; "repos/enable-private-vulnerability-reporting": { @@ -113715,9 +106861,9 @@ export interface operations { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113814,6 +106960,39 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "repos/create-or-update-custom-properties-values": { + 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: { + content: { + "application/json": { + /** @description A list of custom property names and associated values to apply to the repositories. */ + properties: components["schemas"]["custom-property-value"][]; + }; + }; + }; + responses: { + /** @description No Content when custom property values are successfully created or updated */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "pulls/list": { parameters: { query?: { @@ -113827,9 +107006,9 @@ export interface operations { sort?: "created" | "updated" | "popularity" | "long-running"; /** @description The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113921,9 +107100,9 @@ export interface operations { direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114042,9 +107221,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114174,6 +107353,7 @@ export interface operations { }; 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; + 406: components["responses"]["unacceptable"]; 500: components["responses"]["internal_error"]; 503: components["responses"]["service_unavailable"]; }; @@ -114302,9 +107482,9 @@ export interface operations { direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114357,7 +107537,7 @@ export interface operations { path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. + * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ position?: number; /** @@ -114442,9 +107622,9 @@ export interface operations { "pulls/list-commits": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114475,9 +107655,9 @@ export interface operations { "pulls/list-files": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114722,9 +107902,9 @@ export interface operations { "pulls/list-reviews": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114782,7 +107962,7 @@ export interface operations { comments?: { /** @description The relative path to the file that necessitates a review comment. */ path: string; - /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below. */ + /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ position?: number; /** @description Text of the review comment. */ body: string; @@ -114909,9 +108089,9 @@ export interface operations { "pulls/list-comments-for-review": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115130,9 +108310,9 @@ export interface operations { "repos/list-releases": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115431,7 +108611,7 @@ export interface operations { }; requestBody?: never; responses: { - /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ + /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ 200: { headers: { [name: string]: unknown; @@ -115538,9 +108718,9 @@ export interface operations { "repos/list-release-assets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115614,9 +108794,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115722,9 +108902,9 @@ export interface operations { "repos/get-branch-rules": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115754,9 +108934,9 @@ export interface operations { "repos/get-repo-rulesets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; @@ -115804,10 +108984,12 @@ export interface operations { /** @description The name of the ruleset. */ name: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag"; + target?: "branch" | "tag" | "push"; 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"][]; @@ -115844,9 +109026,9 @@ export interface operations { actor_name?: components["parameters"]["actor-name-in-query"]; /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ rule_suite_result?: components["parameters"]["rule-suite-result"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115958,10 +109140,12 @@ export interface operations { /** @description The name of the ruleset. */ name?: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag"; + target?: "branch" | "tag" | "push"; 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"][]; @@ -116027,9 +109211,9 @@ export interface operations { sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; @@ -116164,9 +109348,9 @@ export interface operations { "secret-scanning/list-locations-for-alert": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -116209,11 +109393,11 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: "created" | "updated" | "published"; - /** @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. */ + /** @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. */ + /** @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 Number of advisories to return per page. */ + /** @description The number of advisories to return per page. 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 Filter by state of the repository advisories. Only advisories of this state will be returned. */ state?: "triage" | "draft" | "published" | "closed"; @@ -116400,12 +109584,43 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; + "security-advisories/create-fork": { + 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 GHSA (GitHub Security Advisory) identifier of the advisory. */ + ghsa_id: components["parameters"]["ghsa_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["full-repository"]; + }; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "activity/list-stargazers-for-repo": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116457,6 +109672,13 @@ export interface operations { }; 202: components["responses"]["accepted"]; 204: components["responses"]["no_content"]; + /** @description Repository contains more than 10,000 commits */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; "repos/get-commit-activity-stats": { @@ -116617,9 +109839,9 @@ export interface operations { "activity/list-watchers-for-repo": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116738,9 +109960,9 @@ export interface operations { "repos/list-tags": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116883,9 +110105,9 @@ export interface operations { "repos/list-teams": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116915,9 +110137,9 @@ export interface operations { "repos/get-all-topics": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -117268,7 +110490,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; }; @@ -117300,314 +110522,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - "actions/list-environment-secrets": { - parameters: { - query?: { - /** @description The number of results per page (max 100). */ - per_page?: components["parameters"]["per-page"]; - /** @description Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; - "actions/get-environment-public-key": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; - "actions/get-environment-secret": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; - "actions/create-or-update-environment-secret": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ - encrypted_value: string; - /** @description ID of the key you used to encrypt the secret. */ - key_id: string; - }; - }; - }; - responses: { - /** @description Response when creating a secret */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Response when updating a secret */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "actions/delete-environment-secret": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Default response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "actions/list-environment-variables": { - parameters: { - query?: { - /** @description The number of results per page (max 30). */ - per_page?: components["parameters"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": { - total_count: number; - variables: components["schemas"]["actions-variable"][]; - }; - }; - }; - }; - }; - "actions/create-environment-variable": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name: string; - /** @description The value of the variable. */ - value: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - }; - }; - "actions/get-environment-variable": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - /** @description The name of the variable. */ - name: components["parameters"]["variable-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["actions-variable"]; - }; - }; - }; - }; - "actions/delete-environment-variable": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the variable. */ - name: components["parameters"]["variable-name"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "actions/update-environment-variable": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the variable. */ - name: components["parameters"]["variable-name"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name?: string; - /** @description The value of the variable. */ - value?: string; - }; - }; - }; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; "search/code": { parameters: { query: { @@ -117623,9 +110537,9 @@ export interface operations { * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117662,9 +110576,9 @@ export interface operations { sort?: "author-date" | "committer-date"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117698,9 +110612,9 @@ export interface operations { sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117739,9 +110653,9 @@ export interface operations { sort?: "created" | "updated"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117778,9 +110692,9 @@ export interface operations { sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117812,9 +110726,9 @@ export interface operations { query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */ q: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117848,9 +110762,9 @@ export interface operations { sort?: "followers" | "repositories" | "joined"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117998,9 +110912,9 @@ export interface operations { query?: { /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118148,9 +111062,9 @@ export interface operations { query?: { /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118299,9 +111213,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118371,9 +111285,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118437,9 +111351,9 @@ export interface operations { "teams/list-pending-invitations-legacy": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118468,9 +111382,9 @@ export interface operations { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118703,9 +111617,9 @@ export interface operations { "teams/list-projects-legacy": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118778,7 +111692,7 @@ export interface operations { content: { "application/json": { /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * @enum {string} */ permission?: "read" | "write" | "admin"; @@ -118837,9 +111751,9 @@ export interface operations { "teams/list-repos-legacy": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118970,9 +111884,9 @@ export interface operations { "teams/list-child-legacy": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119071,9 +111985,9 @@ export interface operations { "users/list-blocked-by-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119184,9 +112098,9 @@ export interface operations { "codespaces/list-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 ID of the Repository to filter on */ repository_id?: components["parameters"]["repository-id-in-query"]; @@ -119307,9 +112221,9 @@ export interface operations { "codespaces/list-secrets-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119887,9 +112801,9 @@ export interface operations { "users/list-emails-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119979,9 +112893,9 @@ export interface operations { "users/list-followers-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120008,9 +112922,9 @@ export interface operations { "users/list-followed-by-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120120,9 +113034,9 @@ export interface operations { "users/list-gpg-keys-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120237,9 +113151,9 @@ export interface operations { "apps/list-installations-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120269,9 +113183,9 @@ export interface operations { "apps/list-installation-repos-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120446,9 +113360,9 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120474,9 +113388,9 @@ export interface operations { "users/list-public-ssh-keys-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120590,9 +113504,9 @@ export interface operations { "apps/list-subscriptions-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120619,9 +113533,9 @@ export interface operations { "apps/list-subscriptions-for-authenticated-user-stubbed": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120649,9 +113563,9 @@ export interface operations { query?: { /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120740,9 +113654,9 @@ export interface operations { "migrations/list-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120923,9 +113837,9 @@ export interface operations { "migrations/list-repos-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120953,9 +113867,9 @@ export interface operations { "orgs/list-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120989,9 +113903,9 @@ export interface operations { * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -121095,9 +114009,9 @@ export interface operations { "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 state of the package, either active or deleted. */ state?: "active" | "deleted"; @@ -121246,9 +114160,9 @@ export interface operations { "users/list-public-emails-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121289,9 +114203,9 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since-repo-date"]; @@ -121452,7 +114366,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; 304: components["responses"]["not_modified"]; @@ -121466,9 +114380,9 @@ export interface operations { "repos/list-invitations-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121546,9 +114460,9 @@ export interface operations { "users/list-social-accounts-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121638,9 +114552,9 @@ export interface operations { "users/list-ssh-signing-keys-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121758,9 +114672,9 @@ export interface operations { sort?: components["parameters"]["sort-starred"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121877,9 +114791,9 @@ export interface operations { "activity/list-watched-repos-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121906,9 +114820,9 @@ export interface operations { "teams/list-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121937,7 +114851,7 @@ export interface operations { query?: { /** @description A user ID. Only return users with an ID greater than this ID. */ since?: components["parameters"]["since-user"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; header?: never; @@ -122012,9 +114926,9 @@ export interface operations { "activity/list-events-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122040,9 +114954,9 @@ export interface operations { "activity/list-org-events-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122070,9 +114984,9 @@ export interface operations { "activity/list-public-events-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122098,9 +115012,9 @@ export interface operations { "users/list-followers-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122127,9 +115041,9 @@ export interface operations { "users/list-following-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122187,9 +115101,9 @@ export interface operations { query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122217,9 +115131,9 @@ export interface operations { "users/list-gpg-keys-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122299,9 +115213,9 @@ export interface operations { "users/list-public-keys-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122328,9 +115242,9 @@ export interface operations { "orgs/list-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122364,9 +115278,9 @@ export interface operations { * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -122602,9 +115516,9 @@ export interface operations { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122632,9 +115546,9 @@ export interface operations { "activity/list-received-events-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122660,9 +115574,9 @@ export interface operations { "activity/list-received-public-events-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122694,9 +115608,9 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122792,9 +115706,9 @@ export interface operations { "users/list-social-accounts-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122821,9 +115735,9 @@ export interface operations { "users/list-ssh-signing-keys-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122854,9 +115768,9 @@ export interface operations { sort?: components["parameters"]["sort-starred"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122883,9 +115797,9 @@ export interface operations { "activity/list-repos-watched-by-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -130911,6 +123825,43 @@ export interface operations { }; }; }; + "secret-scanning-alert/validated": { + 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-alert-validated"]; + }; + }; + 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 97b7cdfc0..34704a884 100644 --- a/packages/openapi-typescript/examples/github-api-next.yaml +++ b/packages/openapi-typescript/examples/github-api-next.yaml @@ -160,20 +160,7 @@ paths: in: query description: If specified, only advisories for these ecosystems will be returned. schema: - type: string - enum: - - actions - - composer - - erlang - - go - - maven - - npm - - nuget - - other - - pip - - pub - - rubygems - - rust + "$ref": "#/components/schemas/security-advisory-ecosystems" - name: severity in: query description: If specified, only advisories with these severities will be returned. @@ -244,7 +231,8 @@ paths: - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/direction" - name: per_page - description: The number of results per page (max 100). + 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 schema: type: integer @@ -621,9 +609,9 @@ paths: get: summary: List installations for the authenticated app description: |- - 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. - The permissions the installation has are included under the `permissions` key. + + 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 operationId: apps/list-installations @@ -720,7 +708,13 @@ paths: post: summary: Create an installation access token for an app description: |- - Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. + Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. + + Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. + + 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: @@ -759,7 +753,8 @@ paths: examples: default: value: - repository: Hello-World + repositories: + - Hello-World permissions: issues: write contents: read @@ -1022,13 +1017,16 @@ paths: "/applications/{client_id}/token/scoped": post: summary: Create a scoped access token - description: Use a non-scoped user access token to create a repository scoped - and/or permission scoped user access token. You can specify which repositories - the token can access and which permissions are granted to the token. You must - use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) - when accessing this endpoint, using the `client_id` and `client_secret` of - the GitHub App as the username and password. Invalid tokens will return `404 - NOT FOUND`. + description: |- + Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify + which repositories the token can access and which permissions are granted to the + token. + + Invalid tokens will return `404 NOT FOUND`. + + You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) + when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + as the username and password. tags: - apps operationId: apps/scope-token @@ -1119,10 +1117,9 @@ paths: "/apps/{app_slug}": get: summary: Get an app - description: |- - **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - - If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + description: "**Note**: The `:app_slug` is just the URL-friendly name of your + GitHub App. You can find this on the settings page for your GitHub App (e.g., + `https://github.com/settings/apps/:app_slug`)." tags: - apps operationId: apps/get-by-slug @@ -1432,14 +1429,92 @@ paths: enabledForGitHubApps: true category: emojis subcategory: emojis + "/enterprises/{enterprise}/copilot/usage": + get: + summary: Get a summary of Copilot usage for enterprise members + description: |- + **Note**: This endpoint is in beta 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 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 response contains metrics for the prior 28 days. 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. + + Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage + metrics for the enterprise. + + OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + tags: + - copilot + operationId: copilot/usage-metrics-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members + 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 + 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-enterprise" + '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 "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise description: |- Lists Dependabot alerts for repositories that are owned by the specified enterprise. - To use this endpoint, you must be a member of the enterprise, and you must use an - access token with the `repo` scope or `security_events` scope. + + The authenticated user must be a member of the enterprise to use this endpoint. + 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 the `repo` or `security_events` scope to use this endpoint. tags: - dependabot operationId: dependabot/list-alerts-for-enterprise @@ -1491,7 +1566,12 @@ paths: summary: List secret scanning alerts for an enterprise description: |- Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are 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). + + 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). + + 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 the `repo` scope or `security_events` scope to use this endpoint. tags: - secret-scanning operationId: secret-scanning/list-alerts-for-enterprise @@ -1575,16 +1655,18 @@ paths: get: summary: Get feeds description: |- - GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: + Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * **Timeline**: The GitHub global public timeline - * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) + * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * **Current user public**: The public timeline for the authenticated user * **Current user**: The private timeline for the authenticated user * **Current user actor**: The private timeline for activity created by the authenticated user * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. + By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. tags: - activity @@ -1826,7 +1908,13 @@ paths: "/gists/{gist_id}": get: summary: Get a gist - description: '' + description: |- + Gets a specified gist. + + 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. This is the default if you do not pass any specific media type. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/get @@ -1859,8 +1947,16 @@ paths: patch: summary: Update a gist description: |- - Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. + Allows you to update a gist's description and to update, delete, or rename gist files. Files + from the previous version of the gist that aren't explicitly changed during an edit + are unchanged. + At least one of `description` or `files` is required. + + 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. This is the default if you do not pass any specific media type. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/update @@ -1978,7 +2074,13 @@ paths: "/gists/{gist_id}/comments": get: summary: List gist comments - description: '' + description: |- + Lists the comments on a gist. + + 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. This is the default if you do not pass any specific media type. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/list-comments @@ -2017,7 +2119,13 @@ paths: subcategory: comments post: summary: Create a gist comment - description: '' + description: |- + Creates a comment on a gist. + + 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. This is the default if you do not pass any specific media type. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/create-comment @@ -2075,7 +2183,13 @@ paths: "/gists/{gist_id}/comments/{comment_id}": get: summary: Get a gist comment - description: '' + description: |- + Gets a comment on a gist. + + 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. This is the default if you do not pass any specific media type. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/get-comment @@ -2108,7 +2222,13 @@ paths: subcategory: comments patch: summary: Update a gist comment - description: '' + description: |- + Updates a comment on a gist. + + 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. This is the default if you do not pass any specific media type. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/update-comment @@ -2337,7 +2457,7 @@ paths: put: summary: Star a gist description: Note that you'll need to set `Content-Length` to zero when calling - out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - gists operationId: gists/star @@ -2388,7 +2508,13 @@ paths: "/gists/{gist_id}/{sha}": get: summary: Get a gist revision - description: '' + description: |- + Gets a specified gist revision. + + 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. This is the default if you do not pass any specific media type. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/get-revision @@ -2465,8 +2591,11 @@ paths: get: summary: Get a gitignore template description: |- - The API also allows fetching the source of a single template. - Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. + Get the content of a gitignore template. + + 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 .gitignore contents. operationId: gitignore/get-template tags: - gitignore @@ -2499,10 +2628,7 @@ paths: "/installation/repositories": get: summary: List repositories accessible to the app installation - description: |- - List repositories that an app installation can access. - - You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + description: List repositories that an app installation can access. tags: - apps operationId: apps/list-repos-accessible-to-installation @@ -2557,8 +2683,6 @@ paths: Revokes the installation token you're using to authenticate as an installation and access this endpoint. Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. - - You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. tags: - apps operationId: apps/revoke-installation-access-token @@ -2582,11 +2706,17 @@ paths: repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not necessarily assigned to you. - **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + 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 @@ -3232,7 +3362,8 @@ paths: - "$ref": "#/components/parameters/before" - "$ref": "#/components/parameters/page" - name: per_page - description: The number of results per page (max 50). + description: The number of results per page (max 50). 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 @@ -3386,6 +3517,26 @@ paths: enabledForGitHubApps: false category: activity subcategory: notifications + delete: + summary: Mark a thread as done + description: 'Marks a thread as "done." Marking a thread as "done" is equivalent + to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.' + tags: + - activity + operationId: activity/mark-thread-as-done + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done + parameters: + - "$ref": "#/components/parameters/thread-id" + responses: + '204': + description: No content + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications "/notifications/threads/{thread_id}/subscription": get: summary: Get a thread subscription for the authenticated user @@ -3539,7 +3690,7 @@ paths: get: summary: List organizations description: |- - Lists all organizations, in the order that they were created on GitHub. + Lists all organizations, in the order that they were created. **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. tags: @@ -3579,9 +3730,26 @@ paths: get: summary: Get an organization description: |- - To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + Gets information about an organization. + + When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + + To see the full details about an organization, the authenticated user must be an organization owner. + + The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + - advanced_security_enabled_for_new_repositories + - dependabot_alerts_enabled_for_new_repositories + - dependabot_security_updates_enabled_for_new_repositories + - dependency_graph_enabled_for_new_repositories + - secret_scanning_enabled_for_new_repositories + - secret_scanning_push_protection_enabled_for_new_repositories + + For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + + To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. tags: - orgs operationId: orgs/get @@ -3612,7 +3780,22 @@ paths: description: |- **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. + Updates the organization's profile and member privileges. + + With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + + - advanced_security_enabled_for_new_repositories + - dependabot_alerts_enabled_for_new_repositories + - dependabot_security_updates_enabled_for_new_repositories + - dependency_graph_enabled_for_new_repositories + - secret_scanning_enabled_for_new_repositories + - secret_scanning_push_protection_enabled_for_new_repositories + + For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. tags: - orgs operationId: orgs/update @@ -3648,7 +3831,8 @@ paths: description: The shorthand name of the company. description: type: string - description: The description of the company. + description: The description of the company. The maximum size is + 160 characters. has_organization_projects: type: boolean description: Whether an organization can use organization projects. @@ -3870,7 +4054,8 @@ paths: description: |- Gets the total GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - actions operationId: actions/get-actions-cache-usage-for-org @@ -3903,7 +4088,8 @@ paths: description: |- Lists repositories and their GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - actions operationId: actions/get-actions-cache-usage-by-repo-for-org @@ -3947,8 +4133,8 @@ paths: summary: Get the customization template for an OIDC subject claim for an organization description: |- Gets the customization template for an OpenID Connect (OIDC) subject claim. - You must authenticate using an access token with the `read:org` scope to use this endpoint. - GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - oidc operationId: oidc/get-oidc-custom-sub-template-for-org @@ -3975,8 +4161,8 @@ paths: summary: Set the customization template for an OIDC subject claim for an organization description: |- Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - You must authenticate using an access token with the `write:org` scope to use this endpoint. - GitHub Apps must have the `admin:org` permission to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - oidc operationId: oidc/update-oidc-custom-sub-template-for-org @@ -4019,7 +4205,7 @@ paths: description: |- Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/get-github-actions-permissions-organization tags: - actions @@ -4048,7 +4234,7 @@ paths: description: |- Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/set-github-actions-permissions-organization tags: - actions @@ -4089,7 +4275,7 @@ paths: description: |- Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/list-selected-repositories-enabled-github-actions-organization tags: - actions @@ -4130,7 +4316,8 @@ paths: description: |- Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/set-selected-repositories-enabled-github-actions-organization tags: - actions @@ -4174,7 +4361,7 @@ paths: description: |- Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/enable-selected-repository-github-actions-organization tags: - actions @@ -4197,7 +4384,7 @@ paths: description: |- Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/disable-selected-repository-github-actions-organization tags: - actions @@ -4219,9 +4406,9 @@ paths: get: summary: Get allowed actions and reusable workflows for an organization description: |- - Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/get-allowed-actions-organization tags: - actions @@ -4250,7 +4437,7 @@ paths: description: |- Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/set-allowed-actions-organization tags: - actions @@ -4284,7 +4471,7 @@ paths: as well as whether GitHub Actions can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - actions operationId: actions/get-github-actions-default-workflow-permissions-organization @@ -4315,7 +4502,7 @@ paths: can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - actions operationId: actions/set-github-actions-default-workflow-permissions-organization @@ -4347,10 +4534,9 @@ paths: description: |- Lists all self-hosted runners configured in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-self-hosted-runners-for-org @@ -4400,10 +4586,9 @@ paths: description: |- Lists binaries for the runner application that you can download and run. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-runner-applications-for-org @@ -4435,10 +4620,9 @@ paths: description: |- Generates a configuration that can be passed to the runner application at startup. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + The authenticated user must have admin access to the organization. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/generate-runner-jitconfig-for-org @@ -4503,17 +4687,18 @@ paths: "/orgs/{org}/actions/runners/registration-token": post: summary: Create a registration token for an organization - description: "Returns a token that you can pass to the `config` script. The - token expires after one hour.\n\nYou must authenticate using an access token - with the `admin:org` scope to use this endpoint.\nIf the repository is private, - you must use an access token with the `repo` scope.\nGitHub Apps must have - the `administration` permission for repositories and the `organization_self_hosted_runners` - permission for organizations.\nAuthenticated users must have admin access - to repositories or organizations, or the `manage_runners:enterprise` scope - for enterprises, to use these endpoints.\n\nExample using registration token: - \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration - token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/octo-org - --token TOKEN\n```" + description: |- + Returns a token that you can pass to the `config` script. The token expires after one hour. + + For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: + + ``` + ./config.sh --url https://github.com/octo-org --token TOKEN + ``` + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-registration-token-for-org @@ -4543,19 +4728,15 @@ paths: description: |- Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - - Example using remove token: - - To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this - endpoint. + For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: ``` ./config.sh remove --token TOKEN ``` + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-remove-token-for-org @@ -4585,10 +4766,9 @@ paths: description: |- Gets a specific self-hosted runner configured in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/get-self-hosted-runner-for-org @@ -4618,10 +4798,9 @@ paths: description: |- Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-self-hosted-runner-from-org @@ -4645,10 +4824,9 @@ paths: description: |- Lists all labels for a self-hosted runner configured in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-labels-for-self-hosted-runner-for-org @@ -4671,12 +4849,11 @@ paths: post: summary: Add custom labels to a self-hosted runner for an organization description: |- - Add custom labels to a self-hosted runner configured in an organization. + Adds custom labels to a self-hosted runner configured in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - actions operationId: actions/add-custom-labels-to-self-hosted-runner-for-org @@ -4726,10 +4903,9 @@ paths: Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/set-custom-labels-for-self-hosted-runner-for-org @@ -4780,10 +4956,9 @@ paths: Remove all custom labels from a self-hosted runner configured in an organization. Returns the remaining read-only labels from the runner. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-org @@ -4813,10 +4988,9 @@ paths: This endpoint returns a `404 Not Found` status if the custom label is not present on the runner. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/remove-custom-label-from-self-hosted-runner-for-org @@ -4846,10 +5020,9 @@ paths: Lists all secrets available in an organization without revealing their encrypted values. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-org-secrets @@ -4895,10 +5068,9 @@ paths: Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. + The authenticated user must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-org-public-key @@ -4928,10 +5100,9 @@ paths: description: |- Gets a single organization secret without revealing its encrypted value. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. + The authenticated user must have collaborator access to a repository to create, update, or read secrets + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-org-secret @@ -4962,10 +5133,9 @@ paths: Creates or updates an organization secret with an encrypted value. 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)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-or-update-org-secret @@ -5046,10 +5216,9 @@ paths: description: |- Deletes a secret in an organization using the secret name. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-org-secret @@ -5074,10 +5243,9 @@ paths: Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-selected-repos-for-org-secret @@ -5121,10 +5289,9 @@ paths: for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/set-selected-repos-for-org-secret @@ -5172,13 +5339,12 @@ paths: summary: Add selected repository to an organization secret description: |- Adds a repository to an organization secret when the `visibility` for - repository access is set to `selected`. The visibility is set when you [Create or + repository access is set to `selected`. For more information about setting the visibility, see [Create or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/add-selected-repo-to-org-secret @@ -5210,10 +5376,9 @@ paths: for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/remove-selected-repo-from-org-secret @@ -5243,7 +5408,10 @@ paths: summary: List organization variables description: |- Lists all organization variables. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-org-variables @@ -5287,10 +5455,9 @@ paths: description: |- Creates an organization variable that you can reference in a GitHub Actions workflow. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-org-variable @@ -5362,10 +5529,9 @@ paths: description: |- Gets a specific variable in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. + The authenticated user must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-org-variable @@ -5395,10 +5561,9 @@ paths: description: |- Updates an organization variable that you can reference in a GitHub Actions workflow. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/update-org-variable @@ -5459,10 +5624,9 @@ paths: description: |- Deletes an organization variable using the variable name. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-org-variable @@ -5487,10 +5651,9 @@ paths: Lists all repositories that can access an organization variable that is available to selected repositories. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-selected-repos-for-org-variable @@ -5537,11 +5700,9 @@ paths: to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:write` organization permission to use this - endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/set-selected-repos-for-org-variable @@ -5589,10 +5750,9 @@ paths: Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/add-selected-repo-to-org-variable @@ -5625,10 +5785,9 @@ paths: available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/remove-selected-repo-from-org-variable @@ -5763,9 +5922,9 @@ paths: description: |- Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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)." - To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. + The authenticated user must be an owner or security manager for the organization to use this endpoint. - For public repositories, you may instead use the `public_repo` scope. + OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope 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/list-alerts-for-org @@ -5835,7 +5994,7 @@ paths: description: |- Lists the codespaces associated to a specified organization. - You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-in-organization @@ -5886,7 +6045,7 @@ paths: summary: Manage access control for organization codespaces description: |- Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/set-codespaces-access @@ -5957,7 +6116,7 @@ paths: To use this endpoint, the access settings for the organization must be set to `selected_members`. For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." - You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/set-codespaces-access-users @@ -6015,7 +6174,7 @@ paths: To use this endpoint, the access settings for the organization must be set to `selected_members`. For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." - You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-codespaces-access-users @@ -6069,8 +6228,10 @@ paths: get: summary: List organization secrets description: |- - Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + Lists all Codespaces development environment secrets 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: - codespaces operationId: codespaces/list-org-secrets @@ -6112,10 +6273,9 @@ paths: "/orgs/{org}/codespaces/secrets/public-key": get: summary: Get an organization public key - description: Gets a public key for an organization, which is required in order - to encrypt secrets. You need to encrypt the value of a secret before you can - create or update secrets. You must authenticate using an access token with - the `admin:org` scope to use this endpoint. + description: |- + Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-org-public-key @@ -6144,7 +6304,8 @@ paths: summary: Get an organization secret description: |- Gets an organization development environment secret without revealing its encrypted value. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-org-secret @@ -6178,8 +6339,7 @@ paths: Creates or updates an organization development environment secret with an encrypted value. 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)." - You must authenticate using an access - token with the `admin:org` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-or-update-org-secret @@ -6261,9 +6421,10 @@ paths: subcategory: organization-secrets delete: summary: Delete an organization secret - description: Deletes an organization development environment secret using the - secret name. You must authenticate using an access token with the `admin:org` - scope to use this endpoint. + description: |- + Deletes an organization development environment secret using the secret name. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-org-secret @@ -6286,9 +6447,11 @@ paths: "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": get: summary: List selected repositories for an organization secret - description: Lists all repositories that have been selected when the `visibility` - for repository access to a secret is set to `selected`. You must authenticate - using an access token with the `admin:org` scope to use this endpoint. + description: |- + Lists all repositories that have been selected when the `visibility` + for repository access to a secret is set to `selected`. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-selected-repos-for-org-secret @@ -6329,11 +6492,12 @@ paths: subcategory: organization-secrets put: summary: Set selected repositories for an organization secret - description: Replaces all repositories for an organization development environment - secret when the `visibility` for repository access is set to `selected`. The - visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to - use this endpoint. + description: |- + Replaces all repositories for an organization development environment secret when the `visibility` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/set-selected-repos-for-org-secret @@ -6383,11 +6547,9 @@ paths: "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": put: summary: Add selected repository to an organization secret - description: Adds a repository to an organization development environment secret - when the `visibility` for repository access is set to `selected`. The visibility - is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to - use this endpoint. + description: |- + Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/add-selected-repo-to-org-secret @@ -6418,11 +6580,12 @@ paths: subcategory: organization-secrets delete: summary: Remove selected repository from an organization secret - description: Removes a repository from an organization development environment - secret when the `visibility` for repository access is set to `selected`. The - visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to - use this endpoint. + description: |- + Removes a repository from an organization development environment secret when the `visibility` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/remove-selected-repo-from-org-secret @@ -6453,22 +6616,23 @@ paths: subcategory: organization-secrets "/orgs/{org}/copilot/billing": get: - summary: Get Copilot Business seat information and settings for an organization + summary: Get Copilot seat information and settings for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Gets information about an organization's Copilot Business subscription, including seat breakdown + Gets information about an organization's Copilot subscription, including seat breakdown and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". - Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must - authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + Only organization owners can configure and view details about the organization's Copilot Business subscription. + + OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. tags: - copilot operationId: copilot/get-copilot-organization-details externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-business#get-copilot-business-seat-information-and-settings-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: @@ -6489,32 +6653,36 @@ paths: "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" + '422': + description: There is a problem with your account's associated payment method. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-business + subcategory: copilot-user-management "/orgs/{org}/copilot/billing/seats": get: - summary: List all Copilot Business seat assignments for an organization + summary: List all Copilot seat assignments for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). - Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must - authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + + OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. tags: - copilot operationId: copilot/list-copilot-seats externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-business#list-all-copilot-business-seat-assignments-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/page" - name: per_page - description: The number of results per page (max 100). + 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 schema: type: integer @@ -6529,8 +6697,8 @@ paths: properties: total_seats: type: integer - description: Total number of Copilot For Business seats for the - organization currently being billed. + description: Total number of Copilot seats for the organization + currently being billed. seats: type: array items: @@ -6553,28 +6721,29 @@ paths: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-business + subcategory: copilot-user-management "/orgs/{org}/copilot/billing/selected_teams": post: - summary: Add teams to the Copilot Business subscription for an organization + summary: Add teams to the Copilot subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Purchases a GitHub Copilot Business seat for all users within each specified team. - The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + Purchases a GitHub Copilot seat for all users within each specified team. + The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + + Only organization owners can configure GitHub Copilot in their organization. - Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + 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. + For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. - For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. tags: - copilot - operationId: copilot/add-copilot-for-business-seats-for-teams + operationId: copilot/add-copilot-seats-for-teams externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-business#add-teams-to-the-copilot-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6626,35 +6795,36 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot Business is not enabled for this organization, billing - has not been set up for this organization, a public code suggestions policy - has not been set for this organization, or the organization's Copilot + description: Copilot Business or Enterprise is not enabled for this organization, + billing has not been set up for this organization, a public code suggestions + policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-business + subcategory: copilot-user-management delete: - summary: Remove teams from the Copilot Business subscription for an organization + summary: Remove teams from the Copilot subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Cancels the Copilot Business seat assignment for all members of each team specified. + Cancels the Copilot seat assignment for all members of each team specified. This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. - For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + Only organization owners can configure GitHub Copilot in their organization. + + OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-teams externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-business#remove-teams-from-the-copilot-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6706,36 +6876,37 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot Business is not enabled for this organization, billing - has not been set up for this organization, a public code suggestions policy - has not been set for this organization, or the organization's Copilot + description: Copilot Business or Enterprise is not enabled for this organization, + billing has not been set up for this organization, a public code suggestions + policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-business + subcategory: copilot-user-management "/orgs/{org}/copilot/billing/selected_users": post: - summary: Add users to the Copilot Business subscription for an organization + summary: Add users to the Copilot subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Purchases a GitHub Copilot Business seat for each user specified. - The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + Purchases a GitHub Copilot seat for each user specified. + The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + + Only organization owners can configure GitHub Copilot in their organization. - Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + 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. + For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. - For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. tags: - copilot - operationId: copilot/add-copilot-for-business-seats-for-users + operationId: copilot/add-copilot-seats-for-users externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-business#add-users-to-the-copilot-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6787,35 +6958,36 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot Business is not enabled for this organization, billing - has not been set up for this organization, a public code suggestions policy - has not been set for this organization, or the organization's Copilot + description: Copilot Business or Enterprise is not enabled for this organization, + billing has not been set up for this organization, a public code suggestions + policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-business + subcategory: copilot-user-management delete: - summary: Remove users from the Copilot Business subscription for an organization + summary: Remove users from the Copilot subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Cancels the Copilot Business seat assignment for each user specified. + Cancels the Copilot seat assignment for each user specified. This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. - For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)" + For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + Only organization owners can configure GitHub Copilot in their organization. + + OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-users externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-business#remove-users-from-the-copilot-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6867,27 +7039,100 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot Business is not enabled for this organization, billing - has not been set up for this organization, a public code suggestions policy - has not been set for this organization, the seat management setting is - set to enable Copilot for all users or is unconfigured, or a user's seat - cannot be cancelled because it was assigned to them via a team. + description: Copilot Business or Enterprise is not enabled for this organization, + billing has not been set up for this organization, a public code suggestions + policy has not been set for this organization, the seat management setting + is set to enable Copilot for all users or is unconfigured, or a user's + seat cannot be cancelled because it was assigned to them via a team. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + "/orgs/{org}/copilot/usage": + get: + summary: Get a summary of Copilot usage for organization members + description: |- + **Note**: This endpoint is in beta 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 + across an organization, 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 the prior 28 days. 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. + + Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view + Copilot usage metrics. + + OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + tags: + - copilot + operationId: copilot/usage-metrics-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members + parameters: + - "$ref": "#/components/parameters/org" + - 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-business + subcategory: copilot-usage "/orgs/{org}/dependabot/alerts": get: summary: List Dependabot alerts for an organization description: |- Lists Dependabot alerts for an organization. - To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - - For public repositories, you may instead use the `public_repo` scope. + The authenticated user must be an owner or security manager for the organization to use this endpoint. - GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `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: - dependabot operationId: dependabot/list-alerts-for-org @@ -6938,10 +7183,11 @@ paths: "/orgs/{org}/dependabot/secrets": get: summary: List organization secrets - description: Lists all secrets available in an organization without revealing - their encrypted values. You must authenticate using an access token with the - `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` - organization permission to use this endpoint. + description: |- + Lists all secrets available in an organization without revealing their + encrypted values. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/list-org-secrets @@ -6983,11 +7229,11 @@ paths: "/orgs/{org}/dependabot/secrets/public-key": get: summary: Get an organization public key - description: Gets your public key, which you need to encrypt secrets. You need - to encrypt a secret before you can create or update secrets. You must authenticate - using an access token with the `admin:org` scope to use this endpoint. GitHub - Apps must have the `dependabot_secrets` organization permission to use this - endpoint. + description: |- + Gets your public key, which you need to encrypt secrets. You need to + encrypt a secret before you can create or update secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/get-org-public-key @@ -7014,10 +7260,10 @@ paths: "/orgs/{org}/dependabot/secrets/{secret_name}": get: summary: Get an organization secret - description: Gets a single organization secret without revealing its encrypted - value. You must authenticate using an access token with the `admin:org` scope - to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - permission to use this endpoint. + description: |- + Gets a single organization secret without revealing its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/get-org-secret @@ -7048,9 +7294,7 @@ paths: Creates or updates an organization secret with an encrypted value. 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)." - You must authenticate using an access - token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/create-or-update-org-secret @@ -7128,10 +7372,10 @@ paths: subcategory: secrets delete: summary: Delete an organization secret - description: Deletes a secret in an organization using the secret name. You - must authenticate using an access token with the `admin:org` scope to use - this endpoint. GitHub Apps must have the `dependabot_secrets` organization - permission to use this endpoint. + description: |- + Deletes a secret in an organization using the secret name. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/delete-org-secret @@ -7152,11 +7396,11 @@ paths: "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": get: summary: List selected repositories for an organization secret - description: Lists all repositories that have been selected when the `visibility` - for repository access to a secret is set to `selected`. You must authenticate - using an access token with the `admin:org` scope to use this endpoint. GitHub - Apps must have the `dependabot_secrets` organization permission to use this - endpoint. + description: |- + Lists all repositories that have been selected when the `visibility` + for repository access to a secret is set to `selected`. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/list-selected-repos-for-org-secret @@ -7195,12 +7439,12 @@ paths: subcategory: secrets put: summary: Set selected repositories for an organization secret - description: Replaces all repositories for an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you - [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to - use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - permission to use this endpoint. + description: |- + Replaces all repositories for an organization secret when the `visibility` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/set-selected-repos-for-org-secret @@ -7246,12 +7490,12 @@ paths: "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": put: summary: Add selected repository to an organization secret - description: Adds a repository to an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you - [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to - use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - permission to use this endpoint. + description: |- + Adds a repository to an organization secret when the `visibility` for + repository access is set to `selected`. The visibility is set when you [Create or + update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/add-selected-repo-to-org-secret @@ -7278,12 +7522,12 @@ paths: subcategory: secrets delete: summary: Remove selected repository from an organization secret - description: Removes a repository from an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you - [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to - use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - permission to use this endpoint. + description: |- + Removes a repository from an organization secret when the `visibility` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/remove-selected-repo-from-org-secret @@ -7313,7 +7557,8 @@ paths: summary: Get list of conflicting packages during Docker migration for organization description: |- Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. tags: - packages operationId: packages/list-docker-migration-conflicting-packages-for-organization @@ -7415,7 +7660,11 @@ paths: "/orgs/{org}/hooks": get: summary: List organization webhooks - description: '' + description: |- + You 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. tags: - orgs operationId: orgs/list-webhooks @@ -7450,8 +7699,13 @@ paths: subcategory: webhooks post: summary: Create an organization webhook - description: 'Here''s how you can create a hook that posts payloads in JSON - format:' + description: |- + Create a hook that posts payloads in JSON format. + + You 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. tags: - orgs operationId: orgs/create-webhook @@ -7547,8 +7801,14 @@ paths: "/orgs/{org}/hooks/{hook_id}": get: summary: Get an organization webhook - description: Returns a webhook configured in an organization. To get only the - webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)." + description: |- + Returns a webhook configured in an organization. To get only the webhook + `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + + You 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. tags: - orgs operationId: orgs/get-webhook @@ -7577,11 +7837,17 @@ paths: subcategory: webhooks patch: summary: Update an organization webhook - description: Updates a webhook configured in an organization. When you update - a webhook, the `secret` will be overwritten. If you previously had a `secret` - set, you must provide the same `secret` or set a new `secret` or the secret - will be removed. If you are only updating individual webhook `config` properties, - use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)." + description: |- + Updates a webhook configured in an organization. When you update a webhook, + the `secret` will be overwritten. If you previously had a `secret` set, you must + provide the same `secret` or set a new `secret` or the secret will be removed. If + you are only updating individual webhook `config` properties, use "[Update a webhook + configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". + + You 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. tags: - orgs operationId: orgs/update-webhook @@ -7656,7 +7922,11 @@ paths: subcategory: webhooks delete: summary: Delete an organization webhook - description: '' + description: |- + You 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. tags: - orgs operationId: orgs/delete-webhook @@ -7682,7 +7952,10 @@ paths: description: |- Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." - Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + You 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. tags: - orgs operationId: orgs/get-webhook-config-for-org @@ -7712,7 +7985,10 @@ paths: description: |- Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." - Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + You 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. tags: - orgs operationId: orgs/update-webhook-config-for-org @@ -7763,8 +8039,13 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries": get: summary: List deliveries for an organization webhook - description: Returns a list of webhook deliveries for a webhook configured in - an organization. + description: |- + Returns a list of webhook deliveries for a webhook configured in an organization. + + You 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. tags: - orgs operationId: orgs/list-webhook-deliveries @@ -7805,7 +8086,13 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a webhook delivery for an organization webhook - description: Returns a delivery for a webhook configured in an organization. + description: |- + Returns a delivery for a webhook configured in an organization. + + You 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. tags: - orgs operationId: orgs/get-webhook-delivery @@ -7838,7 +8125,13 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for an organization webhook - description: Redeliver a delivery for a webhook configured in an organization. + description: |- + Redeliver a delivery for a webhook configured in an organization. + + You 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. tags: - orgs operationId: orgs/redeliver-webhook-delivery @@ -7864,8 +8157,14 @@ paths: "/orgs/{org}/hooks/{hook_id}/pings": post: summary: Ping an organization webhook - description: This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) + description: |- + This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + + You 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. tags: - orgs operationId: orgs/ping-webhook @@ -7918,9 +8217,13 @@ paths: "/orgs/{org}/installations": get: summary: List app installations for an organization - description: Lists all GitHub Apps in an organization. The installation count - includes all GitHub Apps installed on repositories in the organization. You - must be an organization owner with `admin:read` scope to use this endpoint. + description: |- + Lists all GitHub Apps in an organization. The installation count includes + all GitHub Apps installed on repositories in the organization. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. tags: - orgs operationId: orgs/list-app-installations @@ -8157,11 +8460,15 @@ paths: - Non-owner organization members with ability to see other members and join teams by invitation. \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings - of your organization." + of your organization. \n * `reinstate` - The previous role assigned + to the invitee before they were removed from your organization. + Can be one of the roles listed above. Only works if the invitee + was previously part of your organization." enum: - admin - direct_member - billing_manager + - reinstate default: direct_member team_ids: type: array @@ -8274,6 +8581,13 @@ paths: reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + 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-for-org @@ -8472,7 +8786,7 @@ paths: description: |- Lists the codespaces that a member of an organization has for repositories in that organization. - You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-codespaces-for-user-in-org @@ -8525,10 +8839,7 @@ paths: description: |- Deletes a user's codespace. - To use this endpoint you must authenticate using one of the following methods: - - - An access token with the `admin:org` scope - - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-from-organization @@ -8563,10 +8874,7 @@ paths: description: |- Stops a user's codespace. - To use this endpoint you must authenticate using one of the following methods: - - - An access token with the `admin:org` scope - - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/stop-in-organization @@ -8604,19 +8912,21 @@ paths: subcategory: organizations "/orgs/{org}/members/{username}/copilot": get: - summary: Get Copilot Business seat assignment details for a user + summary: Get Copilot seat assignment details for a user description: |- **Note**: This endpoint is in beta and is subject to change. - Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + + Organization owners can view GitHub Copilot seat assignment details for members in their organization. - Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. tags: - copilot operationId: copilot/get-copilot-seat-details-for-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-business#get-copilot-business-seat-assignment-details-for-a-user + url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" @@ -8639,13 +8949,13 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot Business is not enabled for this organization or the - user has a pending organization invitation. + description: Copilot Business or Enterprise is not enabled for this organization + or the user has a pending organization invitation. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-business + subcategory: copilot-user-management "/orgs/{org}/memberships/{username}": get: summary: Get organization membership for a user @@ -9093,8 +9403,6 @@ paths: get: summary: List organization fine-grained permissions for an organization description: |- - **Note**: This operation is in beta and subject to change. - Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." @@ -9104,8 +9412,7 @@ paths: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-organization-fine-grained-permissions @@ -9139,17 +9446,14 @@ paths: get: summary: Get all organization roles for an organization description: |- - Lists the organization roles available in this organization. + Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-org-roles @@ -9190,17 +9494,14 @@ paths: post: summary: Create a custom organization role description: |- - Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - - For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/create-custom-organization-role @@ -9289,12 +9590,11 @@ paths: delete: summary: Remove all organization roles for a team description: |- - Removes all assigned organization roles from a team. + Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members:write` organization permission to use this endpoint. + The authenticated user must be an administrator for the organization to use this endpoint. - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/revoke-all-org-roles-team @@ -9316,11 +9616,11 @@ paths: put: summary: Assign an organization role to a team description: |- - Assigns an organization role to a team in an organization. - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members` organization read-write permission to use this endpoint. + Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + + The authenticated user must be an administrator for the organization to use this endpoint. - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/assign-team-to-org-role @@ -9347,12 +9647,11 @@ paths: delete: summary: Remove an organization role from a team description: |- - Removes an organization role from a team. + Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members:write` organization permission to use this endpoint. + The authenticated user must be an administrator for the organization to use this endpoint. - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/revoke-org-role-team @@ -9375,12 +9674,11 @@ paths: delete: summary: Remove all organization roles for a user description: |- - Revokes all assigned organization roles from a user. + Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members:write` organization permission to use this endpoint. + The authenticated user must be an administrator for the organization to use this endpoint. - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/revoke-all-org-roles-user @@ -9402,11 +9700,11 @@ paths: put: summary: Assign an organization role to a user description: |- - Assigns an organization role to a member of an organization. - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members` organization read-write permission to use this endpoint. + Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + 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. tags: - orgs operationId: orgs/assign-user-to-org-role @@ -9434,12 +9732,11 @@ paths: delete: summary: Remove an organization role from a user description: |- - Remove an organization role from a user. + Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members:write` organization permission to use this endpoint. + The authenticated user must be an administrator for the organization to use this endpoint. - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/revoke-org-role-user @@ -9462,17 +9759,14 @@ paths: get: summary: Get an organization role description: |- - Gets an organization role that is available to this organization. + Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/get-org-role @@ -9504,17 +9798,15 @@ paths: patch: summary: Update a custom organization role description: |- - Updates an existing custom organization role. Permission changes will apply to all assignees. + Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - - For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/patch-custom-organization-role @@ -9594,17 +9886,14 @@ paths: delete: summary: Delete a custom organization role. description: |- - Deletes a custom organization role. + Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - - For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/delete-custom-organization-role @@ -9626,12 +9915,11 @@ paths: get: summary: List teams that are assigned to an organization role description: |- - Lists the teams that are assigned to an organization role. + Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members` organization read permission to use this endpoint. + To use this endpoint, you must be an administrator for the organization. - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-org-role-teams @@ -9673,12 +9961,11 @@ paths: get: summary: List users that are assigned to an organization role description: |- - Lists organization members that are assigned to an organization role. + Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members` organization read permission to use this endpoint. + To use this endpoint, you must be an administrator for the organization. - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-org-role-users @@ -9871,7 +10158,7 @@ paths: description: |- Lists packages in an organization readable by the user. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-organization @@ -9899,13 +10186,15 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/package-visibility" - name: page - description: Page number of the results to fetch. + 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)." in: query schema: type: integer default: 1 - name: per_page - description: The number of results per page (max 100). + 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 schema: type: integer @@ -9939,7 +10228,7 @@ paths: description: |- Gets a specific package in an organization. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-organization @@ -9970,9 +10259,9 @@ paths: description: |- Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-org @@ -10007,9 +10296,9 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-org @@ -10046,7 +10335,7 @@ paths: description: |- Lists package versions for a package owned by an organization. - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-org @@ -10098,7 +10387,7 @@ paths: description: |- Gets a specific package version in an organization. - You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-organization @@ -10130,9 +10419,9 @@ paths: description: |- Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. - To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-org @@ -10168,9 +10457,9 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-org @@ -10201,10 +10490,9 @@ paths: summary: List requests to access organization resources with fine-grained personal access tokens description: |- - Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API, - using the `organization_personal_access_token_requests: read` permission. + Lists requests from organization members to access organization resources with a fine-grained personal access token. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/list-pat-grant-requests @@ -10254,10 +10542,9 @@ paths: summary: Review requests to access organization resources with fine-grained personal access tokens description: |- - Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - using the `organization_personal_access_token_requests: write` permission. + Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/review-pat-grant-requests-in-bulk @@ -10327,10 +10614,9 @@ paths: summary: Review a request to access organization resources with a fine-grained personal access token description: |- - Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - using the `organization_personal_access_token_requests: write` permission. + Approves or denies a pending request to access organization resources via a fine-grained personal access token. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/review-pat-grant-request @@ -10395,10 +10681,9 @@ paths: summary: List repositories requested to be accessed by a fine-grained personal access token description: |- - Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API, - using the `organization_personal_access_token_requests: read` permission. + Lists the repositories a fine-grained personal access token request is requesting access to. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/list-pat-grant-request-repositories @@ -10447,10 +10732,9 @@ paths: summary: List fine-grained personal access tokens with access to organization resources description: |- - Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API, - using the `organization_personal_access_tokens: read` permission. + Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/list-pat-grants @@ -10500,10 +10784,9 @@ paths: summary: Update the access to organization resources via fine-grained personal access tokens description: |- - Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - using the `organization_personal_access_tokens: write` permission. + Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/update-pat-accesses @@ -10566,10 +10849,9 @@ paths: summary: Update the access a fine-grained personal access token has to organization resources description: |- - Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - using the `organization_personal_access_tokens: write` permission. + Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/update-pat-access @@ -10619,10 +10901,9 @@ paths: get: summary: List repositories a fine-grained personal access token has access to description: |- - Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API, - using the `organization_personal_access_tokens: read` permission. + Lists the repositories a fine-grained personal access token has access to. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/list-pat-grant-repositories @@ -10779,7 +11060,7 @@ paths: summary: Get all custom properties for an organization description: |- Gets all custom properties defined for an organization. - You must be an organization owner to use this endpoint. + Organization members can read these properties. tags: - orgs operationId: orgs/get-all-custom-properties @@ -10813,7 +11094,10 @@ paths: summary: Create or update custom properties for an organization description: |- Creates new or updates existing custom properties defined for an organization in a batch. - Only organization owners (or users with the proper permissions granted by them) can update these properties + + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs operationId: orgs/create-or-update-custom-properties @@ -10850,6 +11134,7 @@ paths: allowed_values: - production - development + values_editable_by: org_actors - property_name: service value_type: string - property_name: team @@ -10881,7 +11166,7 @@ paths: summary: Get a custom property for an organization description: |- Gets a custom property that is defined for an organization. - You must be an organization owner to use this endpoint. + Organization members can read these properties. tags: - orgs operationId: orgs/get-custom-property @@ -10914,7 +11199,10 @@ paths: summary: Create or update a custom property for an organization description: |- Creates a new or updates an existing custom property that is defined for an organization. - You must be an organization owner to use this endpoint. + + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs operationId: orgs/create-or-update-custom-property @@ -10943,10 +11231,16 @@ paths: 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: - - string - 'null' - description: Default value of the property + - string + - array description: type: - string @@ -10958,7 +11252,11 @@ paths: - 'null' items: type: string - description: Ordered list of allowed values of the property + 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 examples: @@ -10994,7 +11292,10 @@ paths: summary: Remove a custom property for an organization description: |- Removes a custom property that is defined for an organization. - You must be an organization owner to use this endpoint. + + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs operationId: orgs/remove-custom-property @@ -11078,7 +11379,9 @@ paths: Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. - Only organization owners (or users with the proper permissions granted by them) can update these properties + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. tags: - orgs operationId: orgs/create-or-update-custom-properties-values-for-repos @@ -11122,6 +11425,8 @@ paths: "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11190,7 +11495,7 @@ paths: description: |- The user can publicize their own membership. (A user cannot publicize the membership for another user.) - Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - orgs operationId: orgs/set-public-membership-for-authenticated-user @@ -11309,12 +11614,7 @@ paths: description: |- Creates a new repository in the specified organization. The authenticated user must be a member of the organization. - **OAuth scope requirements** - - When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - - * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * `repo` scope to create a private repository + OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. tags: - repos operationId: repos/create-in-org @@ -11501,10 +11801,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/repository" + "$ref": "#/components/schemas/full-repository" examples: default: - "$ref": "#/components/examples/repository" + "$ref": "#/components/examples/full-repository" headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -11583,10 +11883,14 @@ paths: description: The name of the ruleset. target: type: string - description: The target of the ruleset. + description: |- + The target of the ruleset + + **Note**: The `push` target is in beta and is subject to change. enum: - branch - tag + - push enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -11792,10 +12096,14 @@ paths: description: The name of the ruleset. target: type: string - description: The target of the ruleset. + description: |- + The target of the ruleset + + **Note**: The `push` target is in beta and is subject to change. enum: - branch - tag + - push enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -11887,10 +12195,10 @@ paths: summary: List secret scanning alerts for an organization description: |- Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - For public repositories, you may instead use the `public_repo` scope. - GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + 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 `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/list-alerts-for-org @@ -11939,7 +12247,9 @@ paths: description: |- Lists repository security advisories for an organization. - To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. tags: - security-advisories operationId: security-advisories/list-org-repository-advisories @@ -11963,7 +12273,8 @@ paths: - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - name: per_page - description: The number of advisories to return per page. + description: The number of advisories to return per page. 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: @@ -12010,9 +12321,9 @@ paths: 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)." - To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope. + The authenticated user must be an administrator or security manager for the organization to use this endpoint. - GitHub Apps must have the `administration` organization read permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-security-manager-teams @@ -12045,9 +12356,9 @@ paths: 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." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope. + The authenticated user must be an administrator for the organization to use this endpoint. - GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - orgs operationId: orgs/add-security-manager-team @@ -12074,9 +12385,9 @@ paths: 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." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + The authenticated user must be an administrator for the organization to use this endpoint. - GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/remove-security-manager-team @@ -12103,7 +12414,7 @@ paths: Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - Access tokens must have the `repo` or `admin:org` scope. + OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. operationId: billing/get-github-actions-billing-org tags: - billing @@ -12135,7 +12446,7 @@ paths: Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - Access tokens must have the `repo` or `admin:org` scope. + OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. operationId: billing/get-github-packages-billing-org tags: - billing @@ -12167,7 +12478,7 @@ paths: Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - Access tokens must have the `repo` or `admin:org` scope. + OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. operationId: billing/get-shared-storage-billing-org tags: - billing @@ -12191,6 +12502,84 @@ paths: enabledForGitHubApps: false category: billing subcategory: billing + "/orgs/{org}/team/{team_slug}/copilot/usage": + get: + summary: Get a summary of Copilot usage for a team + description: |- + **Note**: This endpoint is in beta 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 a 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 the prior 28 days. 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 team had five or more members on that day. + + Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, + and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. + + OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + tags: + - copilot + operationId: copilot/usage-metrics-for-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$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 "/orgs/{org}/teams": get: summary: List teams @@ -12491,9 +12880,11 @@ paths: get: summary: List discussions description: |- - List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List all discussions on a team's page. **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/list-discussions-in-org @@ -12535,11 +12926,13 @@ paths: post: summary: Create a discussion description: |- - Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Creates a new discussion post on a team's page. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/create-discussion-in-org @@ -12597,9 +12990,11 @@ paths: get: summary: Get a discussion description: |- - Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Get a specific discussion on a team's page. **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/get-discussion-in-org @@ -12628,9 +13023,11 @@ paths: patch: summary: Update a discussion description: |- - Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Edits the title and body text of a discussion post. Only the parameters you provide are updated. **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/update-discussion-in-org @@ -12676,9 +13073,11 @@ paths: delete: summary: Delete a discussion description: |- - Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Delete a discussion from a team's page. **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/delete-discussion-in-org @@ -12701,9 +13100,11 @@ paths: get: summary: List discussion comments description: |- - List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List all comments on a team discussion. **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/list-discussion-comments-in-org @@ -12740,11 +13141,13 @@ paths: post: summary: Create a discussion comment description: |- - Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Creates a new comment on a team discussion. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/create-discussion-comment-in-org @@ -12791,9 +13194,11 @@ paths: get: summary: Get a discussion comment description: |- - Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Get a specific comment on a team discussion. **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/get-discussion-comment-in-org @@ -12823,9 +13228,11 @@ paths: patch: summary: Update a discussion comment description: |- - Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Edits the body text of a discussion comment. **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/update-discussion-comment-in-org @@ -12871,9 +13278,11 @@ paths: delete: summary: Delete a discussion comment description: |- - Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Deletes a comment on a team discussion. **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/delete-discussion-comment-in-org @@ -12897,9 +13306,11 @@ paths: get: summary: List reactions for a team discussion comment description: |- - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/list-for-team-discussion-comment-in-org @@ -12952,9 +13363,13 @@ paths: post: summary: Create reaction for a team discussion comment description: |- - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + + A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/create-for-team-discussion-comment-in-org @@ -13023,7 +13438,9 @@ paths: description: |- **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/delete-for-team-discussion-comment @@ -13048,9 +13465,11 @@ paths: get: summary: List reactions for a team discussion description: |- - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/list-for-team-discussion-in-org @@ -13102,9 +13521,13 @@ paths: post: summary: Create reaction for a team discussion description: |- - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + + A response with an HTTP `200` status means that you already added the reaction type to this team discussion. **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/create-for-team-discussion-in-org @@ -13171,7 +13594,9 @@ paths: description: |- **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/delete-for-team-discussion @@ -13516,7 +13941,7 @@ paths: what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you''ll need to set `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."' + information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' enum: - read - write @@ -13622,7 +14047,7 @@ paths: If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. - If the repository is private, you must have at least `read` permission for that repository and your token must have the `repo` scope. Otherwise, you will receive a `404 Not Found` response status. + If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. tags: @@ -13660,7 +14085,7 @@ paths: put: summary: Add or update team repository permissions description: |- - To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. @@ -13774,14 +14199,11 @@ paths: post: summary: Enable or disable a security feature for an organization description: |- - Enables or disables the specified security feature for all eligible repositories in an organization. + Enables or disables the specified security feature for all eligible repositories in 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)." - To use this endpoint, you must be an organization owner or be member of a team with the security manager role. - A token with the 'write:org' scope is also required. + The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. - GitHub Apps must have the `organization_administration:write` permission to use this endpoint. - - 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)." + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - orgs operationId: orgs/enable-or-disable-security-product-on-all-org-repos @@ -14862,7 +15284,7 @@ paths: Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." @@ -15190,10 +15612,12 @@ paths: delete: summary: Delete a repository description: |- - Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + Deleting a repository requires admin access. If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, you will get a `403 Forbidden` response. + + OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. tags: - repos operationId: repos/delete @@ -15236,10 +15660,12 @@ paths: "/repos/{owner}/{repo}/actions/artifacts": get: summary: List artifacts for a repository - description: Lists all artifacts for a repository. Anyone with read access to - the repository can use this endpoint. If the repository is private you must - use an access token with the `repo` scope. GitHub Apps must have the `actions:read` - permission to use this endpoint. + description: |- + Lists all artifacts for a repository. + + 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. tags: - actions operationId: actions/list-artifacts-for-repo @@ -15283,10 +15709,12 @@ paths: "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": get: summary: Get an artifact - description: Gets a specific artifact for a workflow run. Anyone with read access - to the repository can use this endpoint. If the repository is private you - must use an access token with the `repo` scope. GitHub Apps must have the - `actions:read` permission to use this endpoint. + description: |- + Gets a specific artifact for a workflow run. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-artifact @@ -15314,9 +15742,9 @@ paths: subcategory: artifacts delete: summary: Delete an artifact - description: Deletes an artifact for a workflow run. You must authenticate using - an access token with the `repo` scope to use this endpoint. GitHub Apps must - have the `actions:write` permission to use this endpoint. + description: |- + Deletes an artifact for a workflow run. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-artifact @@ -15342,8 +15770,7 @@ paths: Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. The `:archive_format` must be `zip`. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions:read` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/download-artifact @@ -15378,7 +15805,10 @@ paths: description: |- Gets GitHub Actions cache usage for a repository. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-actions-cache-usage @@ -15408,8 +15838,8 @@ paths: summary: List GitHub Actions caches for a repository description: |- Lists the GitHub Actions caches for a repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions:read` permission to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-actions-cache-list @@ -15449,9 +15879,7 @@ paths: description: |- Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. - You must authenticate using an access token with the `repo` scope to use this endpoint. - - GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-actions-cache-by-key @@ -15484,9 +15912,7 @@ paths: description: |- Deletes a GitHub Actions cache for a repository, using a cache ID. - You must authenticate using an access token with the `repo` scope to use this endpoint. - - GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-actions-cache-by-id @@ -15508,10 +15934,12 @@ paths: "/repos/{owner}/{repo}/actions/jobs/{job_id}": get: summary: Get a job for a workflow run - description: Gets a specific job in a workflow run. Anyone with read access - to the repository can use this endpoint. If the repository is private you - must use an access token with the `repo` scope. GitHub Apps must have the - `actions:read` permission to use this endpoint. + description: |- + Gets a specific job in a workflow run. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-job-for-workflow-run @@ -15542,9 +15970,11 @@ paths: summary: Download job logs for a workflow run description: |- Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look - for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can - use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must - have the `actions:read` permission to use this endpoint. + for `Location:` in the response header to find the URL for the download. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/download-job-logs-for-workflow-run @@ -15574,8 +16004,7 @@ paths: description: |- Re-run a job and its dependent jobs in a workflow run. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/re-run-job-for-workflow-run @@ -15624,8 +16053,8 @@ paths: summary: Get the customization template for an OIDC subject claim for a repository description: |- Gets the customization template for an OpenID Connect (OIDC) subject claim. - You must authenticate using an access token with the `repo` scope to use this - endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-custom-oidc-sub-claim-for-repo @@ -15658,8 +16087,8 @@ paths: summary: Set the customization template for an OIDC subject claim for a repository description: |- Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - You must authenticate using an access token with the `repo` scope to use this - endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/set-custom-oidc-sub-claim-for-repo @@ -15725,9 +16154,9 @@ paths: Lists all organization secrets shared with a repository without revealing their encrypted values. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-repo-organization-secrets @@ -15771,11 +16200,11 @@ paths: get: summary: List repository organization variables description: |- - Lists all organiation variables shared with a repository. + Lists all organization variables shared with a repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-repo-organization-variables @@ -15821,7 +16250,7 @@ paths: description: |- Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/get-github-actions-permissions-repository tags: - actions @@ -15851,7 +16280,7 @@ paths: description: |- Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/set-github-actions-permissions-repository tags: - actions @@ -15895,8 +16324,7 @@ paths: This endpoint only applies to private repositories. For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - repository `administration` permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-workflow-access-to-repository @@ -15929,8 +16357,7 @@ paths: This endpoint only applies to private repositories. For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - repository `administration` permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/set-workflow-access-to-repository @@ -15964,7 +16391,7 @@ paths: description: |- Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/get-allowed-actions-repository tags: - actions @@ -15994,7 +16421,7 @@ paths: description: |- Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/set-allowed-actions-repository tags: - actions @@ -16029,7 +16456,7 @@ paths: as well as if GitHub Actions can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-github-actions-default-workflow-permissions-repository @@ -16061,7 +16488,7 @@ paths: can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/set-github-actions-default-workflow-permissions-repository @@ -16097,9 +16524,9 @@ paths: description: |- Lists all self-hosted runners configured in a repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-self-hosted-runners-for-repo @@ -16150,9 +16577,9 @@ paths: description: |- Lists binaries for the runner application that you can download and run. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-runner-applications-for-repo @@ -16185,9 +16612,9 @@ paths: description: |- Generates a configuration that can be passed to the runner application at startup. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + The authenticated user must have admin access to the repository. + + OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. tags: - actions operationId: actions/generate-runner-jitconfig-for-repo @@ -16254,19 +16681,17 @@ paths: post: summary: Create a registration token for a repository description: |- - Returns a token that you can pass to the `config` script. The token - expires after one hour. + Returns a token that you can pass to the `config` script. The token expires after one hour. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: - Example using registration token: + ``` + ./config.sh --url https://github.com/octo-org --token TOKEN + ``` - Configure your self-hosted runner, replacing `TOKEN` with the registration token provided - by this endpoint. + Authenticated users must have admin access to the repository to use this endpoint. - ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-registration-token-for-repo @@ -16295,19 +16720,17 @@ paths: post: summary: Create a remove token for a repository description: |- - Returns a token that you can pass to remove a self-hosted runner from - a repository. The token expires after one hour. + Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: - Example using remove token: + ``` + ./config.sh remove --token TOKEN + ``` - To remove your self-hosted runner from a repository, replace TOKEN with - the remove token provided by this endpoint. + Authenticated users must have admin access to the repository to use this endpoint. - ```config.sh remove --token TOKEN``` + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-remove-token-for-repo @@ -16338,9 +16761,9 @@ paths: description: |- Gets a specific self-hosted runner configured in a repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-self-hosted-runner-for-repo @@ -16371,9 +16794,9 @@ paths: description: |- Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-self-hosted-runner-from-repo @@ -16398,9 +16821,9 @@ paths: description: |- Lists all labels for a self-hosted runner configured in a repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-labels-for-self-hosted-runner-for-repo @@ -16424,11 +16847,11 @@ paths: post: summary: Add custom labels to a self-hosted runner for a repository description: |- - Add custom labels to a self-hosted runner configured in a repository. + Adds custom labels to a self-hosted runner configured in a repository. + + Authenticated users must have admin access to the organization to use this endpoint. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/add-custom-labels-to-self-hosted-runner-for-repo @@ -16479,9 +16902,9 @@ paths: Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/set-custom-labels-for-self-hosted-runner-for-repo @@ -16533,9 +16956,9 @@ paths: Remove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-repo @@ -16566,9 +16989,9 @@ paths: This endpoint returns a `404 Not Found` status if the custom label is not present on the runner. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/remove-custom-label-from-self-hosted-runner-for-repo @@ -16596,9 +17019,13 @@ paths: get: summary: List workflow runs for a repository description: |- - Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + 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. - Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + 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`. tags: - actions operationId: actions/list-workflow-runs-for-repo @@ -16649,10 +17076,12 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}": get: summary: Get a workflow run - description: Gets a specific workflow run. Anyone with read access to the repository - can use this endpoint. If the repository is private you must use an access - token with the `repo` scope. GitHub Apps must have the `actions:read` permission - to use this endpoint. + description: |- + Gets a specific workflow run. + + 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. tags: - actions operationId: actions/get-workflow-run @@ -16682,9 +17111,11 @@ paths: delete: summary: Delete a workflow run description: |- - Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is - private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use - this endpoint. + Deletes a specific workflow run. + + Anyone with write access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/delete-workflow-run tags: - actions @@ -16706,9 +17137,10 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": get: summary: Get the review history for a workflow run - description: Anyone with read access to the repository can use this endpoint. - If the repository is private, you must use an access token with the `repo` - scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + description: |- + 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. tags: - actions operationId: actions/get-reviews-for-run @@ -16742,7 +17174,7 @@ paths: description: |- Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/approve-workflow-run @@ -16775,10 +17207,12 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": get: summary: List workflow run artifacts - description: Lists artifacts for a workflow run. Anyone with read access to - the repository can use this endpoint. If the repository is private you must - use an access token with the `repo` scope. GitHub Apps must have the `actions:read` - permission to use this endpoint. + description: |- + Lists artifacts for a workflow run. + + 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. tags: - actions operationId: actions/list-workflow-run-artifacts @@ -16824,10 +17258,11 @@ paths: get: summary: Get a workflow run attempt description: |- - Gets a specific workflow run attempt. Anyone with read access to the repository - can use this endpoint. If the repository is private you must use an access token - with the `repo` scope. GitHub Apps must have the `actions:read` permission to - use this endpoint. + Gets a specific workflow run attempt. + + 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. tags: - actions operationId: actions/get-workflow-run-attempt @@ -16858,12 +17293,13 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": get: summary: List jobs for a workflow run attempt - description: Lists jobs for a specific workflow run attempt. Anyone with read - access to the repository can use this endpoint. If the repository is private - you must use an access token with the `repo` scope. GitHub Apps must have - the `actions:read` permission to use this endpoint. You can use parameters - to narrow the list of results. For more information about using parameters, - see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + description: |- + Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information + about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + 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. tags: - actions operationId: actions/list-jobs-for-workflow-run-attempt @@ -16912,9 +17348,11 @@ paths: summary: Download workflow run attempt logs description: |- Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to - the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. - GitHub Apps must have the `actions:read` permission to use this endpoint. + 1 minute. Look for `Location:` in the response header to find the URL for the download. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/download-workflow-run-attempt-logs @@ -16945,8 +17383,7 @@ paths: description: |- Cancels a workflow run using its `id`. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/cancel-workflow-run @@ -16983,8 +17420,7 @@ paths: **Note:** GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have read and write permission for **Deployments** to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - actions operationId: actions/review-custom-gates-for-run @@ -17025,8 +17461,7 @@ paths: Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/force-cancel-workflow-run @@ -17057,11 +17492,13 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": get: summary: List jobs for a workflow run - description: Lists jobs for a workflow run. Anyone with read access to the repository - can use this endpoint. If the repository is private you must use an access - token with the `repo` scope. GitHub Apps must have the `actions:read` permission - to use this endpoint. You can use parameters to narrow the list of results. - For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + description: |- + Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information + about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + 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. tags: - actions operationId: actions/list-jobs-for-workflow-run @@ -17119,9 +17556,11 @@ paths: summary: Download workflow run logs description: |- Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use - this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have - the `actions:read` permission to use this endpoint. + `Location:` in the response header to find the URL for the download. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/download-workflow-run-logs @@ -17147,9 +17586,10 @@ paths: subcategory: workflow-runs delete: summary: Delete workflow run logs - description: Deletes all logs for a workflow run. You must authenticate using - an access token with the `repo` scope to use this endpoint. GitHub Apps must - have the `actions:write` permission to use this endpoint. + description: |- + Deletes all logs for a workflow run. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-workflow-run-logs @@ -17178,7 +17618,9 @@ paths: description: |- Get all deployment environments for a workflow run that are waiting for protection rules to pass. - Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-pending-deployments-for-run @@ -17211,7 +17653,9 @@ paths: description: |- Approve or reject pending deployments that are waiting on approval by a required reviewer. - Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint. + Required reviewers with read access to the repository contents and deployments can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/review-pending-deployments-for-run @@ -17284,9 +17728,10 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": post: summary: Re-run a workflow - description: Re-runs your workflow run using its `id`. You must authenticate - using an access token with the `repo` scope to use this endpoint. GitHub Apps - must have the `actions:write` permission to use this endpoint. + description: |- + Re-runs your workflow run using its `id`. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/re-run-workflow @@ -17331,9 +17776,10 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": post: summary: Re-run failed jobs from a workflow run - description: Re-run all of the failed jobs and their dependent jobs in a workflow - run using the `id` of the workflow run. You must authenticate using an access - token with the `repo` scope to use this endpoint. + description: |- + Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/re-run-workflow-failed-jobs @@ -17381,7 +17827,9 @@ paths: description: |- Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + 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. tags: - actions operationId: actions/get-workflow-run-usage @@ -17414,9 +17862,9 @@ paths: Lists all secrets available in a repository without revealing their encrypted values. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-repo-secrets @@ -17464,9 +17912,8 @@ paths: encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. - If the repository is private you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-repo-public-key @@ -17497,9 +17944,9 @@ paths: description: |- Gets a single repository secret without revealing its encrypted value. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. + The authenticated user must have collaborator access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-repo-secret @@ -17531,9 +17978,9 @@ paths: Creates or updates a repository secret with an encrypted value. 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)." - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-or-update-repo-secret @@ -17588,9 +18035,9 @@ paths: description: |- Deletes a secret in a repository using the secret name. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-repo-secret @@ -17614,9 +18061,10 @@ paths: summary: List repository variables description: |- Lists all repository variables. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-repo-variables @@ -17661,9 +18109,9 @@ paths: description: |- Creates a repository variable that you can reference in a GitHub Actions workflow. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-repo-variable @@ -17715,9 +18163,9 @@ paths: description: |- Gets a specific variable in a repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. + The authenticated user must have collaborator access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-repo-variable @@ -17748,9 +18196,9 @@ paths: description: |- Updates a repository variable that you can reference in a GitHub Actions workflow. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/update-repo-variable @@ -17792,9 +18240,9 @@ paths: description: |- Deletes a repository variable using the variable name. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-repo-variable @@ -17816,10 +18264,12 @@ paths: "/repos/{owner}/{repo}/actions/workflows": get: summary: List repository workflows - description: Lists the workflows in a repository. Anyone with read access to - the repository can use this endpoint. If the repository is private you must - use an access token with the `repo` scope. GitHub Apps must have the `actions:read` - permission to use this endpoint. + description: |- + Lists the workflows in a repository. + + 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. tags: - actions operationId: actions/list-repo-workflows @@ -17862,11 +18312,13 @@ paths: "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": get: summary: Get a workflow - description: Gets a specific workflow. You can replace `workflow_id` with the - workflow file name. For example, you could use `main.yaml`. Anyone with read - access to the repository can use this endpoint. If the repository is private - you must use an access token with the `repo` scope. GitHub Apps must have - the `actions:read` permission to use this endpoint. + description: |- + Gets a specific workflow. You can replace `workflow_id` with the workflow + file name. For example, you could use `main.yaml`. + + 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. tags: - actions operationId: actions/get-workflow @@ -17898,7 +18350,7 @@ paths: description: |- Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/disable-workflow @@ -17925,7 +18377,7 @@ paths: You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/create-workflow-dispatch tags: - actions @@ -17978,7 +18430,7 @@ paths: description: |- Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/enable-workflow @@ -18001,9 +18453,11 @@ paths: get: summary: List workflow runs for a workflow description: |- - List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + Anyone with read access to the repository can use this endpoint - Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - actions operationId: actions/list-workflow-runs @@ -18058,7 +18512,11 @@ paths: description: |- Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + + 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. tags: - actions operationId: actions/get-workflow-usage @@ -18252,9 +18710,9 @@ paths: subcategory: assignees "/repos/{owner}/{repo}/autolinks": get: - summary: List all autolinks of a repository + summary: Get all autolinks of a repository description: |- - This returns a list of autolinks configured for the given repository. + Gets all autolinks that are configured for a repository. Information about autolinks are only available to repository administrators. tags: @@ -18262,11 +18720,10 @@ paths: operationId: repos/list-autolinks externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/autolinks#list-all-autolinks-of-a-repository + url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/page" responses: '200': description: Response @@ -19740,7 +20197,7 @@ paths: description: |- Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: - repos operationId: repos/get-apps-with-access-to-protected-branch @@ -19775,7 +20232,7 @@ paths: description: |- Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: - repos operationId: repos/add-app-access-restrictions @@ -19839,7 +20296,7 @@ paths: description: |- Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: - repos operationId: repos/set-app-access-restrictions @@ -19903,7 +20360,7 @@ paths: description: |- Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: - repos operationId: repos/remove-app-access-restrictions @@ -20432,17 +20889,9 @@ paths: **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". - The permissions required to use this endpoint depends on whether you are renaming the default branch. - - To rename a non-default branch: - - * Users must have push access. - * GitHub Apps must have the `contents:write` repository permission. + The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. - To rename the default branch: - - * Users must have admin or owner permissions. - * GitHub Apps must have the `administration:write` repository permission. + In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. tags: - repos operationId: repos/rename-branch @@ -20494,11 +20943,13 @@ paths: post: summary: Create a check run description: |- - **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + Creates a new check run for a specific commit in a repository. - Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + + **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. tags: - checks operationId: checks/create @@ -20531,11 +20982,15 @@ paths: description: A reference for the run on the integrator's system. status: type: string - description: The current status. + description: The current status of the check run. Only GitHub Actions + can set a status of `waiting`, `pending`, or `requested`. enum: - queued - in_progress - completed + - waiting + - requested + - pending default: queued started_at: type: string @@ -20796,9 +21251,11 @@ paths: get: summary: Get a check run description: |- + Gets a single check run using its `id`. + **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/get @@ -20827,9 +21284,11 @@ paths: patch: summary: Update a check run description: |- - Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + Updates a check run for a specific commit in a repository. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + + OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: - checks operationId: checks/update @@ -20864,11 +21323,15 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' status: type: string - description: The current status. + description: The current status of the check run. Only GitHub Actions + can set a status of `waiting`, `pending`, or `requested`. enum: - queued - in_progress - completed + - waiting + - requested + - pending conclusion: type: string description: "**Required if you provide `completed_at` or a `status` @@ -21088,11 +21551,10 @@ paths: "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": get: summary: List check run annotations - description: Lists annotations for a check run using the annotation `id`. GitHub - Apps must have the `checks:read` permission on a private repository or pull - access to a public repository to get annotations for a check run. OAuth apps - and authenticated users must have the `repo` scope to get annotations for - a check run in a private repository. + description: |- + Lists annotations for a check run using the annotation `id`. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/list-annotations @@ -21131,9 +21593,9 @@ paths: description: |- Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. - For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + + OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: - checks operationId: checks/rerequest-run @@ -21178,9 +21640,11 @@ paths: post: summary: Create a check suite description: |- + Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". + **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: - checks operationId: checks/create-suite @@ -21233,12 +21697,9 @@ paths: "/repos/{owner}/{repo}/check-suites/preferences": patch: summary: Update repository preferences for check suites - description: Changes the default automatic flow when creating check suites. - By default, a check suite is automatically created each time code is pushed - to a repository. When you disable the automatic creation of check suites, - you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). - You must have admin permissions in the repository to set preferences for check - suites. + description: |- + Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). + You must have admin permissions in the repository to set preferences for check suites. tags: - checks operationId: checks/set-suites-preferences @@ -21299,9 +21760,11 @@ paths: get: summary: Get a check suite description: |- + Gets a single check suite using its `id`. + **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/get-suite @@ -21331,9 +21794,11 @@ paths: get: summary: List check runs in a check suite description: |- - Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + Lists check runs for a check suite using its `id`. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/list-for-suite @@ -21393,7 +21858,7 @@ paths: description: |- Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository. + OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: - checks operationId: checks/rerequest-suite @@ -21425,11 +21890,11 @@ paths: description: |- Lists code scanning alerts. - To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. - The response includes a `most_recent_instance` object. This provides details of the most recent instance of this alert for the default branch (or for the specified Git reference if you used `ref` in the request). + + 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/list-alerts-for-repo @@ -21497,10 +21962,10 @@ paths: "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": get: summary: Get a code scanning alert - description: Gets a single code scanning alert. You must use an access token - with the `security_events` scope to use this endpoint with private repos, - the `public_repo` scope also grants permission to read security events on - public repos only. + description: |- + Gets a single 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-alert @@ -21536,10 +22001,9 @@ paths: subcategory: code-scanning patch: summary: Update a code scanning alert - description: Updates the status of a single code scanning alert. You must use - an access token with the `security_events` scope to use this endpoint with - private repositories. You can also use tokens with the `public_repo` scope - for public repositories only. + description: |- + Updates the status of a single 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. operationId: code-scanning/update-alert tags: - code-scanning @@ -21598,8 +22062,8 @@ paths: summary: List instances of a code scanning alert description: |- Lists all instances of the specified code scanning alert. - You must use an access token with the `security_events` scope to use this endpoint with private repos, - the `public_repo` scope also grants permission to read security events on public repos only. + + 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/list-alert-instances @@ -21651,11 +22115,10 @@ paths: For very old analyses this data is not available, and `0` is returned in this field. - You must use an access token with the `security_events` scope to use this endpoint with private repos, - the `public_repo` scope also grants permission to read security events on public repos only. - **Deprecation notice**: The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + + 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. operationId: code-scanning/list-recent-analyses tags: - code-scanning @@ -21721,8 +22184,6 @@ paths: summary: Get a code scanning analysis for a repository description: |- Gets a specified code scanning analysis for a repository. - You must use an access token with the `security_events` scope to use this endpoint with private repos, - the `public_repo` scope also grants permission to read security events on public repos only. The default JSON response contains fields that describe the analysis. This includes the Git reference and commit SHA to which the analysis relates, @@ -21734,10 +22195,11 @@ paths: For very old analyses this data is not available, and `0` is returned in this field. - If you use the Accept header `application/sarif+json`, - the response contains the analysis data that was uploaded. - This is formatted as - [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + 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/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + + 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. operationId: code-scanning/get-analysis tags: - code-scanning @@ -21785,10 +22247,7 @@ paths: delete: summary: Delete a code scanning analysis from a repository description: |- - Deletes a specified code scanning analysis from a repository. For - private repositories, you must use an access token with the `repo` scope. For public repositories, - you must use an access token with `public_repo` scope. - GitHub Apps must have the `security_events` write permission to use this endpoint. + Deletes a specified code scanning analysis from a repository. You can delete one analysis at a time. To delete a series of analyses, start with the most recent analysis and work backwards. @@ -21850,6 +22309,8 @@ paths: * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + + 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. operationId: code-scanning/delete-analysis tags: - code-scanning @@ -21907,8 +22368,7 @@ paths: description: |- Lists the CodeQL databases that are available in a repository. - For private repositories, you must use an access token with the `security_events` scope. - For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + 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/list-codeql-databases @@ -21954,8 +22414,7 @@ paths: your HTTP client is configured to follow redirects or use the `Location` header to make a second request to get the redirect URL. - For private repositories, you must use an access token with the `security_events` scope. - For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + 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-codeql-database @@ -22000,8 +22459,8 @@ paths: summary: Get a code scanning default setup configuration description: |- Gets a code scanning default setup configuration. - You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - scope for public repos. + + 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/get-default-setup @@ -22036,8 +22495,8 @@ paths: summary: Update a code scanning default setup configuration description: |- Updates a code scanning default setup configuration. - You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - scope for public repos. + + 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/update-default-setup @@ -22092,12 +22551,8 @@ paths: post: summary: Upload an analysis as SARIF data description: "Uploads SARIF data containing the results of a code scanning analysis - to make the results available in a repository. You must use an access token - with the `security_events` scope to use this endpoint for private repositories. - You can also use tokens with the `public_repo` scope for public repositories - only. GitHub Apps must have the `security_events` write permission to use - this endpoint. For troubleshooting information, see \"[Troubleshooting SARIF - uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere + to make the results available in a repository. For troubleshooting information, + see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, @@ -22107,7 +22562,7 @@ paths: see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip - -c analysis-data.sarif | base64 -w0\n```\n
\nSARIF upload supports a maximum + -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping @@ -22130,7 +22585,10 @@ paths: \ | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor - more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"" + more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth + 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." operationId: code-scanning/upload-sarif tags: - code-scanning @@ -22218,13 +22676,9 @@ paths: "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": get: summary: Get information about a SARIF upload - description: Gets information about a SARIF upload, including the status and - the URL of the analysis that was uploaded so that you can retrieve details - of the analysis. For more information, see "[Get a code scanning analysis - for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." - You must use an access token with the `security_events` scope to use this - endpoint with private repos, the `public_repo` scope also grants permission - to read security events on public repos only. + description: |- + Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." + 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. operationId: code-scanning/get-sarif tags: - code-scanning @@ -22311,9 +22765,7 @@ paths: description: |- Lists the codespaces associated to a specified repository and the authenticated user. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-in-repository-for-authenticated-user @@ -22363,9 +22815,7 @@ paths: description: |- Creates a codespace owned by the authenticated user in the specified repository. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-with-repo-for-authenticated-user @@ -22476,9 +22926,7 @@ paths: Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files specify launchpoint configurations for codespaces created within the repository. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-devcontainers-in-repository-for-authenticated-user @@ -22540,9 +22988,7 @@ paths: description: |- List the machine types available for a given repository based on its configuration. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/repo-machines-for-authenticated-user @@ -22614,9 +23060,7 @@ paths: description: |- Gets the default attributes for codespaces created by the user with the repository. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/pre-flight-with-repo-for-authenticated-user @@ -22686,9 +23130,7 @@ paths: description: |- Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/check-permissions-for-devcontainer @@ -22747,10 +23189,11 @@ paths: "/repos/{owner}/{repo}/codespaces/secrets": get: summary: List repository secrets - description: Lists all development environment secrets available in a repository - without revealing their encrypted values. You must authenticate using an access - token with the `repo` scope to use this endpoint. GitHub Apps must have write - access to the `codespaces_secrets` repository permission to use this endpoint. + description: |- + Lists all development environment secrets available in a repository without revealing their encrypted + values. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-repo-secrets @@ -22793,12 +23236,13 @@ paths: "/repos/{owner}/{repo}/codespaces/secrets/public-key": get: summary: Get a repository public key - description: Gets your public key, which you need to encrypt secrets. You need - to encrypt a secret before you can create or update secrets. Anyone with read - access to the repository can use this endpoint. If the repository is private - you must use an access token with the `repo` scope. GitHub Apps must have - write access to the `codespaces_secrets` repository permission to use this - endpoint. + description: |- + Gets your public key, which you need to encrypt secrets. You need to + encrypt a secret before you can create or update secrets. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-repo-public-key @@ -22826,10 +23270,10 @@ paths: "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": get: summary: Get a repository secret - description: Gets a single repository development environment secret without - revealing its encrypted value. You must authenticate using an access token - with the `repo` scope to use this endpoint. GitHub Apps must have write access - to the `codespaces_secrets` repository permission to use this endpoint. + description: |- + Gets a single repository development environment secret without revealing its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-repo-secret @@ -22861,9 +23305,7 @@ paths: Creates or updates a repository development environment secret with an encrypted value. 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)." - You must authenticate using an access - token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-or-update-repo-secret @@ -22915,10 +23357,10 @@ paths: subcategory: repository-secrets delete: summary: Delete a repository secret - description: Deletes a development environment secret in a repository using - the secret name. You must authenticate using an access token with the `repo` - scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - repository permission to use this endpoint. + description: |- + Deletes a development environment secret in a repository using the secret name. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-repo-secret @@ -22946,9 +23388,9 @@ paths: Team members will include the members of child teams. - You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - endpoint. + The authenticated user must have push access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos operationId: repos/list-collaborators @@ -23018,9 +23460,9 @@ paths: Team members will include the members of child teams. - You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - endpoint. + The authenticated user must have push access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos operationId: repos/check-collaborator @@ -23054,7 +23496,7 @@ paths: Cannot assign {member} permission of {role name} ``` - Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). @@ -23209,9 +23651,14 @@ paths: get: summary: List commit comments for a repository description: |- - Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + Lists the commit comments for a specified repository. Comments are ordered by ascending ID. - Comments are ordered by ascending ID. + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/list-commit-comments-for-repo @@ -23246,7 +23693,15 @@ paths: "/repos/{owner}/{repo}/comments/{comment_id}": get: summary: Get a commit comment - description: '' + description: |- + Gets a specified commit comment. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/get-commit-comment @@ -23276,7 +23731,15 @@ paths: subcategory: comments patch: summary: Update a commit comment - description: '' + description: |- + Updates the contents of a specified commit comment. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/update-commit-comment @@ -23626,6 +24089,8 @@ paths: "$ref": "#/components/examples/branch-short-items" '422': "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23634,8 +24099,15 @@ paths: "/repos/{owner}/{repo}/commits/{commit_sha}/comments": get: summary: List commit comments - description: Use the `:commit_sha` to specify the commit that will have its - comments listed. + description: |- + Lists the comments for a specified commit. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/list-comments-for-commit @@ -23674,6 +24146,13 @@ paths: Create a comment for a commit using its `:commit_sha`. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/create-commit-comment @@ -23772,6 +24251,8 @@ paths: headers: Link: "$ref": "#/components/headers/link" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23783,11 +24264,13 @@ paths: description: |- Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. - **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. - You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property. + 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)." Pagination query parameters are not supported for these media types. - To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. + - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. + - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. **Signature verification object** @@ -23847,6 +24330,8 @@ paths: "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23856,11 +24341,13 @@ paths: get: summary: List check runs for a Git reference description: |- - Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/list-for-ref @@ -23923,9 +24410,11 @@ paths: get: summary: List check suites for a Git reference description: |- - Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/list-suites-for-ref @@ -24099,9 +24588,14 @@ paths: get: summary: Compare two commits description: |- - Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + + This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. - This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + 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.diff`**: Returns the diff of the commit. + - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. @@ -24189,44 +24683,32 @@ paths: "/repos/{owner}/{repo}/contents/{path}": get: summary: Get repository content - description: "Gets the contents of a file or directory in a repository. Specify - the file path or directory in `:path`. If you omit\n`:path`, you will receive - the contents of the repository's root directory. See the description below - regarding what the API response includes for directories. \n\nFiles and symlinks - support [a custom media type](https://docs.github.com/rest/overview/media-types) - for\nretrieving the raw content or rendered HTML (when supported). All content - types support [a custom media\ntype](https://docs.github.com/rest/overview/media-types) - to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* - \ To get a repository's contents recursively, you can [recursively get the - tree](https://docs.github.com/rest/git/trees#get-a-tree).\n* This API has - an upper limit of 1,000 files for a directory. If you need to retrieve more - files, use the [Git Trees\nAPI](https://docs.github.com/rest/git/trees#get-a-tree).\n - * Download URLs expire and are meant to be used just once. To ensure the - download URL does not expire, please use the contents API to obtain a fresh - download URL for each download.\n Size limits:\nIf the requested file's size - is:\n* 1 MB or smaller: All features of this endpoint are supported.\n* Between - 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) - are supported. Both will work as normal, except that when using the `object` - media type, the `content` field will be an empty string and the `encoding` - field will be `\"none\"`. To get the contents of these larger files, use the - `raw` media type.\n * Greater than 100 MB: This endpoint is not supported.\n\n - If the content is a directory:\nThe response will be an array of objects, - one object for each item in the directory.\nWhen listing the contents of a - directory, submodules have their \"type\" specified as \"file\". Logically, - the value\n_should_ be \"submodule\". This behavior exists in API v3 [for - backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major - version of the API, the type will be returned as \"submodule\".\n\n If the - content is a symlink: \nIf the requested `:path` points to a symlink, and - the symlink's target is a normal file in the repository, then the\nAPI responds - with the content of the file (in the format shown in the example. Otherwise, - the API responds with an object \ndescribing the symlink itself.\n\n If the - content is a submodule:\nThe `submodule_git_url` identifies the location of - the submodule repository, and the `sha` identifies a specific\ncommit within - the submodule repository. Git uses the given URL when cloning the submodule - repository, and checks out\nthe submodule at that specific commit.\n\nIf the - submodule repository is not hosted on github.com, the Git URLs (`git_url` - and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) - will have null values." + description: |- + Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. + + 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 file contents for files and symlinks. + - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + + If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". + + If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + + If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. + + **Notes**: + + - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). + - This API has an upper limit of 1,000 files for a directory. If you need to retrieve + more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). + - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + - If the requested file's size is: + - 1 MB or smaller: All features of this endpoint are supported. + - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + - Greater than 100 MB: This endpoint is not supported. tags: - repos operationId: repos/get-content @@ -24292,9 +24774,11 @@ paths: put: summary: Create or update file contents description: |- - Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. + Creates a new file or replaces an existing file in a repository. **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. tags: - repos operationId: repos/create-or-update-file-contents @@ -24575,10 +25059,9 @@ paths: "/repos/{owner}/{repo}/dependabot/alerts": get: summary: List Dependabot alerts for a repository - description: |- - You must use an access token with the `security_events` scope to use this endpoint with private repositories. - You can also use tokens with the `public_repo` scope for public repositories only. - GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + description: OAuth app tokens and personal access tokens (classic) need the + `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: - dependabot operationId: dependabot/list-alerts-for-repo @@ -24605,7 +25088,8 @@ paths: type: integer default: 1 - name: per_page - description: The number of results per page (max 100). + 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)." deprecated: true in: query schema: @@ -24646,10 +25130,9 @@ paths: "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": get: summary: Get a Dependabot alert - description: |- - You must use an access token with the `security_events` scope to use this endpoint with private repositories. - You can also use tokens with the `public_repo` scope for public repositories only. - GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + description: OAuth app tokens and personal access tokens (classic) need the + `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: - dependabot operationId: dependabot/get-alert @@ -24685,11 +25168,9 @@ paths: patch: summary: Update a Dependabot alert description: |- - You must use an access token with the `security_events` scope to use this endpoint with private repositories. - You can also use tokens with the `public_repo` scope for public repositories only. - GitHub Apps must have **Dependabot alerts** write permission to use this endpoint. + The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." - To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + OAuth app tokens and personal access tokens (classic) need the `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: - dependabot operationId: dependabot/update-alert @@ -24768,10 +25249,11 @@ paths: "/repos/{owner}/{repo}/dependabot/secrets": get: summary: List repository secrets - description: Lists all secrets available in a repository without revealing their - encrypted values. You must authenticate using an access token with the `repo` - scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` - repository permission to use this endpoint. + description: |- + Lists all secrets available in a repository without revealing their encrypted + values. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependabot operationId: dependabot/list-repo-secrets @@ -24814,11 +25296,12 @@ paths: "/repos/{owner}/{repo}/dependabot/secrets/public-key": get: summary: Get a repository public key - description: Gets your public key, which you need to encrypt secrets. You need - to encrypt a secret before you can create or update secrets. Anyone with read - access to the repository can use this endpoint. If the repository is private - you must use an access token with the `repo` scope. GitHub Apps must have - the `dependabot_secrets` repository permission to use this endpoint. + description: |- + Gets your public key, which you need to encrypt secrets. You need to + encrypt a secret before you can create or update secrets. 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 if the repository is private. tags: - dependabot operationId: dependabot/get-repo-public-key @@ -24846,10 +25329,10 @@ paths: "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": get: summary: Get a repository secret - description: Gets a single repository secret without revealing its encrypted - value. You must authenticate using an access token with the `repo` scope to - use this endpoint. GitHub Apps must have the `dependabot_secrets` repository - permission to use this endpoint. + description: |- + Gets a single repository secret without revealing its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependabot operationId: dependabot/get-repo-secret @@ -24881,9 +25364,7 @@ paths: Creates or updates a repository secret with an encrypted value. 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)." - You must authenticate using an access - token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository - permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependabot operationId: dependabot/create-or-update-repo-secret @@ -24935,10 +25416,10 @@ paths: subcategory: secrets delete: summary: Delete a repository secret - description: Deletes a secret in a repository using the secret name. You must - authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `dependabot_secrets` repository permission to use - this endpoint. + description: |- + Deletes a secret in a repository using the secret name. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependabot operationId: dependabot/delete-repo-secret @@ -25041,9 +25522,12 @@ paths: "/repos/{owner}/{repo}/dependency-graph/snapshots": post: summary: Create a snapshot of dependencies for a repository - description: Create a new snapshot of a repository's dependencies. You must - authenticate using an access token with the `repo` scope to use this endpoint - for a repository that the requesting user has access to. + description: |- + Create a new snapshot of a repository's dependencies. + + The authenticated user must have access to the repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependency-graph operationId: dependency-graph/create-repository-snapshot @@ -25196,8 +25680,6 @@ paths: be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled. - Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. - Merged branch response: You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating @@ -25218,6 +25700,8 @@ paths: This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. tags: - repos operationId: repos/create-deployment @@ -25370,7 +25854,7 @@ paths: delete: summary: Delete a deployment description: |- - If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. + If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. To set a deployment as inactive, you must: @@ -25378,6 +25862,8 @@ paths: * Mark the active deployment as inactive by adding any non-successful deployment status. For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. tags: - repos operationId: repos/delete-deployment @@ -25443,7 +25929,7 @@ paths: description: |- Users with `push` access can create deployment statuses for a given deployment. - GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. + OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. tags: - repos operationId: repos/create-deployment-status @@ -25589,12 +26075,9 @@ paths: The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. - This endpoint requires write access to the repository by providing either: - - - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. - This input example shows how you can use the `client_payload` as a test to debug your workflow. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-dispatch-event @@ -25636,6 +26119,8 @@ paths: responses: '204': description: Response + '404': + "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: @@ -25649,7 +26134,9 @@ paths: description: |- Lists the environments for a repository. - Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + 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. tags: - repos operationId: repos/get-all-environments @@ -25692,9 +26179,9 @@ paths: description: |- **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." - Anyone with read access to the repository can use this endpoint. If the - repository is private, you must use an access token with the `repo` scope. GitHub - Apps must have the `actions:read` permission to use this endpoint. + 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. tags: - repos operationId: repos/get-environment @@ -25729,7 +26216,7 @@ paths: **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-or-update-environment @@ -25814,8 +26301,8 @@ paths: subcategory: environments delete: summary: Delete an environment - description: You must authenticate using an access token with the repo scope - to use this endpoint. + description: OAuth app tokens and personal access tokens (classic) need the + `repo` scope to use this endpoint. tags: - repos operationId: repos/delete-an-environment @@ -25840,7 +26327,9 @@ paths: description: |- Lists the deployment branch policies for an environment. - Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + 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. tags: - repos operationId: repos/list-deployment-branch-policies @@ -25887,7 +26376,7 @@ paths: description: |- Creates a deployment branch or tag policy for an environment. - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-deployment-branch-policy @@ -25949,7 +26438,9 @@ paths: description: |- Gets a deployment branch or tag policy for an environment. - Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + 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. tags: - repos operationId: repos/get-deployment-branch-policy @@ -25981,7 +26472,7 @@ paths: description: |- Updates a deployment branch or tag policy for an environment. - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/update-deployment-branch-policy @@ -26023,7 +26514,7 @@ paths: description: |- Deletes a deployment branch or tag policy for an environment. - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/delete-deployment-branch-policy @@ -26047,9 +26538,11 @@ paths: get: summary: Get all deployment protection rules for an environment description: |- - Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/get-all-deployment-protection-rules @@ -26111,9 +26604,11 @@ paths: description: |- Enable a custom deployment protection rule for an environment. - You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. + The authenticated user must have admin or owner permissions to the repository to use this endpoint. For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-deployment-protection-rule @@ -26158,11 +26653,13 @@ paths: get: summary: List custom deployment rule integrations available for an environment description: |- - Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. + Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. - For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/list-custom-deployment-rule-integrations @@ -26206,9 +26703,11 @@ paths: get: summary: Get a custom deployment protection rule description: |- - Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/get-custom-deployment-protection-rule @@ -26240,7 +26739,9 @@ paths: description: |- Disables a custom deployment protection rule for an environment. - You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)". + The authenticated user must have admin or owner permissions to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/disable-deployment-protection-rule @@ -26260,6 +26761,425 @@ paths: enabledForGitHubApps: true category: deployments subcategory: protection-rules + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": + get: + summary: List environment secrets + description: |- + Lists all secrets available in an environment without revealing their + encrypted values. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-environment-secrets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#list-environment-secrets + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + "$ref": "#/components/schemas/actions-secret" + examples: + default: + "$ref": "#/components/examples/actions-secret-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": + get: + summary: Get an environment public key + description: |- + Get the public key for an environment, which you need to encrypt environment + secrets. You need to encrypt a secret before you can create or update secrets. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-environment-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-public-key" + examples: + default: + "$ref": "#/components/examples/actions-public-key" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": + get: + summary: Get an environment secret + description: |- + Gets a single environment secret without revealing its encrypted value. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-environment-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + - "$ref": "#/components/parameters/secret-name" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-secret" + examples: + default: + "$ref": "#/components/examples/actions-secret" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + put: + summary: Create or update an environment secret + description: |- + Creates or updates an environment secret with an encrypted value. 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)." + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/create-or-update-environment-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + - "$ref": "#/components/parameters/secret-name" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get an environment public + key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) + endpoint. + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + type: string + description: ID of the key you used to encrypt the secret. + required: + - encrypted_value + - key_id + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + delete: + summary: Delete an environment secret + description: |- + Deletes a secret in an environment using the secret name. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-environment-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + - "$ref": "#/components/parameters/secret-name" + responses: + '204': + description: Default response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + "/repos/{owner}/{repo}/environments/{environment_name}/variables": + get: + summary: List environment variables + description: |- + Lists all environment variables. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-environment-variables + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#list-environment-variables + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + - "$ref": "#/components/parameters/variables-per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - variables + properties: + total_count: + type: integer + variables: + type: array + items: + "$ref": "#/components/schemas/actions-variable" + examples: + default: + "$ref": "#/components/examples/actions-variables-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + post: + summary: Create an environment variable + description: |- + Create an environment variable that you can reference in a GitHub Actions workflow. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/create-environment-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#create-an-environment-variable + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + required: + - name + - value + examples: + default: + value: + name: USERNAME + value: octocat + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": + get: + summary: Get an environment variable + description: |- + Gets a specific variable in an environment. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-environment-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#get-an-environment-variable + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + - "$ref": "#/components/parameters/variable-name" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-variable" + examples: + default: + "$ref": "#/components/examples/actions-variable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + patch: + summary: Update an environment variable + description: |- + Updates an environment variable that you can reference in a GitHub Actions workflow. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/update-environment-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#update-an-environment-variable + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/variable-name" + - "$ref": "#/components/parameters/environment-name" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + examples: + default: + value: + name: USERNAME + value: octocat + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + delete: + summary: Delete an environment variable + description: |- + Deletes an environment variable using the variable name. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-environment-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/variable-name" + - "$ref": "#/components/parameters/environment-name" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables "/repos/{owner}/{repo}/events": get: summary: List repository events @@ -26478,7 +27398,12 @@ paths: description: |- The `content` in the response will always be Base64 encoded. - _Note_: This API supports blobs up to 100 megabytes in size. + 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 blob data. + - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + + **Note** This endpoint supports blobs up to 100 megabytes in size. tags: - git operationId: git/get-blob @@ -26509,6 +27434,8 @@ paths: "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26678,6 +27605,8 @@ paths: "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26741,6 +27670,8 @@ paths: "$ref": "#/components/examples/git-commit-2" '404': "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26766,7 +27697,7 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/commit-ref" + - "$ref": "#/components/parameters/git-ref-only" responses: '200': description: Response @@ -26782,6 +27713,8 @@ paths: headers: Link: "$ref": "#/components/headers/link" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26803,7 +27736,7 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/commit-ref" + - "$ref": "#/components/parameters/git-ref-only" responses: '200': description: Response @@ -26816,6 +27749,8 @@ paths: "$ref": "#/components/examples/git-ref" '404': "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26876,6 +27811,8 @@ paths: type: string '422': "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26884,7 +27821,9 @@ paths: "/repos/{owner}/{repo}/git/refs/{ref}": patch: summary: Update a reference - description: '' + description: Updates the provided reference to point to a new SHA. For more + information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. tags: - git operationId: git/update-ref @@ -26894,17 +27833,7 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - name: ref - description: The name of the reference to update (for example, `heads/featureA`). - Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). - For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" - in the Git documentation. - in: path - required: true - example: heads/featureA - schema: - type: string - x-multi-segment: true + - "$ref": "#/components/parameters/git-ref-only" requestBody: required: true content: @@ -26940,6 +27869,8 @@ paths: "$ref": "#/components/examples/git-ref" '422': "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26947,7 +27878,7 @@ paths: subcategory: refs delete: summary: Delete a reference - description: '' + description: Deletes the provided reference. tags: - git operationId: git/delete-ref @@ -26957,12 +27888,14 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/commit-ref" + - "$ref": "#/components/parameters/git-ref-only" responses: '204': description: Response '422': "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27089,6 +28022,8 @@ paths: type: string '422': "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27152,6 +28087,8 @@ paths: "$ref": "#/components/examples/git-tag" '404': "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27264,6 +28201,8 @@ paths: "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27321,6 +28260,8 @@ paths: "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27403,14 +28344,6 @@ paths: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" - token: - type: string - examples: - - '"abc"' - digest: - type: string - examples: - - '"sha256"' events: type: array description: Determines what [events](https://docs.github.com/webhooks/event-payloads) @@ -27519,27 +28452,7 @@ paths: type: object properties: config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: - "$ref": "#/components/schemas/webhook-config-url" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - secret: - "$ref": "#/components/schemas/webhook-config-secret" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - address: - type: string - examples: - - '"bar@example.com"' - room: - type: string - examples: - - '"The Serious Room"' - required: - - url + "$ref": "#/components/schemas/webhook-config" events: type: array description: Determines what [events](https://docs.github.com/webhooks/event-payloads) @@ -27619,7 +28532,7 @@ paths: description: |- Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." - Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. tags: - repos operationId: repos/get-webhook-config-for-repo @@ -27650,7 +28563,7 @@ paths: description: |- Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." - Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. tags: - repos operationId: repos/update-webhook-config-for-repo @@ -28600,6 +29513,13 @@ paths: reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + 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-for-repo @@ -28697,6 +29617,13 @@ paths: This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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/create @@ -28821,6 +29748,13 @@ paths: You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. By default, issue comments are ordered by ascending ID. + + 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-comments-for-repo @@ -28870,8 +29804,15 @@ paths: "/repos/{owner}/{repo}/issues/comments/{comment_id}": get: summary: Get an issue comment - description: You can use the REST API to get comments on issues and pull requests. - Every pull request is an issue, but not every issue is a pull request. + description: |- + You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + + 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/get-comment @@ -28901,8 +29842,15 @@ paths: subcategory: comments patch: summary: Update an issue comment - description: You can use the REST API to update comments on issues and pull - requests. Every pull request is an issue, but not every issue is a pull request. + description: |- + You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + + 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/update-comment @@ -29195,7 +30143,7 @@ paths: get: summary: Get an issue description: |- - The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was + The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read @@ -29206,6 +30154,13 @@ paths: reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + 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/get @@ -29241,7 +30196,15 @@ paths: subcategory: issues patch: summary: Update an issue - description: Issue owners and users with push access can edit an issue. + description: |- + Issue owners and users with push access can edit 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/update @@ -29522,6 +30485,13 @@ paths: You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. Issue comments are ordered by ascending ID. + + 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-comments @@ -29561,14 +30531,20 @@ paths: subcategory: comments post: summary: Create an issue comment - description: |2- - + description: |- You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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/create-comment @@ -29961,7 +30937,7 @@ paths: description: |- Users with push access can lock an issue or pull request's conversation. - Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - issues operationId: issues/lock @@ -30638,7 +31614,10 @@ paths: description: |- This method returns the contents of the repository's license file, if one is detected. - Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. + 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 contents of the license. + - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). tags: - licenses operationId: licenses/get-for-repo @@ -30648,6 +31627,7 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/git-ref" responses: '200': description: Response @@ -31175,7 +32155,7 @@ paths: description: |- Gets information about a GitHub Pages site. - A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/get-pages @@ -31207,7 +32187,9 @@ paths: description: |- Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." - To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-pages-site @@ -31290,7 +32272,9 @@ paths: description: |- Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/update-information-about-pages-site @@ -31392,7 +32376,9 @@ paths: description: |- Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/delete-pages-site @@ -31422,7 +32408,7 @@ paths: description: |- Lists builts of a GitHub Pages site. - A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/list-pages-builds @@ -31490,7 +32476,7 @@ paths: description: |- Gets information about the single most recent build of a GitHub Pages site. - A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/get-latest-pages-build @@ -31521,7 +32507,7 @@ paths: description: |- Gets information about a GitHub Pages build. - A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/get-pages-build @@ -31551,13 +32537,13 @@ paths: enabledForGitHubApps: true category: pages subcategory: pages - "/repos/{owner}/{repo}/pages/deployment": + "/repos/{owner}/{repo}/pages/deployments": post: summary: Create a GitHub Pages deployment description: |- Create a GitHub Pages deployment for a repository. - Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint. + The authenticated user must have write permission to the repository. tags: - repos operationId: repos/create-pages-deployment @@ -31575,10 +32561,16 @@ paths: type: object description: The object used to create GitHub Pages deployment properties: + artifact_id: + type: number + description: The ID of an artifact that contains the .zip or .tar + of static assets to deploy. The artifact belongs to the repository. + Either `artifact_id` or `artifact_url` are required. artifact_url: type: string description: The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. + Either `artifact_id` or `artifact_url` are required. environment: type: string description: The target environment for this GitHub Pages deployment. @@ -31593,7 +32585,6 @@ paths: description: The OIDC token issued by GitHub Actions certifying the origin of the deployment. required: - - artifact_url - pages_build_version - oidc_token examples: @@ -31625,6 +32616,67 @@ paths: enabledForGitHubApps: true category: pages subcategory: pages + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": + get: + summary: Get the status of a GitHub Pages deployment + description: |- + Gets the current status of a GitHub Pages deployment. + + The authenticated user must have read permission for the GitHub Pages site. + tags: + - repos + operationId: repos/get-pages-deployment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pages-deployment-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pages-deployment-status" + examples: + default: + "$ref": "#/components/examples/pages-deployment-status" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": + post: + summary: Cancel a GitHub Pages deployment + description: |- + Cancels a GitHub Pages deployment. + + The authenticated user must have write permissions for the GitHub Pages site. + tags: + - repos + operationId: repos/cancel-pages-deployment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pages-deployment-id" + responses: + '204': + "$ref": "#/components/responses/no_content" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages "/repos/{owner}/{repo}/pages/health": get: summary: Get a DNS health check for GitHub Pages @@ -31633,7 +32685,9 @@ paths: The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. - To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions. + The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/get-pages-health-check @@ -31674,6 +32728,45 @@ paths: category: pages subcategory: pages "/repos/{owner}/{repo}/private-vulnerability-reporting": + get: + summary: Check if private vulnerability reporting is enabled for a repository + description: Returns a boolean indicating whether or not private vulnerability + reporting is enabled for the repository. For more information, see "[Evaluating + the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + tags: + - repos + operationId: repos/check-private-vulnerability-reporting + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Private vulnerability reporting status + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether or not private vulnerability reporting is + enabled for the repository. + required: + - enabled + examples: + default: + value: + enabled: true + '422': + "$ref": "#/components/responses/bad_request" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos put: summary: Enable private vulnerability reporting for a repository description: Enables private vulnerability reporting for a repository. The authenticated @@ -31877,14 +32970,73 @@ paths: enabledForGitHubApps: true category: repos subcategory: custom-properties + patch: + summary: Create or update custom property values for a repository + description: |- + Create new or update existing custom property values for a repository. + Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + + Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + tags: + - repos + operationId: repos/create-or-update-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the repositories. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - properties + examples: + default: + "$ref": "#/components/examples/create-or-update-custom-properties-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties "/repos/{owner}/{repo}/pulls": get: summary: List pull requests - description: Draft pull requests are available in public repositories with GitHub - Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository - billing plans, and in public and private repositories with GitHub Team and - GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) + description: |- + Lists pull requests in a specified repository. + + Draft pull requests are available in public repositories with GitHub + Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing + plans, and in public and private repositories with GitHub Team and GitHub Enterprise + Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + 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: - pulls operationId: pulls/list @@ -31978,6 +33130,13 @@ paths: To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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: - pulls operationId: pulls/create @@ -32076,8 +33235,16 @@ paths: "/repos/{owner}/{repo}/pulls/comments": get: summary: List review comments in a repository - description: Lists review comments for all pull requests in a repository. By - default, review comments are in ascending order by ID. + description: |- + Lists review comments for all pull requests in a repository. By default, + review comments are in ascending order by ID. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list-review-comments-for-repo @@ -32131,7 +33298,15 @@ paths: "/repos/{owner}/{repo}/pulls/comments/{comment_id}": get: summary: Get a review comment for a pull request - description: Provides details for a review comment. + description: |- + Provides details for a specified review comment. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/get-review-comment @@ -32161,7 +33336,15 @@ paths: subcategory: comments patch: summary: Update a review comment for a pull request - description: Enables you to edit a review comment. + description: |- + Edits the content of a specified review comment. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/update-review-comment @@ -32392,6 +33575,14 @@ paths: * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + + 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`. + - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. tags: - pulls operationId: pulls/get @@ -32417,6 +33608,8 @@ paths: "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" + '406': + "$ref": "#/components/responses/unacceptable" '500': "$ref": "#/components/responses/internal_error" '503': @@ -32432,6 +33625,13 @@ paths: Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + + 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: - pulls operationId: pulls/update @@ -32503,9 +33703,7 @@ paths: description: |- Creates a codespace owned by the authenticated user for the specified pull request. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-with-pr-for-authenticated-user @@ -32607,8 +33805,16 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/comments": get: summary: List review comments on a pull request - description: Lists all review comments for a pull request. By default, review - comments are in ascending order by ID. + description: |- + Lists all review comments for a specified pull request. By default, review comments + are in ascending order by ID. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list-review-comments @@ -32654,16 +33860,22 @@ paths: subcategory: comments post: summary: Create a review comment for a pull request - description: |2- + description: |- + Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." - Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. + If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. - **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/create-review-comment @@ -32694,10 +33906,15 @@ paths: description: The relative path to the file that necessitates a comment. position: type: integer - description: "**This parameter is deprecated. Use `line` instead**. + description: '**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. - For help finding the position value, read the note above." + The position value equals the number of lines down from the first + "@@" hunk header in the file you want to add a comment. The line + just below the "@@" line is position 1, the next line is position + 2, and so on. The position in the diff continues to increase through + lines of whitespace and additional hunks until the beginning of + a new file.' deprecated: true x-github: deprecationDate: '2022-11-01' @@ -32802,6 +34019,13 @@ paths: This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/create-reply-for-review-comment @@ -32855,10 +34079,17 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/commits": get: summary: List commits on a pull request - description: Lists a maximum of 250 commits for a pull request. To receive a - complete commit list for pull requests with more than 250 commits, use the - [List commits](https://docs.github.com/rest/commits/commits#list-commits) + description: |- + Lists a maximum of 250 commits for a pull request. To receive a complete + commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. + + 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: - pulls operationId: pulls/list-commits @@ -32894,8 +34125,18 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/files": get: summary: List pull requests files - description: "**Note:** Responses include a maximum of 3000 files. The paginated - response returns 30 files per page by default." + description: |- + Lists the files in a specified pull request. + + **Note:** Responses include a maximum of 3000 files. The paginated response + returns 30 files per page by default. + + 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: - pulls operationId: pulls/list-files @@ -33222,7 +34463,15 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": get: summary: List reviews for a pull request - description: The list of reviews returns in chronological order. + description: |- + Lists all reviews for a specified pull request. The list of reviews returns in chronological order. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list-reviews @@ -33258,13 +34507,22 @@ paths: post: summary: Create a review for a pull request description: |- + Creates a review on a specified pull request. + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." - **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/create-review @@ -33319,8 +34577,13 @@ paths: type: integer description: The position in the diff where you want to add a review comment. Note this value is not the same as the - line number in the file. For help finding the position value, - read the note below. + line number in the file. The `position` value equals the + number of lines down from the first "@@" hunk header in + the file you want to add a comment. The line just below + the "@@" line is position 1, the next line is position 2, + and so on. The position in the diff continues to increase + through lines of whitespace and additional hunks until the + beginning of a new file. body: type: string description: Text of the review comment. @@ -33377,7 +34640,15 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": get: summary: Get a review for a pull request - description: Retrieves a pull request review by its ID. + description: |- + Retrieves a pull request review by its ID. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/get-review @@ -33408,7 +34679,15 @@ paths: subcategory: reviews put: summary: Update a review for a pull request - description: Update the review summary comment with new text. + description: |- + Updates the contents of a specified review summary comment. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/update-review @@ -33456,8 +34735,15 @@ paths: subcategory: reviews delete: summary: Delete a pending review for a pull request - description: Deletes a pull request review that has not been submitted. Submitted - reviews cannot be deleted. + description: |- + Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/delete-pending-review @@ -33491,7 +34777,15 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": get: summary: List comments for a pull request review - description: List comments for a specific pull request review. + description: |- + Lists comments for a specific pull request review. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list-comments-for-review @@ -33530,9 +34824,19 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": put: summary: Dismiss a review for a pull request - description: "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - you must be a repository administrator or be included in the list of people - or teams who can dismiss pull request reviews." + description: |- + Dismisses a specified review on a pull request. + + **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), + you must be a repository administrator or be included in the list of people or teams + who can dismiss pull request reviews. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/dismiss-review @@ -33589,9 +34893,15 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": post: summary: Submit a review for a pull request - description: Submits a pending review for a pull request. For more information - about creating a pending review for a pull request, see "[Create a review - for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." + description: |- + Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/submit-review @@ -33722,7 +35032,10 @@ paths: description: |- Gets the preferred README for a repository. - READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + 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 file contents. This is the default if you do not specify a media type. + - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). tags: - repos operationId: repos/get-readme @@ -33764,7 +35077,10 @@ paths: description: |- Gets the README from a repository directory. - READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + 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 file contents. This is the default if you do not specify a media type. + - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). tags: - repos operationId: repos/get-readme-in-directory @@ -34212,8 +35528,12 @@ paths: "/repos/{owner}/{repo}/releases/{release_id}": get: summary: Get a release - description: "**Note:** This returns an `upload_url` key corresponding to the - endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia)." + description: |- + Gets a public release with the specified release ID. + + **Note:** This returns an `upload_url` key corresponding to the endpoint + for uploading release assets. This key is a hypermedia resource. For more information, see + "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." tags: - repos operationId: repos/get-release @@ -34226,8 +35546,9 @@ paths: - "$ref": "#/components/parameters/release-id" responses: '200': - description: "**Note:** This returns an `upload_url` key corresponding to - the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia)." + description: '**Note:** This returns an `upload_url` key corresponding to + the endpoint for uploading release assets. This key is a hypermedia resource. + For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: schema: @@ -34393,7 +35714,7 @@ paths: subcategory: assets post: summary: Upload a release asset - description: "This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) + description: "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) @@ -34724,10 +36045,14 @@ paths: description: The name of the ruleset. target: type: string - description: The target of the ruleset. + description: |- + The target of the ruleset + + **Note**: The `push` target is in beta and is subject to change. enum: - branch - tag + - push enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -34938,10 +36263,14 @@ paths: description: The name of the ruleset. target: type: string - description: The target of the ruleset. + description: |- + The target of the ruleset + + **Note**: The `push` target is in beta and is subject to change. enum: - branch - tag + - push enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -35027,10 +36356,10 @@ paths: summary: List secret scanning alerts for a repository description: |- Lists secret scanning alerts for an eligible repository, from newest to oldest. - To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - For public repositories, you may instead use the `public_repo` scope. - GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + + 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/list-alerts-for-repo @@ -35077,10 +36406,10 @@ paths: summary: Get a secret scanning alert description: |- Gets a single secret scanning alert detected in an eligible repository. - To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - For public repositories, you may instead use the `public_repo` scope. - GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + + 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-alert @@ -35117,10 +36446,10 @@ paths: summary: Update a secret scanning alert description: |- Updates the status of a secret scanning alert in an eligible repository. - To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - For public repositories, you may instead use the `public_repo` scope. - GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + + 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. operationId: secret-scanning/update-alert tags: - secret-scanning @@ -35181,10 +36510,10 @@ paths: summary: List locations for a secret scanning alert description: |- Lists all locations for a given secret scanning alert for an eligible repository. - To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - For public repositories, you may instead use the `public_repo` scope. - GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + + 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/list-locations-for-alert @@ -35228,10 +36557,10 @@ paths: summary: List repository security advisories description: |- Lists security advisories in a repository. - You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to. - You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory. + The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. tags: - security-advisories operationId: security-advisories/list-repository-advisories @@ -35256,7 +36585,8 @@ paths: - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - name: per_page - description: Number of advisories to return per page. + description: The number of advisories to return per page. 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: @@ -35301,9 +36631,10 @@ paths: summary: Create a repository security advisory description: |- Creates a new repository security advisory. - You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. - In order to create a draft repository security advisory, you must be a security manager or administrator of that repository. + In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. tags: - security-advisories operationId: security-advisories/create-repository-advisory @@ -35455,12 +36786,13 @@ paths: summary: Get a repository security advisory description: |- Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - You can access any published security advisory on a public repository. - You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to. - You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a + Anyone can access any published security advisory on a public repository. + + The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on the security advisory. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. tags: - security-advisories operationId: security-advisories/get-repository-advisory @@ -35494,10 +36826,11 @@ paths: summary: Update a repository security advisory description: |- Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. - In order to update any security advisory, you must be a security manager or administrator of that repository, + In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, or a collaborator on the repository security advisory. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. tags: - security-advisories operationId: security-advisories/update-repository-advisory @@ -35595,9 +36928,9 @@ paths: You may request a CVE for public repositories, but cannot do so for private repositories. - You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. - In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. tags: - security-advisories operationId: security-advisories/create-repository-advisory-cve-request @@ -35624,13 +36957,55 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: repository-advisories + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": + post: + summary: Create a temporary private fork + description: |- + Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. + + **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + tags: + - security-advisories + operationId: security-advisories/create-fork + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/ghsa_id" + responses: + '202': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/full-repository" + examples: + default: + "$ref": "#/components/examples/full-repository" + '400': + "$ref": "#/components/responses/bad_request" + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories "/repos/{owner}/{repo}/stargazers": get: summary: List stargazers description: |- Lists the people that have starred the repository. - You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + 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.star+json`**: Includes a timestamp of when the star was created. tags: - activity operationId: activity/list-stargazers-for-repo @@ -35673,8 +37048,12 @@ paths: "/repos/{owner}/{repo}/stats/code_frequency": get: summary: Get the weekly commit activity - description: Returns a weekly aggregate of the number of additions and deletions - pushed to a repository. + description: |2 + + Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + + **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains + 10,000 or more commits, a 422 status code will be returned. tags: - repos operationId: repos/get-code-frequency-stats @@ -35701,6 +37080,8 @@ paths: "$ref": "#/components/responses/accepted" '204': "$ref": "#/components/responses/no_content" + '422': + description: Repository contains more than 10,000 commits x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35748,10 +37129,12 @@ paths: Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: - * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). * `a` - Number of additions * `d` - Number of deletions * `c` - Number of commits + + **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. tags: - repos operationId: repos/get-contributors-stats @@ -36279,11 +37662,7 @@ paths: For a public repository, a team is listed only if that team added the public repository explicitly. - Personal access tokens require the following scopes: - * `public_repo` to call this endpoint on a public repository - * `repo` to call this endpoint on a private repository (this scope also includes public repositories) - - This endpoint is not compatible with fine-grained personal access tokens. + OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/list-teams @@ -36538,9 +37917,11 @@ paths: "/repos/{owner}/{repo}/transfer": post: summary: Transfer a repository - description: |- - A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). - You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. + description: A transfer request will need to be accepted by the new owner when + transferring a personal repository to another user. The response will contain + the original `owner`, and the transfer will continue asynchronously. For more + details on the requirements to transfer personal and organization-owned repositories, + see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). tags: - repos operationId: repos/transfer @@ -36708,12 +38089,7 @@ paths: description: |- Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. - **OAuth scope requirements** - - When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - - * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * `repo` scope to create a private repository + OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. tags: - repos operationId: repos/create-using-template @@ -36780,10 +38156,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/repository" + "$ref": "#/components/schemas/full-repository" examples: default: - "$ref": "#/components/examples/repository-3" + "$ref": "#/components/examples/full-repository" headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -36837,416 +38213,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repositories/{repository_id}/environments/{environment_name}/secrets": - get: - summary: List environment secrets - description: |- - Lists all secrets available in an environment without revealing their - encrypted values. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - tags: - - actions - operationId: actions/list-environment-secrets - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#list-environment-secrets - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - secrets - properties: - total_count: - type: integer - secrets: - type: array - items: - "$ref": "#/components/schemas/actions-secret" - examples: - default: - "$ref": "#/components/examples/actions-secret-paginated" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": - get: - summary: Get an environment public key - description: |- - Get the public key for an environment, which you need to encrypt environment - secrets. You need to encrypt a secret before you can create or update secrets. - - Anyone with read access to the repository can use this endpoint. - If the repository is private you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - tags: - - actions - operationId: actions/get-environment-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-public-key" - examples: - default: - "$ref": "#/components/examples/actions-public-key" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": - get: - summary: Get an environment secret - description: |- - Gets a single environment secret without revealing its encrypted value. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - tags: - - actions - operationId: actions/get-environment-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - - "$ref": "#/components/parameters/secret-name" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-secret" - examples: - default: - "$ref": "#/components/examples/actions-secret" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - put: - summary: Create or update an environment secret - description: |- - Creates or updates an environment secret with an encrypted value. 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)." - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - tags: - - actions - operationId: actions/create-or-update-environment-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - - "$ref": "#/components/parameters/secret-name" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - encrypted_value: - type: string - description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get an environment public - key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) - endpoint. - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - type: string - description: ID of the key you used to encrypt the secret. - required: - - encrypted_value - - key_id - examples: - default: - value: - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - responses: - '201': - description: Response when creating a secret - content: - application/json: - schema: - "$ref": "#/components/schemas/empty-object" - examples: - default: - value: - '204': - description: Response when updating a secret - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - delete: - summary: Delete an environment secret - description: |- - Deletes a secret in an environment using the secret name. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - tags: - - actions - operationId: actions/delete-environment-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - - "$ref": "#/components/parameters/secret-name" - responses: - '204': - description: Default response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/repositories/{repository_id}/environments/{environment_name}/variables": - get: - summary: List environment variables - description: |- - Lists all environment variables. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `environments:read` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. - tags: - - actions - operationId: actions/list-environment-variables - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#list-environment-variables - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - - "$ref": "#/components/parameters/variables-per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - variables - properties: - total_count: - type: integer - variables: - type: array - items: - "$ref": "#/components/schemas/actions-variable" - examples: - default: - "$ref": "#/components/examples/actions-variables-paginated" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - post: - summary: Create an environment variable - description: |- - Create an environment variable that you can reference in a GitHub Actions workflow. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `environment:write` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. - tags: - - actions - operationId: actions/create-environment-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#create-an-environment-variable - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the variable. - value: - type: string - description: The value of the variable. - required: - - name - - value - examples: - default: - value: - name: USERNAME - value: octocat - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/empty-object" - examples: - default: - value: - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": - get: - summary: Get an environment variable - description: |- - Gets a specific variable in an environment. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `environments:read` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. - tags: - - actions - operationId: actions/get-environment-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#get-an-environment-variable - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - - "$ref": "#/components/parameters/variable-name" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-variable" - examples: - default: - "$ref": "#/components/examples/actions-variable" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - patch: - summary: Update an environment variable - description: |- - Updates an environment variable that you can reference in a GitHub Actions workflow. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `environment:write` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. - tags: - - actions - operationId: actions/update-environment-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#update-an-environment-variable - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/variable-name" - - "$ref": "#/components/parameters/environment-name" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the variable. - value: - type: string - description: The value of the variable. - examples: - default: - value: - name: USERNAME - value: octocat - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - delete: - summary: Delete an environment variable - description: |- - Deletes an environment variable using the variable name. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `environment:write` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. - tags: - - actions - operationId: actions/delete-environment-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/variable-name" - - "$ref": "#/components/parameters/environment-name" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables "/search/code": get: summary: Search code @@ -38004,7 +38970,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. - List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List all discussions on a team's page. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/list-discussions-legacy @@ -38044,9 +39012,11 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. - Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Creates a new discussion post on a team's page. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/create-discussion-legacy @@ -38108,7 +39078,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. - Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Get a specific discussion on a team's page. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/get-discussion-legacy @@ -38141,7 +39113,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. - Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Edits the title and body text of a discussion post. Only the parameters you provide are updated. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/update-discussion-legacy @@ -38191,7 +39165,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. - Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Delete a discussion from a team's page. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/delete-discussion-legacy @@ -38218,7 +39194,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. - List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List all comments on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/list-discussion-comments-legacy @@ -38259,9 +39237,11 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Creates a new comment on a team discussion. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/create-discussion-comment-legacy @@ -38312,7 +39292,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Get a specific comment on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/get-discussion-comment-legacy @@ -38346,7 +39328,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Edits the body text of a discussion comment. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/update-discussion-comment-legacy @@ -38396,7 +39380,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Deletes a comment on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/delete-discussion-comment-legacy @@ -38424,7 +39410,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/list-for-team-discussion-comment-legacy @@ -38481,7 +39469,11 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + + A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/create-for-team-discussion-comment-legacy @@ -38542,7 +39534,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/list-for-team-discussion-legacy @@ -38598,7 +39592,11 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + + A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/create-for-team-discussion-legacy @@ -38789,7 +39787,7 @@ paths: **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - teams operationId: teams/add-member-legacy @@ -39101,7 +40099,7 @@ paths: what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you''ll need to set `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."' + information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' enum: - read - write @@ -39262,7 +40260,7 @@ paths: To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. - Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - teams operationId: teams/add-or-update-repo-permissions-legacy @@ -39386,10 +40384,8 @@ paths: "/user": get: summary: Get the authenticated user - description: |- - If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information. - - If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + description: OAuth app tokens and personal access tokens (classic) need the + `user` scope in order for the response to include private profile information. tags: - users operationId: users/get-authenticated @@ -39646,9 +40642,7 @@ paths: description: |- Lists the authenticated user's codespaces. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-for-authenticated-user @@ -39701,9 +40695,7 @@ paths: This endpoint requires either a `repository_id` OR a `pull_request` but not both. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-for-authenticated-user @@ -39859,9 +40851,9 @@ paths: Lists all development environment secrets available for a user's codespaces without revealing their encrypted values. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + The authenticated user must have Codespaces access to use this endpoint. - GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-secrets-for-authenticated-user @@ -39905,9 +40897,9 @@ paths: description: |- Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + The authenticated user must have Codespaces access to use this endpoint. - GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-public-key-for-authenticated-user @@ -39935,9 +40927,9 @@ paths: description: |- Gets a development environment secret available to a user's codespaces without revealing its encrypted value. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + The authenticated user must have Codespaces access to use this endpoint. - GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-secret-for-authenticated-user @@ -39967,9 +40959,9 @@ paths: Creates or updates a development environment secret for a user's codespace with an encrypted value. 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)." - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. + The authenticated user must have Codespaces access to use this endpoint. - GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-or-update-secret-for-authenticated-user @@ -40043,9 +41035,9 @@ paths: description: |- Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + The authenticated user must have Codespaces access to use this endpoint. - GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-secret-for-authenticated-user @@ -40068,9 +41060,9 @@ paths: description: |- List the repositories that have been granted the ability to use a user's development environment secret. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + The authenticated user must have Codespaces access to use this endpoint. - GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-repositories-for-secret-for-authenticated-user @@ -40117,9 +41109,9 @@ paths: description: |- Select the repositories that will use a user's development environment secret. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + The authenticated user must have Codespaces access to use this endpoint. - GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/set-repositories-for-secret-for-authenticated-user @@ -40174,8 +41166,10 @@ paths: summary: Add a selected repository to a user secret description: |- Adds a repository to the selected repositories for a user's development environment secret. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. + + The authenticated user must have Codespaces access to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/add-repository-for-secret-for-authenticated-user @@ -40209,8 +41203,10 @@ paths: summary: Remove a selected repository from a user secret description: |- Removes a repository from the selected repositories for a user's development environment secret. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + + The authenticated user must have Codespaces access to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/remove-repository-for-secret-for-authenticated-user @@ -40246,9 +41242,7 @@ paths: description: |- Gets information about a user's codespace. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-for-authenticated-user @@ -40289,9 +41283,7 @@ paths: If you specify a new machine type it will be applied the next time your codespace is started. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/update-for-authenticated-user @@ -40350,9 +41342,7 @@ paths: description: |- Deletes a user's codespace. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-for-authenticated-user @@ -40387,9 +41377,7 @@ paths: If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. - You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/export-for-authenticated-user @@ -40429,9 +41417,7 @@ paths: description: |- Gets information about an export of a codespace. - You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-export-details-for-authenticated-user @@ -40464,9 +41450,7 @@ paths: description: |- List the machine types a codespace can transition to use. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/codespace-machines-for-authenticated-user @@ -40520,9 +41504,7 @@ paths: This will fail for a codespace that is already published, meaning it has an associated repository. - You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/publish-for-authenticated-user @@ -40578,9 +41560,7 @@ paths: description: |- Starts a user's codespace. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/start-for-authenticated-user @@ -40630,9 +41610,7 @@ paths: description: |- Stops a user's codespace. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/stop-for-authenticated-user @@ -40669,7 +41647,8 @@ paths: summary: Get list of conflicting packages during Docker migration for authenticated-user description: |- Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. tags: - packages operationId: packages/list-docker-migration-conflicting-packages-for-authenticated-user @@ -40754,8 +41733,11 @@ paths: "/user/emails": get: summary: List email addresses for the authenticated user - description: Lists all of your email addresses, and specifies which one is visible - to the public. This endpoint is accessible with the `user:email` scope. + description: |- + Lists all of your email addresses, and specifies which one is visible + to the public. + + OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. tags: - users operationId: users/list-emails-for-authenticated-user @@ -40795,7 +41777,8 @@ paths: subcategory: emails post: summary: Add an email address for the authenticated user - description: This endpoint is accessible with the `user` scope. + description: OAuth app tokens and personal access tokens (classic) need the + `user` scope to use this endpoint. tags: - users operationId: users/add-email-for-authenticated-user @@ -40874,7 +41857,8 @@ paths: subcategory: emails delete: summary: Delete an email address for the authenticated user - description: This endpoint is accessible with the `user` scope. + description: OAuth app tokens and personal access tokens (classic) need the + `user` scope to use this endpoint. tags: - users operationId: users/delete-email-for-authenticated-user @@ -41053,9 +42037,9 @@ paths: put: summary: Follow a user description: |- - Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. tags: - users operationId: users/follow @@ -41082,8 +42066,8 @@ paths: subcategory: followers delete: summary: Unfollow a user - description: Unfollowing a user requires the user to be logged in and authenticated - with basic auth or OAuth with the `user:follow` scope. + description: OAuth app tokens and personal access tokens (classic) need the + `user:follow` scope to use this endpoint. tags: - users operationId: users/unfollow @@ -41111,8 +42095,10 @@ paths: "/user/gpg_keys": get: summary: List GPG keys for the authenticated user - description: Lists the current user's GPG keys. Requires that you are authenticated - via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + Lists the current user's GPG keys. + + OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. tags: - users operationId: users/list-gpg-keys-for-authenticated-user @@ -41152,9 +42138,10 @@ paths: subcategory: gpg-keys post: summary: Create a GPG key for the authenticated user - description: Adds a GPG key to the authenticated user's GitHub account. Requires - that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` - [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + Adds a GPG key to the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. operationId: users/create-gpg-key-for-authenticated-user tags: - users @@ -41215,8 +42202,10 @@ paths: "/user/gpg_keys/{gpg_key_id}": get: summary: Get a GPG key for the authenticated user - description: View extended details for a single GPG key. Requires that you are - authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + View extended details for a single GPG key. + + OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. tags: - users operationId: users/get-gpg-key-for-authenticated-user @@ -41250,9 +42239,10 @@ paths: subcategory: gpg-keys delete: summary: Delete a GPG key for the authenticated user - description: Removes a GPG key from the authenticated user's GitHub account. - Requires that you are authenticated via Basic Auth or via OAuth with at least - `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + Removes a GPG key from the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. tags: - users operationId: users/delete-gpg-key-for-authenticated-user @@ -41285,8 +42275,6 @@ paths: description: |- Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. You can find the permissions for the installation under the `permissions` key. @@ -41342,8 +42330,6 @@ paths: The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - The access the user has to each repository is included in the hash under the `permissions` key. tags: - apps @@ -41395,10 +42381,8 @@ paths: "/user/installations/{installation_id}/repositories/{repository_id}": put: summary: Add a repository to an app installation - description: |- - Add a single repository to an installation. The authenticated user must have admin access to the repository. - - You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + description: Add a single repository to an installation. The authenticated user + must have admin access to the repository. tags: - apps operationId: apps/add-repo-to-installation-for-authenticated-user @@ -41424,10 +42408,9 @@ paths: subcategory: installations delete: summary: Remove a repository from an app installation - description: |- - Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. - - You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + description: Remove a single repository from an installation. The authenticated + user must have admin access to the repository. The installation must have + the `repository_selection` of `selected`. tags: - apps operationId: apps/remove-repo-from-installation-for-authenticated-user @@ -41554,6 +42537,13 @@ paths: reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + 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-for-authenticated-user @@ -41633,9 +42623,10 @@ paths: "/user/keys": get: summary: List public SSH keys for the authenticated user - description: Lists the public SSH keys for the authenticated user's GitHub account. - Requires that you are authenticated via Basic Auth or via OAuth with at least - `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + Lists the public SSH keys for the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. tags: - users operationId: users/list-public-ssh-keys-for-authenticated-user @@ -41675,9 +42666,10 @@ paths: subcategory: keys post: summary: Create a public SSH key for the authenticated user - description: Adds a public SSH key to the authenticated user's GitHub account. - Requires that you are authenticated via Basic Auth, or OAuth with at least - `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + Adds a public SSH key to the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. operationId: users/create-public-ssh-key-for-authenticated-user tags: - users @@ -41736,9 +42728,10 @@ paths: "/user/keys/{key_id}": get: summary: Get a public SSH key for the authenticated user - description: View extended details for a single public SSH key. Requires that - you are authenticated via Basic Auth or via OAuth with at least `read:public_key` - [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + View extended details for a single public SSH key. + + OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. tags: - users operationId: users/get-public-ssh-key-for-authenticated-user @@ -41772,9 +42765,10 @@ paths: subcategory: keys delete: summary: Delete a public SSH key for the authenticated user - description: Removes a public SSH key from the authenticated user's GitHub account. - Requires that you are authenticated via Basic Auth or via OAuth with at least - `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + Removes a public SSH key from the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. tags: - users operationId: users/delete-public-ssh-key-for-authenticated-user @@ -41802,10 +42796,7 @@ paths: "/user/marketplace_purchases": get: summary: List subscriptions for the authenticated user - description: Lists the active subscriptions for the authenticated user. GitHub - Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), - created for a user who has authorized your GitHub App, to access this endpoint. - OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + description: Lists the active subscriptions for the authenticated user. tags: - apps operationId: apps/list-subscriptions-for-authenticated-user @@ -41844,10 +42835,7 @@ paths: "/user/marketplace_purchases/stubbed": get: summary: List subscriptions for the authenticated user (stubbed) - description: Lists the active subscriptions for the authenticated user. GitHub - Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), - created for a user who has authorized your GitHub App, to access this endpoint. - OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + description: Lists the active subscriptions for the authenticated user. tags: - apps operationId: apps/list-subscriptions-for-authenticated-user-stubbed @@ -42380,9 +43368,7 @@ paths: description: |- List organizations for the authenticated user. - **OAuth scope requirements** - - This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. tags: - orgs operationId: orgs/list-for-authenticated-user @@ -42424,7 +43410,7 @@ paths: description: |- Lists packages owned by the authenticated user within the user's namespace. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-authenticated-user @@ -42477,7 +43463,7 @@ paths: description: |- Gets a specific package for a package owned by the authenticated user. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-authenticated-user @@ -42507,8 +43493,7 @@ paths: description: |- Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-authenticated-user @@ -42542,7 +43527,7 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-authenticated-user @@ -42578,7 +43563,7 @@ paths: description: |- Lists package versions for a package owned by the authenticated user. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-authenticated-user @@ -42629,7 +43614,7 @@ paths: description: |- Gets a specific package version for a package owned by the authenticated user. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-authenticated-user @@ -42660,8 +43645,9 @@ paths: description: |- Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. - To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + The authenticated user must have admin permissions in the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-authenticated-user @@ -42696,7 +43682,7 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-authenticated-user @@ -42788,9 +43774,12 @@ paths: "/user/public_emails": get: summary: List public email addresses for the authenticated user - description: Lists your publicly visible email address, which you can set with - the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) - endpoint. This endpoint is accessible with the `user:email` scope. + description: |- + Lists your publicly visible email address, which you can set with the + [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + endpoint. + + OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. tags: - users operationId: users/list-public-emails-for-authenticated-user @@ -42934,12 +43923,7 @@ paths: description: |- Creates a new repository for the authenticated user. - **OAuth scope requirements** - - When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - - * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * `repo` scope to create a private repository. + OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. tags: - repos operationId: repos/create-for-authenticated-user @@ -43118,10 +44102,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/repository" + "$ref": "#/components/schemas/full-repository" examples: default: - "$ref": "#/components/examples/repository" + "$ref": "#/components/examples/full-repository" headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -43284,8 +44268,10 @@ paths: subcategory: social-accounts post: summary: Add social accounts for the authenticated user - description: Add one or more social accounts to the authenticated user's profile. - This endpoint is accessible with the `user` scope. + description: |- + Add one or more social accounts to the authenticated user's profile. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. tags: - users operationId: users/add-social-account-for-authenticated-user @@ -43350,8 +44336,10 @@ paths: subcategory: social-accounts delete: summary: Delete social accounts for the authenticated user - description: Deletes one or more social accounts from the authenticated user's - profile. This endpoint is accessible with the `user` scope. + description: |- + Deletes one or more social accounts from the authenticated user's profile. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. tags: - users operationId: users/delete-social-account-for-authenticated-user @@ -43408,10 +44396,10 @@ paths: "/user/ssh_signing_keys": get: summary: List SSH signing keys for the authenticated user - description: Lists the SSH signing keys for the authenticated user's GitHub - account. You must authenticate with Basic Authentication, or you must authenticate - with OAuth with at least `read:ssh_signing_key` scope. For more information, - see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + description: |- + Lists the SSH signing keys for the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. tags: - users operationId: users/list-ssh-signing-keys-for-authenticated-user @@ -43452,10 +44440,10 @@ paths: subcategory: ssh-signing-keys post: summary: Create a SSH signing key for the authenticated user - description: Creates an SSH signing key for the authenticated user's GitHub - account. You must authenticate with Basic Authentication, or you must authenticate - with OAuth with at least `write:ssh_signing_key` scope. For more information, - see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + description: |- + Creates an SSH signing key for the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. operationId: users/create-ssh-signing-key-for-authenticated-user tags: - users @@ -43516,10 +44504,10 @@ paths: "/user/ssh_signing_keys/{ssh_signing_key_id}": get: summary: Get an SSH signing key for the authenticated user - description: Gets extended details for an SSH signing key. You must authenticate - with Basic Authentication, or you must authenticate with OAuth with at least - `read:ssh_signing_key` scope. For more information, see "[Understanding scopes - for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + description: |- + Gets extended details for an SSH signing key. + + OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. tags: - users operationId: users/get-ssh-signing-key-for-authenticated-user @@ -43553,10 +44541,10 @@ paths: subcategory: ssh-signing-keys delete: summary: Delete an SSH signing key for the authenticated user - description: Deletes an SSH signing key from the authenticated user's GitHub - account. You must authenticate with Basic Authentication, or you must authenticate - with OAuth with at least `admin:ssh_signing_key` scope. For more information, - see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + description: |- + Deletes an SSH signing key from the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. tags: - users operationId: users/delete-ssh-signing-key-for-authenticated-user @@ -43587,7 +44575,9 @@ paths: description: |- Lists repositories the authenticated user has starred. - You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + 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.star+json`**: Includes a timestamp of when the star was created. tags: - activity operationId: activity/list-repos-starred-by-authenticated-user @@ -43669,7 +44659,7 @@ paths: put: summary: Star a repository for the authenticated user description: Note that you'll need to set `Content-Length` to zero when calling - out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - activity operationId: activity/star-repo-for-authenticated-user @@ -43766,15 +44756,13 @@ paths: "/user/teams": get: summary: List teams for the authenticated user - description: List all of the teams across all of the organizations to which - the authenticated user belongs. This method requires `user`, `repo`, or `read:org` - [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) - when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). - When using a fine-grained personal access token, the resource owner of the - token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), - and have at least read-only member organization permissions. The response - payload only contains the teams from a single organization when using a fine-grained - personal access token. + description: |- + List all of the teams across all of the organizations to which the authenticated + user belongs. + + OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + + When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. tags: - teams operationId: teams/list-for-authenticated-user @@ -43856,9 +44844,7 @@ paths: description: |- Provides publicly available information about someone with a GitHub account. - GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" - - The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). + The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". tags: @@ -43895,7 +44881,8 @@ paths: summary: Get list of conflicting packages during Docker migration for user description: |- Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. tags: - packages operationId: packages/list-docker-migration-conflicting-packages-for-user @@ -44192,14 +45179,11 @@ paths: get: summary: Get contextual information for a user description: |- - Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. - The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: + The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). - ```shell - curl -u username:token - https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - ``` + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - users operationId: users/get-context-for-user @@ -44355,7 +45339,7 @@ paths: description: |- Lists all packages in a user's namespace for which the requesting user has access. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-user @@ -44413,7 +45397,7 @@ paths: description: |- Gets a specific package metadata for a public package owned by a user. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-user @@ -44444,9 +45428,9 @@ paths: description: |- Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-user @@ -44481,9 +45465,9 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-user @@ -44520,7 +45504,7 @@ paths: description: |- Lists package versions for a public package owned by a specified user. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-user @@ -44560,7 +45544,7 @@ paths: description: |- Gets a specific package version for a public package owned by a specified user. - At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-user @@ -44592,9 +45576,9 @@ paths: description: |- Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. - To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-user @@ -44630,9 +45614,9 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-user @@ -44708,9 +45692,9 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repos and following - users. If you are authenticated as the given user, you will see private events. - Otherwise, you'll only see public events. + description: These are events that you've received by watching repositories + and following users. If you are authenticated as the given user, you will + see private events. Otherwise, you'll only see public events. tags: - activity operationId: activity/list-received-events-for-user @@ -44772,8 +45756,7 @@ paths: "/users/{username}/repos": get: summary: List repositories for a user - description: 'Lists public repositories for the specified user. Note: For GitHub - AE, this endpoint will list internal repositories for the specified user.' + description: Lists public repositories for the specified user. tags: - repos operationId: repos/list-for-user @@ -44845,7 +45828,7 @@ paths: Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - Access tokens must have the `user` scope. + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. operationId: billing/get-github-actions-billing-user tags: - billing @@ -44877,7 +45860,7 @@ paths: Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - Access tokens must have the `user` scope. + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. operationId: billing/get-github-packages-billing-user tags: - billing @@ -44909,7 +45892,7 @@ paths: Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - Access tokens must have the `user` scope. + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. operationId: billing/get-shared-storage-billing-user tags: - billing @@ -45009,7 +45992,9 @@ paths: description: |- Lists repositories a user has starred. - You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + 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.star+json`**: Includes a timestamp of when the star was created. tags: - activity operationId: activity/list-repos-starred-by-user @@ -46865,7 +47850,8 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. - description: A Dependabot alert was automatically closed. + description: A Dependabot alert was automatically closed by a Dependabot auto-triage + rule. operationId: dependabot-alert/auto-dismissed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert @@ -46933,7 +47919,9 @@ webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. - description: A Dependabot alert was automatically reopened. + description: A Dependabot alert, that had been automatically closed by a Dependabot + auto-triage rule, was automatically reopened because the alert metadata or + rule changed. operationId: dependabot-alert/auto-reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert @@ -53392,12 +54380,14 @@ webhooks: project-card-converted: post: summary: |- - This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A note in a classic project was converted to an issue. + description: A note in a project (classic) was converted to an issue. operationId: project-card/converted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card @@ -53458,12 +54448,14 @@ webhooks: project-card-created: post: summary: |- - This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card was added to a classic project. + description: A card was added to a project (classic). operationId: project-card/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card @@ -53524,12 +54516,14 @@ webhooks: project-card-deleted: post: summary: |- - This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card on a classic project was deleted. + description: A card on a project (classic) was deleted. operationId: project-card/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card @@ -53590,12 +54584,14 @@ webhooks: project-card-edited: post: summary: |- - This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A note on a classic project was edited. + description: A note on a project (classic) was edited. operationId: project-card/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card @@ -53656,13 +54652,15 @@ webhooks: project-card-moved: post: summary: |- - This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card on a classic project was moved to another column or to another - position in its column. + description: A card on a project (classic) was moved to another column or to + another position in its column. operationId: project-card/moved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card @@ -53723,12 +54721,14 @@ webhooks: project-closed: post: summary: |- - This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A classic project was closed. + description: A project (classic) was closed. operationId: project/closed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project @@ -53789,12 +54789,14 @@ webhooks: project-column-created: post: summary: |- - This event occurs when there is activity relating to a column on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was added to a classic project. + description: A column was added to a project (classic). operationId: project-column/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column @@ -53855,12 +54857,14 @@ webhooks: project-column-deleted: post: summary: |- - This event occurs when there is activity relating to a column on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - For activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was deleted from a classic project. + description: A column was deleted from a project (classic). operationId: project-column/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column @@ -53921,12 +54925,14 @@ webhooks: project-column-edited: post: summary: |- - This event occurs when there is activity relating to a column on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: The name of a column on a classic project was changed. + description: The name of a column on a project (classic) was changed. operationId: project-column/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column @@ -53987,12 +54993,14 @@ webhooks: project-column-moved: post: summary: |- - This event occurs when there is activity relating to a column on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - For activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was moved to a new position on a classic project. + description: A column was moved to a new position on a project (classic). operationId: project-column/moved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column @@ -54053,12 +55061,14 @@ webhooks: project-created: post: summary: |- - This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A classic project was created. + description: A project (classic) was created. operationId: project/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project @@ -54119,12 +55129,14 @@ webhooks: project-deleted: post: summary: |- - This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A classic project was deleted. + description: A project (classic) was deleted. operationId: project/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project @@ -54185,12 +55197,14 @@ webhooks: project-edited: post: summary: |- - This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: The name or description of a classic project was changed. + description: The name or description of a project (classic) was changed. operationId: project/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project @@ -54251,12 +55265,14 @@ webhooks: project-reopened: post: summary: |- - This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A classic project was closed. + description: A project (classic) was closed. operationId: project/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project @@ -58093,11 +59109,9 @@ webhooks: repository-dispatch-sample.collected: post: summary: |- - This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). + This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` - request body. operationId: repository-dispatch/sample.collected externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch @@ -59403,16 +60417,18 @@ webhooks: - repository - organization - app - security-advisory-published: + secret-scanning-alert-validated: post: summary: |- - This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A security advisory was published to the GitHub community. - operationId: security-advisory/published + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + 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 alert was validated. + operationId: secret-scanning-alert/validated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -59454,7 +60470,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59462,18 +60478,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: secret_scanning_alert supported-webhook-types: + - repository + - organization - app - security-advisory-updated: + security-advisory-published: post: summary: |- - This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: The metadata or description of a security advisory was changed, - or the security advisory was withdrawn. - operationId: security-advisory/updated + description: A security advisory was published to the GitHub community. + operationId: security-advisory/published externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: @@ -59517,7 +60534,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-security-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59528,14 +60545,14 @@ webhooks: subcategory: security_advisory supported-webhook-types: - app - security-advisory-withdrawn: + security-advisory-updated: post: summary: |- - This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A previously published security advisory was withdrawn. - operationId: security-advisory/withdrawn + description: The metadata or description of a security advisory was changed. + operationId: security-advisory/updated externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: @@ -59579,7 +60596,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59590,15 +60607,16 @@ webhooks: subcategory: security_advisory supported-webhook-types: - app - security-and-analysis: + security-advisory-withdrawn: post: summary: |- - This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - operationId: security-and-analysis + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + description: A previously published security advisory was withdrawn. + operationId: security-advisory/withdrawn externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -59640,7 +60658,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59648,24 +60666,18 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_and_analysis + subcategory: security_advisory supported-webhook-types: - - repository - - organization - app - sponsorship-cancelled: + security-and-analysis: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsorship was cancelled and the last billing cycle has ended. + This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/cancelled + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + operationId: security-and-analysis externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis parameters: - name: User-Agent in: header @@ -59707,7 +60719,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-and-analysis" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59715,82 +60727,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: security_and_analysis supported-webhook-types: - - sponsors_listing - sponsorship-created: + - repository + - organization + - app + sponsorship-cancelled: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor created a sponsorship for a sponsored account. This event - occurs once the payment is successfully processed. - operationId: sponsorship/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship - 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-sponsorship-created" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sponsorship - supported-webhook-types: - - sponsors_listing - sponsorship-edited: - post: - summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + description: |- + A sponsorship was cancelled and the last billing cycle has ended. - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A monthly sponsor changed who can see their sponsorship. If you - recognize your sponsors publicly, you may want to update your sponsor recognition - to reflect the change when this event occurs. - operationId: sponsorship/edited + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/cancelled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -59834,7 +60786,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59845,17 +60797,15 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-pending-cancellation: + sponsorship-created: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. - - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/pending-cancellation + description: A sponsor created a sponsorship for a sponsored account. This event + occurs once the payment is successfully processed. + operationId: sponsorship/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -59899,7 +60849,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" + "$ref": "#/components/schemas/webhook-sponsorship-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59910,15 +60860,16 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-pending-tier-change: + sponsorship-edited: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor scheduled a downgrade to a lower sponsorship tier. The - new tier will become effective on their next billing date. - operationId: sponsorship/pending-tier-change + description: A monthly sponsor changed who can see their sponsorship. If you + recognize your sponsors publicly, you may want to update your sponsor recognition + to reflect the change when this event occurs. + operationId: sponsorship/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -59962,7 +60913,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" + "$ref": "#/components/schemas/webhook-sponsorship-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59973,17 +60924,17 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-tier-changed: + sponsorship-pending-cancellation: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor changed the tier of their sponsorship and the change - has taken effect. If a sponsor upgraded their tier, the change took effect - immediately. If a sponsor downgraded their tier, the change took effect at - the beginning of the sponsor's next billing cycle. - operationId: sponsorship/tier-changed + description: |- + A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. + + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/pending-cancellation externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -60027,7 +60978,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" + "$ref": "#/components/schemas/webhook-sponsorship-pending-cancellation" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60038,16 +60989,17 @@ webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - star-created: + sponsorship-pending-tier-change: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone starred a repository. - operationId: star/created + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A sponsor scheduled a downgrade to a lower sponsorship tier. The + new tier will become effective on their next billing date. + operationId: sponsorship/pending-tier-change externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -60089,7 +61041,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-created" + "$ref": "#/components/schemas/webhook-sponsorship-pending-tier-change" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60097,21 +61049,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - star-deleted: + - sponsors_listing + sponsorship-tier-changed: post: summary: |- - This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone unstarred the repository. - operationId: star/deleted + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A sponsor changed the tier of their sponsorship and the change + has taken effect. If a sponsor upgraded their tier, the change took effect + immediately. If a sponsor downgraded their tier, the change took effect at + the beginning of the sponsor's next billing cycle. + operationId: sponsorship/tier-changed externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#star + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: - name: User-Agent in: header @@ -60153,7 +61106,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-star-deleted" + "$ref": "#/components/schemas/webhook-sponsorship-tier-changed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60161,20 +61114,19 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: star + subcategory: sponsorship supported-webhook-types: - - repository - - organization - - app - status: + - sponsors_listing + star-created: post: summary: |- - This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. - operationId: status + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone starred a repository. + operationId: star/created externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#status + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -60216,7 +61168,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-status" + "$ref": "#/components/schemas/webhook-star-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60224,23 +61176,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: status + subcategory: star supported-webhook-types: - repository - organization - app - team-add: + star-deleted: post: summary: |- - This event occurs when a team is added to a repository. - For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." - - For activity relating to teams, see the `teams` event. + This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/rest/activity/starring)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - operationId: team-add + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone unstarred the repository. + operationId: star/deleted externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add + url: https://docs.github.com/webhooks/webhook-events-and-payloads#star parameters: - name: User-Agent in: header @@ -60282,7 +61232,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-add" + "$ref": "#/components/schemas/webhook-star-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60290,22 +61240,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team_add + subcategory: star supported-webhook-types: - repository - organization - app - team-added-to-repository: + status: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/rest/commits/statuses)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was granted access to a repository. - operationId: team/added-to-repository + To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission. + operationId: status externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#status parameters: - name: User-Agent in: header @@ -60347,7 +61295,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-added-to-repository" + "$ref": "#/components/schemas/webhook-status" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60355,22 +61303,23 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: status supported-webhook-types: + - repository - organization - - business - app - team-created: + team-add: post: summary: |- - This event occurs when there is activity relating to teams in an organization. - For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." + This event occurs when a team is added to a repository. + For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)." + + For activity relating to teams, see the `teams` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was created. - operationId: team/created + operationId: team-add externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#team + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team_add parameters: - name: User-Agent in: header @@ -60412,7 +61361,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-created" + "$ref": "#/components/schemas/webhook-team-add" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60420,20 +61369,20 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: team + subcategory: team_add supported-webhook-types: + - repository - organization - - business - app - team-deleted: + team-added-to-repository: post: summary: |- This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team was deleted. - operationId: team/deleted + description: A team was granted access to a repository. + operationId: team/added-to-repository externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: @@ -60477,7 +61426,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-deleted" + "$ref": "#/components/schemas/webhook-team-added-to-repository" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60490,15 +61439,15 @@ webhooks: - organization - business - app - team-edited: + team-created: post: summary: |- This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: The name, description, or visibility of a team was changed. - operationId: team/edited + description: A team was created. + operationId: team/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: @@ -60542,7 +61491,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-edited" + "$ref": "#/components/schemas/webhook-team-created" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60555,15 +61504,15 @@ webhooks: - organization - business - app - team-removed-from-repository: + team-deleted: post: summary: |- This event occurs when there is activity relating to teams in an organization. For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. - description: A team's access to a repository was removed. - operationId: team/removed-from-repository + description: A team was deleted. + operationId: team/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: @@ -60607,7 +61556,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-team-removed-from-repository" + "$ref": "#/components/schemas/webhook-team-deleted" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60620,16 +61569,17 @@ webhooks: - organization - business - app - watch-started: + team-edited: post: summary: |- - This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/rest/activity/watching)" in the REST API documentation. + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. - description: Someone started watching the repository. - operationId: watch/started + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: The name, description, or visibility of a team was changed. + operationId: team/edited externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#watch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -60671,7 +61621,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-watch-started" + "$ref": "#/components/schemas/webhook-team-edited" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60679,22 +61629,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: watch + subcategory: team supported-webhook-types: - - repository - organization + - business - app - workflow-dispatch: + team-removed-from-repository: post: summary: |- - This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow)." - - For activity relating to workflow runs, use the `workflow_run` event. + This event occurs when there is activity relating to teams in an organization. + For more information, see "[About teams](https://docs.github.com/organizations/organizing-members-into-teams/about-teams)." - To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - operationId: workflow-dispatch + To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission. + description: A team's access to a repository was removed. + operationId: team/removed-from-repository externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch + url: https://docs.github.com/webhooks/webhook-events-and-payloads#team parameters: - name: User-Agent in: header @@ -60736,7 +61686,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-workflow-dispatch" + "$ref": "#/components/schemas/webhook-team-removed-from-repository" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60744,23 +61694,21 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: workflow_dispatch + subcategory: team supported-webhook-types: + - organization + - business - app - workflow-job-completed: + watch-started: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. - - For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/rest/activity/watching)" in the REST API documentation. - To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A job in a workflow run finished. This event occurs when a job - in a workflow is completed, regardless of whether the job was successful or - unsuccessful. - operationId: workflow-job/completed + To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission. + description: Someone started watching the repository. + operationId: watch/started externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/webhooks/webhook-events-and-payloads#watch parameters: - name: User-Agent in: header @@ -60802,7 +61750,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-workflow-job-completed" + "$ref": "#/components/schemas/webhook-watch-started" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60810,24 +61758,22 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: workflow_job + subcategory: watch supported-webhook-types: - - business - repository - organization - app - workflow-job-in-progress: + workflow-dispatch: post: summary: |- - This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. + This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/actions/managing-workflow-runs/manually-running-a-workflow)." - For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + For activity relating to workflow runs, use the `workflow_run` event. - To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A job in a workflow run started processing on a runner. - operationId: workflow-job/in-progress + To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. + operationId: workflow-dispatch externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job + url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_dispatch parameters: - name: User-Agent in: header @@ -60869,7 +61815,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-workflow-job-in-progress" + "$ref": "#/components/schemas/webhook-workflow-dispatch" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60877,13 +61823,10 @@ webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: workflow_job + subcategory: workflow_dispatch supported-webhook-types: - - business - - repository - - organization - app - workflow-job-queued: + workflow-job-completed: post: summary: |- This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. @@ -60891,8 +61834,10 @@ webhooks: For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A job in a workflow run was created. - operationId: workflow-job/queued + description: A job in a workflow run finished. This event occurs when a job + in a workflow is completed, regardless of whether the job was successful or + unsuccessful. + operationId: workflow-job/completed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job parameters: @@ -60936,7 +61881,7 @@ webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-workflow-job-queued" + "$ref": "#/components/schemas/webhook-workflow-job-completed" responses: '200': description: Return a 200 status to indicate that the data was received @@ -60950,7 +61895,7 @@ webhooks: - repository - organization - app - workflow-job-waiting: + workflow-job-in-progress: post: summary: |- This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. @@ -60958,8 +61903,142 @@ webhooks: For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. - description: A job in a workflow run was created and is waiting for approvals. - operationId: workflow-job/waiting + description: A job in a workflow run started processing on a runner. + operationId: workflow-job/in-progress + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job + 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-workflow-job-in-progress" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: workflow_job + supported-webhook-types: + - business + - repository + - organization + - app + workflow-job-queued: + post: + summary: |- + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. + + For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. + description: A job in a workflow run was created. + operationId: workflow-job/queued + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job + 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-workflow-job-queued" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: workflow_job + supported-webhook-types: + - business + - repository + - organization + - app + workflow-job-waiting: + post: + summary: |- + This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/rest/actions/workflow-jobs)" in the REST API documentation. + + For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event. + + To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission. + description: A job in a workflow run was created and is waiting for approvals. + operationId: workflow-job/waiting externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#workflow_job parameters: @@ -61263,6 +62342,7 @@ components: hub_url: type: string format: uri-template + deprecated: true issue_search_url: type: string format: uri-template @@ -61336,7 +62416,6 @@ components: - followers_url - following_url - gists_url - - hub_url - issue_search_url - issues_url - keys_url @@ -61373,6 +62452,50 @@ components: - pub - other - swift + vulnerability: + description: A vulnerability describing the product and its affected versions + within a GitHub Security Advisory. + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: + - object + - 'null' + properties: + ecosystem: + "$ref": "#/components/schemas/security-advisory-ecosystems" + name: + type: + - string + - 'null' + description: The unique package name within its ecosystem. + required: + - ecosystem + - name + vulnerable_version_range: + type: + - string + - 'null' + description: The range of the package versions affected by the vulnerability. + first_patched_version: + type: + - string + - 'null' + description: The package version that resolves the vulnerability. + vulnerable_functions: + type: + - array + - 'null' + description: The functions in the package that are affected by the vulnerability. + readOnly: true + items: + type: string + required: + - package + - vulnerable_version_range + - first_patched_version + - vulnerable_functions simple-user: title: Simple User description: A GitHub user. @@ -61637,48 +62760,7 @@ components: description: The products and respective version ranges affected by the advisory. items: - type: object - properties: - package: - description: The name of the package affected by the vulnerability. - type: - - object - - 'null' - properties: - ecosystem: - "$ref": "#/components/schemas/security-advisory-ecosystems" - name: - type: - - string - - 'null' - description: The unique package name within its ecosystem. - required: - - ecosystem - - name - vulnerable_version_range: - type: - - string - - 'null' - description: The range of the package versions affected by the vulnerability. - first_patched_version: - type: - - string - - 'null' - description: The package version that resolve the vulnerability. - vulnerable_functions: - type: - - array - - 'null' - description: The functions in the package that are affected by the - vulnerability. - readOnly: true - items: - type: string - required: - - package - - vulnerable_version_range - - first_patched_version - - vulnerable_functions + "$ref": "#/components/schemas/vulnerability" cvss: type: - object @@ -61791,7 +62873,9 @@ components: 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. - type: object + type: + - object + - 'null' properties: id: description: Unique identifier of the GitHub app @@ -62343,6 +63427,13 @@ components: enum: - read - write + codespaces: + type: string + description: The level of permission to grant the access token to create, + edit, delete, and list Codespaces. + enum: + - read + - write contents: type: string description: The level of permission to grant the access token for repository @@ -62350,6 +63441,13 @@ components: enum: - read - write + dependabot_secrets: + type: string + description: The leve of permission to grant the access token to manage + Dependabot secrets. + enum: + - read + - write deployments: type: string description: The level of permission to grant the access token for deployments @@ -62399,6 +63497,13 @@ components: enum: - read - write + repository_custom_properties: + type: string + description: The level of permission to grant the access token to view and + edit custom properties for a repository, when allowed by the property. + enum: + - read + - write repository_hooks: type: string description: The level of permission to grant the access token to manage @@ -62479,8 +63584,14 @@ components: organization_custom_roles: type: string description: The level of permission to grant the access token for custom - repository roles management. This property is in beta and is subject to - change. + repository roles management. + enum: + - read + - write + organization_custom_org_roles: + type: string + description: The level of permission to grant the access token for custom + organization roles management. enum: - read - write @@ -62492,6 +63603,13 @@ components: - read - write - admin + organization_copilot_seat_management: + type: string + description: The level of permission to grant the access token for managing + access to GitHub Copilot for members of an organization with a Copilot + Business subscription. This property is in beta and is subject to change. + enum: + - write organization_announcement_banners: type: string description: The level of permission to grant the access token to view and @@ -62499,6 +63617,12 @@ components: enum: - read - write + organization_events: + type: string + description: The level of permission to grant the access token to view events + triggered by an activity in an organization. + enum: + - read organization_hooks: type: string description: The level of permission to grant the access token to manage @@ -62570,6 +63694,54 @@ components: enum: - read - write + email_addresses: + type: string + description: The level of permission to grant the access token to manage + the email addresses belonging to a user. + enum: + - read + - write + followers: + type: string + description: The level of permission to grant the access token to manage + the followers belonging to a user. + enum: + - read + - write + git_ssh_keys: + type: string + description: The level of permission to grant the access token to manage + git SSH keys. + enum: + - read + - write + gpg_keys: + type: string + description: The level of permission to grant the access token to view and + manage GPG keys belonging to a user. + enum: + - read + - write + interaction_limits: + type: string + description: The level of permission to grant the access token to view and + manage interaction limits on a repository. + enum: + - read + - write + profile: + type: string + description: The level of permission to grant the access token to manage + the profile settings belonging to a user. + enum: + - write + starring: + type: string + description: The level of permission to grant the access token to list and + manage repositories a user is starring. + enum: + - read + - write example: contents: read issues: read @@ -62758,10 +63930,6 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/license-simple" - organization: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" forks: type: integer permissions: @@ -63010,8 +64178,8 @@ components: examples: - 80 size: - description: The size of the repository. Size is calculated hourly. When - a repository is initially created, the size is 0. + description: The size of the repository, in kilobytes. Size is calculated + hourly. When a repository is initially created, the size is 0. type: integer examples: - 108 @@ -63106,271 +64274,6 @@ components: type: boolean examples: - true - template_repository: - type: - - object - - 'null' - properties: - id: - type: integer - node_id: - type: string - name: - type: string - full_name: - type: string - owner: - type: object - properties: - login: - type: string - id: - type: integer - node_id: - type: string - avatar_url: - type: string - gravatar_id: - type: string - url: - type: string - html_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - starred_url: - type: string - subscriptions_url: - type: string - organizations_url: - type: string - repos_url: - type: string - events_url: - type: string - received_events_url: - type: string - type: - type: string - site_admin: - type: boolean - private: - type: boolean - html_url: - type: string - description: - type: string - fork: - type: boolean - url: - type: string - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - downloads_url: - type: string - events_url: - type: string - forks_url: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - git_url: - type: string - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - notifications_url: - type: string - pulls_url: - type: string - releases_url: - type: string - ssh_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - clone_url: - type: string - mirror_url: - type: string - hooks_url: - type: string - svn_url: - type: string - homepage: - type: string - language: - type: string - forks_count: - type: integer - stargazers_count: - type: integer - watchers_count: - type: integer - size: - type: integer - default_branch: - type: string - open_issues_count: - type: integer - is_template: - type: boolean - topics: - type: array - items: - type: string - has_issues: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - has_pages: - type: boolean - has_downloads: - type: boolean - archived: - type: boolean - disabled: - type: boolean - visibility: - type: string - pushed_at: - type: string - created_at: - type: string - updated_at: - type: string - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - allow_rebase_merge: - type: boolean - temp_clone_token: - type: string - allow_squash_merge: - type: boolean - allow_auto_merge: - type: boolean - delete_branch_on_merge: - type: boolean - allow_update_branch: - type: boolean - use_squash_pr_title_as_default: - type: boolean - squash_merge_commit_title: - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - squash_merge_commit_message: - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - merge_commit_title: - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - merge_commit_message: - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - allow_merge_commit: - type: boolean - subscribers_count: - type: integer - network_count: - type: integer temp_clone_token: type: string allow_squash_merge: @@ -63463,10 +64366,6 @@ components: description: Whether to require contributors to sign off on web-based commits default: false type: boolean - subscribers_count: - type: integer - network_count: - type: integer open_issues: type: integer watchers: @@ -64316,6 +65215,90 @@ components: - html_url - key - name + 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. @@ -66685,6 +67668,12 @@ components: type: string examples: - example.com + actions: + type: array + items: + type: string + examples: + - example.com required: - verifiable_password_authentication security-and-analysis: @@ -66954,8 +67943,8 @@ components: watchers_count: type: integer size: - description: The size of the repository. Size is calculated hourly. When - a repository is initially created, the size is 0. + description: The size of the repository, in kilobytes. Size is calculated + hourly. When a repository is initially created, the size is 0. type: integer default_branch: type: string @@ -68053,7 +69042,7 @@ components: - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - code-scanning-alert-rule: + code-scanning-alert-rule-summary: type: object properties: id: @@ -68064,6 +69053,13 @@ components: name: type: string description: The name of the rule used to detect the alert. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string severity: type: - string @@ -68089,27 +69085,6 @@ components: description: type: string description: A short description of the rule used to detect the alert. - full_description: - type: string - description: description of the rule used to detect the alert. - tags: - type: - - array - - 'null' - description: A set of tags applicable for the rule. - items: - type: string - help: - type: - - string - - 'null' - description: Detailed documentation for the rule as GitHub Flavored Markdown. - help_uri: - type: - - string - - 'null' - description: A link to the documentation for the rule used to detect the - alert. code-scanning-analysis-tool-version: type: - string @@ -68230,7 +69205,7 @@ components: dismissed_comment: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" rule: - "$ref": "#/components/schemas/code-scanning-alert-rule" + "$ref": "#/components/schemas/code-scanning-alert-rule-summary" tool: "$ref": "#/components/schemas/code-scanning-analysis-tool" most_recent_instance: @@ -68683,7 +69658,7 @@ components: - block - unconfigured - unknown - copilot_chat: + ide_chat: type: string description: The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. @@ -68691,6 +69666,22 @@ components: - enabled - disabled - unconfigured + platform_chat: + type: string + description: The organization policy for allowing or disallowing organization + members to use Copilot features within github.com. + enum: + - enabled + - disabled + - unconfigured + cli: + type: string + description: The organization policy for allowing or disallowing organization + members to use Copilot within their CLI. + enum: + - enabled + - disabled + - unconfigured seat_management_setting: type: string description: The mode of assigning new seats. @@ -69901,10 +70892,16 @@ components: 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: - - string - 'null' - description: Default value of the property + - string + - array description: type: - string @@ -69916,7 +70913,22 @@ components: - 'null' items: type: string - description: Ordered list of allowed values of the property + maxLength: 75 + maxItems: 200 + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + values_editable_by: + type: + - string + - 'null' + enum: + - org_actors + - org_and_repo_actors + - + description: Who can edit the values of the property + examples: + - org_actors required: - property_name - value_type @@ -69929,10 +70941,16 @@ components: type: string description: The name of the property value: + oneOf: + - type: string + - type: array + items: + type: string + description: The value assigned to the property type: - - string - 'null' - description: The value assigned to the property + - string + - array required: - property_name - value @@ -69963,6 +70981,588 @@ components: - repository_name - repository_full_name - properties + code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple + type: object + properties: + url: + type: string + format: uri + examples: + - https://api.github.com/repos/github/docs/community/code_of_conduct + key: + type: string + examples: + - citizen_code_of_conduct + name: + type: string + examples: + - Citizen Code of Conduct + html_url: + type: + - string + - 'null' + format: uri + examples: + - https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + required: + - url + - key + - name + - html_url + full-repository: + title: Full Repository + description: Full Repository + type: object + properties: + id: + type: integer + examples: + - 1296269 + node_id: + type: string + examples: + - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + examples: + - Hello-World + full_name: + type: string + examples: + - octocat/Hello-World + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + html_url: + type: string + format: uri + examples: + - https://github.com/octocat/Hello-World + description: + type: + - string + - 'null' + examples: + - This your first repo! + fork: + type: boolean + url: + type: string + format: uri + examples: + - https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + examples: + - git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + examples: + - git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + examples: + - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + examples: + - https://github.com/octocat/Hello-World.git + mirror_url: + type: + - string + - 'null' + format: uri + examples: + - git:git.example.com/octocat/Hello-World + hooks_url: + type: string + format: uri + examples: + - http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + examples: + - https://svn.github.com/octocat/Hello-World + homepage: + type: + - string + - 'null' + format: uri + examples: + - https://github.com + language: + type: + - string + - 'null' + forks_count: + type: integer + examples: + - 9 + stargazers_count: + type: integer + examples: + - 80 + watchers_count: + type: integer + examples: + - 80 + size: + description: The size of the repository, in kilobytes. Size is calculated + hourly. When a repository is initially created, the size is 0. + type: integer + examples: + - 108 + default_branch: + type: string + examples: + - master + open_issues_count: + type: integer + examples: + - 0 + is_template: + type: boolean + examples: + - true + topics: + type: array + items: + type: string + examples: + - octocat + - atom + - electron + - API + has_issues: + type: boolean + examples: + - true + has_projects: + type: boolean + examples: + - true + has_wiki: + type: boolean + examples: + - true + has_pages: + type: boolean + has_downloads: + type: boolean + examples: + - true + has_discussions: + type: boolean + examples: + - true + archived: + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + type: string + examples: + - public + pushed_at: + type: string + format: date-time + examples: + - '2011-01-26T19:06:43Z' + created_at: + type: string + format: date-time + examples: + - '2011-01-26T19:01:12Z' + updated_at: + type: string + format: date-time + examples: + - '2011-01-26T19:14:43Z' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + allow_rebase_merge: + type: boolean + examples: + - true + template_repository: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/repository" + temp_clone_token: + type: + - string + - 'null' + allow_squash_merge: + type: boolean + examples: + - true + allow_auto_merge: + type: boolean + examples: + - false + delete_branch_on_merge: + type: boolean + examples: + - false + allow_merge_commit: + type: boolean + examples: + - true + allow_update_branch: + type: boolean + examples: + - true + use_squash_pr_title_as_default: + type: boolean + examples: + - false + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + examples: + - PR_TITLE + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + examples: + - PR_BODY + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + examples: + - PR_TITLE + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + examples: + - PR_BODY + allow_forking: + type: boolean + examples: + - true + web_commit_signoff_required: + type: boolean + examples: + - false + subscribers_count: + type: integer + examples: + - 42 + network_count: + type: integer + examples: + - 0 + license: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/license-simple" + organization: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + parent: + "$ref": "#/components/schemas/repository" + source: + "$ref": "#/components/schemas/repository" + forks: + type: integer + master_branch: + type: string + open_issues: + type: integer + watchers: + type: integer + anonymous_access_enabled: + description: Whether anonymous git access is allowed. + default: true + type: boolean + code_of_conduct: + "$ref": "#/components/schemas/code-of-conduct-simple" + security_and_analysis: + "$ref": "#/components/schemas/security-and-analysis" + custom_properties: + type: object + description: The custom properties that were defined for the repository. + The keys are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + 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 + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_issues + - has_projects + - has_wiki + - has_pages + - has_discussions + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + - network_count + - subscribers_count repository-rule-enforcement: type: string description: The enforcement level of the ruleset. `evaluate` allows admins @@ -69977,26 +71577,37 @@ components: type: object description: An actor that can bypass rules in a ruleset required: - - actor_id - actor_type - bypass_mode properties: actor_id: - type: integer - description: The ID of the actor that can bypass a ruleset. If `actor_type` - is `OrganizationAdmin`, this should be `1`. + type: + - integer + - 'null' + description: 'The ID of the actor that can bypass a ruleset. If `actor_type` + is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, + this should be null. `OrganizationAdmin` is not applicable for personal + repositories. + + ' actor_type: type: string enum: - - RepositoryRole - - Team - Integration - OrganizationAdmin - description: The type of actor that can bypass a ruleset + - RepositoryRole + - Team + - DeployKey + description: 'The type of actor that can bypass a ruleset. + + ' bypass_mode: type: string - description: When the specified actor can bypass the ruleset. `pull_request` - means that an actor can only bypass rules on pull requests. + description: 'When the specified actor can bypass the ruleset. `pull_request` + means that an actor can only bypass rules on pull requests. `pull_request` + is not applicable for the `DeployKey` actor type. + + ' enum: - always - pull_request @@ -70063,6 +71674,44 @@ components: type: integer required: - repository_id + repository-ruleset-conditions-repository-property-spec: + title: Repository ruleset property targeting definition + type: object + description: Parameters for a targeting a repository property + properties: + name: + type: string + description: The name of the repository property to target + property_values: + type: array + description: The values to match for the repository property + items: + type: string + required: + - name + - property_values + repository-ruleset-conditions-repository-property-target: + title: Repository ruleset conditions for repository properties + type: object + description: Parameters for a repository property condition + properties: + repository_property: + type: object + properties: + include: + type: array + description: The repository properties and values to include. All of + these properties must match for the condition to pass. + items: + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + exclude: + type: array + description: The repository properties and values to exclude. The condition + will not pass if any of these properties match. + items: + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + required: + - repository_property org-ruleset-conditions: title: Organization ruleset conditions type: object @@ -70070,7 +71719,7 @@ components: should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. -' + ' oneOf: - type: object title: repository_name_and_ref_name @@ -70084,6 +71733,12 @@ components: allOf: - "$ref": "#/components/schemas/repository-ruleset-conditions" - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" + - type: object + title: repository_property_and_ref_name + description: Conditions to target repositories by property and refs by name + allOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" repository-rule-creation: title: creation description: Only allow users with bypass permission to create matching refs. @@ -70437,6 +72092,19 @@ components: required: - operator - pattern + repository-rule-params-restricted-commits: + title: RestrictedCommits + description: Restricted commit + type: object + properties: + oid: + type: string + description: Full or abbreviated commit hash to reject + reason: + type: string + description: Reason for restriction + required: + - oid repository-rule-params-workflow-file-reference: title: WorkflowFileReference description: A workflow that must run for this rule to pass @@ -70479,6 +72147,40 @@ components: "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" required: - workflows + repository-rule-params-code-scanning-tool: + title: CodeScanningTool + description: A tool that must provide code scanning results for this rule to + pass. + type: object + properties: + alerts_threshold: + type: string + description: The severity level at which code scanning results that raise + alerts block a reference update. For more information on alert severity + levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - errors + - errors_and_warnings + - all + security_alerts_threshold: + type: string + description: The severity level at which code scanning results that raise + security alerts block a reference update. For more information on security + severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - critical + - high_or_higher + - medium_or_higher + - all + tool: + type: string + description: The name of a code scanning tool + required: + - alerts_threshold + - security_alerts_threshold + - tool repository-rule: title: Repository Rule type: object @@ -70498,6 +72200,101 @@ components: - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + - title: file_path_restriction + description: |- + Note: file_path_restriction is in beta and subject to change. + + Prevent commits that include changes in specified file paths from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted from being pushed + to the commit graph. + items: + type: string + required: + - restricted_file_paths + - title: max_file_path_length + description: |- + Note: max_file_path_length is in beta and subject to change. + + Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed in file paths + minimum: 1 + maximum: 256 + required: + - max_file_path_length + - title: file_extension_restriction + description: |- + Note: file_extension_restriction is in beta and subject to change. + + Prevent commits that include files with specified file extensions from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted from being pushed + to the commit graph. + items: + type: string + required: + - restricted_file_extensions + - title: max_file_size + description: |- + Note: max_file_size is in beta and subject to change. + + Prevent commits that exceed a specified file size limit from being pushed to the commit. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. This limit + does not apply to Git Large File Storage (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size - "$ref": "#/components/schemas/repository-rule-workflows" repository-ruleset: title: Repository ruleset @@ -70517,10 +72314,14 @@ components: description: The name of the ruleset target: type: string - description: The target of the ruleset + description: |- + The target of the ruleset + + **Note**: The `push` target is in beta and is subject to change. enum: - branch - tag + - push source_type: type: string description: The type of the source of the ruleset @@ -70567,6 +72368,9 @@ components: anyOf: - "$ref": "#/components/schemas/repository-ruleset-conditions" - "$ref": "#/components/schemas/org-ruleset-conditions" + type: + - 'null' + - object rules: type: array items: @@ -70638,10 +72442,14 @@ components: type: integer description: The unique identifier of the rule insight. actor_id: - type: integer + type: + - integer + - 'null' description: The number that identifies the user. actor_name: - type: string + type: + - string + - 'null' description: The handle for the GitHub user account. before_sha: type: string @@ -72532,582 +74340,6 @@ components: required: - rate - resources - code-of-conduct-simple: - title: Code Of Conduct Simple - description: Code of Conduct Simple - type: object - properties: - url: - type: string - format: uri - examples: - - https://api.github.com/repos/github/docs/community/code_of_conduct - key: - type: string - examples: - - citizen_code_of_conduct - name: - type: string - examples: - - Citizen Code of Conduct - html_url: - type: - - string - - 'null' - format: uri - examples: - - https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: - - url - - key - - name - - html_url - full-repository: - title: Full Repository - description: Full Repository - type: object - properties: - id: - type: integer - examples: - - 1296269 - node_id: - type: string - examples: - - MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: - type: string - examples: - - Hello-World - full_name: - type: string - examples: - - octocat/Hello-World - owner: - "$ref": "#/components/schemas/simple-user" - private: - type: boolean - html_url: - type: string - format: uri - examples: - - https://github.com/octocat/Hello-World - description: - type: - - string - - 'null' - examples: - - This your first repo! - fork: - type: boolean - url: - type: string - format: uri - examples: - - https://api.github.com/repos/octocat/Hello-World - archive_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: - type: string - format: uri - examples: - - http://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: - type: string - format: uri - examples: - - http://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: - type: string - format: uri - examples: - - http://api.github.com/repos/octocat/Hello-World/downloads - events_url: - type: string - format: uri - examples: - - http://api.github.com/repos/octocat/Hello-World/events - forks_url: - type: string - format: uri - examples: - - http://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: - type: string - examples: - - git:github.com/octocat/Hello-World.git - issue_comment_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: - type: string - format: uri - examples: - - http://api.github.com/repos/octocat/Hello-World/languages - merges_url: - type: string - format: uri - examples: - - http://api.github.com/repos/octocat/Hello-World/merges - milestones_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: - type: string - examples: - - git@github.com:octocat/Hello-World.git - stargazers_url: - type: string - format: uri - examples: - - http://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: - type: string - format: uri - examples: - - http://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: - type: string - format: uri - examples: - - http://api.github.com/repos/octocat/Hello-World/subscription - tags_url: - type: string - format: uri - examples: - - http://api.github.com/repos/octocat/Hello-World/tags - teams_url: - type: string - format: uri - examples: - - http://api.github.com/repos/octocat/Hello-World/teams - trees_url: - type: string - examples: - - http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: - type: string - examples: - - https://github.com/octocat/Hello-World.git - mirror_url: - type: - - string - - 'null' - format: uri - examples: - - git:git.example.com/octocat/Hello-World - hooks_url: - type: string - format: uri - examples: - - http://api.github.com/repos/octocat/Hello-World/hooks - svn_url: - type: string - format: uri - examples: - - https://svn.github.com/octocat/Hello-World - homepage: - type: - - string - - 'null' - format: uri - examples: - - https://github.com - language: - type: - - string - - 'null' - forks_count: - type: integer - examples: - - 9 - stargazers_count: - type: integer - examples: - - 80 - watchers_count: - type: integer - examples: - - 80 - size: - description: The size of the repository. Size is calculated hourly. When - a repository is initially created, the size is 0. - type: integer - examples: - - 108 - default_branch: - type: string - examples: - - master - open_issues_count: - type: integer - examples: - - 0 - is_template: - type: boolean - examples: - - true - topics: - type: array - items: - type: string - examples: - - octocat - - atom - - electron - - API - has_issues: - type: boolean - examples: - - true - has_projects: - type: boolean - examples: - - true - has_wiki: - type: boolean - examples: - - true - has_pages: - type: boolean - has_downloads: - type: boolean - examples: - - true - has_discussions: - type: boolean - examples: - - true - archived: - type: boolean - disabled: - type: boolean - description: Returns whether or not this repository disabled. - visibility: - description: 'The repository visibility: public, private, or internal.' - type: string - examples: - - public - pushed_at: - type: string - format: date-time - examples: - - '2011-01-26T19:06:43Z' - created_at: - type: string - format: date-time - examples: - - '2011-01-26T19:01:12Z' - updated_at: - type: string - format: date-time - examples: - - '2011-01-26T19:14:43Z' - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - required: - - admin - - pull - - push - allow_rebase_merge: - type: boolean - examples: - - true - template_repository: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/repository" - temp_clone_token: - type: - - string - - 'null' - allow_squash_merge: - type: boolean - examples: - - true - allow_auto_merge: - type: boolean - examples: - - false - delete_branch_on_merge: - type: boolean - examples: - - false - allow_merge_commit: - type: boolean - examples: - - true - allow_update_branch: - type: boolean - examples: - - true - use_squash_pr_title_as_default: - type: boolean - examples: - - false - squash_merge_commit_title: - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - examples: - - PR_TITLE - squash_merge_commit_message: - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - examples: - - PR_BODY - merge_commit_title: - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - examples: - - PR_TITLE - merge_commit_message: - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - examples: - - PR_BODY - allow_forking: - type: boolean - examples: - - true - web_commit_signoff_required: - type: boolean - examples: - - false - subscribers_count: - type: integer - examples: - - 42 - network_count: - type: integer - examples: - - 0 - license: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/license-simple" - organization: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - parent: - "$ref": "#/components/schemas/repository" - source: - "$ref": "#/components/schemas/repository" - forks: - type: integer - master_branch: - type: string - open_issues: - type: integer - watchers: - type: integer - anonymous_access_enabled: - description: Whether anonymous git access is allowed. - default: true - type: boolean - code_of_conduct: - "$ref": "#/components/schemas/code-of-conduct-simple" - security_and_analysis: - "$ref": "#/components/schemas/security-and-analysis" - 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 - - clone_url - - default_branch - - forks - - forks_count - - git_url - - has_issues - - has_projects - - has_wiki - - has_pages - - has_discussions - - homepage - - language - - archived - - disabled - - mirror_url - - open_issues - - open_issues_count - - license - - pushed_at - - size - - ssh_url - - stargazers_count - - svn_url - - watchers - - watchers_count - - created_at - - updated_at - - network_count - - subscribers_count artifact: title: Artifact description: An artifact @@ -73294,6 +74526,8 @@ components: - in_progress - completed - waiting + - requested + - pending examples: - queued conclusion: @@ -73565,7 +74799,7 @@ components: Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the repository. - `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization. + `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. enum: - none - user @@ -75570,11 +76804,16 @@ components: - https://example.com status: description: The phase of the lifecycle that the check is currently in. + Statuses of waiting, requested, and pending are reserved for GitHub Actions + check runs. type: string enum: - queued - in_progress - completed + - waiting + - requested + - pending examples: - queued conclusion: @@ -75770,10 +77009,16 @@ components: type: - string - 'null' + description: The phase of the lifecycle that the check suite is currently + in. Statuses of waiting, requested, and pending are reserved for GitHub + Actions check suites. enum: - queued - in_progress - completed + - waiting + - requested + - pending - examples: - completed @@ -75887,38 +77132,6 @@ components: - setting repository: "$ref": "#/components/schemas/minimal-repository" - code-scanning-alert-rule-summary: - type: object - properties: - id: - type: - - string - - 'null' - description: A unique identifier for the rule used to detect the alert. - name: - type: string - description: The name of the rule used to detect the alert. - tags: - type: - - array - - 'null' - description: A set of tags applicable for the rule. - items: - type: string - severity: - type: - - string - - 'null' - description: The severity of the alert. - enum: - - none - - note - - warning - - error - - - description: - type: string - description: A short description of the rule used to detect the alert. code-scanning-alert-items: type: object properties: @@ -75967,6 +77180,63 @@ components: - rule - tool - most_recent_instance + code-scanning-alert-rule: + type: object + properties: + id: + type: + - string + - 'null' + description: A unique identifier for the rule used to detect the alert. + name: + type: string + description: The name of the rule used to detect the alert. + severity: + type: + - string + - 'null' + description: The severity of the alert. + enum: + - none + - note + - warning + - error + - + security_severity_level: + type: + - string + - 'null' + description: The security severity of the alert. + enum: + - low + - medium + - high + - critical + - + description: + type: string + description: A short description of the rule used to detect the alert. + full_description: + type: string + description: description of the rule used to detect the alert. + tags: + type: + - array + - 'null' + description: A set of tags applicable for the rule. + items: + type: string + help: + type: + - string + - 'null' + description: Detailed documentation for the rule as GitHub Flavored Markdown. + help_uri: + type: + - string + - 'null' + description: A link to the documentation for the rule used to detect the + alert. code-scanning-alert: type: object properties: @@ -76275,8 +77545,8 @@ components: type: string description: |- The full Git reference, formatted as `refs/heads/`, - `refs/pull//merge`, or `refs/pull//head`. - pattern: "^refs/(heads|pull)/.*$" + `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. + pattern: "^refs/(heads|tags|pull)/.*$" examples: - refs/heads/main code-scanning-analysis-sarif-file: @@ -79268,40 +80538,7 @@ components: - push - pull_request config: - type: object - properties: - email: - type: string - examples: - - '"foo@bar.com"' - password: - type: string - examples: - - '"foo"' - room: - type: string - examples: - - '"roomer"' - subdomain: - type: string - examples: - - '"foo"' - url: - "$ref": "#/components/schemas/webhook-config-url" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - digest: - type: string - examples: - - '"sha256"' - secret: - "$ref": "#/components/schemas/webhook-config-secret" - token: - type: string - examples: - - '"abc"' + "$ref": "#/components/schemas/webhook-config" updated_at: type: string format: date-time @@ -81571,12 +82808,18 @@ components: description: The GitHub Pages deployment status. type: object properties: + id: + oneOf: + - type: integer + - type: string + description: The ID of the GitHub Pages deployment. This is the Git SHA + of the deployed commit. status_url: type: string description: The URI to monitor GitHub Pages deployment status. format: uri examples: - - https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status + - https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 page_url: type: string description: The URI to the deployed GitHub Pages. @@ -81590,8 +82833,28 @@ components: examples: - monalisa-1231a2312sa32-23sda74.drafts.github.io required: + - id - status_url - page_url + pages-deployment-status: + title: GitHub Pages deployment status + type: object + properties: + status: + type: string + description: The current status of the deployment. + enum: + - deployment_in_progress + - syncing_files + - finished_file_sync + - updating_pages + - purging_cdn + - deployment_cancelled + - deployment_failed + - deployment_content_failed + - deployment_attempt_error + - deployment_lost + - succeed pages-health-check: title: Pages Health Check Status description: Pages Health Check Status @@ -83681,6 +84944,61 @@ components: - blob_url - commit_sha - commit_url + secret-scanning-location-wiki-commit: + description: Represents a 'wiki_commit' secret scanning location type. This + location type shows that a secret was detected inside a commit to a repository + wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + examples: + - "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8-bit ASCII. + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + examples: + - af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + examples: + - https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + examples: + - 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + examples: + - https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url secret-scanning-location-issue-title: description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -83720,6 +85038,119 @@ components: - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url + secret-scanning-location-discussion-title: + description: Represents a 'discussion_title' secret scanning location type. + This location type shows that a secret was detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + examples: + - https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + secret-scanning-location-discussion-body: + description: Represents a 'discussion_body' secret scanning location type. This + location type shows that a secret was detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + examples: + - https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + secret-scanning-location-discussion-comment: + description: Represents a 'discussion_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment where the secret + was detected. + examples: + - https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + secret-scanning-location-pull-request-title: + description: Represents a 'pull_request_title' secret scanning location type. + This location type shows that a secret was detected in the title of a pull + request. + type: object + properties: + pull_request_title_url: + type: string + 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 + required: + - pull_request_title_url + secret-scanning-location-pull-request-body: + description: Represents a 'pull_request_body' secret scanning location type. + This location type shows that a secret was detected in the body of a pull + request. + type: object + properties: + pull_request_body_url: + type: string + 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 + required: + - pull_request_body_url + secret-scanning-location-pull-request-comment: + description: Represents a 'pull_request_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a pull + request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment where the secret + was detected. + examples: + - https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + secret-scanning-location-pull-request-review: + description: Represents a 'pull_request_review' secret scanning location type. + This location type shows that a secret was detected in a review on a pull + request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review where the secret + was detected. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + secret-scanning-location-pull-request-review-comment: + description: Represents a 'pull_request_review_comment' secret scanning location + type. This location type shows that a secret was detected in a review comment + on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review comment where the + secret was detected. + examples: + - https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url secret-scanning-location: type: object properties: @@ -83727,23 +85158,38 @@ components: type: string enum: - commit + - wiki_commit - issue_title - issue_body - issue_comment + - discussion_title + - discussion_body + - discussion_comment + - pull_request_title + - pull_request_body + - pull_request_comment + - pull_request_review + - pull_request_review_comment description: The location type. Because secrets may be found in different - types of resources (ie. code, comments, issues), this field identifies - the type of resource where the secret was found. + types of resources (ie. code, comments, issues, pull requests, discussions), + this field identifies the type of resource where the secret was found. examples: - commit details: oneOf: - "$ref": "#/components/schemas/secret-scanning-location-commit" + - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" - "$ref": "#/components/schemas/secret-scanning-location-issue-title" - "$ref": "#/components/schemas/secret-scanning-location-issue-body" - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" - required: - - type - - details + - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" repository-advisory-create: type: object properties: @@ -83843,6 +85289,11 @@ components: - 'null' description: The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + start_private_fork: + type: boolean + description: Whether to create a temporary private fork of the repository + to collaborate on a fix. + default: false required: - summary - description @@ -83926,6 +85377,11 @@ components: - 'null' description: The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. + start_private_fork: + type: boolean + description: Whether to create a temporary private fork of the repository + to collaborate on a fix. + default: false required: - summary - description @@ -86702,8 +88158,8 @@ components: examples: - 80 size: - description: The size of the repository. Size is calculated hourly. When - a repository is initially created, the size is 0. + description: The size of the repository, in kilobytes. Size is calculated + hourly. When a repository is initially created, the size is 0. type: integer examples: - 108 @@ -87368,6 +88824,136 @@ components: - subscriptions_url - type - url + webhooks_rule: + title: branch protection rule + description: The branch protection rule. Includes a `name` and all the [branch + protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) + applied to branches that match the name. Binary settings are boolean. Multi-level + configurations are one of `off`, `non_admins`, or `everyone`. Actor and build + lists are arrays of strings. + type: object + properties: + admin_enforced: + type: boolean + allow_deletions_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + allow_force_pushes_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + authorized_actor_names: + type: array + items: + type: string + authorized_actors_only: + type: boolean + authorized_dismissal_actors_only: + type: boolean + create_protected: + type: boolean + created_at: + type: string + format: date-time + dismiss_stale_reviews_on_push: + type: boolean + id: + type: integer + ignore_approvals_from_contributors: + type: boolean + linear_history_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + merge_queue_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + name: + type: string + pull_request_reviews_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + repository_id: + type: integer + require_code_owner_review: + type: boolean + require_last_push_approval: + description: Whether the most recent push must be approved by someone other + than the person who pushed it + type: boolean + required_approving_review_count: + type: integer + required_conversation_resolution_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_deployments_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_status_checks: + type: array + items: + type: string + required_status_checks_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + signature_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + strict_required_status_checks_policy: + type: boolean + updated_at: + type: string + format: date-time + required: + - id + - repository_id + - name + - created_at + - updated_at + - pull_request_reviews_enforcement_level + - required_approving_review_count + - dismiss_stale_reviews_on_push + - require_code_owner_review + - authorized_dismissal_actors_only + - ignore_approvals_from_contributors + - required_status_checks + - required_status_checks_enforcement_level + - strict_required_status_checks_policy + - signature_requirement_enforcement_level + - linear_history_requirement_enforcement_level + - admin_enforced + - allow_force_pushes_enforcement_level + - allow_deletions_enforcement_level + - merge_queue_enforcement_level + - required_deployments_enforcement_level + - required_conversation_resolution_level + - authorized_actors_only + - authorized_actor_names simple-check-suite: description: A suite of checks performed on the code of a given code change type: object @@ -87584,6 +89170,475 @@ components: - output - app - pull_requests + webhooks_code_scanning_commit_oid: + description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` + or `closed_by_user`, the event was triggered by the `sender` and this value + will be empty. + type: string + webhooks_code_scanning_ref: + description: The Git reference of the code scanning alert. When the action is + `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` + and this value will be empty. + type: string + webhooks_deploy_pusher_type: + description: The pusher type for the event. Can be either `user` or a deploy + key. + type: string + webhooks_ref_0: + description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) + resource. + type: string + webhooks_deploy_key: + description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) + resource. + type: object + properties: + added_by: + type: + - string + - 'null' + created_at: + type: string + id: + type: integer + key: + type: string + last_used: + type: + - string + - 'null' + read_only: + type: boolean + title: + type: string + url: + type: string + format: uri + verified: + type: boolean + required: + - id + - key + - url + - title + - verified + - created_at + - read_only + webhooks_workflow: + title: Workflow + type: + - object + - 'null' + properties: + badge_url: + type: string + format: uri + created_at: + type: string + format: date-time + html_url: + type: string + format: uri + id: + type: integer + name: + type: string + node_id: + type: string + path: + type: string + state: + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - badge_url + - created_at + - html_url + - id + - name + - node_id + - path + - state + - updated_at + - url + webhooks_approver: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + webhooks_reviewers: + type: array + items: + type: object + properties: + reviewer: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + type: + type: string + enum: + - User + webhooks_workflow_job_run: + type: object + properties: + conclusion: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - 'null' + status: + type: string + updated_at: + type: string + required: + - id + - name + - status + - conclusion + - html_url + - created_at + - updated_at + - environment + webhooks_user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + webhooks_answer: + type: object + properties: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + type: string + child_comment_count: + type: integer + created_at: + type: string + format: date-time + discussion_id: + type: integer + html_url: + type: string + id: + type: integer + node_id: + type: string + parent_id: + type: + - 'null' + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + updated_at: + type: string + format: date-time + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - id + - node_id + - html_url + - parent_id + - child_comment_count + - repository_url + - discussion_id + - author_association + - user + - created_at + - updated_at + - body discussion: title: Discussion description: A Discussion in a repository. @@ -87894,2399 +89949,4245 @@ components: - author_association - active_lock_reason - body - merge-group: + webhooks_comment: type: object - title: Merge Group - description: 'A group of pull requests that the merge queue has grouped together - to be merged. - -' properties: - head_sha: - description: The SHA of the merge group. + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. type: string - head_ref: - description: The full ref of the merge group. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: type: string - base_sha: - description: The SHA of the merge group's parent commit. + child_comment_count: + type: integer + created_at: type: string - base_ref: - description: The full ref of the branch the merge group will be merged into. + discussion_id: + type: integer + html_url: type: string - head_commit: - "$ref": "#/components/schemas/simple-commit" - required: - - head_sha - - head_ref - - base_sha - - base_ref - - head_commit - personal-access-token-request: - title: Personal Access Token Request - description: Details of a Personal Access Token Request. - type: object - properties: id: type: integer - description: Unique identifier of the request for access via fine-grained - personal access token. Used as the `pat_request_id` parameter in the list - and review API calls. - owner: - "$ref": "#/components/schemas/simple-user" - permissions_added: - type: object - description: New requested permissions, categorized by type of permission. - properties: - organization: - type: object - additionalProperties: - type: string - repository: - type: object - additionalProperties: - type: string - other: - type: object - additionalProperties: - type: string - permissions_upgraded: - type: object - description: Requested permissions that elevate access for a previously - approved request for access, categorized by type of permission. - properties: - organization: - type: object - additionalProperties: - type: string - repository: - type: object - additionalProperties: - type: string - other: - type: object - additionalProperties: - type: string - permissions_result: - type: object - description: Permissions requested, categorized by type of permission. This - field incorporates `permissions_added` and `permissions_upgraded`. - properties: - organization: - type: object - additionalProperties: - type: string - repository: - type: object - additionalProperties: - type: string - other: - type: object - additionalProperties: - type: string - repository_selection: + node_id: type: string - description: Type of repository selection requested. - enum: - - none - - all - - subset - repository_count: - description: The number of repositories the token is requesting access to. - This field is only populated when `repository_selection` is `subset`. + parent_id: type: - integer - 'null' - repositories: - type: - - array - - 'null' - description: An array of repository objects the token is requesting access - to. This field is only populated when `repository_selection` is `subset`. - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - created_at: + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: type: string - description: Date and time when the request for access was created. - token_expired: - type: boolean - description: Whether the associated fine-grained personal access token has - expired. - token_expires_at: - type: - - string - - 'null' - description: Date and time when the associated fine-grained personal access - token expires. - token_last_used_at: + updated_at: + type: string + user: + title: User type: - - string + - object - 'null' - description: Date and time when the associated fine-grained personal access - token was last used for authentication. + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id required: - id - - owner - - permissions_added - - permissions_upgraded - - permissions_result - - repository_selection - - repository_count - - repositories + - node_id + - html_url + - parent_id + - child_comment_count + - repository_url + - discussion_id + - author_association + - user - created_at - - token_expired - - token_expires_at - - token_last_used_at - projects-v2: - title: Projects v2 Project - description: A projects v2 project + - updated_at + - body + - reactions + webhooks_label: + title: Label type: object properties: - id: - type: number - node_id: - type: string - owner: - "$ref": "#/components/schemas/simple-user" - creator: - "$ref": "#/components/schemas/simple-user" - title: + color: + description: '6-character hex code, without the leading #, identifying the + color' type: string - description: - type: - - string - - 'null' - public: + default: type: boolean - closed_at: + description: type: - string - 'null' - format: date-time - examples: - - '2022-04-28T12:00:00Z' - created_at: + id: + type: integer + name: + description: The name of the label. type: string - format: date-time - examples: - - '2022-04-28T12:00:00Z' - updated_at: + node_id: type: string - format: date-time - examples: - - '2022-04-28T12:00:00Z' - number: - type: integer - short_description: - type: - - string - - 'null' - deleted_at: - type: - - string - - 'null' - format: date-time - examples: - - '2022-04-28T12:00:00Z' - deleted_by: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" + url: + description: URL for the label + type: string + format: uri required: - id - node_id - - owner - - creator - - title + - url + - name + - color + - default - description - - public - - closed_at - - created_at - - updated_at - - number - - short_description - - deleted_at - - deleted_by - projects-v2-item-content-type: - title: Projects v2 Item Content Type - description: The type of content tracked in a project item + webhooks_repositories: + description: An array of repository objects that the installation can access. + type: array + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + required: + - id + - node_id + - name + - full_name + - private + webhooks_repositories_added: + description: An array of repository objects, which were added to the installation. + type: array + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + required: + - id + - node_id + - name + - full_name + - private + webhooks_repository_selection: + description: Describe whether all repositories have been selected or there's + a selection involved type: string enum: - - Issue - - PullRequest - - DraftIssue - projects-v2-item: - title: Projects v2 Item - description: An item belonging to a project + - all + - selected + webhooks_issue_comment: + title: issue comment + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) + itself. type: object properties: - id: - type: number - node_id: - type: string - project_node_id: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. type: string - content_node_id: + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue comment type: string - content_type: - "$ref": "#/components/schemas/projects-v2-item-content-type" - creator: - "$ref": "#/components/schemas/simple-user" created_at: type: string format: date-time - examples: - - '2022-04-28T12:00:00Z' + html_url: + type: string + format: uri + id: + description: Unique identifier of the issue comment + type: integer + format: int64 + issue_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: + "$ref": "#/components/schemas/integration" + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket updated_at: type: string format: date-time - examples: - - '2022-04-28T12:00:00Z' - archived_at: + url: + description: URL for the issue comment + type: string + format: uri + user: + title: User type: - - string + - object - 'null' - format: date-time - examples: - - '2022-04-28T12:00:00Z' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id required: + - url + - html_url + - issue_url - id - - content_node_id - - content_type + - node_id + - user - created_at - updated_at - - archived_at - secret-scanning-alert-resolution-webhook: - type: - - string - - 'null' - description: The reason for resolving the alert. - enum: - - false_positive - - wont_fix - - revoked - - used_in_tests - - pattern_deleted - - pattern_edited - - - secret-scanning-alert-webhook: + - author_association + - performed_via_github_app + - body + - reactions + webhooks_changes: + description: The changes to the comment. type: object properties: - number: - "$ref": "#/components/schemas/alert-number" - created_at: - "$ref": "#/components/schemas/alert-created-at" - updated_at: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/alert-updated-at" - url: - "$ref": "#/components/schemas/alert-url" - html_url: - "$ref": "#/components/schemas/alert-html-url" - locations_url: - type: string - format: uri - description: The REST API URL of the code locations for this alert. - resolution: - "$ref": "#/components/schemas/secret-scanning-alert-resolution-webhook" - resolved_at: - type: - - string - - 'null' - format: date-time - description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - resolved_by: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - resolution_comment: + body: + type: object + properties: + from: + description: The previous version of the body. + type: string + required: + - from + webhooks_issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: type: - string - 'null' - description: An optional comment to resolve an alert. - secret_type: - type: string - description: The type of secret that secret scanning detected. - push_protection_bypassed: - type: - - boolean - - 'null' - description: Whether push protection was bypassed for the detected secret. - push_protection_bypassed_by: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/simple-user" - push_protection_bypassed_at: + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User type: - - string + - object - 'null' - format: date-time - description: 'The time that push protection was bypassed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - webhook-branch-protection-configuration-disabled: - title: branch protection configuration disabled event - type: object - properties: - action: - type: string - enum: - - disabled - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-branch-protection-configuration-enabled: - title: branch protection configuration enabled event - type: object - properties: - action: - type: string - enum: - - enabled - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-branch-protection-rule-created: - title: branch protection rule created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - rule: - title: branch protection rule - description: The branch protection rule. Includes a `name` and all the [branch - protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) - applied to branches that match the name. Binary settings are boolean. - Multi-level configurations are one of `off`, `non_admins`, or `everyone`. - Actor and build lists are arrays of strings. - type: object properties: - admin_enforced: + avatar_url: + type: string + format: uri + deleted: type: boolean - allow_deletions_enforcement_level: + email: + type: + - string + - 'null' + events_url: type: string - enum: - - 'off' - - non_admins - - everyone - allow_force_pushes_enforcement_level: + format: uri-template + followers_url: type: string - enum: - - 'off' - - non_admins - - everyone - authorized_actor_names: - type: array - items: - type: string - authorized_actors_only: - type: boolean - authorized_dismissal_actors_only: - type: boolean - create_protected: - type: boolean - created_at: + format: uri + following_url: type: string - format: date-time - dismiss_stale_reviews_on_push: - type: boolean + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer - ignore_approvals_from_contributors: - type: boolean - linear_history_requirement_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - merge_queue_enforcement_level: + login: type: string - enum: - - 'off' - - non_admins - - everyone name: type: string - pull_request_reviews_enforcement_level: + node_id: type: string - enum: - - 'off' - - non_admins - - everyone - repository_id: - type: integer - require_code_owner_review: - type: boolean - require_last_push_approval: - description: Whether the most recent push must be approved by someone - other than the person who pushed it - type: boolean - required_approving_review_count: - type: integer - required_conversation_resolution_level: + organizations_url: type: string - enum: - - 'off' - - non_admins - - everyone - required_deployments_enforcement_level: + format: uri + received_events_url: type: string - enum: - - 'off' - - non_admins - - everyone - required_status_checks: - type: array - items: - type: string - required_status_checks_enforcement_level: + format: uri + repos_url: type: string - enum: - - 'off' - - non_admins - - everyone - signature_requirement_enforcement_level: + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string enum: - - 'off' - - non_admins - - everyone - strict_required_status_checks_policy: - type: boolean - updated_at: + - Bot + - User + - Organization + - Mannequin + url: type: string - format: date-time + format: uri required: + - login - id - - repository_id - - name - - created_at - - updated_at - - pull_request_reviews_enforcement_level - - required_approving_review_count - - dismiss_stale_reviews_on_push - - require_code_owner_review - - authorized_dismissal_actors_only - - ignore_approvals_from_contributors - - required_status_checks - - required_status_checks_enforcement_level - - strict_required_status_checks_policy - - signature_requirement_enforcement_level - - linear_history_requirement_enforcement_level - - admin_enforced - - allow_force_pushes_enforcement_level - - allow_deletions_enforcement_level - - merge_queue_enforcement_level - - required_deployments_enforcement_level - - required_conversation_resolution_level - - authorized_actors_only - - authorized_actor_names - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - rule - - repository - - sender - webhook-branch-protection-rule-deleted: - title: branch protection rule deleted event - type: object - properties: - action: + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. type: string enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - rule: - title: branch protection rule - description: The branch protection rule. Includes a `name` and all the [branch - protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) - applied to branches that match the name. Binary settings are boolean. - Multi-level configurations are one of `off`, `non_admins`, or `everyone`. - Actor and build lists are arrays of strings. - type: object - properties: - admin_enforced: - type: boolean - allow_deletions_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - allow_force_pushes_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - authorized_actor_names: - type: array - items: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - authorized_actors_only: - type: boolean - authorized_dismissal_actors_only: - type: boolean - create_protected: - type: boolean + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer created_at: type: string format: date-time - dismiss_stale_reviews_on_push: - type: boolean + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri id: type: integer - ignore_approvals_from_contributors: - type: boolean - linear_history_requirement_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - merge_queue_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - name: + labels_url: type: string - pull_request_reviews_enforcement_level: + format: uri + node_id: type: string - enum: - - 'off' - - non_admins - - everyone - repository_id: + number: + description: The number of the milestone. type: integer - require_code_owner_review: - type: boolean - require_last_push_approval: - description: Whether the most recent push must be approved by someone - other than the person who pushed it - type: boolean - required_approving_review_count: + open_issues: type: integer - required_conversation_resolution_level: - type: string - enum: - - 'off' - - non_admins - - everyone - required_deployments_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - required_status_checks: - type: array - items: - type: string - required_status_checks_enforcement_level: + state: + description: The state of the milestone. type: string enum: - - 'off' - - non_admins - - everyone - signature_requirement_enforcement_level: + - open + - closed + title: + description: The title of the milestone. type: string - enum: - - 'off' - - non_admins - - everyone - strict_required_status_checks_policy: - type: boolean updated_at: type: string format: date-time + url: + type: string + format: uri required: + - url + - html_url + - labels_url - id - - repository_id - - name + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state - created_at - updated_at - - pull_request_reviews_enforcement_level - - required_approving_review_count - - dismiss_stale_reviews_on_push - - require_code_owner_review - - authorized_dismissal_actors_only - - ignore_approvals_from_contributors - - required_status_checks - - required_status_checks_enforcement_level - - strict_required_status_checks_policy - - signature_requirement_enforcement_level - - linear_history_requirement_enforcement_level - - admin_enforced - - allow_force_pushes_enforcement_level - - allow_deletions_enforcement_level - - merge_queue_enforcement_level - - required_deployments_enforcement_level - - required_conversation_resolution_level - - authorized_actors_only - - authorized_actor_names - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - rule - - repository - - sender - webhook-branch-protection-rule-edited: - title: branch protection rule edited event - type: object - properties: - action: + - due_on + - closed_at + node_id: type: string - enum: - - edited - changes: - description: If the action was `edited`, the changes to the rule. - type: object + number: + type: integer + performed_via_github_app: + title: 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. + type: + - object + - 'null' properties: - admin_enforced: - type: object - properties: - from: - type: - - boolean - - 'null' - required: - - from - authorized_actor_names: - type: object - properties: - from: - type: array - items: - type: string - required: - - from - authorized_actors_only: - type: object - properties: - from: - type: - - boolean - - 'null' - required: - - from - authorized_dismissal_actors_only: - type: object + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' properties: - from: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - - boolean + - string - 'null' - required: - - from - linear_history_requirement_enforcement_level: - type: object - properties: - from: + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string enum: - - 'off' - - non_admins - - everyone - required: - - from - required_status_checks: - type: object - properties: - from: - type: array - items: - type: string + - Bot + - User + - Organization + url: + type: string + format: uri required: - - from - required_status_checks_enforcement_level: + - login + - id + permissions: + description: The set of permissions for the GitHub app type: object properties: - from: + actions: type: string enum: - - 'off' - - non_admins - - everyone - required: - - from - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - rule: - title: branch protection rule - description: The branch protection rule. Includes a `name` and all the [branch - protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) - applied to branches that match the name. Binary settings are boolean. - Multi-level configurations are one of `off`, `non_admins`, or `everyone`. - Actor and build lists are arrays of strings. + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: type: object properties: - admin_enforced: - type: boolean - allow_deletions_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - allow_force_pushes_enforcement_level: + diff_url: type: string - enum: - - 'off' - - non_admins - - everyone - authorized_actor_names: - type: array - items: - type: string - authorized_actors_only: - type: boolean - authorized_dismissal_actors_only: - type: boolean - create_protected: - type: boolean - created_at: + format: uri + html_url: type: string + format: uri + merged_at: + type: + - string + - 'null' format: date-time - dismiss_stale_reviews_on_push: - type: boolean - id: - type: integer - ignore_approvals_from_contributors: - type: boolean - linear_history_requirement_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - merge_queue_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - name: + patch_url: type: string - pull_request_reviews_enforcement_level: + format: uri + url: type: string - enum: - - 'off' - - non_admins - - everyone - repository_id: + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": type: integer - require_code_owner_review: - type: boolean - require_last_push_approval: - description: Whether the most recent push must be approved by someone - other than the person who pushed it - type: boolean - required_approving_review_count: + "-1": type: integer - required_conversation_resolution_level: - type: string - enum: - - 'off' - - non_admins - - everyone - required_deployments_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - required_status_checks: - type: array - items: - type: string - required_status_checks_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - signature_requirement_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - strict_required_status_checks_policy: - type: boolean - updated_at: + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: type: string - format: date-time + format: uri required: - - id - - repository_id - - name - - created_at - - updated_at - - pull_request_reviews_enforcement_level - - required_approving_review_count - - dismiss_stale_reviews_on_push - - require_code_owner_review - - authorized_dismissal_actors_only - - ignore_approvals_from_contributors - - required_status_checks - - required_status_checks_enforcement_level - - strict_required_status_checks_policy - - signature_requirement_enforcement_level - - linear_history_requirement_enforcement_level - - admin_enforced - - allow_force_pushes_enforcement_level - - allow_deletions_enforcement_level - - merge_queue_enforcement_level - - required_deployments_enforcement_level - - required_conversation_resolution_level - - authorized_actors_only - - authorized_actor_names - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - rule - - repository - - sender - webhook-check-run-completed: - title: Check Run Completed Event - type: object - properties: - action: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + state: + description: State of the issue; either 'open' or 'closed' type: string enum: - - completed - check_run: - "$ref": "#/components/schemas/check-run-with-simple-check-suite" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - check_run - - repository - - sender - webhook-check-run-completed-form-encoded: - title: Check Run Completed Event - description: The check_run.completed webhook encoded with URL encoding - type: object - properties: - payload: - description: A URL-encoded string of the check_run.completed JSON payload. - The decoded payload is a JSON object. + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: type: string - required: - - payload - webhook-check-run-created: - title: Check Run Created Event - type: object - properties: - action: + format: uri + title: + description: Title of the issue type: string - enum: - - created - check_run: - "$ref": "#/components/schemas/check-run-with-simple-check-suite" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - check_run - - repository - - sender - webhook-check-run-created-form-encoded: - title: Check Run Created Event - description: The check_run.created webhook encoded with URL encoding - type: object - properties: - payload: - description: A URL-encoded string of the check_run.created JSON payload. - The decoded payload is a JSON object. + updated_at: type: string - required: - - payload - webhook-check-run-requested-action: - title: Check Run Requested Action Event - type: object - properties: - action: + format: date-time + url: + description: URL for the issue type: string - enum: - - requested_action - check_run: - "$ref": "#/components/schemas/check-run-with-simple-check-suite" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - requested_action: - description: The action requested by the user. - type: object + format: uri + user: + title: User + type: + - object + - 'null' properties: - identifier: - description: The integrator reference of the action requested by the - user. + avatar_url: type: string - sender: - "$ref": "#/components/schemas/simple-user-webhooks" + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id required: - - action - - check_run - - repository - - sender - webhook-check-run-requested-action-form-encoded: - title: Check Run Requested Action Event - description: The check_run.requested_action webhook encoded with URL encoding + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + webhooks_milestone: + title: Milestone + description: A collection of related issues and pull requests. type: object properties: - payload: - description: A URL-encoded string of the check_run.requested_action JSON - payload. The decoded payload is a JSON object. + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: type: string - required: - - payload - webhook-check-run-rerequested: - title: Check Run Re-Requested Event - type: object - properties: - action: + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. type: string enum: - - rerequested - check_run: - "$ref": "#/components/schemas/check-run-with-simple-check-suite" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - check_run - - repository - - sender - webhook-check-run-rerequested-form-encoded: - title: Check Run Re-Requested Event - description: The check_run.rerequested webhook encoded with URL encoding - type: object - properties: - payload: - description: A URL-encoded string of the check_run.rerequested JSON payload. - The decoded payload is a JSON object. + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: type: string + format: uri required: - - payload - webhook-check-suite-completed: - title: check_suite completed event + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + webhooks_issue_2: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. type: object properties: - action: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. type: string enum: - - completed - check_suite: - description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). - type: object + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' properties: - after: + closed_at: type: - string - 'null' - app: - title: 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. - type: object + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' properties: - created_at: - type: - - string - - 'null' - format: date-time - description: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - string - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - - merge_group - - pull_request_review_thread - - workflow_job - - merge_queue_entry - - security_and_analysis - - projects_v2_item - - secret_scanning_alert_location - external_url: + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: 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. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - string - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string html_url: type: string format: uri id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' + type: integer + login: + type: string name: - description: The name of the GitHub app type: string node_id: type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app + organizations_url: type: string - updated_at: - type: - - string - - 'null' - format: date-time + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri required: + - login - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - before: + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: type: - string - 'null' - check_runs_url: + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: type: string format: uri - conclusion: - description: The summary conclusion for all check runs that are part - of the check suite. This value will be `null` until the check run - has `completed`. + html_url: + type: string + format: uri + merged_at: type: - string - 'null' - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - - - skipped - - startup_failure - created_at: - type: string format: date-time - head_branch: - description: The head branch name the changes are on. + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - string - 'null' - head_commit: - title: SimpleCommit - type: object - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - required: - - id - - tree_id - - message - - timestamp - - author - - committer - head_sha: - description: The SHA of the head commit that is being checked. + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer - latest_check_runs_count: + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + webhooks_user_mannequin: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + webhooks_marketplace_purchase: + title: Marketplace Purchase + type: object + required: + - account + - billing_cycle + - free_trial_ends_on + - next_billing_date + - on_free_trial + - plan + - unit_count + properties: + account: + type: object + required: + - type + - id + - node_id + - login + - organization_billing_email + properties: + id: type: integer + login: + type: string node_id: type: string - pull_requests: - description: An array of pull requests that match this check suite. - A pull request matches a check suite if they have the same `head_sha` - and `head_branch`. When the check suite's `head_branch` is in a forked - repository it will be `null` and the `pull_requests` array will be - empty. + organization_billing_email: + type: + - string + - 'null' + type: + type: string + billing_cycle: + type: string + free_trial_ends_on: + type: + - string + - 'null' + next_billing_date: + type: + - string + - 'null' + on_free_trial: + type: boolean + plan: + type: object + required: + - id + - name + - description + - monthly_price_in_cents + - yearly_price_in_cents + - price_model + - has_free_trial + - unit_name + - bullets + properties: + bullets: type: array items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - rerequestable: - type: boolean - runs_rerequestable: + type: + - string + - 'null' + description: + type: string + has_free_trial: type: boolean - status: - description: The summary status for all check runs that are part of - the check suite. Can be `requested`, `in_progress`, or `completed`. + id: + type: integer + monthly_price_in_cents: + type: integer + name: + type: string + price_model: + type: string + enum: + - FREE + - FLAT_RATE + - PER_UNIT + unit_name: type: - string - 'null' - enum: - - requested - - in_progress - - completed - - queued - - - - pending - updated_at: + yearly_price_in_cents: + type: integer + unit_count: + type: integer + webhooks_previous_marketplace_purchase: + title: Marketplace Purchase + type: object + properties: + account: + type: object + properties: + id: + type: integer + login: type: string - format: date-time - url: - description: URL that points to the check suite API resource. + node_id: + type: string + organization_billing_email: + type: + - string + - 'null' + type: type: string - format: uri required: + - type - id - node_id - - head_branch - - head_sha - - status - - conclusion - - url - - before - - after - - pull_requests - - app - - created_at - - updated_at - - latest_check_runs_count - - check_runs_url - - head_commit - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" + - login + - organization_billing_email + billing_cycle: + type: string + free_trial_ends_on: + type: + - 'null' + next_billing_date: + type: + - string + - 'null' + on_free_trial: + type: boolean + plan: + type: object + properties: + bullets: + type: array + items: + type: string + description: + type: string + has_free_trial: + type: boolean + id: + type: integer + monthly_price_in_cents: + type: integer + name: + type: string + price_model: + type: string + enum: + - FREE + - FLAT_RATE + - PER_UNIT + unit_name: + type: + - string + - 'null' + yearly_price_in_cents: + type: integer + required: + - id + - name + - description + - monthly_price_in_cents + - yearly_price_in_cents + - price_model + - has_free_trial + - unit_name + - bullets + unit_count: + type: integer required: - - action - - check_suite - - repository - - sender - webhook-check-suite-requested: - title: check_suite requested event + - account + - billing_cycle + - unit_count + - on_free_trial + - free_trial_ends_on + - plan + webhooks_team: + title: Team + description: Groups of organization members that gives permissions on specified + repositories. type: object properties: - action: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: type: string - enum: - - requested - check_suite: - description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). - type: object + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' properties: - after: + description: + description: Description of the team type: - string - 'null' - app: - title: 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. - type: object - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - - workflow_job - - merge_queue_entry - - security_and_analysis - - secret_scanning_alert_location - - projects_v2_item - - merge_group - - repository_import - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - before: - type: - - string - - 'null' - check_runs_url: + html_url: type: string format: uri - conclusion: - description: The summary conclusion for all check runs that are part - of the check suite. This value will be `null` until the check run - has completed. - type: - - string - - 'null' + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - - - skipped - created_at: + - open + - closed + - secret + notification_setting: + description: Whether team members will receive notifications when their + team is @mentioned type: string - format: date-time - head_branch: - description: The head branch name the changes are on. + enum: + - notifications_enabled + - notifications_disabled + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - notification_setting + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + notification_setting: + type: string + enum: + - notifications_enabled + - notifications_disabled + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + merge-group: + type: object + title: Merge Group + description: 'A group of pull requests that the merge queue has grouped together + to be merged. + + ' + properties: + head_sha: + description: The SHA of the merge group. + type: string + head_ref: + description: The full ref of the merge group. + type: string + base_sha: + description: The SHA of the merge group's parent commit. + type: string + base_ref: + description: The full ref of the branch the merge group will be merged into. + type: string + head_commit: + "$ref": "#/components/schemas/simple-commit" + required: + - head_sha + - head_ref + - base_sha + - base_ref + - head_commit + webhooks_milestone_3: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - string - 'null' - head_commit: - title: SimpleCommit - type: object - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - required: - - id - - tree_id - - message - - timestamp - - author - - committer - head_sha: - description: The SHA of the head commit that is being checked. + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer - latest_check_runs_count: - type: integer + login: + type: string + name: + type: string node_id: type: string - pull_requests: - description: An array of pull requests that match this check suite. - A pull request matches a check suite if they have the same `head_sha` - and `head_branch`. When the check suite's `head_branch` is in a forked - repository it will be `null` and the `pull_requests` array will be - empty. - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - rerequestable: + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: type: boolean - runs_rerequestable: + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + webhooks_membership: + title: Membership + description: The membership between the user and the organization. Not present + when the action is `member_invited`. + type: object + properties: + organization_url: + type: string + format: uri + role: + type: string + state: + type: string + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: type: boolean - status: - description: The summary status for all check runs that are part of - the check suite. Can be `requested`, `in_progress`, or `completed`. + email: type: - string - 'null' - enum: - - requested - - in_progress - - completed - - queued - - - updated_at: + events_url: type: string - format: date-time + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: - description: URL that points to the check suite API resource. type: string format: uri required: + - login - id - - node_id - - head_branch - - head_sha - - status - - conclusion - - url - - before - - after - - pull_requests - - app - - created_at - - updated_at - - latest_check_runs_count - - check_runs_url - - head_commit - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" required: - - action - - check_suite - - repository - - sender - webhook-check-suite-rerequested: - title: check_suite rerequested event + - url + - state + - role + - organization_url + - user + personal-access-token-request: + title: Personal Access Token Request + description: Details of a Personal Access Token Request. type: object properties: - action: + id: + type: integer + description: Unique identifier of the request for access via fine-grained + personal access token. Used as the `pat_request_id` parameter in the list + and review API calls. + owner: + "$ref": "#/components/schemas/simple-user" + permissions_added: + type: object + description: New requested permissions, categorized by type of permission. + properties: + organization: + type: object + additionalProperties: + type: string + repository: + type: object + additionalProperties: + type: string + other: + type: object + additionalProperties: + type: string + permissions_upgraded: + type: object + description: Requested permissions that elevate access for a previously + approved request for access, categorized by type of permission. + properties: + organization: + type: object + additionalProperties: + type: string + repository: + type: object + additionalProperties: + type: string + other: + type: object + additionalProperties: + type: string + permissions_result: + type: object + description: Permissions requested, categorized by type of permission. This + field incorporates `permissions_added` and `permissions_upgraded`. + properties: + organization: + type: object + additionalProperties: + type: string + repository: + type: object + additionalProperties: + type: string + other: + type: object + additionalProperties: + type: string + repository_selection: type: string + description: Type of repository selection requested. enum: - - rerequested - check_suite: - description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). - type: object + - none + - all + - subset + repository_count: + description: The number of repositories the token is requesting access to. + This field is only populated when `repository_selection` is `subset`. + type: + - integer + - 'null' + repositories: + type: + - array + - 'null' + description: An array of repository objects the token is requesting access + to. This field is only populated when `repository_selection` is `subset`. + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + required: + - id + - node_id + - name + - full_name + - private + created_at: + type: string + description: Date and time when the request for access was created. + token_expired: + type: boolean + description: Whether the associated fine-grained personal access token has + expired. + token_expires_at: + type: + - string + - 'null' + description: Date and time when the associated fine-grained personal access + token expires. + token_last_used_at: + type: + - string + - 'null' + description: Date and time when the associated fine-grained personal access + token was last used for authentication. + required: + - id + - owner + - permissions_added + - permissions_upgraded + - permissions_result + - repository_selection + - repository_count + - repositories + - created_at + - token_expired + - token_expires_at + - token_last_used_at + webhooks_project_card: + title: Project Card + type: object + properties: + after_id: + type: + - integer + - 'null' + archived: + description: Whether or not the card is archived + type: boolean + column_id: + type: integer + column_url: + type: string + format: uri + content_url: + type: string + format: uri + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' properties: - after: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - string - 'null' - app: - title: 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. - type: object - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - - merge_queue_entry - - workflow_job - external_url: + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + id: + description: The project card's ID + type: integer + node_id: + type: string + note: + type: + - string + - 'null' + project_url: + type: string + format: uri + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - project_url + - column_url + - column_id + - id + - node_id + - note + - archived + - creator + - created_at + - updated_at + webhooks_project: + title: Project + type: object + properties: + body: + description: Body of the project + type: + - string + - 'null' + columns_url: + type: string + format: uri + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + html_url: + type: string + format: uri + id: + type: integer + name: + description: Name of the project + type: string + node_id: + type: string + number: + type: integer + owner_url: + type: string + format: uri + state: + description: State of the project; either 'open' or 'closed' + type: string + enum: + - open + - closed + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - owner_url + - url + - html_url + - columns_url + - id + - node_id + - name + - body + - number + - state + - creator + - created_at + - updated_at + webhooks_project_column: + title: Project Column + type: object + properties: + after_id: + type: + - integer + - 'null' + cards_url: + type: string + format: uri + created_at: + type: string + format: date-time + id: + description: The unique identifier of the project column + type: integer + name: + description: Name of the project column + type: string + node_id: + type: string + project_url: + type: string + format: uri + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - project_url + - cards_url + - id + - node_id + - name + - created_at + - updated_at + projects-v2: + title: Projects v2 Project + description: A projects v2 project + type: object + properties: + id: + type: number + node_id: + type: string + owner: + "$ref": "#/components/schemas/simple-user" + creator: + "$ref": "#/components/schemas/simple-user" + title: + type: string + description: + type: + - string + - 'null' + public: + type: boolean + closed_at: + type: + - string + - 'null' + format: date-time + examples: + - '2022-04-28T12:00:00Z' + created_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + number: + type: integer + short_description: + type: + - string + - 'null' + deleted_at: + type: + - string + - 'null' + format: date-time + examples: + - '2022-04-28T12:00:00Z' + deleted_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + required: + - id + - node_id + - owner + - creator + - title + - description + - public + - closed_at + - created_at + - updated_at + - number + - short_description + - deleted_at + - deleted_by + webhooks_project_changes: + type: object + properties: + archived_at: + type: object + properties: + from: + type: + - string + - 'null' + format: date-time + to: + type: + - string + - 'null' + format: date-time + projects-v2-item-content-type: + title: Projects v2 Item Content Type + description: The type of content tracked in a project item + type: string + enum: + - Issue + - PullRequest + - DraftIssue + projects-v2-item: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + node_id: + type: string + project_node_id: + type: string + content_node_id: + type: string + content_type: + "$ref": "#/components/schemas/projects-v2-item-content-type" + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + examples: + - '2022-04-28T12:00:00Z' + archived_at: + type: + - string + - 'null' + format: date-time + examples: + - '2022-04-28T12:00:00Z' + required: + - id + - content_node_id + - content_type + - created_at + - updated_at + - archived_at + webhooks_number: + description: The pull request number. + type: integer + pull-request-webhook: + allOf: + - "$ref": "#/components/schemas/pull-request" + - type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_update_branch: + description: Whether to allow updating the pull request's branch. + type: boolean + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged. + type: boolean + default: false + merge_commit_message: + description: |- + The default value for a merge commit message. + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull request title + as default. **This property has been deprecated. Please use `squash_merge_commit_title` + instead.** + type: boolean + default: false + webhooks_pull_request_5: + title: Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - string - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string html_url: type: string format: uri id: - description: Unique identifier of the GitHub app + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: type: - - integer + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string - 'null' + format: uri name: - description: The name of the GitHub app + description: The name of the repository. type: string node_id: type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string owner: title: User type: @@ -90357,461 +94258,208 @@ components: - login - id permissions: - description: The set of permissions for the GitHub app type: object properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: type: string - updated_at: + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: type: - string - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull request + title as default. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based + commits + type: boolean required: - id - node_id - - owner - name - - description - - external_url + - full_name + - private + - owner - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url - created_at - updated_at - before: - type: - - string - - 'null' - check_runs_url: - type: string - format: uri - conclusion: - description: The summary conclusion for all check runs that are part - of the check suite. This value will be `null` until the check run - has completed. - type: - - string - - 'null' - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - - created_at: - type: string - format: date-time - head_branch: - description: The head branch name the changes are on. - type: - - string - - 'null' - head_commit: - title: SimpleCommit - type: object - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - required: - - id - - tree_id - - message - - timestamp - - author - - committer - head_sha: - description: The SHA of the head commit that is being checked. - type: string - id: - type: integer - latest_check_runs_count: - type: integer - node_id: - type: string - pull_requests: - description: An array of pull requests that match this check suite. - A pull request matches a check suite if they have the same `head_sha` - and `head_branch`. When the check suite's `head_branch` is in a forked - repository it will be `null` and the `pull_requests` array will be - empty. - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - rerequestable: - type: boolean - runs_rerequestable: - type: boolean - status: - description: The summary status for all check runs that are part of - the check suite. Can be `requested`, `in_progress`, or `completed`. - type: - - string - - 'null' - enum: - - requested - - in_progress - - completed - - queued - - - updated_at: - type: string - format: date-time - url: - description: URL that points to the check suite API resource. - type: string - format: uri - required: - - id - - node_id - - head_branch - - head_sha - - status - - conclusion - - url - - before - - after - - pull_requests - - app - - created_at - - updated_at - - latest_check_runs_count - - check_runs_url - - head_commit - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - check_suite - - repository - - sender - webhook-code-scanning-alert-appeared-in-branch: - title: code_scanning_alert appeared_in_branch event - type: object - properties: - action: - type: string - enum: - - appeared_in_branch - alert: - description: The code scanning alert involved in the event. - type: object - properties: - created_at: - description: 'The time that the alert was created in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ.`' + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - type: - - string - - 'null' - format: date-time - dismissed_by: + user: title: User type: - object @@ -90880,701 +94528,800 @@ components: required: - login - id - dismissed_reason: - description: The reason for dismissing or closing the alert. - type: - - string - - 'null' - enum: - - false positive - - won't fix - - used in tests - - - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - most_recent_instance: - title: Alert Instance - type: - - object - - 'null' - properties: - analysis_key: - description: Identifies the configuration under which the analysis - was executed. For example, in GitHub Actions this includes the - workflow filename and job name. - type: string - category: - description: Identifies the configuration under which the analysis - was executed. - type: string - classifications: - type: array - items: - type: string - commit_sha: - type: string - environment: - description: Identifies the variable values associated with the - environment in which the analysis that generated this alert instance - was performed, such as the language that was analyzed. - type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. - type: string - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect the - alert. - type: string - id: - description: A unique identifier for the rule used to detect the - alert. - type: string - severity: - description: The severity of the alert. - type: - - string - - 'null' - enum: - - none - - note - - warning - - error - - - required: - - id - - severity - - description - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - tool: - type: object - properties: - name: - description: The name of the tool used to generate the code scanning - analysis alert. - type: string - version: - description: The version of the tool used to detect the alert. - type: - - string - - 'null' - required: - - name - - version - url: - type: string - format: uri required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - description: The commit SHA of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - ref: - description: The Git reference of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. + format: uri + commits: + type: integer + commits_url: type: string - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - webhook-code-scanning-alert-closed-by-user: - title: code_scanning_alert closed_by_user event - type: object - properties: - action: + format: uri + created_at: type: string - enum: - - closed_by_user - alert: - description: The code scanning alert involved in the event. + format: date-time + deletions: + type: integer + diff_url: + type: string + format: uri + draft: + description: Indicates whether or not the pull request is a draft. + type: boolean + head: type: object properties: - created_at: - description: 'The time that the alert was created in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ.`' + label: type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' + ref: type: string - format: date-time - dismissed_by: - title: User - type: - - object - - 'null' + repo: + title: Repository + description: A git repository + type: object properties: - avatar_url: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: type: string - format: uri - deleted: + format: uri-template + archived: + description: Whether the repository is archived. type: boolean - email: - type: - - string - - 'null' - events_url: + default: false + assignees_url: type: string format: uri-template - followers_url: + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: type: string format: uri - following_url: + collaborators_url: type: string format: uri-template - gists_url: + comments_url: type: string format: uri-template - gravatar_id: + commits_url: type: string - html_url: + format: uri-template + compare_url: type: string - format: uri - id: - type: integer - login: + format: uri-template + contents_url: type: string - name: + format: uri-template + contributors_url: type: string - node_id: + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. type: string - organizations_url: + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: type: string format: uri - received_events_url: + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: type: string format: uri - repos_url: + events_url: type: string format: uri - site_admin: + fork: type: boolean - starred_url: + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: type: string format: uri-template - subscriptions_url: + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: type: string format: uri - type: + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: + - string + - 'null' + hooks_url: type: string - enum: - - Bot - - User - - Organization - url: + format: uri + html_url: type: string format: uri - required: - - login - - id - dismissed_reason: - description: The reason for dismissing or closing the alert. - type: - - string - - 'null' - enum: - - false positive - - won't fix - - used in tests - - - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - most_recent_instance: - title: Alert Instance - type: - - object - - 'null' - properties: - analysis_key: - description: Identifies the configuration under which the analysis - was executed. For example, in GitHub Actions this includes the - workflow filename and job name. + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: type: string - category: - description: Identifies the configuration under which the analysis - was executed. + format: uri-template + issue_events_url: type: string - classifications: - type: array - items: - type: string - commit_sha: + format: uri-template + issues_url: type: string - environment: - description: Identifies the variable values associated with the - environment in which the analysis that generated this alert instance - was performed, such as the language that was analyzed. + format: uri-template + keys_url: type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. - type: string - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect the - alert. - type: string - full_description: + format: uri-template + labels_url: type: string - help: + format: uri-template + language: type: - string - 'null' - help_uri: - description: A link to the documentation for the rule used to detect - the alert. + languages_url: + type: string + format: uri + license: + title: License type: - - string + - object - 'null' - id: - description: A unique identifier for the rule used to detect the - alert. + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: type: string - name: + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. type: string - severity: - description: The severity of the alert. - type: - - string - - 'null' enum: - - none - - note - - warning - - error - - - tags: - type: - - array - - 'null' - items: - type: string - required: - - id - - severity - - description - state: - description: State of a code scanning alert. - type: string - enum: - - dismissed - - fixed - tool: - type: object - properties: - guid: - type: - - string - - 'null' - name: - description: The name of the tool used to generate the code scanning - analysis alert. + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). type: string - version: - description: The version of the tool used to detect the alert. + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: type: - string - 'null' - required: - - name - - version - url: - type: string - format: uri - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - description: The commit SHA of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - ref: - description: The Git reference of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - webhook-code-scanning-alert-created: - title: code_scanning_alert created event - type: object - properties: - action: - type: string - enum: - - created - alert: - description: The code scanning alert involved in the event. - type: object - properties: - created_at: - description: 'The time that the alert was created in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ.`' - type: - - string - - 'null' - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - type: - - 'null' - dismissed_by: - type: - - 'null' - dismissed_comment: - "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" - dismissed_reason: - description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' - type: - - 'null' - fixed_at: - type: - - 'null' - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - instances_url: - type: string - most_recent_instance: - title: Alert Instance - type: - - object - - 'null' - properties: - analysis_key: - description: Identifies the configuration under which the analysis - was executed. For example, in GitHub Actions this includes the - workflow filename and job name. + format: uri + name: + description: The name of the repository. type: string - category: - description: Identifies the configuration under which the analysis - was executed. + node_id: type: string - classifications: - type: array - items: - type: string - commit_sha: + notifications_url: type: string - environment: - description: Identifies the variable values associated with the - environment in which the analysis that generated this alert instance - was performed, such as the language that was analyzed. + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: type: string - location: - type: object + owner: + title: User + type: + - object + - 'null' properties: - end_column: - type: integer - end_line: - type: integer - path: + avatar_url: type: string - start_column: - type: integer - start_line: + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: type: integer - message: + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: type: object properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. - type: string - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect the - alert. - type: string - full_description: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: type: string - help: + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time type: - - string - 'null' - help_uri: - description: A link to the documentation for the rule used to detect - the alert. - type: + - integer - string - - 'null' - id: - description: A unique identifier for the rule used to detect the - alert. - type: string - name: + releases_url: type: string - severity: - description: The severity of the alert. + format: uri-template + role_name: type: - string - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string enum: - - none - - note - - warning - - error - - - tags: - type: - - array - - 'null' + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array items: type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull request + title as default. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based + commits + type: boolean required: - id - - severity + - node_id + - name + - full_name + - private + - owner + - html_url - description - state: - description: State of a code scanning alert. + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: type: string - enum: - - open - - dismissed - tool: + user: + title: User type: - object - 'null' properties: - guid: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - string - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string name: - description: The name of the tool used to generate the code scanning - analysis alert. type: string - version: - description: The version of the tool used to detect the alert. - type: - - string - - 'null' + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri required: - - name - - version - updated_at: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + merge_commit_sha: + type: + - string + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - string - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin url: type: string format: uri required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - description: The commit SHA of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - ref: - description: The Git reference of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - webhook-code-scanning-alert-fixed: - title: code_scanning_alert fixed event - type: object - properties: - action: - type: string - enum: - - fixed - alert: - description: The code scanning alert involved in the event. - type: object + - login + - id + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' properties: - created_at: - description: 'The time that the alert was created in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' + closed_at: type: - string - 'null' format: date-time - dismissed_by: + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: title: User type: - object @@ -91637,2482 +95384,1874 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri required: - login - id - dismissed_reason: - description: The reason for dismissing or closing the alert. + description: type: - string - 'null' - enum: - - false positive - - won't fix - - used in tests - - + due_on: + type: + - string + - 'null' + format: date-time html_url: - description: The GitHub URL of the alert resource. type: string format: uri - instances_url: + id: + type: integer + labels_url: type: string format: uri - most_recent_instance: - title: Alert Instance + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within its repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: + - boolean + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User type: - object - 'null' properties: - analysis_key: - description: Identifies the configuration under which the analysis - was executed. For example, in GitHub Actions this includes the - workflow filename and job name. - type: string - category: - description: Identifies the configuration under which the analysis - was executed. + avatar_url: type: string - classifications: - type: array - items: - type: string - commit_sha: + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: type: string - environment: - description: Identifies the variable values associated with the - environment in which the analysis that generated this alert instance - was performed, such as the language that was analyzed. + format: uri-template + followers_url: type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. + format: uri + following_url: type: string - state: - description: State of a code scanning alert. + format: uri-template + gists_url: type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect the - alert. + format: uri-template + gravatar_id: type: string - full_description: + html_url: type: string - help: - type: - - string - - 'null' - help_uri: - description: A link to the documentation for the rule used to detect - the alert. - type: - - string - - 'null' + format: uri id: - description: A unique identifier for the rule used to detect the - alert. + type: integer + login: type: string name: type: string - severity: - description: The severity of the alert. - type: - - string - - 'null' - enum: - - none - - note - - warning - - error - - - tags: - type: - - array - - 'null' - items: - type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri required: + - login - id - - severity - - description - state: - description: State of a code scanning alert. - type: string - enum: - - fixed - tool: + - title: Team + description: Groups of organization members that gives permissions on + specified repositories. type: object properties: - guid: + deleted: + type: boolean + description: + description: Description of the team type: - string - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template name: - description: The name of the tool used to generate the code scanning - analysis alert. + description: Name of the team type: string - version: - description: The version of the tool used to detect the alert. + node_id: + type: string + parent: type: - - string + - object - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri required: - name - - version - url: - type: string - format: uri - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - description: The commit SHA of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. + - id + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions on + specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - ref: - description: The Git reference of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. + format: uri-template + review_comments: + type: integer + review_comments_url: type: string - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - webhook-code-scanning-alert-reopened: - title: code_scanning_alert reopened event - type: object - properties: - action: + format: uri + state: + description: State of this Pull Request. Either `open` or `closed`. type: string enum: - - reopened - alert: - description: The code scanning alert involved in the event. + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: + title: User type: - object - 'null' properties: - created_at: - description: 'The time that the alert was created in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ.`' + avatar_url: type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - type: - - string - - 'null' - dismissed_by: - type: - - object - - 'null' - dismissed_reason: - description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + format: uri + deleted: + type: boolean + email: type: - string - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string html_url: - description: The GitHub URL of the alert resource. type: string format: uri - most_recent_instance: - title: Alert Instance - type: - - object - - 'null' - properties: - analysis_key: - description: Identifies the configuration under which the analysis - was executed. For example, in GitHub Actions this includes the - workflow filename and job name. - type: string - category: - description: Identifies the configuration under which the analysis - was executed. - type: string - classifications: - type: array - items: - type: string - commit_sha: - type: string - environment: - description: Identifies the variable values associated with the - environment in which the analysis that generated this alert instance - was performed, such as the language that was analyzed. - type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. - type: string - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. + id: type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect the - alert. - type: string - full_description: - type: string - help: - type: - - string - - 'null' - help_uri: - description: A link to the documentation for the rule used to detect - the alert. - type: - - string - - 'null' - id: - description: A unique identifier for the rule used to detect the - alert. - type: string - name: - type: string - severity: - description: The severity of the alert. - type: - - string - - 'null' - enum: - - none - - note - - warning - - error - - - tags: - type: - - array - - 'null' - items: - type: string - required: - - id - - severity - - description - state: - description: State of a code scanning alert. + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string enum: - - open - - dismissed - - fixed - tool: - type: object - properties: - guid: - type: - - string - - 'null' - name: - description: The name of the tool used to generate the code scanning - analysis alert. - type: string - version: - description: The version of the tool used to detect the alert. - type: - - string - - 'null' - required: - - name - - version + - Bot + - User + - Organization + - Mannequin url: type: string format: uri required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - description: The commit SHA of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: - - string - - 'null' - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - ref: - description: The Git reference of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: - - string - - 'null' - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" + - login + - id required: - - action - - alert - - ref - - commit_oid - - repository - - sender - webhook-code-scanning-alert-reopened-by-user: - title: code_scanning_alert reopened_by_user event + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft + webhooks_review_comment: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. type: object properties: - action: - type: string - enum: - - reopened_by_user - alert: - description: The code scanning alert involved in the event. + _links: type: object properties: - created_at: - description: 'The time that the alert was created in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - type: - - 'null' - dismissed_by: - type: - - 'null' - dismissed_reason: - description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' - type: - - 'null' - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - most_recent_instance: - title: Alert Instance - type: - - object - - 'null' + html: + title: Link + type: object properties: - analysis_key: - description: Identifies the configuration under which the analysis - was executed. For example, in GitHub Actions this includes the - workflow filename and job name. - type: string - category: - description: Identifies the configuration under which the analysis - was executed. - type: string - classifications: - type: array - items: - type: string - commit_sha: - type: string - environment: - description: Identifies the variable values associated with the - environment in which the analysis that generated this alert instance - was performed, such as the language that was analyzed. - type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. - type: string - state: - description: State of a code scanning alert. + href: type: string - enum: - - open - - dismissed - - fixed + format: uri-template required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: + - href + pull_request: + title: Link type: object properties: - description: - description: A short description of the rule used to detect the - alert. - type: string - id: - description: A unique identifier for the rule used to detect the - alert. + href: type: string - severity: - description: The severity of the alert. - type: - - string - - 'null' - enum: - - none - - note - - warning - - error - - + format: uri-template required: - - id - - severity - - description - state: - description: State of a code scanning alert. - type: string - enum: - - open - - fixed - tool: + - href + self: + title: Link type: object properties: - name: - description: The name of the tool used to generate the code scanning - analysis alert. + href: type: string - version: - description: The version of the tool used to detect the alert. - type: - - string - - 'null' + format: uri-template required: - - name - - version + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment applies. The last + line of the range for a multi-line comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the comment applies. + type: string + original_line: + description: The line of the blob to which the comment applies. The last + line of the range for a multi-line comment + type: integer + original_position: + description: The index of the original line in the diff to which the comment + applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the comment applies. + type: string + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review comment belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer url: type: string format: uri required: - - number - - created_at - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - description: The commit SHA of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - ref: - description: The Git reference of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for a multi-line comment. type: string - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - webhook-commit-comment-created: - title: commit_comment created event - type: object - properties: - action: - description: The action performed. Can be `created`. + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for a multi-line comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, can be a diff line + or a file. type: string enum: - - created - comment: - description: The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) - resource. - type: object + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. + avatar_url: type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: type: string - commit_id: - description: The SHA of the commit to which the comment applies. + format: uri-template + followers_url: type: string - created_at: + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: type: string html_url: type: string format: uri id: - description: The ID of the commit comment. type: integer - line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment - type: - - integer - - 'null' + login: + type: string + name: + type: string node_id: - description: The node ID of the commit comment. type: string - path: - description: The relative path of the file to which the comment applies. - type: - - string - - 'null' - position: - description: The line index in the diff to which the comment applies. - type: - - integer - - 'null' - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - updated_at: + organizations_url: type: string - url: + format: uri + received_events_url: type: string format: uri - user: - title: User - type: - - object - - 'null' + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + webhooks_review: + description: The review that was affected. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: + href: type: string format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: + required: + - href + pull_request: + title: Link + type: object + properties: + href: type: string format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri required: - - login - - id + - href required: - - url - - html_url - - id - - node_id - - user - - position - - line - - path - - commit_id - - created_at - - updated_at - - author_association - - body - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - comment - - repository - - sender - webhook-create: - title: create event - type: object - properties: - description: - description: The repository's current description. + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the review. type: - string - 'null' - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - master_branch: - description: The name of the repository's default branch (usually `main`). - type: string - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pusher_type: - description: The pusher type for the event. Can be either `user` or a deploy - key. + commit_id: + description: A commit SHA for the review. type: string - ref: - description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) - resource. + html_url: type: string - ref_type: - description: The type of Git ref object created in the repository. + format: uri + id: + description: Unique identifier of the review + type: integer + node_id: type: string - enum: - - tag - - branch - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - ref - - ref_type - - master_branch - - description - - pusher_type - - repository - - sender - webhook-custom-property-created: - title: custom property created event - type: object - properties: - action: + pull_request_url: type: string - enum: - - created - definition: - "$ref": "#/components/schemas/org-custom-property" - 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-webhooks" - required: - - action - - definition - - organization - webhook-custom-property-deleted: - title: custom property deleted event - type: object - properties: - action: + format: uri + state: type: string - enum: - - deleted - definition: - type: object + submitted_at: + type: + - string + - 'null' + format: date-time + user: + title: User + type: + - object + - 'null' properties: - property_name: + avatar_url: type: string - description: The name of the property that was deleted. - required: - - property_name - 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-webhooks" - required: - - action - - definition - - organization - webhook-custom-property-updated: - title: custom property updated event - type: object - properties: - action: - type: string - enum: - - updated - definition: - "$ref": "#/components/schemas/org-custom-property" - 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-webhooks" - required: - - action - - definition - - organization - webhook-custom-property-values-updated: - title: Custom property values updated event - type: object - properties: - action: - type: string - enum: - - updated - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - repository: - "$ref": "#/components/schemas/repository-webhooks" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - new_property_values: - type: array - description: The new custom property values for the repository. - items: - "$ref": "#/components/schemas/custom-property-value" - old_property_values: - type: array - description: The old custom property values for the repository. - items: - "$ref": "#/components/schemas/custom-property-value" - required: - - action - - repository - - organization - - new_property_values - - old_property_values - webhook-delete: - title: delete event - type: object - properties: - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pusher_type: - description: The pusher type for the event. Can be either `user` or a deploy - key. - type: string - ref: - description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) - resource. - type: string - ref_type: - description: The type of Git ref object deleted in the repository. - type: string - enum: - - tag - - branch - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - ref - - ref_type - - pusher_type - - repository - - sender - webhook-dependabot-alert-auto-dismissed: - title: Dependabot alert auto-dismissed event - type: object - properties: - action: - type: string - enum: - - auto_dismissed - alert: - "$ref": "#/components/schemas/dependabot-alert" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-dependabot-alert-auto-reopened: - title: Dependabot alert auto-reopened event - type: object - properties: - action: - type: string - enum: - - auto_reopened - alert: - "$ref": "#/components/schemas/dependabot-alert" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-dependabot-alert-created: - title: Dependabot alert created event - type: object - properties: - action: - type: string - enum: - - created - alert: - "$ref": "#/components/schemas/dependabot-alert" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-dependabot-alert-dismissed: - title: Dependabot alert dismissed event - type: object - properties: - action: - type: string - enum: - - dismissed - alert: - "$ref": "#/components/schemas/dependabot-alert" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-dependabot-alert-fixed: - title: Dependabot alert fixed event - type: object - properties: - action: - type: string - enum: - - fixed - alert: - "$ref": "#/components/schemas/dependabot-alert" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-dependabot-alert-reintroduced: - title: Dependabot alert reintroduced event - type: object - properties: - action: - type: string - enum: - - reintroduced - alert: - "$ref": "#/components/schemas/dependabot-alert" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-dependabot-alert-reopened: - title: Dependabot alert reopened event - type: object - properties: - action: - type: string - enum: - - reopened - alert: - "$ref": "#/components/schemas/dependabot-alert" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-deploy-key-created: - title: deploy_key created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - key: - description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) - resource. - type: object - properties: - added_by: + format: uri + deleted: + type: boolean + email: type: - string - 'null' - created_at: + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer - key: + login: type: string - last_used: - type: - - string - - 'null' - read_only: + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: type: boolean - title: + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string + enum: + - Bot + - User + - Organization url: type: string format: uri - verified: - type: boolean required: + - login - id - - key - - url - - title - - verified - - created_at - - read_only - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" required: - - action - - key - - repository - - sender - webhook-deploy-key-deleted: - title: deploy_key deleted event + - id + - node_id + - user + - body + - commit_id + - submitted_at + - state + - html_url + - pull_request_url + - author_association + - _links + webhooks_nullable_string: + type: + - string + - 'null' + webhooks_release: + title: Release + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) + object. type: object properties: - action: + assets: + type: array + items: + title: Release Asset + description: Data related to a release. + type: object + properties: + browser_download_url: + type: string + format: uri + content_type: + type: string + created_at: + type: string + format: date-time + download_count: + type: integer + id: + type: integer + label: + type: + - string + - 'null' + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + url: + type: string + format: uri + required: + - url + - browser_download_url + - id + - node_id + - name + - label + - state + - content_type + - size + - download_count + - created_at + - updated_at + assets_url: type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - key: - description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) - resource. - type: object + format: uri + author: + title: User + type: + - object + - 'null' properties: - added_by: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - string - 'null' - created_at: + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer - key: + login: type: string - last_used: - type: - - string - - 'null' - read_only: + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: type: boolean - title: + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string + enum: + - Bot + - User + - Organization url: type: string format: uri - verified: - type: boolean required: + - login - id - - key - - url - - title - - verified - - created_at - - read_only - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - key - - repository - - sender - webhook-deployment-created: - title: deployment created event - type: object - properties: - action: + body: + type: + - string + - 'null' + created_at: + type: + - string + - 'null' + format: date-time + discussion_url: type: string - enum: - - created - deployment: - title: Deployment - description: The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). + format: uri + draft: + description: Whether the release is a draft or published + type: boolean + html_url: + type: string + format: uri + id: + type: integer + name: + type: + - string + - 'null' + node_id: + type: string + prerelease: + description: Whether the release is identified as a prerelease or a full + release. + type: boolean + published_at: + type: + - string + - 'null' + format: date-time + reactions: + title: Reactions type: object properties: - created_at: - type: string - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - environment: - type: string - id: + "+1": type: integer - node_id: - type: string - original_environment: - type: string - payload: - oneOf: - - type: object - - type: string - performed_via_github_app: - title: 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. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - - workflow_job - - pull_request_review_thread - - merge_queue_entry - - secret_scanning_alert_location - - merge_group - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - production_environment: - type: boolean - ref: - type: string - repository_url: - type: string - format: uri - sha: - type: string - statuses_url: - type: string - format: uri - task: - type: string - transient_environment: - type: boolean - updated_at: - type: string - url: + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: type: string format: uri required: - url - - id - - node_id - - sha - - ref - - task - - payload - - original_environment - - environment - - description - - creator - - created_at - - updated_at - - statuses_url - - repository_url - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - workflow: - title: Workflow + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + tag_name: + description: The name of the tag. + type: string + tarball_url: + type: + - string + - 'null' + format: uri + target_commitish: + description: Specifies the commitish value that determines where the Git + tag is created from. + type: string + upload_url: + type: string + format: uri-template + url: + type: string + format: uri + zipball_url: + type: + - string + - 'null' + format: uri + required: + - url + - assets_url + - upload_url + - html_url + - id + - node_id + - tag_name + - target_commitish + - name + - draft + - author + - prerelease + - created_at + - published_at + - assets + - tarball_url + - zipball_url + - body + webhooks_release_1: + title: Release + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) + object. + type: object + required: + - assets + - assets_url + - author + - body + - created_at + - draft + - html_url + - id + - name + - node_id + - prerelease + - published_at + - tag_name + - tarball_url + - target_commitish + - upload_url + - url + - zipball_url + properties: + assets: + type: array + items: + title: Release Asset + description: Data related to a release. + type: + - object + - 'null' + required: + - url + - browser_download_url + - id + - node_id + - name + - label + - state + - content_type + - size + - download_count + - created_at + - updated_at + properties: + browser_download_url: + type: string + format: uri + content_type: + type: string + created_at: + type: string + format: date-time + download_count: + type: integer + id: + type: integer + label: + type: + - string + - 'null' + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + url: + type: string + format: uri + assets_url: + type: string + format: uri + author: + title: User type: - object - 'null' + required: + - login + - id properties: - badge_url: + avatar_url: type: string format: uri - created_at: + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: type: string - format: date-time html_url: type: string format: uri id: type: integer + login: + type: string name: type: string node_id: type: string - path: + organizations_url: type: string - state: + format: uri + received_events_url: type: string - updated_at: + format: uri + repos_url: type: string - format: date-time + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: type: string format: uri + body: + type: + - string + - 'null' + created_at: + type: + - string + - 'null' + format: date-time + discussion_url: + type: string + format: uri + draft: + description: Whether the release is a draft or published + type: boolean + html_url: + type: string + format: uri + id: + type: integer + name: + type: + - string + - 'null' + node_id: + type: string + prerelease: + description: Whether the release is identified as a prerelease or a full + release. + type: boolean + published_at: + type: + - string + - 'null' + format: date-time + reactions: + title: Reactions + type: object required: - - badge_url - - created_at - - html_url - - id - - name - - node_id - - path - - state - - updated_at - url - workflow_run: - title: Deployment Workflow Run + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + tag_name: + description: The name of the tag. + type: string + tarball_url: + type: + - string + - 'null' + format: uri + target_commitish: + description: Specifies the commitish value that determines where the Git + tag is created from. + type: string + upload_url: + type: string + format: uri-template + url: + type: string + format: uri + zipball_url: + type: + - string + - 'null' + format: uri + webhooks_alert: + title: Repository Vulnerability Alert Alert + description: The security alert of the vulnerable dependency. + type: object + required: + - affected_package_name + - affected_range + - created_at + - external_identifier + - external_reference + - ghsa_id + - id + - node_id + - number + - severity + - state + properties: + affected_package_name: + type: string + affected_range: + type: string + created_at: + type: string + dismiss_reason: + type: string + dismissed_at: + type: string + dismisser: + title: User type: - object - 'null' + required: + - login + - id properties: - actor: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: + avatar_url: type: string - conclusion: + format: uri + deleted: + type: boolean + email: type: - string - 'null' - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - - created_at: + events_url: type: string - format: date-time - display_title: + format: uri-template + followers_url: type: string - event: + format: uri + following_url: type: string - head_branch: + format: uri-template + gists_url: type: string - head_commit: - type: - - 'null' - head_repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: - - 'null' - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - head_sha: + format: uri-template + gravatar_id: type: string html_url: type: string format: uri id: type: integer - jobs_url: - type: string - logs_url: + login: type: string name: type: string node_id: type: string - path: + organizations_url: type: string - previous_attempt_url: - type: - - 'null' - pull_requests: - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - referenced_workflows: - type: - - array - - 'null' - items: - type: object - properties: - path: - type: string - ref: - type: string - sha: - type: string - required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: - - 'null' - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: + format: uri + received_events_url: type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: + format: uri + repos_url: type: string - format: date-time - status: + format: uri + site_admin: + type: boolean + starred_url: type: string - enum: - - requested - - in_progress - - completed - - queued - - waiting - - pending - triggering_actor: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - updated_at: + format: uri-template + subscriptions_url: type: string - format: date-time + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: type: string format: uri - workflow_id: - type: integer - workflow_url: - type: string - required: - - id - - name - - node_id - - head_branch - - head_sha - - run_number - - event - - status - - conclusion - - workflow_id - - check_suite_id - - check_suite_node_id - - url - - html_url - - path - - pull_requests - - created_at - - updated_at - - actor - - run_attempt - - run_started_at - - display_title - required: - - action - - deployment - - workflow - - workflow_run - - repository - - sender - webhook-deployment-protection-rule-requested: - title: deployment protection rule requested event + external_identifier: + type: string + external_reference: + type: + - string + - 'null' + format: uri + fix_reason: + type: string + fixed_at: + type: string + format: date-time + fixed_in: + type: string + ghsa_id: + type: string + id: + type: integer + node_id: + type: string + number: + type: integer + severity: + type: string + state: + type: string + enum: + - open + secret-scanning-alert-resolution-webhook: + type: + - string + - 'null' + description: The reason for resolving the alert. + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + - pattern_deleted + - pattern_edited + - + secret-scanning-alert-webhook: type: object properties: - action: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/alert-updated-at" + url: + "$ref": "#/components/schemas/alert-url" + html_url: + "$ref": "#/components/schemas/alert-html-url" + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + resolution: + "$ref": "#/components/schemas/secret-scanning-alert-resolution-webhook" + resolved_at: + type: + - string + - 'null' + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + resolved_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + resolution_comment: + type: + - string + - 'null' + description: An optional comment to resolve an alert. + secret_type: + type: string + description: The type of secret that secret scanning detected. + validity: type: string + description: The token status as of the latest validity check. enum: - - requested - environment: - description: The name of the environment that has the deployment protection - rule. + - active + - inactive + - unknown + push_protection_bypassed: + type: + - boolean + - 'null' + description: Whether push protection was bypassed for the detected secret. + push_protection_bypassed_by: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/simple-user" + push_protection_bypassed_at: + type: + - string + - 'null' + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + webhooks_security_advisory: + description: The details of the security advisory, including summary, description, + and severity. + type: object + properties: + cvss: + type: object + properties: + score: + type: number + vector_string: + type: + - string + - 'null' + required: + - vector_string + - score + cwes: + type: array + items: + type: object + properties: + cwe_id: + type: string + name: + type: string + required: + - cwe_id + - name + description: type: string - event: - description: The event that triggered the deployment protection rule. + ghsa_id: type: string - deployment_callback_url: - description: The URL to review the deployment protection rule. + identifiers: + type: array + items: + type: object + properties: + type: + type: string + value: + type: string + required: + - value + - type + published_at: type: string - format: uri - deployment: - "$ref": "#/components/schemas/deployment" - pull_requests: + references: type: array items: - "$ref": "#/components/schemas/pull-request" - repository: - "$ref": "#/components/schemas/repository-webhooks" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - webhook-deployment-review-approved: + type: object + properties: + url: + type: string + format: uri + required: + - url + severity: + type: string + summary: + type: string + updated_at: + type: string + vulnerabilities: + type: array + items: + type: object + properties: + first_patched_version: + type: + - object + - 'null' + properties: + identifier: + type: string + required: + - identifier + package: + type: object + properties: + ecosystem: + type: string + name: + type: string + required: + - ecosystem + - name + severity: + type: string + vulnerable_version_range: + type: string + required: + - package + - severity + - vulnerable_version_range + - first_patched_version + withdrawn_at: + type: + - string + - 'null' + required: + - cvss + - cwes + - ghsa_id + - summary + - description + - severity + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + - vulnerabilities + webhooks_sponsorship: type: object properties: - action: + created_at: type: string - enum: - - approved - approver: + maintainer: type: object properties: avatar_url: @@ -94151,419 +97290,1169 @@ components: type: string url: type: string - comment: + node_id: type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - reviewers: - type: array - items: - type: object - properties: - reviewer: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - type: - type: string - enum: - - User - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - since: + privacy_level: type: string - workflow_job_run: - type: object + sponsor: + title: User + type: + - object + - 'null' properties: - conclusion: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: + - string - 'null' - created_at: + events_url: type: string - environment: + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: type: string html_url: type: string + format: uri id: type: integer + login: + type: string name: - type: - - 'null' - status: type: string - updated_at: + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: type: string + format: uri required: + - login - id - - name - - status - - conclusion - - html_url - - created_at - - updated_at - - environment - workflow_job_runs: - type: array - items: - type: object - properties: - conclusion: - type: - - 'null' - created_at: - type: string - environment: - type: string - html_url: - type: string - id: - type: integer - name: - type: - - string - - 'null' - status: - type: string - updated_at: - type: string - workflow_run: - title: Deployment Workflow Run + sponsorable: + title: User type: - object - 'null' properties: - actor: - title: User + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - - object + - string - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - artifacts_url: + events_url: type: string - cancel_url: + format: uri-template + followers_url: type: string - check_suite_id: + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: type: integer - check_suite_node_id: + login: type: string - check_suite_url: + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string - conclusion: - type: - - string - - 'null' enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + tier: + title: Sponsorship Tier + description: The `tier_changed` and `pending_tier_change` will include the + original tier before the change or pending change. For more information, + see the pending tier change payload. + type: object + properties: created_at: type: string - format: date-time - display_title: + description: type: string - event: + is_custom_ammount: + type: boolean + is_custom_amount: + type: boolean + is_one_time: + type: boolean + monthly_price_in_cents: + type: integer + monthly_price_in_dollars: + type: integer + name: type: string - head_branch: + node_id: type: string - head_commit: - type: - - object - - 'null' - head_repository: + required: + - node_id + - created_at + - description + - monthly_price_in_cents + - monthly_price_in_dollars + - name + - is_one_time + required: + - node_id + - created_at + - sponsorable + - sponsor + - privacy_level + - tier + webhooks_effective_date: + description: The `pending_cancellation` and `pending_tier_change` event types + will include the date the cancellation or tier change will take effect. + type: string + webhooks_changes_8: + type: object + properties: + tier: + type: object + properties: + from: + title: Sponsorship Tier + description: The `tier_changed` and `pending_tier_change` will include + the original tier before the change or pending change. For more information, + see the pending tier change payload. type: object properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: + created_at: type: string description: - type: - - string - - 'null' - downloads_url: - type: string - events_url: type: string - fork: + is_custom_ammount: type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: + is_custom_amount: + type: boolean + is_one_time: + type: boolean + monthly_price_in_cents: + type: integer + monthly_price_in_dollars: type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string name: type: string node_id: type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - head_sha: - type: string + required: + - node_id + - created_at + - description + - monthly_price_in_cents + - monthly_price_in_dollars + - name + - is_one_time + required: + - from + required: + - tier + webhooks_team_1: + title: Team + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' html_url: type: string format: uri id: + description: Unique identifier of the team type: integer - jobs_url: - type: string - logs_url: + members_url: type: string + format: uri-template name: + description: Name of the team type: string node_id: type: string - path: + permission: + description: Permission that the team will have for its repositories type: string - previous_attempt_url: + privacy: + type: string + enum: + - open + - closed + - secret + notification_setting: + description: Whether team members will receive notifications when their + team is @mentioned + type: string + enum: + - notifications_enabled + - notifications_disabled + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - notification_setting + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + notification_setting: + description: Whether team members will receive notifications when their + team is @mentioned + type: string + enum: + - notifications_enabled + - notifications_disabled + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + webhook-branch-protection-configuration-disabled: + title: branch protection configuration disabled event + type: object + properties: + action: + type: string + enum: + - disabled + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-branch-protection-configuration-enabled: + title: branch protection configuration enabled event + type: object + properties: + action: + type: string + enum: + - enabled + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-branch-protection-rule-created: + title: branch protection rule created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + rule: + "$ref": "#/components/schemas/webhooks_rule" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - rule + - repository + - sender + webhook-branch-protection-rule-deleted: + title: branch protection rule deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + rule: + "$ref": "#/components/schemas/webhooks_rule" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - rule + - repository + - sender + webhook-branch-protection-rule-edited: + title: branch protection rule edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + description: If the action was `edited`, the changes to the rule. + type: object + properties: + admin_enforced: + type: object + properties: + from: + type: + - boolean + - 'null' + required: + - from + authorized_actor_names: + type: object + properties: + from: + type: array + items: + type: string + required: + - from + authorized_actors_only: + type: object + properties: + from: + type: + - boolean + - 'null' + required: + - from + authorized_dismissal_actors_only: + type: object + properties: + from: + type: + - boolean + - 'null' + required: + - from + linear_history_requirement_enforcement_level: + type: object + properties: + from: + type: string + enum: + - 'off' + - non_admins + - everyone + required: + - from + required_status_checks: + type: object + properties: + from: + type: array + items: + type: string + required: + - from + required_status_checks_enforcement_level: + type: object + properties: + from: + type: string + enum: + - 'off' + - non_admins + - everyone + required: + - from + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + rule: + "$ref": "#/components/schemas/webhooks_rule" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - rule + - repository + - sender + webhook-check-run-completed: + title: Check Run Completed Event + type: object + properties: + action: + type: string + enum: + - completed + check_run: + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - check_run + - repository + - sender + webhook-check-run-completed-form-encoded: + title: Check Run Completed Event + description: The check_run.completed webhook encoded with URL encoding + type: object + properties: + payload: + description: A URL-encoded string of the check_run.completed JSON payload. + The decoded payload is a JSON object. + type: string + required: + - payload + webhook-check-run-created: + title: Check Run Created Event + type: object + properties: + action: + type: string + enum: + - created + check_run: + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - check_run + - repository + - sender + webhook-check-run-created-form-encoded: + title: Check Run Created Event + description: The check_run.created webhook encoded with URL encoding + type: object + properties: + payload: + description: A URL-encoded string of the check_run.created JSON payload. + The decoded payload is a JSON object. + type: string + required: + - payload + webhook-check-run-requested-action: + title: Check Run Requested Action Event + type: object + properties: + action: + type: string + enum: + - requested_action + check_run: + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requested_action: + description: The action requested by the user. + type: object + properties: + identifier: + description: The integrator reference of the action requested by the + user. + type: string + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - check_run + - repository + - sender + webhook-check-run-requested-action-form-encoded: + title: Check Run Requested Action Event + description: The check_run.requested_action webhook encoded with URL encoding + type: object + properties: + payload: + description: A URL-encoded string of the check_run.requested_action JSON + payload. The decoded payload is a JSON object. + type: string + required: + - payload + webhook-check-run-rerequested: + title: Check Run Re-Requested Event + type: object + properties: + action: + type: string + enum: + - rerequested + check_run: + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - check_run + - repository + - sender + webhook-check-run-rerequested-form-encoded: + title: Check Run Re-Requested Event + description: The check_run.rerequested webhook encoded with URL encoding + type: object + properties: + payload: + description: A URL-encoded string of the check_run.rerequested JSON payload. + The decoded payload is a JSON object. + type: string + required: + - payload + webhook-check-suite-completed: + title: check_suite completed event + type: object + properties: + action: + type: string + enum: + - completed + check_suite: + description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: + type: + - string + - 'null' + app: + title: 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. + type: object + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + - merge_group + - pull_request_review_thread + - workflow_job + - merge_queue_entry + - security_and_analysis + - projects_v2_item + - secret_scanning_alert_location + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + - admin + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: + type: + - string + - 'null' + check_runs_url: + type: string + format: uri + conclusion: + description: The summary conclusion for all check runs that are part + of the check suite. This value will be `null` until the check run + has `completed`. + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - skipped + - startup_failure + created_at: + type: string + format: date-time + head_branch: + description: The head branch name the changes are on. type: - string - 'null' + head_commit: + title: SimpleCommit + type: object + properties: + author: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + id: + type: string + message: + type: string + timestamp: + type: string + tree_id: + type: string + required: + - id + - tree_id + - message + - timestamp + - author + - committer + head_sha: + description: The SHA of the head commit that is being checked. + type: string + id: + type: integer + latest_check_runs_count: + type: integer + node_id: + type: string pull_requests: + description: An array of pull requests that match this check suite. + A pull request matches a check suite if they have the same `head_sha` + and `head_branch`. When the check suite's `head_branch` is in a forked + repository it will be `null` and the `pull_requests` array will be + empty. type: array items: title: Check Run Pull Request @@ -94634,563 +98523,451 @@ components: - number - head - base - referenced_workflows: + rerequestable: + type: boolean + runs_rerequestable: + type: boolean + status: + description: The summary status for all check runs that are part of + the check suite. Can be `requested`, `in_progress`, or `completed`. type: - - array + - string - 'null' - items: - type: object - properties: - path: - type: string - ref: - type: string - sha: - type: string - required: - - path - - sha - repository: + enum: + - requested + - in_progress + - completed + - queued + - + - pending + updated_at: + type: string + format: date-time + url: + description: URL that points to the check suite API resource. + type: string + format: uri + required: + - id + - node_id + - head_branch + - head_sha + - status + - conclusion + - url + - before + - after + - pull_requests + - app + - created_at + - updated_at + - latest_check_runs_count + - check_runs_url + - head_commit + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - check_suite + - repository + - sender + webhook-check-suite-requested: + title: check_suite requested event + type: object + properties: + action: + type: string + enum: + - requested + check_suite: + description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: + type: + - string + - 'null' + app: + title: 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. type: object properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string + created_at: + type: + - string + - 'null' + format: date-time description: type: - string - 'null' - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + - workflow_job + - merge_queue_entry + - security_and_analysis + - secret_scanning_alert_location + - projects_v2_item + - merge_group + - repository_import + external_url: + type: + - string + - 'null' + format: uri html_url: type: string + format: uri id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string + description: Unique identifier of the GitHub app + type: + - integer + - 'null' name: + description: The name of the GitHub app type: string node_id: type: string - notifications_url: - type: string owner: - type: object + title: User + type: + - object + - 'null' properties: avatar_url: type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string + format: uri-template gravatar_id: type: string html_url: type: string + format: uri id: type: integer login: type: string + name: + type: string node_id: type: string organizations_url: type: string + format: uri received_events_url: type: string + format: uri repos_url: type: string + format: uri site_admin: type: boolean starred_url: type: string + format: uri-template subscriptions_url: type: string + format: uri type: type: string + enum: + - Bot + - User + - Organization url: type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: - type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: - type: string - enum: - - requested - - in_progress - - completed - - queued - - waiting - - pending - triggering_actor: - title: User - type: - - object - - 'null' - properties: - avatar_url: + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + - admin + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app type: string - format: uri - deleted: - type: boolean - email: + updated_at: type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri + format: date-time required: - - login - id - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - required: - - id - - name - - node_id - - head_branch - - head_sha - - run_number - - event - - status - - conclusion - - workflow_id - - check_suite_id - - check_suite_node_id - - url - - html_url - - path - - pull_requests - - created_at - - updated_at - - actor - - triggering_actor - - run_attempt - - run_started_at - - display_title - required: - - action - - workflow_run - - since - - repository - - organization - - sender - webhook-deployment-review-rejected: - type: object - properties: - action: - type: string - enum: - - rejected - approver: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - comment: - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - reviewers: - type: array - items: - type: object - properties: - reviewer: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - type: - type: string - enum: - - User - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - since: - type: string - workflow_job_run: - type: object - properties: - conclusion: - type: - - 'null' - created_at: - type: string - environment: - type: string - html_url: - type: string - id: - type: integer - name: - type: - - 'null' - status: - type: string - updated_at: - type: string - required: - - id - - name - - status - - conclusion - - html_url - - created_at - - updated_at - - environment - workflow_job_runs: - type: array - items: - type: object - properties: - conclusion: - type: - - string - - 'null' - created_at: - type: string - environment: - type: string - html_url: - type: string - id: - type: integer - name: - type: - - string - - 'null' - status: - type: string - updated_at: - type: string - workflow_run: - title: Deployment Workflow Run - type: - - object - - 'null' - properties: - actor: - title: User + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: type: - - object + - string - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: + check_runs_url: type: string + format: uri conclusion: + description: The summary conclusion for all check runs that are part + of the check suite. This value will be `null` until the check run + has completed. type: - string - 'null' @@ -95203,173 +98980,91 @@ components: - action_required - stale - + - skipped created_at: type: string format: date-time - event: - type: string head_branch: - type: string - head_commit: + description: The head branch name the changes are on. type: - - object + - string - 'null' - head_repository: + head_commit: + title: SimpleCommit type: object properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: - - string - - 'null' - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: + author: + title: Committer + description: Metaproperties for Git author/committer information. type: object properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: + date: type: string - repos_url: + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. type: string - site_admin: - type: boolean - starred_url: + username: type: string - subscriptions_url: + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: type: string - type: + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. type: string - url: + username: type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: + required: + - email + - name + id: type: string - teams_url: + message: type: string - trees_url: + timestamp: type: string - url: + tree_id: type: string + required: + - id + - tree_id + - message + - timestamp + - author + - committer head_sha: + description: The SHA of the head commit that is being checked. type: string - html_url: - type: string - format: uri id: type: integer - jobs_url: - type: string - logs_url: - type: string - name: - type: string + latest_check_runs_count: + type: integer node_id: type: string - path: - type: string - previous_attempt_url: - type: - - string - - 'null' pull_requests: + description: An array of pull requests that match this check suite. + A pull request matches a check suite if they have the same `head_sha` + and `head_branch`. When the check suite's `head_branch` is in a forked + repository it will be `null` and the `pull_requests` array will be + empty. type: array items: title: Check Run Pull Request @@ -95440,491 +99135,691 @@ components: - number - head - base - referenced_workflows: + rerequestable: + type: boolean + runs_rerequestable: + type: boolean + status: + description: The summary status for all check runs that are part of + the check suite. Can be `requested`, `in_progress`, or `completed`. type: - - array + - string - 'null' - items: - type: object - properties: - path: - type: string - ref: - type: string - sha: - type: string - required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string + enum: + - requested + - in_progress + - completed + - queued + - + updated_at: + type: string + format: date-time + url: + description: URL that points to the check suite API resource. + type: string + format: uri + required: + - id + - node_id + - head_branch + - head_sha + - status + - conclusion + - url + - before + - after + - pull_requests + - app + - created_at + - updated_at + - latest_check_runs_count + - check_runs_url + - head_commit + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - check_suite + - repository + - sender + webhook-check-suite-rerequested: + title: check_suite rerequested event + type: object + properties: + action: + type: string + enum: + - rerequested + check_suite: + description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: + type: + - string + - 'null' + app: + title: 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. + type: object + properties: + created_at: + type: + - string + - 'null' + format: date-time description: type: - string - 'null' - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + - merge_queue_entry + - workflow_job + external_url: + type: + - string + - 'null' + format: uri html_url: type: string + format: uri id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string + description: Unique identifier of the GitHub app + type: + - integer + - 'null' name: + description: The name of the GitHub app type: string node_id: type: string - notifications_url: - type: string owner: - type: object + title: User + type: + - object + - 'null' properties: avatar_url: type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string + format: uri-template gravatar_id: type: string html_url: type: string + format: uri id: type: integer login: type: string + name: + type: string node_id: type: string organizations_url: type: string + format: uri received_events_url: type: string + format: uri repos_url: type: string + format: uri site_admin: type: boolean starred_url: type: string + format: uri-template subscriptions_url: type: string + format: uri type: type: string + enum: + - Bot + - User + - Organization url: type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + - admin + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app type: string - tags_url: + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: + type: + - string + - 'null' + check_runs_url: + type: string + format: uri + conclusion: + description: The summary conclusion for all check runs that are part + of the check suite. This value will be `null` until the check run + has completed. + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + head_branch: + description: The head branch name the changes are on. + type: + - string + - 'null' + head_commit: + title: SimpleCommit + type: object + properties: + author: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + id: type: string - teams_url: + message: type: string - trees_url: + timestamp: type: string - url: + tree_id: type: string - rerun_url: + required: + - id + - tree_id + - message + - timestamp + - author + - committer + head_sha: + description: The SHA of the head commit that is being checked. type: string - run_attempt: + id: type: integer - run_number: + latest_check_runs_count: type: integer - run_started_at: + node_id: type: string - format: date-time + pull_requests: + description: An array of pull requests that match this check suite. + A pull request matches a check suite if they have the same `head_sha` + and `head_branch`. When the check suite's `head_branch` is in a forked + repository it will be `null` and the `pull_requests` array will be + empty. + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + rerequestable: + type: boolean + runs_rerequestable: + type: boolean status: - type: string + description: The summary status for all check runs that are part of + the check suite. Can be `requested`, `in_progress`, or `completed`. + type: + - string + - 'null' enum: - requested - in_progress - completed - queued - - waiting - triggering_actor: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id + - updated_at: type: string format: date-time url: + description: URL that points to the check suite API resource. type: string format: uri - workflow_id: - type: integer - workflow_url: - type: string - display_title: - type: string required: - id - - name - node_id - head_branch - head_sha - - run_number - - event - status - conclusion - - workflow_id - - check_suite_id - - check_suite_node_id - url - - html_url - - path + - before + - after - pull_requests + - app - created_at - updated_at - - actor - - triggering_actor - - run_attempt - - run_started_at - - display_title - required: - - action - - workflow_run - - since - - repository - - organization - - sender - webhook-deployment-review-requested: - type: object - properties: - action: - type: string - enum: - - requested + - latest_check_runs_count + - check_runs_url + - head_commit enterprise: "$ref": "#/components/schemas/enterprise-webhooks" - environment: - type: string installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" - requestor: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - reviewers: - type: array - items: - type: object - properties: - reviewer: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - id - type: - type: string - enum: - - User - - Team sender: "$ref": "#/components/schemas/simple-user-webhooks" - since: + required: + - action + - check_suite + - repository + - sender + webhook-code-scanning-alert-appeared-in-branch: + title: code_scanning_alert appeared_in_branch event + type: object + properties: + action: type: string - workflow_job_run: + enum: + - appeared_in_branch + alert: + description: The code scanning alert involved in the event. type: object properties: - conclusion: - type: - - 'null' created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' type: string - environment: - type: string - html_url: - type: string - id: - type: integer - name: + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' type: - string - 'null' - status: - type: string - updated_at: - type: string - required: - - id - - name - - status - - conclusion - - html_url - - created_at - - updated_at - - environment - workflow_run: - title: Deployment Workflow Run - type: - - object - - 'null' - properties: - actor: + format: date-time + dismissed_by: title: User type: - object @@ -95993,435 +99888,189 @@ components: required: - login - id - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - conclusion: + dismissed_reason: + description: The reason for dismissing or closing the alert. type: - string - 'null' enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale + - false positive + - won't fix + - used in tests - - created_at: - type: string - format: date-time - event: - type: string - head_branch: + html_url: + description: The GitHub URL of the alert resource. type: string - head_commit: + format: uri + most_recent_instance: + title: Alert Instance type: - object - 'null' - head_repository: - type: object properties: - archive_url: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. type: string - assignees_url: + category: + description: Identifies the configuration under which the analysis + was executed. type: string - blobs_url: + classifications: + type: array + items: + type: string + commit_sha: type: string - branches_url: + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. type: string - collaborators_url: + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. type: string - comments_url: + state: + description: State of a code scanning alert. type: string - commits_url: + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: + id: + description: A unique identifier for the rule used to detect the + alert. type: string - description: + severity: + description: The severity of the alert. type: - string - 'null' - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - jobs_url: - type: string - logs_url: - type: string - name: - type: string - node_id: - type: string - path: + enum: + - none + - note + - warning + - error + - + required: + - id + - severity + - description + state: + description: State of a code scanning alert. type: string - previous_attempt_url: - type: - - string - - 'null' - pull_requests: - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - referenced_workflows: - type: - - array - - 'null' - items: - type: object - properties: - path: - type: string - ref: - type: string - sha: - type: string - required: - - path - - sha - repository: + enum: + - open + - dismissed + - fixed + tool: type: object properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: + name: + description: The name of the tool used to generate the code scanning + analysis alert. type: string - description: + version: + description: The version of the tool used to detect the alert. type: - string - 'null' - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: + required: + - name + - version + url: type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: + format: uri + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + commit_oid: + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + ref: + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - ref + - commit_oid + - repository + - sender + webhook-code-scanning-alert-closed-by-user: + title: code_scanning_alert closed_by_user event + type: object + properties: + action: + type: string + enum: + - closed_by_user + alert: + description: The code scanning alert involved in the event. + type: object + properties: + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' type: string format: date-time - status: + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' type: string - enum: - - requested - - in_progress - - completed - - queued - - waiting - - pending - triggering_actor: + format: date-time + dismissed_by: title: User type: - object @@ -96490,143 +100139,432 @@ components: required: - login - id - updated_at: - type: string - format: date-time - url: + dismissed_reason: + description: The reason for dismissing or closing the alert. + type: + - string + - 'null' + enum: + - false positive + - won't fix + - used in tests + - + html_url: + description: The GitHub URL of the alert resource. type: string format: uri - workflow_id: + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. type: integer - workflow_url: + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + full_description: + type: string + help: + type: + - string + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + name: + type: string + severity: + description: The severity of the alert. + type: + - string + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. type: string - display_title: + enum: + - dismissed + - fixed + tool: + type: object + properties: + guid: + type: + - string + - 'null' + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: + - string + - 'null' + required: + - name + - version + url: type: string + format: uri required: - - id - - name - - node_id - - head_branch - - head_sha - - run_number - - event - - status - - conclusion - - workflow_id - - check_suite_id - - check_suite_node_id + - number + - created_at - url - html_url - - path - - pull_requests - - created_at - - updated_at - - actor - - triggering_actor - - run_attempt - - run_started_at - - display_title + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + commit_oid: + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + ref: + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - workflow_run - - since - - workflow_job_run - - environment - - reviewers - - requestor + - alert + - ref + - commit_oid - repository - - organization - sender - webhook-deployment-status-created: - title: deployment_status created event + webhook-code-scanning-alert-created: + title: code_scanning_alert created event type: object properties: action: type: string enum: - created - check_run: - type: - - object - - 'null' + alert: + description: The code scanning alert involved in the event. + type: object properties: - completed_at: + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' type: - string - 'null' format: date-time - conclusion: - description: The result of the completed check run. This value will - be `null` until the check run has completed. + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - 'null' + dismissed_by: + type: + - 'null' + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + dismissed_reason: + description: 'The reason for dismissing or closing the alert. Can be + one of: `false positive`, `won''t fix`, and `used in tests`.' + type: + - 'null' + fixed_at: type: - - string - 'null' - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - skipped - - - details_url: - type: string - format: uri - external_id: - type: string - head_sha: - description: The SHA of the commit that is being checked. - type: string html_url: + description: The GitHub URL of the alert resource. type: string format: uri - id: - description: The id of the check. - type: integer - name: - description: The name of the check run. - type: string - node_id: - type: string - started_at: + instances_url: type: string - format: date-time - status: - description: The current status of the check run. Can be `queued`, `in_progress`, - or `completed`. + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + full_description: + type: string + help: + type: + - string + - 'null' + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + name: + type: string + severity: + description: The severity of the alert. + type: + - string + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. type: string enum: - - queued - - in_progress - - completed - - waiting - - pending + - open + - dismissed + tool: + type: + - object + - 'null' + properties: + guid: + type: + - string + - 'null' + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: + - string + - 'null' + required: + - name + - version + updated_at: + type: + - string + - 'null' url: type: string format: uri required: - - id - - name - - node_id - - head_sha - - external_id + - number + - created_at - url - html_url - - details_url - - status - - conclusion - - started_at - - completed_at - deployment: - title: Deployment - description: The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + commit_oid: + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + ref: + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - ref + - commit_oid + - repository + - sender + webhook-code-scanning-alert-fixed: + title: code_scanning_alert fixed event + type: object + properties: + action: + type: string + enum: + - fixed + alert: + description: The code scanning alert involved in the event. type: object properties: created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' type: string - creator: + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - string + - 'null' + format: date-time + dismissed_by: title: User type: - object @@ -96695,429 +100633,691 @@ components: required: - login - id - description: + dismissed_reason: + description: The reason for dismissing or closing the alert. type: - string - 'null' - environment: - type: string - id: - type: integer - node_id: + enum: + - false positive + - won't fix + - used in tests + - + html_url: + description: The GitHub URL of the alert resource. type: string - original_environment: + format: uri + instances_url: type: string - payload: - oneOf: - - type: string - - type: object - type: - - 'null' - - string - - object - performed_via_github_app: - title: 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. + format: uri + most_recent_instance: + title: Alert Instance type: - object - 'null' properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: type: array items: type: string - enum: - - 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 - - merge_queue_entry - - workflow_job - - pull_request_review_thread - - secret_scanning_alert_location - - merge_group - external_url: + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + full_description: + type: string + help: type: - string - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app + help_uri: + description: A link to the documentation for the rule used to detect + the alert. type: - - integer + - string - 'null' + id: + description: A unique identifier for the rule used to detect the + alert. + type: string name: - description: The name of the GitHub app type: string - node_id: + severity: + description: The severity of the alert. + type: + - string + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: string + enum: + - fixed + tool: + type: object + properties: + guid: + type: + - string + - 'null' + name: + description: The name of the tool used to generate the code scanning + analysis alert. type: string - owner: - title: User + version: + description: The version of the tool used to detect the alert. type: - - object + - string - 'null' + required: + - name + - version + url: + type: string + format: uri + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + commit_oid: + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + ref: + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - ref + - commit_oid + - repository + - sender + webhook-code-scanning-alert-reopened: + title: code_scanning_alert reopened event + type: object + properties: + action: + type: string + enum: + - reopened + alert: + description: The code scanning alert involved in the event. + type: + - object + - 'null' + properties: + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - string + - 'null' + dismissed_by: + type: + - object + - 'null' + dismissed_reason: + description: 'The reason for dismissing or closing the alert. Can be + one of: `false positive`, `won''t fix`, and `used in tests`.' + type: + - string + - 'null' + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: + end_column: type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: + end_line: + type: integer + path: type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app + start_column: + type: integer + start_line: + type: integer + message: type: object properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: + text: type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app + ref: + description: The full Git reference, formatted as `refs/heads/`. type: string - updated_at: + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + full_description: + type: string + help: type: - string - 'null' - format: date-time + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: + - string + - 'null' + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + name: + type: string + severity: + description: The severity of the alert. + type: + - string + - 'null' + enum: + - none + - note + - warning + - error + - + tags: + type: + - array + - 'null' + items: + type: string required: - id - - node_id - - owner - - name + - severity - description - - external_url - - html_url - - created_at - - updated_at - production_environment: - type: boolean - ref: + state: + description: State of a code scanning alert. type: string - repository_url: + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + guid: + type: + - string + - 'null' + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: + - string + - 'null' + required: + - name + - version + url: type: string format: uri - sha: + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + commit_oid: + description: The commit SHA of the code scanning alert. When the action + is `reopened_by_user` or `closed_by_user`, the event was triggered by + the `sender` and this value will be empty. + type: + - string + - 'null' + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + ref: + description: The Git reference of the code scanning alert. When the action + is `reopened_by_user` or `closed_by_user`, the event was triggered by + the `sender` and this value will be empty. + type: + - string + - 'null' + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - ref + - commit_oid + - repository + - sender + webhook-code-scanning-alert-reopened-by-user: + title: code_scanning_alert reopened_by_user event + type: object + properties: + action: + type: string + enum: + - reopened_by_user + alert: + description: The code scanning alert involved in the event. + type: object + properties: + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' type: string - statuses_url: + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: + - 'null' + dismissed_by: + type: + - 'null' + dismissed_reason: + description: 'The reason for dismissing or closing the alert. Can be + one of: `false positive`, `won''t fix`, and `used in tests`.' + type: + - 'null' + html_url: + description: The GitHub URL of the alert resource. type: string format: uri - task: - type: string - transient_environment: - type: boolean - updated_at: + most_recent_instance: + title: Alert Instance + type: + - object + - 'null' + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + severity: + description: The severity of the alert. + type: + - string + - 'null' + enum: + - none + - note + - warning + - error + - + required: + - id + - severity + - description + state: + description: State of a code scanning alert. type: string + enum: + - open + - fixed + tool: + type: object + properties: + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: + - string + - 'null' + required: + - name + - version url: type: string format: uri required: - - url - - id - - node_id - - sha - - ref - - task - - payload - - original_environment - - environment - - description - - creator + - number - created_at - - updated_at - - statuses_url - - repository_url - deployment_status: - description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + commit_oid: + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + ref: + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - ref + - commit_oid + - repository + - sender + webhook-commit-comment-created: + title: commit_comment created event + type: object + properties: + action: + description: The action performed. Can be `created`. + type: string + enum: + - created + comment: + description: The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) + resource. type: object properties: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string created_at: type: string - creator: + html_url: + type: string + format: uri + id: + description: The ID of the commit comment. + type: integer + line: + description: The line of the blob to which the comment applies. The + last line of the range for a multi-line comment + type: + - integer + - 'null' + node_id: + description: The node ID of the commit comment. + type: string + path: + description: The relative path of the file to which the comment applies. + type: + - string + - 'null' + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + updated_at: + type: string + url: + type: string + format: uri + user: title: User type: - object @@ -97186,30 +101386,542 @@ components: required: - login - id - deployment_url: - type: string - format: uri - description: - description: The optional human-readable description added to the status. - type: string - environment: - type: string - environment_url: - type: string - format: uri - id: - type: integer - log_url: - type: string - format: uri - node_id: + required: + - url + - html_url + - id + - node_id + - user + - position + - line + - path + - commit_id + - created_at + - updated_at + - author_association + - body + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - comment + - repository + - sender + webhook-create: + title: create event + type: object + properties: + description: + description: The repository's current description. + type: + - string + - 'null' + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + master_branch: + description: The name of the repository's default branch (usually `main`). + type: string + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pusher_type: + "$ref": "#/components/schemas/webhooks_deploy_pusher_type" + ref: + "$ref": "#/components/schemas/webhooks_ref_0" + ref_type: + description: The type of Git ref object created in the repository. + type: string + enum: + - tag + - branch + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - ref + - ref_type + - master_branch + - description + - pusher_type + - repository + - sender + webhook-custom-property-created: + title: custom property created event + type: object + properties: + action: + type: string + enum: + - created + definition: + "$ref": "#/components/schemas/org-custom-property" + 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-webhooks" + required: + - action + - definition + - organization + webhook-custom-property-deleted: + title: custom property deleted event + type: object + properties: + action: + type: string + enum: + - deleted + definition: + type: object + properties: + property_name: type: string - performed_via_github_app: - title: 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. + description: The name of the property that was deleted. + required: + - property_name + 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-webhooks" + required: + - action + - definition + - organization + webhook-custom-property-updated: + title: custom property updated event + type: object + properties: + action: + type: string + enum: + - updated + definition: + "$ref": "#/components/schemas/org-custom-property" + 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-webhooks" + required: + - action + - definition + - organization + webhook-custom-property-values-updated: + title: Custom property values updated event + type: object + properties: + action: + type: string + enum: + - updated + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + repository: + "$ref": "#/components/schemas/repository-webhooks" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + new_property_values: + type: array + description: The new custom property values for the repository. + items: + "$ref": "#/components/schemas/custom-property-value" + old_property_values: + type: array + description: The old custom property values for the repository. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - action + - repository + - organization + - new_property_values + - old_property_values + webhook-delete: + title: delete event + type: object + properties: + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pusher_type: + "$ref": "#/components/schemas/webhooks_deploy_pusher_type" + ref: + "$ref": "#/components/schemas/webhooks_ref_0" + ref_type: + description: The type of Git ref object deleted in the repository. + type: string + enum: + - tag + - branch + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - ref + - ref_type + - pusher_type + - repository + - sender + webhook-dependabot-alert-auto-dismissed: + title: Dependabot alert auto-dismissed event + type: object + properties: + action: + type: string + enum: + - auto_dismissed + alert: + "$ref": "#/components/schemas/dependabot-alert" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-dependabot-alert-auto-reopened: + title: Dependabot alert auto-reopened event + type: object + properties: + action: + type: string + enum: + - auto_reopened + alert: + "$ref": "#/components/schemas/dependabot-alert" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-dependabot-alert-created: + title: Dependabot alert created event + type: object + properties: + action: + type: string + enum: + - created + alert: + "$ref": "#/components/schemas/dependabot-alert" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-dependabot-alert-dismissed: + title: Dependabot alert dismissed event + type: object + properties: + action: + type: string + enum: + - dismissed + alert: + "$ref": "#/components/schemas/dependabot-alert" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-dependabot-alert-fixed: + title: Dependabot alert fixed event + type: object + properties: + action: + type: string + enum: + - fixed + alert: + "$ref": "#/components/schemas/dependabot-alert" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-dependabot-alert-reintroduced: + title: Dependabot alert reintroduced event + type: object + properties: + action: + type: string + enum: + - reintroduced + alert: + "$ref": "#/components/schemas/dependabot-alert" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-dependabot-alert-reopened: + title: Dependabot alert reopened event + type: object + properties: + action: + type: string + enum: + - reopened + alert: + "$ref": "#/components/schemas/dependabot-alert" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-deploy-key-created: + title: deploy_key created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + key: + "$ref": "#/components/schemas/webhooks_deploy_key" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - key + - repository + - sender + webhook-deploy-key-deleted: + title: deploy_key deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + key: + "$ref": "#/components/schemas/webhooks_deploy_key" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - key + - repository + - sender + webhook-deployment-created: + title: deployment created event + type: object + properties: + action: + type: string + enum: + - created + deployment: + title: Deployment + description: The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + description: + type: + - string + - 'null' + environment: + type: string + id: + type: integer + node_id: + type: string + original_environment: + type: string + payload: + oneOf: + - type: object + - type: string + performed_via_github_app: + title: 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. type: - object - 'null' @@ -97274,11 +101986,11 @@ components: - watch - workflow_dispatch - workflow_run + - workflow_job - pull_request_review_thread - merge_queue_entry - - workflow_job - - merge_group - secret_scanning_alert_location + - merge_group external_url: type: - string @@ -97563,16 +102275,22 @@ components: - html_url - created_at - updated_at + production_environment: + type: boolean + ref: + type: string repository_url: type: string format: uri - state: - description: The new state. Can be `pending`, `success`, `failure`, - or `error`. + sha: type: string - target_url: - description: The optional link added to the status. + statuses_url: + type: string + format: uri + task: type: string + transient_environment: + type: boolean updated_at: type: string url: @@ -97582,14 +102300,17 @@ components: - url - id - node_id - - state - - creator - - description + - sha + - ref + - task + - payload + - original_environment - environment - - target_url + - description + - creator - created_at - updated_at - - deployment_url + - statuses_url - repository_url enterprise: "$ref": "#/components/schemas/enterprise-webhooks" @@ -97602,47 +102323,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" workflow: - title: Workflow - type: - - object - - 'null' - properties: - badge_url: - type: string - format: uri - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - node_id: - type: string - path: - type: string - state: - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - badge_url - - created_at - - html_url - - id - - name - - node_id - - path - - state - - updated_at - - url + "$ref": "#/components/schemas/webhooks_workflow" workflow_run: title: Deployment Workflow Run type: @@ -97741,7 +102422,6 @@ components: - action_required - stale - - - startup_failure created_at: type: string format: date-time @@ -98244,100 +102924,107 @@ components: - created_at - updated_at - actor - - triggering_actor - run_attempt - run_started_at - display_title required: - action - - deployment_status - deployment + - workflow + - workflow_run - repository - sender - webhook-discussion-answered: - title: discussion answered event + webhook-deployment-protection-rule-requested: + title: deployment protection rule requested event type: object properties: action: type: string enum: - - answered - answer: - type: object + - requested + environment: + description: The name of the environment that has the deployment protection + rule. + type: string + event: + description: The event that triggered the deployment protection rule. + type: string + deployment_callback_url: + description: The URL to review the deployment protection rule. + type: string + format: uri + deployment: + "$ref": "#/components/schemas/deployment" + pull_requests: + type: array + items: + "$ref": "#/components/schemas/pull-request" + repository: + "$ref": "#/components/schemas/repository-webhooks" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + webhook-deployment-review-approved: + type: object + properties: + action: + type: string + enum: + - approved + approver: + "$ref": "#/components/schemas/webhooks_approver" + comment: + type: string + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + reviewers: + "$ref": "#/components/schemas/webhooks_reviewers" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + since: + type: string + workflow_job_run: + "$ref": "#/components/schemas/webhooks_workflow_job_run" + workflow_job_runs: + type: array + items: + type: object + properties: + conclusion: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + status: + type: string + updated_at: + type: string + workflow_run: + title: Deployment Workflow Run + type: + - object + - 'null' properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - child_comment_count: - type: integer - created_at: - type: string - format: date-time - discussion_id: - type: integer - html_url: - type: string - id: - type: integer - node_id: - type: string - parent_id: - type: - - 'null' - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - updated_at: - type: string - format: date-time - user: + actor: title: User type: - object @@ -98406,215 +103093,437 @@ components: required: - login - id - required: - - id - - node_id - - html_url - - parent_id - - child_comment_count - - repository_url - - discussion_id - - author_association - - user - - created_at - - updated_at - - body - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - answer - - repository - - sender - webhook-discussion-category-changed: - title: discussion category changed event - type: object - properties: - action: - type: string - enum: - - category_changed - changes: - type: object - properties: - category: + artifacts_url: + type: string + cancel_url: + type: string + check_suite_id: + type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + display_title: + type: string + event: + type: string + head_branch: + type: string + head_commit: + type: + - object + - 'null' + head_repository: type: object properties: - from: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: + - string + - 'null' + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: type: object properties: - created_at: + avatar_url: type: string - format: date-time - description: + events_url: type: string - emoji: + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: type: string id: type: integer - is_answerable: - type: boolean - name: + login: type: string node_id: type: string - repository_id: - type: integer - slug: + organizations_url: type: string - updated_at: + received_events_url: type: string - required: - - id - - repository_id - - emoji - - name - - description - - created_at - - updated_at - - slug - - is_answerable - required: - - from - required: - - category - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - changes - - discussion - - repository - - sender - webhook-discussion-closed: - title: discussion closed event - type: object - properties: - action: - type: string - enum: - - closed - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - repository - - sender - webhook-discussion-comment-created: - title: discussion_comment created event - type: object - properties: - action: - type: string - enum: - - created - comment: - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - child_comment_count: - type: integer - created_at: + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: type: string - discussion_id: - type: integer html_url: type: string + format: uri id: type: integer + jobs_url: + type: string + logs_url: + type: string + name: + type: string node_id: type: string - parent_id: + path: + type: string + previous_attempt_url: type: - - integer + - string - 'null' - reactions: - title: Reactions + pull_requests: + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + referenced_workflows: + type: + - array + - 'null' + items: + type: object + properties: + path: + type: string + ref: + type: string + sha: + type: string + required: + - path + - sha + repository: type: object properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: + - string + - 'null' + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string url: type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: + rerun_url: type: string - updated_at: + run_attempt: + type: integer + run_number: + type: integer + run_started_at: type: string - user: + format: date-time + status: + type: string + enum: + - requested + - in_progress + - completed + - queued + - waiting + - pending + triggering_actor: title: User type: - object @@ -98683,22 +103592,58 @@ components: required: - login - id + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string required: - id + - name - node_id + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id + - url - html_url - - parent_id - - child_comment_count - - repository_url - - discussion_id - - author_association - - user + - path + - pull_requests - created_at - updated_at - - body - - reactions - discussion: - "$ref": "#/components/schemas/discussion" + - actor + - triggering_actor + - run_attempt + - run_started_at + - display_title + required: + - action + - workflow_run + - since + - repository + - organization + - sender + webhook-deployment-review-rejected: + type: object + properties: + action: + type: string + enum: + - rejected + approver: + "$ref": "#/components/schemas/webhooks_approver" + comment: + type: string enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -98707,97 +103652,46 @@ components: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" + reviewers: + "$ref": "#/components/schemas/webhooks_reviewers" sender: "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - comment - - discussion - - repository - - sender - webhook-discussion-comment-deleted: - title: discussion_comment deleted event - type: object - properties: - action: + since: type: string - enum: - - deleted - comment: - type: object + workflow_job_run: + "$ref": "#/components/schemas/webhooks_workflow_job_run" + workflow_job_runs: + type: array + items: + type: object + properties: + conclusion: + type: + - string + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + status: + type: string + updated_at: + type: string + workflow_run: + title: Deployment Workflow Run + type: + - object + - 'null' properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - child_comment_count: - type: integer - created_at: - type: string - discussion_id: - type: integer - html_url: - type: string - id: - type: integer - node_id: - type: string - parent_id: - type: - - integer - - 'null' - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - updated_at: - type: string - user: + actor: title: User type: - object @@ -98866,133 +103760,434 @@ components: required: - login - id - required: - - id - - node_id - - html_url - - parent_id - - child_comment_count - - repository_url - - discussion_id - - author_association - - user - - created_at - - updated_at - - body - - reactions - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - comment - - discussion - - repository - - sender - webhook-discussion-comment-edited: - title: discussion_comment edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - body: - type: object - properties: - from: - type: string - required: - - from - required: - - body - comment: - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. + artifacts_url: type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: + cancel_url: type: string - child_comment_count: + check_suite_id: type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - created_at: type: string - discussion_id: - type: integer - html_url: + format: date-time + event: type: string - id: - type: integer - node_id: + head_branch: type: string - parent_id: + head_commit: type: - - integer + - object - 'null' - reactions: - title: Reactions + head_repository: type: object properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: + archive_url: type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: + - string + - 'null' + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: type: string - updated_at: + html_url: type: string - user: + format: uri + id: + type: integer + jobs_url: + type: string + logs_url: + type: string + name: + type: string + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + pull_requests: + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + referenced_workflows: + type: + - array + - 'null' + items: + type: object + properties: + path: + type: string + ref: + type: string + sha: + type: string + required: + - path + - sha + repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: + - string + - 'null' + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + rerun_url: + type: string + run_attempt: + type: integer + run_number: + type: integer + run_started_at: + type: string + format: date-time + status: + type: string + enum: + - requested + - in_progress + - completed + - queued + - waiting + triggering_actor: title: User type: - object @@ -99061,61 +104256,74 @@ components: required: - login - id + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + display_title: + type: string required: - id + - name - node_id + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id + - url - html_url - - parent_id - - child_comment_count - - repository_url - - discussion_id - - author_association - - user + - path + - pull_requests - created_at - updated_at - - body - - reactions - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" + - actor + - triggering_actor + - run_attempt + - run_started_at + - display_title required: - action - - changes - - comment - - discussion + - workflow_run + - since - repository + - organization - sender - webhook-discussion-created: - title: discussion created event + webhook-deployment-review-requested: type: object properties: action: type: string enum: - - created - discussion: - allOf: - - title: Discussion + - requested + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + environment: + type: string + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requestor: + "$ref": "#/components/schemas/webhooks_user" + reviewers: + type: array + items: type: object properties: - active_lock_reason: - type: - - string - - 'null' - answer_chosen_at: - type: - - string - - 'null' - answer_chosen_by: + reviewer: title: User type: - object @@ -99182,699 +104390,756 @@ components: type: string format: uri required: - - login - id - answer_html_url: - type: - - string - - 'null' - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. + type: type: string enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: + - User + - Team + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + since: + type: string + workflow_job_run: + type: object + properties: + conclusion: + type: + - 'null' + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + status: + type: string + updated_at: + type: string + required: + - id + - name + - status + - conclusion + - html_url + - created_at + - updated_at + - environment + workflow_run: + title: Deployment Workflow Run + type: + - object + - 'null' + properties: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - category: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + artifacts_url: + type: string + cancel_url: + type: string + check_suite_id: + type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + conclusion: + type: + - string + - 'null' + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: string + head_commit: + type: + - object + - 'null' + head_repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: + - string + - 'null' + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: + type: string + html_url: + type: string + format: uri + id: + type: integer + jobs_url: + type: string + logs_url: + type: string + name: + type: string + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + pull_requests: + type: array + items: + title: Check Run Pull Request type: object properties: - created_at: - type: string - format: date-time - description: - type: string - emoji: - type: string + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo id: type: integer - is_answerable: - type: boolean - name: - type: string - node_id: - type: string - repository_id: - type: integer - slug: - type: string - updated_at: - type: string - required: - - id - - repository_id - - emoji - - name - - description - - created_at - - updated_at - - slug - - is_answerable - comments: - type: integer - created_at: - type: string - format: date-time - html_url: - type: string - id: - type: integer - locked: - type: boolean - node_id: - type: string - number: - type: integer - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: + number: type: integer url: type: string format: uri required: - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - state: - type: string - enum: - - open - - locked - - converting - - transferring - timeline_url: - type: string - title: - type: string - updated_at: - type: string - format: date-time - user: - title: User - type: - - object - - 'null' + - id + - number + - head + - base + referenced_workflows: + type: + - array + - 'null' + items: + type: object properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: + path: type: string - format: uri - type: + ref: type: string - enum: - - Bot - - User - - Organization - url: + sha: type: string - format: uri required: - - login - - id - required: - - repository_url - - category - - answer_html_url - - answer_chosen_at - - answer_chosen_by - - html_url - - id - - node_id - - number - - title - - user - - state - - locked - - comments - - created_at - - updated_at - - author_association - - active_lock_reason - - body - - type: object - properties: - active_lock_reason: - type: - - 'null' - answer_chosen_at: - type: - - 'null' - answer_chosen_by: - type: - - 'null' - answer_html_url: - type: - - string - - 'null' - author_association: - type: string - body: - type: - - string - - 'null' - category: - type: object - properties: - created_at: - type: string - description: - type: string - emoji: - type: string - id: - type: integer - is_answerable: - type: boolean - name: - type: string - node_id: - type: string - repository_id: - type: integer - slug: - type: string - updated_at: - type: string - comments: - type: integer - created_at: - type: string - html_url: - type: string - id: - type: integer - locked: - type: boolean - enum: - - false - node_id: - type: string - number: - type: integer - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - type: string - enum: - - open - - converting - - transferring - timeline_url: - type: string - title: - type: string - updated_at: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - required: - - state - - locked - - answer_html_url - - answer_chosen_at - - answer_chosen_by - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - repository - - sender - webhook-discussion-deleted: - title: discussion deleted event - type: object - properties: - action: - type: string - enum: - - deleted - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - repository - - sender - webhook-discussion-edited: - title: discussion edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - body: + - path + - sha + repository: type: object properties: - from: + archive_url: type: string - required: - - from - title: - type: object - properties: - from: + assignees_url: type: string - required: - - from - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - repository - - sender - webhook-discussion-labeled: - title: discussion labeled event - type: object - properties: - action: - type: string - enum: - - labeled - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: + - string + - 'null' + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + rerun_url: type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: + run_attempt: type: integer - name: - description: The name of the label. + run_number: + type: integer + run_started_at: type: string - node_id: + format: date-time + status: + type: string + enum: + - requested + - in_progress + - completed + - queued + - waiting + - pending + triggering_actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + updated_at: type: string + format: date-time url: - description: URL for the label type: string format: uri + workflow_id: + type: integer + workflow_url: + type: string + display_title: + type: string required: - id + - name - node_id + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id - url - - name - - color - - default - - description - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - label - - repository - - sender - webhook-discussion-locked: - title: discussion locked event - type: object - properties: - action: - type: string - enum: - - locked - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - repository - - sender - webhook-discussion-pinned: - title: discussion pinned event - type: object - properties: - action: - type: string - enum: - - pinned - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - repository - - sender - webhook-discussion-reopened: - title: discussion reopened event - type: object - properties: - action: - type: string - enum: - - reopened - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - repository - - sender - webhook-discussion-transferred: - title: discussion transferred event - type: object - properties: - action: - type: string - enum: - - transferred - changes: - type: object - properties: - new_discussion: - "$ref": "#/components/schemas/discussion" - new_repository: - "$ref": "#/components/schemas/repository-webhooks" - required: - - new_discussion - - new_repository - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" + - html_url + - path + - pull_requests + - created_at + - updated_at + - actor + - triggering_actor + - run_attempt + - run_started_at + - display_title required: - action - - changes - - discussion + - workflow_run + - since + - workflow_job_run + - environment + - reviewers + - requestor - repository + - organization - sender - webhook-discussion-unanswered: - title: discussion unanswered event + webhook-deployment-status-created: + title: deployment_status created event type: object properties: action: type: string enum: - - unanswered - discussion: - "$ref": "#/components/schemas/discussion" - old_answer: - type: object + - created + check_run: + type: + - object + - 'null' properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string + completed_at: + type: + - string + - 'null' + format: date-time + conclusion: + description: The result of the completed check run. This value will + be `null` until the check run has completed. + type: + - string + - 'null' enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - skipped + - + details_url: type: string - child_comment_count: - type: integer - created_at: + format: uri + external_id: + type: string + head_sha: + description: The SHA of the commit that is being checked. type: string - format: date-time - discussion_id: - type: integer html_url: type: string + format: uri id: + description: The id of the check. type: integer - node_id: + name: + description: The name of the check run. type: string - parent_id: - type: - - 'null' - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: + node_id: type: string - updated_at: + started_at: type: string format: date-time - user: + status: + description: The current status of the check run. Can be `queued`, `in_progress`, + or `completed`. + type: string + enum: + - queued + - in_progress + - completed + - waiting + - pending + url: + type: string + format: uri + required: + - id + - name + - node_id + - head_sha + - external_id + - url + - html_url + - details_url + - status + - conclusion + - started_at + - completed_at + deployment: + title: Deployment + description: The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). + type: object + properties: + created_at: + type: string + creator: title: User type: - object @@ -99943,1749 +105208,1417 @@ components: required: - login - id - required: - - id - - node_id - - html_url - - parent_id - - child_comment_count - - repository_url - - discussion_id - - author_association - - user - - created_at - - updated_at - - body - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - old_answer - - repository - webhook-discussion-unlabeled: - title: discussion unlabeled event - type: object - properties: - action: - type: string - enum: - - unlabeled - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean description: type: - string - 'null' + environment: + type: string id: type: integer - name: - description: The name of the label. - type: string node_id: type: string - url: - description: URL for the label + original_environment: type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - label - - repository - - sender - webhook-discussion-unlocked: - title: discussion unlocked event - type: object - properties: - action: - type: string - enum: - - unlocked - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - repository - - sender - webhook-discussion-unpinned: - title: discussion unpinned event - type: object - properties: - action: - type: string - enum: - - unpinned - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - repository - - sender - webhook-fork: - title: fork event - description: A user forks a repository. - type: object - properties: - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - forkee: - description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) - resource. - allOf: - - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string + payload: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + performed_via_github_app: + title: 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. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' format: date-time - custom_properties: - type: object - description: The custom properties that were defined for the repository. - The keys are the custom property names, and the values are the corresponding - custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + description: type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: type: string enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string + - 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 + - merge_queue_entry + - workflow_job + - pull_request_review_thread + - secret_scanning_alert_location + - merge_group + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + production_environment: + type: boolean + ref: + type: string + repository_url: + type: string + format: uri + sha: + type: string + statuses_url: + type: string + format: uri + task: + type: string + transient_environment: + type: boolean + updated_at: + type: string + url: + type: string + format: uri + required: + - url + - id + - node_id + - sha + - ref + - task + - payload + - original_environment + - environment + - description + - creator + - created_at + - updated_at + - statuses_url + - repository_url + deployment_status: + description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). + type: object + properties: + created_at: + type: string + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on web-based - commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - - type: object - properties: - allow_forking: - type: boolean - archive_url: - type: string - archived: - type: boolean - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - clone_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - created_at: - type: string - default_branch: - type: string - deployments_url: - type: string - description: - type: - - string - - 'null' - disabled: - type: boolean - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - enum: - - true - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - git_url: - type: string - has_downloads: - type: boolean - has_issues: - type: boolean - has_pages: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - homepage: - type: - - string - - 'null' - hooks_url: - type: string - html_url: - type: string - id: - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - language: - type: - - 'null' - languages_url: - type: string - license: - type: - - object - - 'null' - merges_url: - type: string - milestones_url: - type: string - mirror_url: - type: - - 'null' - name: - type: string - node_id: - type: string - notifications_url: - type: string - open_issues: - type: integer - open_issues_count: - type: integer - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string + format: uri + deleted: + type: boolean + email: type: - type: string - url: - type: string - private: - type: boolean - public: - type: boolean - pulls_url: - type: string - pushed_at: - type: string - releases_url: - type: string - size: - type: integer - ssh_url: - type: string - stargazers_count: - type: integer - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - svn_url: - type: string - tags_url: - type: string - teams_url: - type: string - topics: - type: array - items: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + deployment_url: + type: string + format: uri + description: + description: The optional human-readable description added to the status. + type: string + environment: + type: string + environment_url: + type: string + format: uri + id: + type: integer + log_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: + title: 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. + type: + - object + - 'null' + properties: + created_at: type: + - string - 'null' - trees_url: - type: string - updated_at: - type: string - url: - type: string - visibility: - type: string - watchers: - type: integer - watchers_count: - type: integer - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - forkee - - repository - - sender - webhook-github-app-authorization-revoked: - title: github_app_authorization revoked event - type: object - properties: - action: - type: string - enum: - - revoked - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - sender - webhook-gollum: - title: gollum event - type: object - properties: - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pages: - description: The pages that were updated. - type: array - items: - type: object - properties: - action: - description: The action that was performed on the page. Can be `created` - or `edited`. - type: string - enum: - - created - - edited - html_url: - description: Points to the HTML wiki page. - type: string - format: uri - page_name: - description: The name of the page. - type: string - sha: - description: The latest commit SHA of the page. - type: string - summary: - type: - - string - - 'null' - title: - description: The current page title. - type: string - required: - - page_name - - title - - summary - - action - - sha - - html_url - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - pages - - repository - - sender - webhook-installation-created: - title: installation created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - description: An array of repository objects that the installation can access. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + - merge_queue_entry + - workflow_job + - merge_group + - secret_scanning_alert_location + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + repository_url: type: string format: uri - site_admin: - type: boolean - starred_url: + state: + description: The new state. Can be `pending`, `success`, `failure`, + or `error`. type: string - format: uri-template - subscriptions_url: + target_url: + description: The optional link added to the status. type: string - format: uri - type: + updated_at: type: string - enum: - - Bot - - User - - Organization url: type: string format: uri required: - - login + - url - id - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - installation - - sender - webhook-installation-deleted: - title: installation deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - description: An array of repository objects that the installation can access. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - type: - - 'null' - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - installation - - sender - webhook-installation-new-permissions-accepted: - title: installation new_permissions_accepted event - type: object - properties: - action: - type: string - enum: - - new_permissions_accepted + - node_id + - state + - creator + - description + - environment + - target_url + - created_at + - updated_at + - deployment_url + - repository_url enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: - "$ref": "#/components/schemas/installation" + "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - description: An array of repository objects that the installation can access. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private repository: "$ref": "#/components/schemas/repository-webhooks" - requester: - type: - - 'null' sender: "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - installation - - sender - webhook-installation-repositories-added: - title: installation_repositories added event - type: object - properties: - action: - type: string - enum: - - added - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories_added: - description: An array of repository objects, which were added to the installation. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repositories_removed: - description: An array of repository objects, which were removed from the - installation. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_selection: - description: Describe whether all repositories have been selected or there's - a selection involved - type: string - enum: - - all - - selected - requester: - title: User + workflow: + "$ref": "#/components/schemas/webhooks_workflow" + workflow_run: + title: Deployment Workflow Run type: - object - 'null' properties: - avatar_url: + actor: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + artifacts_url: type: string - format: uri - deleted: - type: boolean - email: + cancel_url: + type: string + check_suite_id: + type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + conclusion: type: - string - 'null' - events_url: + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - startup_failure + created_at: type: string - format: uri-template - followers_url: + format: date-time + display_title: type: string - format: uri - following_url: + event: type: string - format: uri-template - gists_url: + head_branch: type: string - format: uri-template - gravatar_id: + head_commit: + type: + - 'null' + head_repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: + - 'null' + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: type: string html_url: type: string format: uri id: type: integer - login: + jobs_url: + type: string + logs_url: type: string name: type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: + path: type: string - format: uri - required: - - login - - id - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - installation - - repository_selection - - repositories_added - - repositories_removed - - requester - - sender - webhook-installation-repositories-removed: - title: installation_repositories removed event - type: object - properties: - action: - type: string - enum: - - removed - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories_added: - description: An array of repository objects, which were added to the installation. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repositories_removed: - description: An array of repository objects, which were removed from the - installation. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_selection: - description: Describe whether all repositories have been selected or there's - a selection involved - type: string - enum: - - all - - selected - requester: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - installation - - repository_selection - - repositories_added - - repositories_removed - - requester - - sender - webhook-installation-suspend: - title: installation suspend event - type: object - properties: - action: - type: string - enum: - - suspend - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - description: An array of repository objects that the installation can access. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - type: - - 'null' - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - installation - - sender - webhook-installation-target-renamed: - type: object - properties: - account: - type: object - properties: - archived_at: - type: - - string - - 'null' - avatar_url: - type: string - created_at: - type: string - description: + previous_attempt_url: type: - 'null' - events_url: - type: string - followers: - type: integer - followers_url: - type: string - following: - type: integer - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - has_organization_projects: - type: boolean - has_repository_projects: - type: boolean - hooks_url: - type: string - html_url: - type: string - id: - type: integer - is_verified: - type: boolean - issues_url: - type: string - login: - type: string - members_url: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - public_gists: - type: integer - public_members_url: - type: string - public_repos: - type: integer - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - slug: - type: string - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - updated_at: - type: string - url: - type: string - website_url: + pull_requests: + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + referenced_workflows: type: + - array - 'null' - required: - - id - - node_id - - avatar_url - - html_url - action: - type: string - enum: - - renamed - changes: - type: object - properties: - login: + items: + type: object + properties: + path: + type: string + ref: + type: string + sha: + type: string + required: + - path + - sha + repository: type: object properties: - from: + archive_url: type: string - required: - - from - slug: - type: object - properties: - from: + assignees_url: type: string - required: - - from - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - target_type: - type: string - required: - - action - - target_type - - account - - changes - - installation - webhook-installation-unsuspend: - title: installation unsuspend event - type: object - properties: - action: - type: string - enum: - - unsuspend - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - description: An array of repository objects that the installation can access. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - type: - - 'null' - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - installation - - sender - webhook-issue-comment-created: - title: issue_comment created event - type: object - properties: - action: - type: string - enum: - - created - comment: - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue comment - type: string - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - description: Unique identifier of the issue comment - type: integer - format: int64 - issue_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/integration" - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: + - 'null' + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string url: type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - updated_at: + rerun_url: + type: string + run_attempt: + type: integer + run_number: + type: integer + run_started_at: type: string format: date-time - url: - description: URL for the issue comment + status: type: string - format: uri - user: + enum: + - requested + - in_progress + - completed + - queued + - waiting + - pending + triggering_actor: title: User type: - object @@ -101754,890 +106687,872 @@ components: required: - login - id + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string required: - - url - - html_url - - issue_url - id + - name - node_id - - user + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id + - url + - html_url + - path + - pull_requests - created_at - updated_at - - author_association - - performed_via_github_app - - body - - reactions + - actor + - triggering_actor + - run_attempt + - run_started_at + - display_title + required: + - action + - deployment_status + - deployment + - repository + - sender + webhook-discussion-answered: + title: discussion answered event + type: object + properties: + action: + type: string + enum: + - answered + answer: + "$ref": "#/components/schemas/webhooks_answer" + discussion: + "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" - issue: - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - the comment belongs to. - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: - - object - - 'null' + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - answer + - repository + - sender + webhook-discussion-category-changed: + title: discussion category changed event + type: object + properties: + action: + type: string + enum: + - category_changed + changes: + type: object + properties: + category: + type: object + properties: + from: + type: object properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: + created_at: type: string - format: uri-template - gravatar_id: + format: date-time + description: type: string - html_url: + emoji: type: string - format: uri id: type: integer - login: - type: string + is_answerable: + type: boolean name: type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: + repository_id: type: integer - name: - description: The name of the label. - type: string - node_id: + slug: type: string - url: - description: URL for the label + updated_at: type: string - format: uri required: - id - - node_id - - url + - repository_id + - emoji - name - - color - - default - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: + - created_at + - updated_at + - slug + - is_answerable + required: + - from + required: + - category + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - discussion + - repository + - sender + webhook-discussion-closed: + title: discussion closed event + type: object + properties: + action: + type: string + enum: + - closed + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-comment-created: + title: discussion_comment created event + type: object + properties: + action: + type: string + enum: + - created + comment: + "$ref": "#/components/schemas/webhooks_comment" + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - comment + - discussion + - repository + - sender + webhook-discussion-comment-deleted: + title: discussion_comment deleted event + type: object + properties: + action: + type: string + enum: + - deleted + comment: + "$ref": "#/components/schemas/webhooks_comment" + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - comment + - discussion + - repository + - sender + webhook-discussion-comment-edited: + title: discussion_comment edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + type: object + properties: + body: + type: object + properties: + from: + type: string + required: + - from + required: + - body + comment: + "$ref": "#/components/schemas/webhooks_comment" + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - comment + - discussion + - repository + - sender + webhook-discussion-created: + title: discussion created event + type: object + properties: + action: + type: string + enum: + - created + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-deleted: + title: discussion deleted event + type: object + properties: + action: + type: string + enum: + - deleted + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-edited: + title: discussion edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + type: object + properties: + body: + type: object + properties: + from: + type: string + required: + - from + title: + type: object + properties: + from: + type: string + required: + - from + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-labeled: + title: discussion labeled event + type: object + properties: + action: + type: string + enum: + - labeled + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + label: + "$ref": "#/components/schemas/webhooks_label" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - label + - repository + - sender + webhook-discussion-locked: + title: discussion locked event + type: object + properties: + action: + type: string + enum: + - locked + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-pinned: + title: discussion pinned event + type: object + properties: + action: + type: string + enum: + - pinned + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-reopened: + title: discussion reopened event + type: object + properties: + action: + type: string + enum: + - reopened + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-transferred: + title: discussion transferred event + type: object + properties: + action: + type: string + enum: + - transferred + changes: + type: object + properties: + new_discussion: + "$ref": "#/components/schemas/discussion" + new_repository: + "$ref": "#/components/schemas/repository-webhooks" + required: + - new_discussion + - new_repository + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - discussion + - repository + - sender + webhook-discussion-unanswered: + title: discussion unanswered event + type: object + properties: + action: + type: string + enum: + - unanswered + discussion: + "$ref": "#/components/schemas/discussion" + old_answer: + "$ref": "#/components/schemas/webhooks_answer" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - old_answer + - repository + webhook-discussion-unlabeled: + title: discussion unlabeled event + type: object + properties: + action: + type: string + enum: + - unlabeled + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + label: + "$ref": "#/components/schemas/webhooks_label" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - label + - repository + - sender + webhook-discussion-unlocked: + title: discussion unlocked event + type: object + properties: + action: + type: string + enum: + - unlocked + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-unpinned: + title: discussion unpinned event + type: object + properties: + action: + type: string + enum: + - unpinned + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-fork: + title: fork event + description: A user forks a repository. + type: object + properties: + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + forkee: + description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) + resource. + allOf: + - title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + custom_properties: + type: object + description: The custom properties that were defined for the repository. + The keys are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are + merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: type: string - format: uri - id: - type: integer - labels_url: + name: type: string - format: uri node_id: type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: + spdx_id: type: string - format: date-time url: - type: string + type: + - string + - 'null' format: uri required: + - key + - name + - spdx_id - url - - html_url - - labels_url - - id - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at + master_branch: + type: string + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string node_id: type: string - number: + notifications_url: + type: string + format: uri-template + open_issues: type: integer - performed_via_github_app: - title: 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. + open_issues_count: + type: integer + organization: + type: string + owner: + title: User type: - object - 'null' properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - string - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string html_url: type: string format: uri id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string + type: integer + login: + type: string name: type: string node_id: @@ -102665,230 +107580,307 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - login - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - assignee: - title: User - type: - - object - - 'null' + permissions: + type: object properties: - avatar_url: - type: string - format: uri - deleted: + admin: type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri required: - - login - - id - assignees: - type: array - items: - type: - - object - - 'null' - author_association: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: type: string - body: + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time type: - - string - 'null' - closed_at: + - integer + - string + releases_url: + type: string + format: uri-template + role_name: type: - string - 'null' - comments: + size: + type: integer + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based + commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + - type: object + properties: + allow_forking: + type: boolean + archive_url: + type: string + archived: + type: boolean + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + clone_url: + type: string + collaborators_url: + type: string comments_url: type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string created_at: type: string + default_branch: + type: string + deployments_url: + type: string + description: + type: + - string + - 'null' + disabled: + type: boolean + downloads_url: + type: string events_url: type: string + fork: + type: boolean + enum: + - true + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + git_url: + type: string + has_downloads: + type: boolean + has_issues: + type: boolean + has_pages: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + homepage: + type: + - string + - 'null' + hooks_url: + type: string html_url: type: string id: type: integer - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description + is_template: + type: boolean + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string labels_url: type: string - locked: - type: boolean - milestone: + language: type: - - object - 'null' - node_id: + languages_url: type: string - number: - type: integer - performed_via_github_app: + license: type: - object - 'null' - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - description: State of the issue; either 'open' or 'closed' + merges_url: type: string - enum: - - open - - closed - timeline_url: + milestones_url: type: string - title: + mirror_url: + type: + - 'null' + name: type: string - updated_at: + node_id: type: string - url: + notifications_url: type: string - user: + open_issues: + type: integer + open_issues_count: + type: integer + owner: type: object properties: avatar_url: @@ -102927,11 +107919,55 @@ components: type: string url: type: string - required: - - labels - - state - - locked - - assignee + private: + type: boolean + public: + type: boolean + pulls_url: + type: string + pushed_at: + type: string + releases_url: + type: string + size: + type: integer + ssh_url: + type: string + stargazers_count: + type: integer + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + svn_url: + type: string + tags_url: + type: string + teams_url: + type: string + topics: + type: array + items: + type: + - 'null' + trees_url: + type: string + updated_at: + type: string + url: + type: string + visibility: + type: string + watchers: + type: integer + watchers_count: + type: integer + installation: + "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -102939,241 +107975,676 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - - action - - issue - - comment + - forkee - repository - sender - webhook-issue-comment-deleted: - title: issue_comment deleted event + webhook-github-app-authorization-revoked: + title: github_app_authorization revoked event type: object properties: action: type: string enum: - - deleted - comment: - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue comment - type: string - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - description: Unique identifier of the issue comment - type: integer - format: int64 - issue_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/integration" - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - updated_at: - type: string - format: date-time - url: - description: URL for the issue comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - html_url - - issue_url - - id - - node_id - - user - - created_at - - updated_at - - author_association - - performed_via_github_app - - body - - reactions + - revoked + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - sender + webhook-gollum: + title: gollum event + type: object + properties: enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" - issue: - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - the comment belongs to. - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pages: + description: The pages that were updated. + type: array + items: type: object properties: - active_lock_reason: - type: - - string - - 'null' + action: + description: The action that was performed on the page. Can be `created` + or `edited`. + type: string enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User + - created + - edited + html_url: + description: Points to the HTML wiki page. + type: string + format: uri + page_name: + description: The name of the page. + type: string + sha: + description: The latest commit SHA of the page. + type: string + summary: type: - - object + - string - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri + title: + description: The current page title. + type: string + required: + - page_name + - title + - summary + - action + - sha + - html_url + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - pages + - repository + - sender + webhook-installation-created: + title: installation created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + "$ref": "#/components/schemas/webhooks_user" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - installation + - sender + webhook-installation-deleted: + title: installation deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + type: + - 'null' + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - installation + - sender + webhook-installation-new-permissions-accepted: + title: installation new_permissions_accepted event + type: object + properties: + action: + type: string + enum: + - new_permissions_accepted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + type: + - 'null' + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - installation + - sender + webhook-installation-repositories-added: + title: installation_repositories added event + type: object + properties: + action: + type: string + enum: + - added + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories_added: + "$ref": "#/components/schemas/webhooks_repositories_added" + repositories_removed: + description: An array of repository objects, which were removed from the + installation. + type: array + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_selection: + "$ref": "#/components/schemas/webhooks_repository_selection" + requester: + "$ref": "#/components/schemas/webhooks_user" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - installation + - repository_selection + - repositories_added + - repositories_removed + - requester + - sender + webhook-installation-repositories-removed: + title: installation_repositories removed event + type: object + properties: + action: + type: string + enum: + - removed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories_added: + "$ref": "#/components/schemas/webhooks_repositories_added" + repositories_removed: + description: An array of repository objects, which were removed from the + installation. + type: array + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + required: + - id + - node_id + - name + - full_name + - private + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_selection: + "$ref": "#/components/schemas/webhooks_repository_selection" + requester: + "$ref": "#/components/schemas/webhooks_user" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - installation + - repository_selection + - repositories_added + - repositories_removed + - requester + - sender + webhook-installation-suspend: + title: installation suspend event + type: object + properties: + action: + type: string + enum: + - suspend + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + type: + - 'null' + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - installation + - sender + webhook-installation-target-renamed: + type: object + properties: + account: + type: object + properties: + archived_at: + type: + - string + - 'null' + avatar_url: + type: string + created_at: + type: string + description: + type: + - 'null' + events_url: + type: string + followers: + type: integer + followers_url: + type: string + following: + type: integer + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + has_organization_projects: + type: boolean + has_repository_projects: + type: boolean + hooks_url: + type: string + html_url: + type: string + id: + type: integer + is_verified: + type: boolean + issues_url: + type: string + login: + type: string + members_url: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + public_gists: + type: integer + public_members_url: + type: string + public_repos: + type: integer + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + slug: + type: string + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + updated_at: + type: string + url: + type: string + website_url: + type: + - 'null' + required: + - id + - node_id + - avatar_url + - html_url + action: + type: string + enum: + - renamed + changes: + type: object + properties: + login: + type: object + properties: + from: + type: string + required: + - from + slug: + type: object + properties: + from: + type: string + required: + - from + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + target_type: + type: string + required: + - action + - target_type + - account + - changes + - installation + webhook-installation-unsuspend: + title: installation unsuspend event + type: object + properties: + action: + type: string + enum: + - unsuspend + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + type: + - 'null' + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - installation + - sender + webhook-issue-comment-created: + title: issue_comment created event + type: object + properties: + action: + type: string + enum: + - created + comment: + title: issue comment + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) + itself. + type: object + properties: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue comment + type: string + created_at: + type: string + format: date-time + html_url: + type: string + format: uri + id: + description: Unique identifier of the issue comment + type: integer + format: int64 + issue_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/integration" + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + updated_at: + type: string + format: date-time + url: + description: URL for the issue comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - url + - html_url + - issue_url + - id + - node_id + - user + - created_at + - updated_at + - author_association + - performed_via_github_app + - body + - reactions + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer login: @@ -103584,6 +109055,8 @@ components: - watch - workflow_dispatch - workflow_run + - reminder + - pull_request_review_thread external_url: type: - string @@ -103765,6 +109238,7 @@ components: enum: - read - write + - admin organization_secrets: type: string enum: @@ -103805,6 +109279,7 @@ components: enum: - read - write + - admin secret_scanning_alerts: type: string enum: @@ -104292,193 +109767,16 @@ components: - comment - repository - sender - webhook-issue-comment-edited: - title: issue_comment edited event + webhook-issue-comment-deleted: + title: issue_comment deleted event type: object properties: action: type: string enum: - - edited - changes: - description: The changes to the comment. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from + - deleted comment: - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue comment - type: string - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - description: Unique identifier of the issue comment - type: integer - format: int64 - issue_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/integration" - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - updated_at: - type: string - format: date-time - url: - description: URL for the issue comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - html_url - - issue_url - - id - - node_id - - user - - created_at - - updated_at - - author_association - - performed_via_github_app - - body - - reactions + "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -104944,8 +110242,6 @@ components: - watch - workflow_dispatch - workflow_run - - reminder - - pull_request_review_thread external_url: type: - string @@ -105127,7 +110423,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -105651,182 +110946,46 @@ components: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - changes - issue - comment - repository - sender - webhook-issues-assigned: - title: issues assigned event + webhook-issue-comment-edited: + title: issue_comment edited event type: object properties: action: - description: The action that was performed. type: string enum: - - assigned - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id + - edited + changes: + "$ref": "#/components/schemas/webhooks_changes" + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: - title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: title: User type: - object @@ -105896,882 +111055,9 @@ components: required: - login - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - repository - - sender - webhook-issues-closed: - title: issues closed event - type: object - properties: - action: - description: The action that was performed. - type: string - enum: - - closed - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: + assignees: + type: array + items: title: User type: - object @@ -107141,7 +111427,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - reminder - pull_request_review_thread external_url: @@ -107610,9 +111895,75 @@ components: - string - 'null' assignee: + title: User type: - object - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id assignees: type: array items: @@ -107644,9 +111995,38 @@ components: labels: type: array items: - type: - - object - - 'null' + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description labels_url: type: string locked: @@ -107689,10 +112069,11 @@ components: repository_url: type: string state: + description: State of the issue; either 'open' or 'closed' type: string enum: - - closed - open + - closed timeline_url: type: string title: @@ -107741,8 +112122,10 @@ components: url: type: string required: + - labels - state - - closed_at + - locked + - assignee organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -107751,109 +112134,72 @@ components: "$ref": "#/components/schemas/simple-user-webhooks" required: - action + - changes - issue + - comment - repository - sender - webhook-issues-deleted: - title: issues deleted event + webhook-issues-assigned: + title: issues assigned event type: object properties: action: + description: The action that was performed. type: string enum: - - deleted + - assigned + assignee: + "$ref": "#/components/schemas/webhooks_user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - repository + - sender + webhook-issues-closed: + title: issues closed event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - closed enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: - title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: title: User type: - object @@ -107916,872 +112262,7 @@ components: - Bot - User - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - repository - - sender - webhook-issues-demilestoned: - title: issues demilestoned event - type: object - properties: - action: - type: string - enum: - - demilestoned - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin + - Mannequin url: type: string format: uri @@ -109160,6 +112641,9 @@ components: - watch - workflow_dispatch - workflow_run + - security_and_analysis + - reminder + - pull_request_review_thread external_url: type: - string @@ -109668,148 +113152,9 @@ components: locked: type: boolean milestone: - title: Milestone - description: A collection of related issues and pull requests. type: - object - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at node_id: type: string number: @@ -109845,6 +113190,9 @@ components: type: string state: type: string + enum: + - closed + - open timeline_url: type: string title: @@ -109893,148 +113241,8 @@ components: url: type: string required: - - milestone - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at + - state + - closed_at organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -110046,34 +113254,14 @@ components: - issue - repository - sender - webhook-issues-edited: - title: issues edited event + webhook-issues-deleted: + title: issues deleted event type: object properties: action: type: string enum: - - edited - changes: - description: The changes to the issue. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from - title: - type: object - properties: - from: - description: The previous version of the title. - type: string - required: - - from + - deleted enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -110157,7 +113345,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -110229,7 +113416,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -110398,7 +113584,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -110535,8 +113720,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - pull_request_review_thread - reminder external_url: type: @@ -110719,7 +113902,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -110968,7 +114150,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -110997,39 +114178,6 @@ components: - active_lock_reason - body - reactions - label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -111038,18 +114186,17 @@ components: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - changes - issue - repository - sender - webhook-issues-labeled: - title: issues labeled event + webhook-issues-demilestoned: + title: issues demilestoned event type: object properties: action: type: string enum: - - labeled + - demilestoned enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -111059,6 +114206,28 @@ components: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user properties: active_lock_reason: type: @@ -111075,6 +114244,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -111137,9 +114309,6 @@ components: url: type: string format: uri - required: - - login - - id assignees: type: array items: @@ -111147,6 +114316,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -111209,9 +114381,6 @@ components: url: type: string format: uri - required: - - login - - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -111258,7 +114427,17 @@ components: type: array items: title: Label - type: object + type: + - object + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description properties: color: description: '6-character hex code, without the leading #, identifying @@ -111281,14 +114460,6 @@ components: description: URL for the label type: string format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description labels_url: type: string format: uri-template @@ -111300,6 +114471,23 @@ components: type: - object - 'null' + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at properties: closed_at: type: @@ -111316,6 +114504,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -111378,9 +114569,6 @@ components: url: type: string format: uri - required: - - login - - id description: type: - string @@ -111420,23 +114608,6 @@ components: url: type: string format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at node_id: type: string number: @@ -111450,6 +114621,16 @@ components: type: - object - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: created_at: type: @@ -111511,8 +114692,6 @@ components: - watch - workflow_dispatch - workflow_run - - pull_request_review_thread - - reminder external_url: type: - string @@ -111536,6 +114715,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -111597,9 +114779,6 @@ components: url: type: string format: uri - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -111788,16 +114967,6 @@ components: - string - 'null' format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -111821,6 +114990,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -111843,17 +115023,6 @@ components: url: type: string format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket repository_url: type: string format: uri @@ -111885,6 +115054,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -111947,64 +115119,8 @@ components: url: type: string format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description + milestone: + "$ref": "#/components/schemas/webhooks_milestone" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -112016,36 +115132,127 @@ components: - issue - repository - sender - webhook-issues-locked: - title: issues locked event + webhook-issues-edited: + title: issues edited event type: object properties: action: type: string enum: - - locked + - edited + changes: + description: The changes to the issue. + type: object + properties: + body: + type: object + properties: + from: + description: The previous version of the body. + type: string + required: + - from + title: + type: object + properties: + from: + description: The previous version of the title. + type: string + required: + - from enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: title: User type: - object @@ -112108,15 +115315,113 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri required: - login - id - assignees: - type: array - items: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: title: User type: - object @@ -112179,1027 +115484,889 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri required: - login - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: 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. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + avatar_url: type: string - default: + format: uri + deleted: type: boolean - description: + email: type: - string - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer + login: + type: string name: - description: The name of the label. type: string node_id: type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: - description: URL for the label type: string format: uri required: + - login - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + label: + "$ref": "#/components/schemas/webhooks_label" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - issue + - repository + - sender + webhook-issues-labeled: + title: issues labeled event + type: object + properties: + action: + type: string + enum: + - labeled + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: + title: User type: - object - 'null' properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: + avatar_url: type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: + format: uri + deleted: + type: boolean + email: type: - string - 'null' - format: date-time + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string html_url: type: string format: uri id: type: integer - labels_url: + login: + type: string + name: type: string - format: uri node_id: type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. + organizations_url: type: string - enum: - - open - - closed - title: - description: The title of the milestone. + format: uri + received_events_url: type: string - updated_at: + format: uri + repos_url: type: string - format: date-time + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin url: type: string format: uri required: - - url - - html_url - - labels_url + - login - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: - - object - - 'null' + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object properties: - created_at: - type: - - string - - 'null' - format: date-time + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean description: type: - string - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri id: type: integer - login: - type: string name: + description: The name of the label. type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization url: + description: URL for the label type: string format: uri required: - - login - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - type: - - object - - 'null' - assignees: - type: array - items: - type: - - object - - 'null' - author_association: - type: string - body: - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: type: - - object + - string - 'null' - labels_url: - type: string - locked: - type: boolean - enum: - - true - milestone: - type: - - object - - 'null' - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: - - object - - 'null' - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - type: string - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - required: - - locked - - active_lock_reason - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - repository - - sender - webhook-issues-milestoned: - title: issues milestoned event - type: object - properties: - action: - type: string - enum: - - milestoned - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: title: User type: - object @@ -113262,1231 +116429,1148 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri required: - login - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: 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. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + avatar_url: type: string - default: + format: uri + deleted: type: boolean - description: + email: type: - string - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer + login: + type: string name: - description: The name of the label. type: string node_id: type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: - description: URL for the label type: string format: uri required: + - login - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + label: + "$ref": "#/components/schemas/webhooks_label" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - repository + - sender + webhook-issues-locked: + title: issues locked event + type: object + properties: + action: + type: string + enum: + - locked + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - locked + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + assignees: + type: array + items: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: + format: uri + deleted: + type: boolean + email: type: - string - 'null' - format: date-time + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string html_url: type: string format: uri id: type: integer - labels_url: + login: + type: string + name: type: string - format: uri node_id: type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. + organizations_url: type: string - enum: - - open - - closed - title: - description: The title of the milestone. + format: uri + received_events_url: type: string - updated_at: + format: uri + repos_url: type: string - format: date-time + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: type: string format: uri + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: + - object + - 'null' required: - - url - - html_url - - labels_url - id - node_id - - number - - title + - url + - name + - color + - default - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: - - object - - 'null' properties: - created_at: - type: - - string - - 'null' - format: date-time + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean description: type: - string - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' + type: integer name: - description: The name of the GitHub app + description: The name of the label. type: string node_id: type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + url: + description: URL for the label + type: string + format: uri + labels_url: + type: string + format: uri-template + locked: + type: boolean + enum: + - true + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - assignee: - type: - - object - - 'null' - assignees: - type: array - items: - type: - - object - - 'null' - author_association: - type: string - body: - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + description: type: - - object + - string - 'null' - labels_url: - type: string - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: - - object - - 'null' - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - type: string - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - required: - - milestone - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + due_on: type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string + format: date-time html_url: type: string format: uri id: type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: + labels_url: type: string format: uri - repos_url: + node_id: type: string - format: uri - site_admin: - type: boolean - starred_url: + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. type: string - format: uri-template - subscriptions_url: + enum: + - open + - closed + title: + description: The title of the milestone. type: string - format: uri - type: + updated_at: type: string - enum: - - Bot - - User - - Organization - - Mannequin + format: date-time url: type: string format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri node_id: type: string number: - description: The number of the milestone. - type: integer - open_issues: type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - milestone - - repository - - sender - webhook-issues-opened: - title: issues opened event - type: object - properties: - action: - type: string - enum: - - opened - changes: - type: object - properties: - old_issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. + performed_via_github_app: + title: 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. type: - object - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: - active_lock_reason: + created_at: type: - string - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: title: User type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -114548,1310 +117632,363 @@ components: url: type: string format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, - identifying the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' + permissions: + description: The set of permissions for the GitHub app + type: object properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: + actions: type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: + enum: + - read + - write + administration: type: string - format: uri - id: - type: integer - labels_url: + enum: + - read + - write + checks: type: string - format: uri - node_id: + enum: + - read + - write + content_references: type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. + enum: + - read + - write + contents: type: string enum: - - open - - closed - title: - description: The title of the milestone. + - read + - write + deployments: type: string - updated_at: + enum: + - read + - write + discussions: type: string - format: date-time - url: + enum: + - read + - write + emails: type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: - - string - - 'null' - format: uri - html_url: + enum: + - read + - write + environments: type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app + enum: + - read + - write + issues: type: string - node_id: + enum: + - read + - write + keys: type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app + enum: + - read + - write + members: type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: + enum: + - read + - write + metadata: type: string - format: uri - html_url: + enum: + - read + - write + organization_administration: type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: + enum: + - read + - write + organization_hooks: type: string - format: uri - url: + enum: + - read + - write + organization_packages: type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: + enum: + - read + - write + organization_plan: type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: + enum: + - read + - write + organization_projects: type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: + enum: + - read + - write + organization_secrets: type: string - format: uri-template - followers_url: + enum: + - read + - write + organization_self_hosted_runners: type: string - format: uri - following_url: + enum: + - read + - write + organization_user_blocking: type: string - format: uri-template - gists_url: + enum: + - read + - write + packages: type: string - format: uri-template - gravatar_id: + enum: + - read + - write + pages: type: string - html_url: + enum: + - read + - write + pull_requests: type: string - format: uri - id: - type: integer - login: + enum: + - read + - write + repository_hooks: type: string - name: + enum: + - read + - write + repository_projects: type: string - node_id: + enum: + - read + - write + secret_scanning_alerts: type: string - organizations_url: + enum: + - read + - write + secrets: type: string - format: uri - received_events_url: + enum: + - read + - write + security_events: type: string - format: uri - repos_url: + enum: + - read + - write + security_scanning_alert: type: string - format: uri - site_admin: - type: boolean - starred_url: + enum: + - read + - write + single_file: type: string - format: uri-template - subscriptions_url: + enum: + - read + - write + statuses: type: string - format: uri - type: + enum: + - read + - write + team_discussions: type: string enum: - - Bot - - User - - Organization - url: + - read + - write + vulnerability_alerts: type: string - format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - old_repository: - title: Repository - description: A git repository + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + pull_request: type: object properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: + diff_url: type: string format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: - type: object - description: The custom properties that were defined for the repository. - The keys are the custom property names, and the values are the - corresponding custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: + html_url: type: string format: uri - description: + merged_at: type: - string - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: + format: date-time + patch_url: type: string format: uri - events_url: + url: type: string format: uri - fork: - type: boolean - forks: + reactions: + title: Reactions + type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + properties: + "+1": type: integer - forks_count: + "-1": type: integer - forks_url: + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: type: string format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: + repository_url: + type: string + format: uri + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: type: string format: uri - has_discussions: - description: Whether the repository has discussions enabled. - type: boolean - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. + deleted: type: boolean - default: true - homepage: + email: type: - string - 'null' - hooks_url: + events_url: type: string - format: uri - html_url: + format: uri-template + followers_url: type: string format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: + following_url: type: string format: uri-template - issue_events_url: + gists_url: type: string format: uri-template - issues_url: + gravatar_id: type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: + html_url: type: string format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: + id: + type: integer + login: type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri name: - description: The name of the repository. type: string node_id: type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: + organizations_url: type: string format: uri - subscription_url: + received_events_url: type: string format: uri - svn_url: + repos_url: type: string format: uri - tags_url: + site_admin: + type: boolean + starred_url: type: string - format: uri - teams_url: + format: uri-template + subscriptions_url: type: string format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: + type: type: string - format: date-time + enum: + - Bot + - User + - Organization url: type: string format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require commit signoff. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - required: - - old_issue - - old_repository + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - repository + - sender + webhook-issues-milestoned: + title: issues milestoned event + type: object + properties: + action: + type: string + enum: + - milestoned enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -115861,6 +117998,28 @@ components: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user properties: active_lock_reason: type: @@ -115877,6 +118036,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -115938,9 +118100,6 @@ components: url: type: string format: uri - required: - - login - - id assignees: type: array items: @@ -115948,6 +118107,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -116009,9 +118171,6 @@ components: url: type: string format: uri - required: - - login - - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -116058,7 +118217,17 @@ components: type: array items: title: Label - type: object + type: + - object + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description properties: color: description: '6-character hex code, without the leading #, identifying @@ -116081,14 +118250,6 @@ components: description: URL for the label type: string format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description labels_url: type: string format: uri-template @@ -116100,6 +118261,23 @@ components: type: - object - 'null' + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at properties: closed_at: type: @@ -116116,6 +118294,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -116178,9 +118359,6 @@ components: url: type: string format: uri - required: - - login - - id description: type: - string @@ -116220,23 +118398,6 @@ components: url: type: string format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at node_id: type: string number: @@ -116250,6 +118411,16 @@ components: type: - object - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: created_at: type: @@ -116311,8 +118482,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - pull_request_review_thread - reminder external_url: type: @@ -116337,6 +118506,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -116398,9 +118570,6 @@ components: url: type: string format: uri - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -116589,16 +118758,6 @@ components: - string - 'null' format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -116622,6 +118781,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -116644,17 +118814,6 @@ components: url: type: string format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket repository_url: type: string format: uri @@ -116686,6 +118845,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -116747,31 +118909,8 @@ components: url: type: string format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions + milestone: + "$ref": "#/components/schemas/webhooks_milestone" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -116781,276 +118920,39 @@ components: required: - action - issue + - milestone - repository - sender - webhook-issues-pinned: - title: issues pinned event + webhook-issues-opened: + title: issues opened event type: object properties: action: type: string enum: - - pinned - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. + - opened + changes: type: object properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User + old_issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. type: - object - 'null' properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + active_lock_reason: type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: + - resolved + - off-topic + - too heated + - spam + - + assignee: title: User type: - object @@ -117119,705 +119021,1065 @@ components: required: - login - id - description: + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue type: - string - 'null' - due_on: + closed_at: type: - string - 'null' format: date-time - html_url: - type: string - format: uri - id: + comments: type: integer - labels_url: + comments_url: type: string format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: + created_at: type: string format: date-time - url: + draft: + type: boolean + events_url: type: string format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: - - string - - 'null' - format: uri html_url: type: string format: uri id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, + identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: type: string - owner: - title: User + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. type: - object - 'null' properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + closed_at: type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: + format: date-time + closed_issues: + type: integer + created_at: type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time html_url: type: string format: uri id: type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: + labels_url: type: string format: uri - repos_url: + node_id: type: string - format: uri - site_admin: - type: boolean - starred_url: + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. type: string - format: uri-template - subscriptions_url: + enum: + - open + - closed + title: + description: The title of the milestone. type: string - format: uri - type: + updated_at: type: string - enum: - - Bot - - User - - Organization + format: date-time url: type: string format: uri required: - - login + - url + - html_url + - labels_url - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: - type: string - format: uri - url: + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: + number: type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + performed_via_github_app: + title: 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. type: - - string + - object - 'null' - events_url: - type: string - format: uri-template - followers_url: + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: type: string format: uri - following_url: + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + old_repository: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: type: string format: uri-template - gists_url: + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: type: string format: uri-template - gravatar_id: + blobs_url: type: string - html_url: + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: type: string format: uri - id: + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + custom_properties: + type: object + description: The custom properties that were defined for the repository. + The keys are the custom property names, and the values are the + corresponding custom property values. + additionalProperties: true + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: type: integer - login: + forks_count: + type: integer + forks_url: type: string - name: + format: uri + full_name: type: string - node_id: + git_commits_url: type: string - organizations_url: + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: type: string format: uri - received_events_url: + has_discussions: + description: Whether the repository has discussions enabled. + type: boolean + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + homepage: + type: + - string + - 'null' + hooks_url: type: string format: uri - repos_url: + html_url: type: string format: uri - site_admin: + id: + description: Unique identifier of the repository + type: integer + is_template: type: boolean - starred_url: + issue_comment_url: type: string format: uri-template - subscriptions_url: + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: type: string format: uri - type: + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: type: string - enum: - - Bot - - User - - Organization - url: + merges_url: type: string format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - repository - - sender - webhook-issues-reopened: - title: issues reopened event - type: object - properties: - action: - type: string - enum: - - reopened - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + milestones_url: + type: string + format: uri-template + mirror_url: type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: title: User type: - object @@ -117880,684 +120142,278 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - login - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label + permissions: type: object properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require commit signoff. + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + required: + - old_issue + - old_repository + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: title: User type: - object @@ -118620,213 +120476,112 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - login - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - assignee: - type: - - object - - 'null' - assignees: - type: array - items: - type: - - object - - 'null' - author_association: - type: string - body: - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - type: - - object - - 'null' - labels_url: - type: string - locked: - type: boolean - milestone: - type: - - object - - 'null' - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: - - object - - 'null' - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - type: string - enum: - - open - - closed - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: + - string + - 'null' + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label type: object properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string + default: + type: boolean + description: + type: + - string + - 'null' id: type: integer - login: + name: + description: The name of the label. type: string node_id: type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string url: + description: URL for the label type: string - required: - - state - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - repository - - sender - webhook-issues-transferred: - title: issues transferred event - type: object - properties: - action: - type: string - enum: - - transferred - changes: - type: object - properties: - new_issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: title: User type: - object @@ -118889,749 +120644,165 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri required: - login - id - assignees: - type: array - items: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue + description: type: - string - 'null' - closed_at: + due_on: type: - string - 'null' format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri html_url: type: string format: uri id: type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, - identifying the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description labels_url: type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at + format: uri node_id: type: string number: + description: The number of the milestone. + type: integer + open_issues: type: integer - performed_via_github_app: - title: 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. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri state: - description: State of the issue; either 'open' or 'closed' + description: The state of the milestone. type: string enum: - open - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri title: - description: Title of the issue + description: The title of the milestone. type: string updated_at: type: string format: date-time url: - description: URL for the issue type: string format: uri - user: + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: 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. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: title: User type: - object @@ -119700,505 +120871,421 @@ components: required: - login - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - new_repository: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: + permissions: + description: The set of permissions for the GitHub app type: object - description: The custom properties that were defined for the repository. - The keys are the custom property names, and the values are the - corresponding custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' properties: - key: + actions: type: string - name: + enum: + - read + - write + administration: type: string - node_id: + enum: + - read + - write + checks: type: string - spdx_id: + enum: + - read + - write + content_references: type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: + enum: + - read + - write + contents: type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: + enum: + - read + - write + deployments: type: string - format: uri-template - followers_url: + enum: + - read + - write + discussions: type: string - format: uri - following_url: + enum: + - read + - write + emails: type: string - format: uri-template - gists_url: + enum: + - read + - write + environments: type: string - format: uri-template - gravatar_id: + enum: + - read + - write + issues: type: string - html_url: + enum: + - read + - write + keys: type: string - format: uri - id: - type: integer - login: + enum: + - read + - write + members: type: string - name: + enum: + - read + - write + metadata: type: string - node_id: + enum: + - read + - write + organization_administration: type: string - organizations_url: + enum: + - read + - write + organization_hooks: type: string - format: uri - received_events_url: + enum: + - read + - write + organization_packages: type: string - format: uri - repos_url: + enum: + - read + - write + organization_plan: type: string - format: uri - site_admin: - type: boolean - starred_url: + enum: + - read + - write + organization_projects: type: string - format: uri-template - subscriptions_url: + enum: + - read + - write + - admin + organization_secrets: type: string - format: uri - type: + enum: + - read + - write + organization_self_hosted_runners: type: string enum: - - Bot - - User - - Organization - url: + - read + - write + organization_user_blocking: type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time + updated_at: type: - - 'null' - - integer - string - releases_url: + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: type: string - format: uri-template - role_name: + format: uri + html_url: + type: string + format: uri + merged_at: type: - string - 'null' - size: - type: integer - ssh_url: + format: date-time + patch_url: type: string - stargazers: + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": type: integer - stargazers_count: + "-1": type: integer - stargazers_url: + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: type: string format: uri - statuses_url: + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: type: string format: uri-template - subscribers_url: + followers_url: type: string format: uri - subscription_url: + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: type: string format: uri - svn_url: + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: type: string format: uri - tags_url: + received_events_url: type: string format: uri - teams_url: + repos_url: type: string format: uri - topics: - type: array - items: - type: string - trees_url: + site_admin: + type: boolean + starred_url: type: string format: uri-template - updated_at: - type: string - format: date-time - url: + subscriptions_url: type: string format: uri - visibility: + type: type: string enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on web-based - commits - type: boolean + - Bot + - User + - Organization + url: + type: string + format: uri required: + - login - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility required: - - new_issue - - new_repository + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - repository + - sender + webhook-issues-pinned: + title: issues pinned event + type: object + properties: + action: + type: string + enum: + - pinned + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue_2" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - repository + - sender + webhook-issues-reopened: + title: issues reopened event + type: object + properties: + action: + type: string + enum: + - reopened enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -120208,6 +121295,29 @@ components: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - milestone + - node_id + - number + - reactions + - repository_url + - state + - title + - updated_at + - url + - user properties: active_lock_reason: type: @@ -120224,6 +121334,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -120285,9 +121398,6 @@ components: url: type: string format: uri - required: - - login - - id assignees: type: array items: @@ -120295,6 +121405,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -120353,12 +121466,10 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri - required: - - login - - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -120405,7 +121516,17 @@ components: type: array items: title: Label - type: object + type: + - object + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description properties: color: description: '6-character hex code, without the leading #, identifying @@ -120428,14 +121549,6 @@ components: description: URL for the label type: string format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description labels_url: type: string format: uri-template @@ -120447,6 +121560,23 @@ components: type: - object - 'null' + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at properties: closed_at: type: @@ -120463,6 +121593,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -120521,12 +121654,10 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri - required: - - login - - id description: type: - string @@ -120566,23 +121697,6 @@ components: url: type: string format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at node_id: type: string number: @@ -120596,6 +121710,16 @@ components: type: - object - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: created_at: type: @@ -120657,6 +121781,8 @@ components: - watch - workflow_dispatch - workflow_run + - pull_request_review_thread + - reminder external_url: type: - string @@ -120680,6 +121806,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -120741,9 +121870,6 @@ components: url: type: string format: uri - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -120838,6 +121964,7 @@ components: enum: - read - write + - admin organization_secrets: type: string enum: @@ -120878,6 +122005,7 @@ components: enum: - read - write + - admin secret_scanning_alerts: type: string enum: @@ -120931,16 +122059,6 @@ components: - string - 'null' format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -120964,6 +122082,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -120986,17 +122115,6 @@ components: url: type: string format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket repository_url: type: string format: uri @@ -121028,6 +122146,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -121086,34 +122207,10 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -121122,351 +122219,37 @@ components: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - changes - issue - repository - sender - webhook-issues-unassigned: - title: issues unassigned event + webhook-issues-transferred: + title: issues transferred event type: object properties: action: - description: The action that was performed. type: string enum: - - unassigned - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. + - transferred + changes: type: object properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' + new_issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + active_lock_reason: type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: + - resolved + - off-topic + - too heated + - spam + - + assignee: title: User type: - object @@ -121529,164 +122312,749 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - login - id - description: + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue type: - string - 'null' - due_on: + closed_at: type: - string - 'null' format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri html_url: type: string format: uri id: type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, + identifying the color' + type: string + default: + type: boolean + description: + type: + - string + - 'null' + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description labels_url: type: string - format: uri + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at node_id: type: string number: - description: The number of the milestone. - type: integer - open_issues: type: integer + performed_via_github_app: + title: 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. + type: + - object + - 'null' + properties: + created_at: + type: + - string + - 'null' + format: date-time + description: + type: + - string + - 'null' + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + external_url: + type: + - string + - 'null' + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: + - integer + - 'null' + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: + - string + - 'null' + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: + - string + - 'null' + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri state: - description: The state of the milestone. + description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed + state_reason: + type: + - string + - 'null' + timeline_url: + type: string + format: uri title: - description: The title of the milestone. + description: Title of the issue type: string updated_at: type: string format: date-time url: + description: URL for the issue type: string format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: + user: title: User type: - object @@ -121755,378 +123123,540 @@ components: required: - login - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url - id - node_id - - owner - - name - - description - - external_url - - html_url + - number + - title + - user + - assignees + - milestone + - comments - created_at - updated_at - pull_request: + - closed_at + - author_association + - active_lock_reason + - body + - reactions + new_repository: + title: Repository + description: A git repository type: object properties: - diff_url: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: type: string format: uri - html_url: + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: type: string format: uri - merged_at: + created_at: + oneOf: + - type: integer + - type: string + format: date-time + custom_properties: + type: object + description: The custom properties that were defined for the repository. + The keys are the custom property names, and the values are the + corresponding custom property values. + additionalProperties: true + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: type: - string - 'null' - format: date-time - patch_url: + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: type: string format: uri - url: + events_url: type: string format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: + fork: + type: boolean + forks: type: integer - total_count: + forks_count: type: integer - url: + forks_url: type: string format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: type: string format: uri - deleted: + has_downloads: + description: Whether downloads are enabled. type: boolean - email: + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: type: - string - 'null' - events_url: + hooks_url: type: string - format: uri-template - followers_url: + format: uri + html_url: type: string format: uri - following_url: + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: type: string format: uri-template - gists_url: + issue_events_url: type: string format: uri-template - gravatar_id: + issues_url: type: string - html_url: + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: type: string format: uri - id: - type: integer - login: + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merges_url: + type: string + format: uri + milestones_url: type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri name: + description: The name of the repository. type: string node_id: type: string - organizations_url: + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: type: string format: uri - received_events_url: + statuses_url: + type: string + format: uri-template + subscribers_url: type: string format: uri - repos_url: + subscription_url: type: string format: uri - site_admin: - type: boolean - starred_url: + svn_url: type: string - format: uri-template - subscriptions_url: + format: uri + tags_url: type: string format: uri - type: + teams_url: type: string - enum: - - Bot - - User - - Organization - - Mannequin + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time url: type: string format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based + commits + type: boolean required: - - login - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions + - new_issue + - new_repository + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue_2" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - issue + - repository + - sender + webhook-issues-unassigned: + title: issues unassigned event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - unassigned + assignee: + "$ref": "#/components/schemas/webhooks_user_mannequin" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -122150,11 +123680,61 @@ components: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + label: + "$ref": "#/components/schemas/webhooks_label" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - repository + - sender + webhook-issues-unlocked: + title: issues unlocked event + type: object + properties: + action: + type: string + enum: + - unlocked + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - locked + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user properties: active_lock_reason: type: @@ -122171,6 +123751,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -122229,13 +123812,9 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri - required: - - login - - id assignees: type: array items: @@ -122243,6 +123822,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -122301,13 +123883,9 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri - required: - - login - - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -122354,7 +123932,17 @@ components: type: array items: title: Label - type: object + type: + - object + - 'null' + required: + - id + - node_id + - url + - name + - color + - default + - description properties: color: description: '6-character hex code, without the leading #, identifying @@ -122377,25 +123965,36 @@ components: description: URL for the label type: string format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description labels_url: type: string format: uri-template locked: type: boolean + enum: + - false milestone: title: Milestone description: A collection of related issues and pull requests. type: - object - 'null' + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at properties: closed_at: type: @@ -122412,6 +124011,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -122470,13 +124072,9 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri - required: - - login - - id description: type: - string @@ -122516,23 +124114,6 @@ components: url: type: string format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at node_id: type: string number: @@ -122546,6 +124127,16 @@ components: type: - object - 'null' + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: created_at: type: @@ -122607,8 +124198,6 @@ components: - watch - workflow_dispatch - workflow_run - - reminder - - pull_request_review_thread external_url: type: - string @@ -122632,6 +124221,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -122693,9 +124285,6 @@ components: url: type: string format: uri - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -122790,7 +124379,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -122884,16 +124472,6 @@ components: - string - 'null' format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -122917,6 +124495,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -122939,17 +124528,6 @@ components: url: type: string format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket repository_url: type: string format: uri @@ -122981,6 +124559,9 @@ components: type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -123039,68 +124620,9 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -123112,1068 +124634,20 @@ components: - issue - repository - sender - webhook-issues-unlocked: - title: issues unlocked event + webhook-issues-unpinned: + title: issues unpinned event type: object properties: action: type: string enum: - - unlocked + - unpinned enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: - - 'null' - assignee: - type: - - object - - 'null' - assignees: - type: array - items: - type: - - object - - 'null' - author_association: - type: string - body: - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - type: - - object - - 'null' - labels_url: - type: string - locked: - type: boolean - enum: - - false - milestone: - type: - - object - - 'null' - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: - - 'null' - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - type: string - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - required: - - locked - - active_lock_reason + "$ref": "#/components/schemas/webhooks_issue_2" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -124185,985 +124659,20 @@ components: - issue - repository - sender - webhook-issues-unpinned: - title: issues unpinned event + webhook-label-created: + title: label created event type: object properties: action: type: string enum: - - unpinned - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: - - object - - 'null' - properties: - created_at: - type: - - string - - 'null' - format: date-time - description: - type: - - string - - 'null' - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: - - string - - 'null' - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: - - integer - - 'null' - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: - - string - - 'null' - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: - - string - - 'null' - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: - - string - - 'null' - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - repository - - sender - webhook-label-created: - title: label created event - type: object - properties: - action: - type: string - enum: - - created + - created enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description + "$ref": "#/components/schemas/webhooks_label" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -125187,38 +124696,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description + "$ref": "#/components/schemas/webhooks_label" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -125274,38 +124752,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description + "$ref": "#/components/schemas/webhooks_label" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -125332,241 +124779,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: - allOf: - - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: - - string - - 'null' - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - type: - - string - - 'null' - next_billing_date: - type: - - string - - 'null' - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: - - string - - 'null' - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan - - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: - - string - - 'null' - type: - type: string - billing_cycle: - type: string - free_trial_ends_on: - type: - - string - - 'null' - next_billing_date: - type: - - string - - 'null' - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: - - string - - 'null' - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: - - string - - 'null' - yearly_price_in_cents: - type: integer - unit_count: - type: integer - required: - - next_billing_date + "$ref": "#/components/schemas/webhooks_marketplace_purchase" organization: "$ref": "#/components/schemas/organization-simple-webhooks" previous_marketplace_purchase: - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: - - string - - 'null' - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - type: - - 'null' - next_billing_date: - type: - - string - - 'null' - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: - - string - - 'null' - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan + "$ref": "#/components/schemas/webhooks_previous_marketplace_purchase" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -125591,155 +124808,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: - allOf: - - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: - - string - - 'null' - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - type: - - string - - 'null' - next_billing_date: - type: - - string - - 'null' - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: - - string - - 'null' - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan - - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: - - string - - 'null' - type: - type: string - billing_cycle: - type: string - free_trial_ends_on: - type: - - string - - 'null' - next_billing_date: - type: - - string - - 'null' - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: - - string - - 'null' - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: - - string - - 'null' - yearly_price_in_cents: - type: integer - unit_count: - type: integer - required: - - next_billing_date + "$ref": "#/components/schemas/webhooks_marketplace_purchase" organization: "$ref": "#/components/schemas/organization-simple-webhooks" previous_marketplace_purchase: @@ -125853,155 +124922,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: - allOf: - - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: - - string - - 'null' - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - type: - - string - - 'null' - next_billing_date: - type: - - string - - 'null' - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: - - string - - 'null' - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan - - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: - - string - - 'null' - type: - type: string - billing_cycle: - type: string - free_trial_ends_on: - type: - - string - - 'null' - next_billing_date: - type: - - string - - 'null' - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: - - string - - 'null' - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: - - string - - 'null' - yearly_price_in_cents: - type: integer - unit_count: - type: integer - required: - - next_billing_date + "$ref": "#/components/schemas/webhooks_marketplace_purchase" organization: "$ref": "#/components/schemas/organization-simple-webhooks" previous_marketplace_purchase: @@ -126113,104 +125034,25 @@ components: installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: - allOf: - - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: - - string - - 'null' - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - type: - - 'null' - next_billing_date: - type: - - string - - 'null' - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: - - string - - 'null' - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan - - type: object - properties: - next_billing_date: - type: string - required: - - next_billing_date - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - previous_marketplace_purchase: title: Marketplace Purchase type: object + required: + - account + - billing_cycle + - free_trial_ends_on + - next_billing_date + - on_free_trial + - plan + - unit_count properties: account: type: object + required: + - type + - id + - node_id + - login + - organization_billing_email properties: id: type: integer @@ -126224,12 +125066,6 @@ components: - 'null' type: type: string - required: - - type - - id - - node_id - - login - - organization_billing_email billing_cycle: type: string free_trial_ends_on: @@ -126243,6 +125079,16 @@ components: type: boolean plan: type: object + required: + - id + - name + - description + - monthly_price_in_cents + - yearly_price_in_cents + - price_model + - has_free_trial + - unit_name + - bullets properties: bullets: type: array @@ -126270,25 +125116,12 @@ components: - 'null' yearly_price_in_cents: type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets unit_count: type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + previous_marketplace_purchase: + "$ref": "#/components/schemas/webhooks_previous_marketplace_purchase" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -126313,241 +125146,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: - allOf: - - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: - - string - - 'null' - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - type: - - string - - 'null' - next_billing_date: - type: - - string - - 'null' - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: - - string - - 'null' - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan - - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: - - string - - 'null' - type: - type: string - billing_cycle: - type: string - free_trial_ends_on: - type: - - string - - 'null' - next_billing_date: - type: - - string - - 'null' - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: - - string - - 'null' - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: - - string - - 'null' - yearly_price_in_cents: - type: integer - unit_count: - type: integer - required: - - next_billing_date + "$ref": "#/components/schemas/webhooks_marketplace_purchase" organization: "$ref": "#/components/schemas/organization-simple-webhooks" previous_marketplace_purchase: - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: - - string - - 'null' - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - type: - - 'null' - next_billing_date: - type: - - string - - 'null' - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: - - string - - 'null' - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan + "$ref": "#/components/schemas/webhooks_previous_marketplace_purchase" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -126569,6 +125172,11 @@ components: type: object properties: permission: + description: |- + This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + assigned to the collaborator, use the `role_name` field instead, which will provide the full + role name, including custom roles. type: object properties: to: @@ -126579,79 +125187,20 @@ components: - read required: - to + role_name: + description: The role assigned to the collaborator. + type: object + properties: + to: + type: string + required: + - to enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" member: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id + "$ref": "#/components/schemas/webhooks_user" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -126700,74 +125249,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" member: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id + "$ref": "#/components/schemas/webhooks_user" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -126793,74 +125275,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" member: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id + "$ref": "#/components/schemas/webhooks_user" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -126885,6 +125300,17 @@ components: installation: "$ref": "#/components/schemas/simple-installation" member: + "$ref": "#/components/schemas/webhooks_user" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + scope: + description: The scope of the membership. Currently, can only be `team`. + type: string + enum: + - team + sender: title: User type: - object @@ -126953,6 +125379,29 @@ components: required: - login - id + team: + "$ref": "#/components/schemas/webhooks_team" + required: + - action + - scope + - member + - sender + - team + - organization + webhook-membership-removed: + title: membership removed event + type: object + properties: + action: + type: string + enum: + - removed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + member: + "$ref": "#/components/schemas/webhooks_user" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -126962,6 +125411,7 @@ components: type: string enum: - team + - organization sender: title: User type: @@ -127032,120 +125482,7 @@ components: - login - id team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team" required: - action - scope @@ -127153,295 +125490,13 @@ components: - sender - team - organization - webhook-membership-removed: - title: membership removed event + webhook-merge-group-checks-requested: type: object properties: action: type: string enum: - - removed - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - member: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - scope: - description: The scope of the membership. Currently, can only be `team`. - type: string - enum: - - team - - organization - sender: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - required: - - action - - scope - - member - - sender - - team - - organization - webhook-merge-group-checks-requested: - type: object - properties: - action: - type: string - enum: - - checks_requested + - checks_requested installation: "$ref": "#/components/schemas/simple-installation" merge_group: @@ -127628,146 +125683,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at + "$ref": "#/components/schemas/webhooks_milestone" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -127792,145 +125708,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at + "$ref": "#/components/schemas/webhooks_milestone_3" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -127955,146 +125733,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at + "$ref": "#/components/schemas/webhooks_milestone" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -128150,21 +125789,181 @@ components: installation: "$ref": "#/components/schemas/simple-installation" milestone: - title: Milestone - description: A collection of related issues and pull requests. + "$ref": "#/components/schemas/webhooks_milestone" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - milestone + - repository + - sender + webhook-milestone-opened: + title: milestone opened event + type: object + properties: + action: + type: string + enum: + - opened + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + milestone: + "$ref": "#/components/schemas/webhooks_milestone_3" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - milestone + - repository + - sender + webhook-org-block-blocked: + title: org_block blocked event + type: object + properties: + action: + type: string + enum: + - blocked + blocked_user: + "$ref": "#/components/schemas/webhooks_user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - blocked_user + - organization + - sender + webhook-org-block-unblocked: + title: org_block unblocked event + type: object + properties: + action: + type: string + enum: + - unblocked + blocked_user: + "$ref": "#/components/schemas/webhooks_user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - blocked_user + - organization + - sender + webhook-organization-deleted: + title: organization deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + membership: + "$ref": "#/components/schemas/webhooks_membership" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - organization + - sender + webhook-organization-member-added: + title: organization member_added event + type: object + properties: + action: + type: string + enum: + - member_added + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + membership: + "$ref": "#/components/schemas/webhooks_membership" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - membership + - organization + - sender + webhook-organization-member-invited: + title: organization member_invited event + type: object + properties: + action: + type: string + enum: + - member_invited + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + invitation: + description: The invitation for the user or email if the action is `member_invited`. type: object properties: - closed_at: + created_at: + type: string + format: date-time + email: + type: + - string + - 'null' + failed_at: type: - string - 'null' format: date-time - closed_issues: - type: integer - created_at: + failed_reason: + type: + - string + - 'null' + id: + type: number + invitation_teams_url: type: string - format: date-time - creator: + format: uri + inviter: title: User type: - object @@ -128227,109 +126026,177 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - login - id - description: - type: - - string - - 'null' - due_on: + login: type: - string - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri node_id: type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: + role: type: string - format: date-time - url: + team_count: + type: number + invitation_source: type: string - format: uri required: - - url - - html_url - - labels_url - id - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state + - login + - email + - role - created_at - - updated_at - - due_on - - closed_at + - failed_at + - failed_reason + - inviter + - team_count + - invitation_teams_url organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" + user: + "$ref": "#/components/schemas/webhooks_user" required: - action - - changes - - milestone - - repository + - invitation + - organization - sender - webhook-milestone-opened: - title: milestone opened event + webhook-organization-member-removed: + title: organization member_removed event type: object properties: action: type: string enum: - - opened + - member_removed enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" - milestone: - title: Milestone - description: A collection of related issues and pull requests. + membership: + "$ref": "#/components/schemas/webhooks_membership" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - membership + - organization + - sender + webhook-organization-renamed: + title: organization renamed event + type: object + properties: + action: + type: string + enum: + - renamed + changes: type: object properties: - closed_at: + login: + type: object + properties: + from: + type: string + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + membership: + "$ref": "#/components/schemas/webhooks_membership" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - organization + - sender + webhook-rubygems-metadata: + title: Ruby Gems metadata + type: object + properties: + name: + type: string + description: + type: string + readme: + type: string + homepage: + type: string + version_info: + type: object + properties: + version: + type: string + platform: + type: string + metadata: + type: object + additionalProperties: + type: string + repo: + type: string + dependencies: + type: array + items: + type: object + additionalProperties: + type: string + commit_oid: + type: string + webhook-package-published: + title: package published event + type: object + properties: + action: + type: string + enum: + - published + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + package: + description: Information about the package. + type: object + properties: + created_at: type: - string - 'null' - format: date-time - closed_issues: + description: + type: + - string + - 'null' + ecosystem: + type: string + html_url: + type: string + format: uri + id: type: integer - created_at: + name: type: string - format: date-time - creator: + namespace: + type: string + owner: title: User type: - object @@ -128398,399 +126265,540 @@ components: required: - login - id - description: - type: - - string - - 'null' - due_on: + package_type: + type: string + package_version: type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - milestone - - repository - - sender - webhook-org-block-blocked: - title: org_block blocked event - type: object - properties: - action: - type: string - enum: - - blocked - blocked_user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - blocked_user - - organization - - sender - webhook-org-block-unblocked: - title: org_block unblocked event - type: object - properties: - action: - type: string - enum: - - unblocked - blocked_user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - blocked_user - - organization - - sender - webhook-organization-deleted: - title: organization deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - membership: - title: Membership - description: The membership between the user and the organization. Not present - when the action is `member_invited`. - type: object - properties: - organization_url: - type: string - format: uri - role: - type: string - state: - type: string - url: - type: string - format: uri - user: - title: User - type: - - object + - object - 'null' properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + author: + title: User type: - - string + - object - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + body: + oneOf: + - type: string + - type: object + body_html: type: string - format: uri-template - gists_url: + container_metadata: + type: + - object + - 'null' + properties: + labels: + type: + - object + - 'null' + manifest: + type: + - object + - 'null' + tag: + type: object + properties: + digest: + type: string + name: + type: string + created_at: type: string - format: uri-template - gravatar_id: + description: type: string + docker_metadata: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: string + draft: + type: boolean html_url: type: string format: uri id: type: integer - login: + installation_command: + type: string + manifest: type: string + metadata: + type: array + items: + type: object + additionalProperties: true name: type: string - node_id: + npm_metadata: + type: + - object + - 'null' + properties: + name: + type: string + version: + type: string + npm_user: + type: string + author: + type: + - object + - 'null' + bugs: + type: + - object + - 'null' + dependencies: + type: object + dev_dependencies: + type: object + peer_dependencies: + type: object + optional_dependencies: + type: object + description: + type: string + dist: + type: + - object + - 'null' + git_head: + type: string + homepage: + type: string + license: + type: string + main: + type: string + repository: + type: + - object + - 'null' + scripts: + type: object + id: + type: string + node_version: + type: string + npm_version: + type: string + has_shrinkwrap: + type: boolean + maintainers: + type: array + items: + type: object + contributors: + type: array + items: + type: object + engines: + type: object + keywords: + type: array + items: + type: string + files: + type: array + items: + type: string + bin: + type: object + man: + type: object + directories: + type: + - object + - 'null' + os: + type: array + items: + type: string + cpu: + type: array + items: + type: string + readme: + type: string + installation_command: + type: string + release_id: + type: integer + commit_oid: + type: string + published_via_actions: + type: boolean + deleted_by_id: + type: integer + nuget_metadata: + type: + - array + - 'null' + items: + type: object + properties: + id: + oneOf: + - type: integer + - type: string + name: + type: string + value: + oneOf: + - type: boolean + - type: string + - type: integer + - type: object + properties: + url: + type: string + branch: + type: string + commit: + type: string + type: + type: string + package_files: + type: array + items: + type: object + properties: + content_type: + type: string + created_at: + type: string + download_url: + type: string + format: uri + id: + type: integer + md5: + type: + - string + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + sha256: + type: + - string + - 'null' + size: + type: integer + state: + type: + - string + - 'null' + updated_at: + type: string + required: + - download_url + - id + - name + - sha256 + - sha1 + - md5 + - content_type + - state + - size + - created_at + - updated_at + package_url: type: string - organizations_url: + prerelease: + type: boolean + release: + type: object + properties: + author: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + created_at: + type: string + draft: + type: boolean + html_url: + type: string + format: uri + id: + type: integer + name: + type: + - string + - 'null' + prerelease: + type: boolean + published_at: + type: string + tag_name: + type: string + target_commitish: + type: string + url: + type: string + format: uri + required: + - url + - html_url + - id + - tag_name + - target_commitish + - name + - draft + - author + - prerelease + - created_at + - published_at + rubygems_metadata: + type: array + items: + "$ref": "#/components/schemas/webhook-rubygems-metadata" + source_url: type: string - format: uri - received_events_url: + summary: type: string - format: uri - repos_url: + tag_name: type: string - format: uri - site_admin: - type: boolean - starred_url: + target_commitish: type: string - format: uri-template - subscriptions_url: + target_oid: + type: string + updated_at: + type: string + version: + type: string + required: + - id + - version + - summary + - name + - description + - html_url + - metadata + - package_files + - installation_command + registry: + type: + - object + - 'null' + properties: + about_url: type: string format: uri + name: + type: string type: type: string - enum: - - Bot - - User - - Organization url: type: string format: uri + vendor: + type: string required: - - login - - id + - about_url + - name + - type + - url + - vendor + updated_at: + type: + - string + - 'null' required: - - url - - state - - role - - organization_url - - user - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" + - id + - name + - namespace + - description + - ecosystem + - package_type + - html_url + - created_at + - updated_at + - owner + - package_version + - registry repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - organization + - package - sender - webhook-organization-member-added: - title: organization member_added event + webhook-package-updated: + title: package updated event type: object properties: action: type: string enum: - - member_added + - updated enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" - membership: - title: Membership - description: The membership between the user and the organization. Not present - when the action is `member_invited`. + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + package: + description: Information about the package. type: object properties: - organization_url: - type: string - format: uri - role: + created_at: type: string - state: + description: + type: + - string + - 'null' + ecosystem: type: string - url: + html_url: type: string format: uri - user: + id: + type: integer + name: + type: string + namespace: + type: string + owner: title: User type: - object @@ -128859,918 +126867,160 @@ components: required: - login - id - required: - - url - - state - - role - - organization_url - - user - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - membership - - organization - - sender - webhook-organization-member-invited: - title: organization member_invited event - type: object - properties: - action: - type: string - enum: - - member_invited - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - invitation: - description: The invitation for the user or email if the action is `member_invited`. - type: object - properties: - created_at: - type: string - format: date-time - email: - type: - - string - - 'null' - failed_at: - type: - - string - - 'null' - format: date-time - failed_reason: - type: - - string - - 'null' - id: - type: number - invitation_teams_url: + package_type: type: string - format: uri - inviter: - title: User - type: - - object - - 'null' + package_version: + type: object properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + author: + title: User type: - - string + - object - 'null' - events_url: - type: string - format: uri-template - followers_url: + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + body: type: string - format: uri - following_url: + body_html: type: string - format: uri-template - gists_url: + created_at: type: string - format: uri-template - gravatar_id: + description: type: string + docker_metadata: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: string + draft: + type: boolean html_url: type: string format: uri id: type: integer - login: - type: string - name: - type: string - node_id: + installation_command: type: string - organizations_url: + manifest: type: string - format: uri - received_events_url: + metadata: + type: array + items: + type: object + additionalProperties: true + name: type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - login: - type: - - string - - 'null' - node_id: - type: string - role: - type: string - team_count: - type: number - invitation_source: - type: string - required: - - id - - node_id - - login - - email - - role - - created_at - - failed_at - - failed_reason - - inviter - - team_count - - invitation_teams_url - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - action - - invitation - - organization - - sender - webhook-organization-member-removed: - title: organization member_removed event - type: object - properties: - action: - type: string - enum: - - member_removed - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - membership: - title: Membership - description: The membership between the user and the organization. Not present - when the action is `member_invited`. - type: object - properties: - organization_url: - type: string - format: uri - role: - type: string - state: - type: string - url: - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - state - - role - - organization_url - - user - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - membership - - organization - - sender - webhook-organization-renamed: - title: organization renamed event - type: object - properties: - action: - type: string - enum: - - renamed - changes: - type: object - properties: - login: - type: object - properties: - from: - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - membership: - title: Membership - description: The membership between the user and the organization. Not present - when the action is `member_invited`. - type: object - properties: - organization_url: - type: string - format: uri - role: - type: string - state: - type: string - url: - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - state - - role - - organization_url - - user - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - organization - - sender - webhook-rubygems-metadata: - title: Ruby Gems metadata - type: object - properties: - name: - type: string - description: - type: string - readme: - type: string - homepage: - type: string - version_info: - type: object - properties: - version: - type: string - platform: - type: string - metadata: - type: object - additionalProperties: - type: string - repo: - type: string - dependencies: - type: array - items: - type: object - additionalProperties: - type: string - commit_oid: - type: string - webhook-package-published: - title: package published event - type: object - properties: - action: - type: string - enum: - - published - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - package: - description: Information about the package. - type: object - properties: - created_at: - type: - - string - - 'null' - description: - type: - - string - - 'null' - ecosystem: - type: string - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - namespace: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - package_type: - type: string - package_version: - type: - - object - - 'null' - properties: - author: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - body: - oneOf: - - type: string - - type: object - body_html: - type: string - container_metadata: - type: - - object - - 'null' - properties: - labels: - type: - - object - - 'null' - manifest: - type: - - object - - 'null' - tag: - type: object - properties: - digest: - type: string - name: - type: string - created_at: - type: string - description: - type: string - docker_metadata: - type: array - items: - type: object - properties: - tags: - type: array - items: - type: string - draft: - type: boolean - html_url: - type: string - format: uri - id: - type: integer - installation_command: - type: string - manifest: - type: string - metadata: - type: array - items: - type: object - additionalProperties: true - name: - type: string - npm_metadata: - type: - - object - - 'null' - properties: - name: - type: string - version: - type: string - npm_user: - type: string - author: - type: - - object - - 'null' - bugs: - type: - - object - - 'null' - dependencies: - type: object - dev_dependencies: - type: object - peer_dependencies: - type: object - optional_dependencies: - type: object - description: - type: string - dist: - type: - - object - - 'null' - git_head: - type: string - homepage: - type: string - license: - type: string - main: - type: string - repository: - type: - - object - - 'null' - scripts: - type: object - id: - type: string - node_version: - type: string - npm_version: - type: string - has_shrinkwrap: - type: boolean - maintainers: - type: array - items: - type: object - contributors: - type: array - items: - type: object - engines: - type: object - keywords: - type: array - items: - type: string - files: - type: array - items: - type: string - bin: - type: object - man: - type: object - directories: - type: - - object - - 'null' - os: - type: array - items: - type: string - cpu: - type: array - items: - type: string - readme: - type: string - installation_command: - type: string - release_id: - type: integer - commit_oid: - type: string - published_via_actions: - type: boolean - deleted_by_id: - type: integer - nuget_metadata: - type: - - array - - 'null' - items: - type: object - properties: - id: - oneOf: - - type: integer - - type: string - name: - type: string - value: - oneOf: - - type: boolean - - type: string - - type: integer - - type: object - properties: - url: - type: string - branch: - type: string - commit: - type: string - type: - type: string - package_files: - type: array - items: - type: object - properties: - content_type: - type: string - created_at: - type: string - download_url: - type: string - format: uri - id: - type: integer - md5: - type: - - string - - 'null' - name: - type: string - sha1: - type: - - string - - 'null' - sha256: - type: - - string - - 'null' - size: - type: integer - state: - type: - - string - - 'null' - updated_at: - type: string - required: - - download_url - - id - - name - - sha256 - - sha1 - - md5 - - content_type - - state - - size - - created_at - - updated_at - package_url: + package_files: + type: array + items: + type: object + properties: + content_type: + type: string + created_at: + type: string + download_url: + type: string + format: uri + id: + type: integer + md5: + type: + - string + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + sha256: + type: string + size: + type: integer + state: + type: string + updated_at: + type: string + required: + - download_url + - id + - name + - sha256 + - sha1 + - md5 + - content_type + - state + - size + - created_at + - updated_at + package_url: type: string prerelease: type: boolean @@ -129856,9 +127106,7 @@ components: id: type: integer name: - type: - - string - - 'null' + type: string prerelease: type: boolean published_at: @@ -129888,6 +127136,7 @@ components: "$ref": "#/components/schemas/webhook-rubygems-metadata" source_url: type: string + format: uri summary: type: string tag_name: @@ -129906,9 +127155,16 @@ components: - summary - name - description + - body + - body_html - html_url + - target_commitish + - target_oid + - created_at + - updated_at - metadata - package_files + - author - installation_command registry: type: @@ -129934,9 +127190,7 @@ components: - url - vendor updated_at: - type: - - string - - 'null' + type: string required: - id - name @@ -129957,43 +127211,35 @@ components: required: - action - package + - repository - sender - webhook-package-updated: - title: package updated event + webhook-page-build: + title: page_build event type: object properties: - action: - type: string - enum: - - updated - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - package: - description: Information about the package. + build: + description: The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) + itself. type: object properties: - created_at: - type: string - description: + commit: type: - string - 'null' - ecosystem: - type: string - html_url: + created_at: type: string - format: uri - id: + duration: type: integer - name: - type: string - namespace: - type: string - owner: + error: + type: object + properties: + message: + type: + - string + - 'null' + required: + - message + pusher: title: User type: - object @@ -130062,587 +127308,146 @@ components: required: - login - id - package_type: + status: type: string - package_version: - type: object - properties: - author: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - body: - type: string - body_html: - type: string - created_at: - type: string - description: - type: string - docker_metadata: - type: array - items: - type: object - properties: - tags: - type: array - items: - type: string - draft: - type: boolean - html_url: - type: string - format: uri - id: - type: integer - installation_command: - type: string - manifest: - type: string - metadata: - type: array - items: - type: object - additionalProperties: true - name: - type: string - package_files: - type: array - items: - type: object - properties: - content_type: - type: string - created_at: - type: string - download_url: - type: string - format: uri - id: - type: integer - md5: - type: - - string - - 'null' - name: - type: string - sha1: - type: - - string - - 'null' - sha256: - type: string - size: - type: integer - state: - type: string - updated_at: - type: string - required: - - download_url - - id - - name - - sha256 - - sha1 - - md5 - - content_type - - state - - size - - created_at - - updated_at - package_url: - type: string - prerelease: - type: boolean - release: - type: object - properties: - author: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - created_at: - type: string - draft: - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - prerelease: - type: boolean - published_at: - type: string - tag_name: - type: string - target_commitish: - type: string - url: - type: string - format: uri - required: - - url - - html_url - - id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - rubygems_metadata: - type: array - items: - "$ref": "#/components/schemas/webhook-rubygems-metadata" - source_url: - type: string - format: uri - summary: - type: string - tag_name: - type: string - target_commitish: - type: string - target_oid: - type: string - updated_at: - type: string - version: - type: string - required: - - id - - version - - summary - - name - - description - - body - - body_html - - html_url - - target_commitish - - target_oid - - created_at - - updated_at - - metadata - - package_files - - author - - installation_command - registry: - type: - - object - - 'null' - properties: - about_url: - type: string - format: uri - name: - type: string - type: - type: string - url: - type: string - format: uri - vendor: - type: string - required: - - about_url - - name - - type - - url - - vendor - updated_at: - type: string - required: - - id - - name - - namespace - - description - - ecosystem - - package_type - - html_url - - created_at - - updated_at - - owner - - package_version - - registry - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - package - - repository - - sender - webhook-page-build: - title: page_build event - type: object - properties: - build: - description: The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) - itself. - type: object - properties: - commit: - type: - - string - - 'null' - created_at: - type: string - duration: - type: integer - error: - type: object - properties: - message: - type: - - string - - 'null' - required: - - message - pusher: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - status: - type: string - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - status - - error - - pusher - - commit - - duration - - created_at - - updated_at - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - id: - type: integer - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - id - - build - - repository - - sender - webhook-personal-access-token-request-approved: - title: personal_access_token_request approved event - type: object - properties: - action: - type: string - enum: - - approved - personal_access_token_request: - "$ref": "#/components/schemas/personal-access-token-request" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - required: - - action - - personal_access_token_request - - organization - - sender - - installation - webhook-personal-access-token-request-cancelled: - title: personal_access_token_request cancelled event - type: object - properties: - action: - type: string - enum: - - cancelled - personal_access_token_request: - "$ref": "#/components/schemas/personal-access-token-request" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - required: - - action - - personal_access_token_request - - organization - - sender - - installation - webhook-personal-access-token-request-created: - title: personal_access_token_request created event - type: object - properties: - action: - type: string - enum: - - created - personal_access_token_request: - "$ref": "#/components/schemas/personal-access-token-request" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - required: - - action - - personal_access_token_request - - organization - - sender - - installation - webhook-personal-access-token-request-denied: - title: personal_access_token_request denied event - type: object - properties: - action: - type: string - enum: - - denied - personal_access_token_request: - "$ref": "#/components/schemas/personal-access-token-request" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - required: - - action - - personal_access_token_request - - organization - - sender - - installation - webhook-ping: - type: object - properties: - hook: - title: Webhook - description: The webhook that is being pinged - type: object - properties: - active: - description: Determines whether the hook is actually triggered for the - events it subscribes to. - type: boolean - app_id: - description: Only included for GitHub Apps. When you register a new - GitHub App, GitHub sends a ping event to the webhook URL you specified - during registration. The GitHub App ID sent in this field is required - for authenticating an app. - type: integer - config: + updated_at: + type: string + url: + type: string + format: uri + required: + - url + - status + - error + - pusher + - commit + - duration + - created_at + - updated_at + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + id: + type: integer + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - id + - build + - repository + - sender + webhook-personal-access-token-request-approved: + title: personal_access_token_request approved event + type: object + properties: + action: + type: string + enum: + - approved + personal_access_token_request: + "$ref": "#/components/schemas/personal-access-token-request" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + required: + - action + - personal_access_token_request + - organization + - sender + - installation + webhook-personal-access-token-request-cancelled: + title: personal_access_token_request cancelled event + type: object + properties: + action: + type: string + enum: + - cancelled + personal_access_token_request: + "$ref": "#/components/schemas/personal-access-token-request" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + required: + - action + - personal_access_token_request + - organization + - sender + - installation + webhook-personal-access-token-request-created: + title: personal_access_token_request created event + type: object + properties: + action: + type: string + enum: + - created + personal_access_token_request: + "$ref": "#/components/schemas/personal-access-token-request" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + required: + - action + - personal_access_token_request + - organization + - sender + - installation + webhook-personal-access-token-request-denied: + title: personal_access_token_request denied event + type: object + properties: + action: + type: string + enum: + - denied + personal_access_token_request: + "$ref": "#/components/schemas/personal-access-token-request" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + required: + - action + - personal_access_token_request + - organization + - sender + - installation + webhook-ping: + type: object + properties: + hook: + title: Webhook + description: The webhook that is being pinged + type: object + properties: + active: + description: Determines whether the hook is actually triggered for the + events it subscribes to. + type: boolean + app_id: + description: Only included for GitHub Apps. When you register a new + GitHub App, GitHub sends a ping event to the webhook URL you specified + during registration. The GitHub App ID sent in this field is required + for authenticating an app. + type: integer + config: type: object properties: content_type: @@ -130747,126 +127552,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project_card: - title: Project Card - type: object - properties: - after_id: - type: - - integer - - 'null' - archived: - description: Whether or not the card is archived - type: boolean - column_id: - type: integer - column_url: - type: string - format: uri - content_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - id: - description: The project card's ID - type: integer - node_id: - type: string - note: - type: - - string - - 'null' - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - column_url - - column_id - - id - - node_id - - note - - archived - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project_card" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -130891,126 +127577,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project_card: - title: Project Card - type: object - properties: - after_id: - type: - - integer - - 'null' - archived: - description: Whether or not the card is archived - type: boolean - column_id: - type: integer - column_url: - type: string - format: uri - content_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - id: - description: The project card's ID - type: integer - node_id: - type: string - note: - type: - - string - - 'null' - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - column_url - - column_id - - id - - node_id - - note - - archived - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project_card" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -131196,126 +127763,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project_card: - title: Project Card - type: object - properties: - after_id: - type: - - integer - - 'null' - archived: - description: Whether or not the card is archived - type: boolean - column_id: - type: integer - column_url: - type: string - format: uri - content_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - id: - description: The project card's ID - type: integer - node_id: - type: string - note: - type: - - string - - 'null' - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - column_url - - column_id - - id - - node_id - - note - - archived - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project_card" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -131568,277 +128016,78 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project: - title: Project + "$ref": "#/components/schemas/webhooks_project" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - project + - sender + webhook-project-column-created: + title: project_column created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + project_column: + "$ref": "#/components/schemas/webhooks_project_column" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - project_column + webhook-project-column-deleted: + title: project_column deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + project_column: + "$ref": "#/components/schemas/webhooks_project_column" + repository: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - project_column + webhook-project-column-edited: + title: project_column edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: type: object properties: - body: - description: Body of the project - type: - - string - - 'null' - columns_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' + name: + type: object properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - html_url: - type: string - format: uri - id: - type: integer - name: - description: Name of the project - type: string - node_id: - type: string - number: - type: integer - owner_url: - type: string - format: uri - state: - description: State of the project; either 'open' or 'closed' - type: string - enum: - - open - - closed - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - project - - sender - webhook-project-column-created: - title: project_column created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - project_column: - title: Project Column - type: object - properties: - after_id: - type: - - integer - - 'null' - cards_url: - type: string - format: uri - created_at: - type: string - format: date-time - id: - description: The unique identifier of the project column - type: integer - name: - description: Name of the project column - type: string - node_id: - type: string - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - cards_url - - id - - node_id - - name - - created_at - - updated_at - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - project_column - webhook-project-column-deleted: - title: project_column deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - project_column: - title: Project Column - type: object - properties: - after_id: - type: - - integer - - 'null' - cards_url: - type: string - format: uri - created_at: - type: string - format: date-time - id: - description: The unique identifier of the project column - type: integer - name: - description: Name of the project column - type: string - node_id: - type: string - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - cards_url - - id - - node_id - - name - - created_at - - updated_at - repository: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - project_column - webhook-project-column-edited: - title: project_column edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - name: - type: object - properties: - from: + from: type: string required: - from @@ -131849,45 +128098,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project_column: - title: Project Column - type: object - properties: - after_id: - type: - - integer - - 'null' - cards_url: - type: string - format: uri - created_at: - type: string - format: date-time - id: - description: The unique identifier of the project column - type: integer - name: - description: Name of the project column - type: string - node_id: - type: string - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - cards_url - - id - - node_id - - name - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project_column" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -131911,45 +128122,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project_column: - title: Project Column - type: object - properties: - after_id: - type: - - integer - - 'null' - cards_url: - type: string - format: uri - created_at: - type: string - format: date-time - id: - description: The unique identifier of the project column - type: integer - name: - description: Name of the project column - type: string - node_id: - type: string - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - cards_url - - id - - node_id - - name - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project_column" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -131973,130 +128146,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project: - title: Project - type: object - properties: - body: - description: Body of the project - type: - - string - - 'null' - columns_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - html_url: - type: string - format: uri - id: - type: integer - name: - description: Name of the project - type: string - node_id: - type: string - number: - type: integer - owner_url: - type: string - format: uri - state: - description: State of the project; either 'open' or 'closed' - type: string - enum: - - open - - closed - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -132120,130 +128170,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project: - title: Project - type: object - properties: - body: - description: Body of the project - type: - - string - - 'null' - columns_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - html_url: - type: string - format: uri - id: - type: integer - name: - description: Name of the project - type: string - node_id: - type: string - number: - type: integer - owner_url: - type: string - format: uri - state: - description: State of the project; either 'open' or 'closed' - type: string - enum: - - open - - closed - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project" repository: anyOf: - type: 'null' @@ -132289,130 +128216,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project: - title: Project - type: object - properties: - body: - description: Body of the project - type: - - string - - 'null' - columns_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - html_url: - type: string - format: uri - id: - type: integer - name: - description: Name of the project - type: string - node_id: - type: string - number: - type: integer - owner_url: - type: string - format: uri - state: - description: State of the project; either 'open' or 'closed' - type: string - enum: - - open - - closed - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -132435,130 +128239,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project: - title: Project - type: object - properties: - body: - description: Body of the project - type: - - string - - 'null' - columns_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - html_url: - type: string - format: uri - id: - type: integer - name: - description: Name of the project - type: string - node_id: - type: string - number: - type: integer - owner_url: - type: string - format: uri - state: - description: State of the project; either 'open' or 'closed' - type: string - enum: - - open - - closed - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -132700,21 +128381,7 @@ components: enum: - archived changes: - type: object - properties: - archived_at: - type: object - properties: - from: - type: - - string - - 'null' - format: date-time - to: - type: - - string - - 'null' - format: date-time + "$ref": "#/components/schemas/webhooks_project_changes" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -132899,21 +128566,7 @@ components: enum: - restored changes: - type: object - properties: - archived_at: - type: object - properties: - from: - type: - - string - - 'null' - format: date-time - to: - type: - - string - - 'null' - format: date-time + "$ref": "#/components/schemas/webhooks_project_changes" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -132975,81 +128628,13 @@ components: enum: - assigned assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id + "$ref": "#/components/schemas/webhooks_user" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: - description: The pull request number. - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: @@ -140038,73 +135623,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" number: - description: The pull request number. - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - allOf: - - "$ref": "#/components/schemas/pull-request" - - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_update_branch: - description: Whether to allow updating the pull request's branch. - type: boolean - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged. - type: boolean - default: false - merge_commit_message: - description: |- - The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull request - title as default. **This property has been deprecated. Please use - `squash_merge_commit_title` instead.** - type: boolean - default: false + "$ref": "#/components/schemas/pull-request-webhook" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -140128,73 +135651,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" number: - description: The pull request number. - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - allOf: - - "$ref": "#/components/schemas/pull-request" - - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_update_branch: - description: Whether to allow updating the pull request's branch. - type: boolean - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged. - type: boolean - default: false - merge_commit_message: - description: |- - The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull request - title as default. **This property has been deprecated. Please use - `squash_merge_commit_title` instead.** - type: boolean - default: false + "$ref": "#/components/schemas/pull-request-webhook" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -140218,7 +135679,33 @@ components: milestone: "$ref": "#/components/schemas/milestone" number: - description: The pull request number. + "$ref": "#/components/schemas/webhooks_number" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + "$ref": "#/components/schemas/webhooks_pull_request_5" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - number + - pull_request + - repository + webhook-pull-request-dequeued: + title: pull_request dequeued event + type: object + properties: + action: + type: string + enum: + - dequeued + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: type: integer organization: "$ref": "#/components/schemas/organization-simple-webhooks" @@ -140385,7 +135872,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -140457,7 +135943,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -141006,7 +136491,8 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. type: boolean default: false visibility: @@ -141639,7 +137125,8 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. type: boolean default: false visibility: @@ -141939,7 +137426,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -142513,6 +137999,8 @@ components: - auto_merge - active_lock_reason - draft + reason: + type: string repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -142522,14 +138010,86 @@ components: - number - pull_request - repository - webhook-pull-request-dequeued: - title: pull_request dequeued event + - sender + - reason + webhook-pull-request-edited: + title: pull_request edited event type: object properties: action: type: string enum: - - dequeued + - edited + changes: + description: The changes to the comment if the action was `edited`. + type: object + properties: + base: + type: object + properties: + ref: + type: object + properties: + from: + type: string + required: + - from + sha: + type: object + properties: + from: + type: string + required: + - from + required: + - ref + - sha + body: + type: object + properties: + from: + description: The previous version of the body if the action was + `edited`. + type: string + required: + - from + title: + type: object + properties: + from: + description: The previous version of the title if the action was + `edited`. + type: string + required: + - from + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: + "$ref": "#/components/schemas/webhooks_number" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + "$ref": "#/components/schemas/pull-request-webhook" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - number + - pull_request + - repository + webhook-pull-request-enqueued: + title: pull_request enqueued event + type: object + properties: + action: + type: string + enum: + - enqueued enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -143401,8 +138961,8 @@ components: - has_projects - has_downloads - has_wiki - - has_pages - has_discussions + - has_pages - forks_count - mirror_url - archived @@ -144828,8 +140388,6 @@ components: - auto_merge - active_lock_reason - draft - reason: - type: string repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -144840,153 +140398,22 @@ components: - pull_request - repository - sender - - reason - webhook-pull-request-edited: - title: pull_request edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: The changes to the comment if the action was `edited`. - type: object - properties: - base: - type: object - properties: - ref: - type: object - properties: - from: - type: string - required: - - from - sha: - type: object - properties: - from: - type: string - required: - - from - required: - - ref - - sha - body: - type: object - properties: - from: - description: The previous version of the body if the action was - `edited`. - type: string - required: - - from - title: - type: object - properties: - from: - description: The previous version of the title if the action was - `edited`. - type: string - required: - - from - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - allOf: - - "$ref": "#/components/schemas/pull-request" - - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_update_branch: - description: Whether to allow updating the pull request's branch. - type: boolean - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged. - type: boolean - default: false - merge_commit_message: - description: |- - The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull request - title as default. **This property has been deprecated. Please use - `squash_merge_commit_title` instead. - type: boolean - default: false - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - changes - - number - - pull_request - - repository - webhook-pull-request-enqueued: - title: pull_request enqueued event + webhook-pull-request-labeled: + title: pull_request labeled event type: object properties: action: type: string enum: - - enqueued + - labeled enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + label: + "$ref": "#/components/schemas/webhooks_label" number: - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: @@ -145152,6 +140579,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -145223,6 +140651,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -145852,8 +141281,8 @@ components: - has_projects - has_downloads - has_wiki - - has_discussions - has_pages + - has_discussions - forks_count - mirror_url - archived @@ -145978,13 +141407,17 @@ components: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -146706,6 +142139,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -146934,6 +142368,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -147042,6 +142477,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -147289,54 +142733,20 @@ components: - pull_request - repository - sender - webhook-pull-request-labeled: - title: pull_request labeled event + webhook-pull-request-locked: + title: pull_request locked event type: object properties: action: type: string enum: - - labeled + - locked enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" - label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description number: - description: The pull request number. - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: @@ -147502,7 +142912,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -149149,7 +144558,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -149656,48 +145064,134 @@ components: - pull_request - repository - sender - webhook-pull-request-locked: - title: pull_request locked event + webhook-pull-request-milestoned: + title: pull_request milestoned event type: object properties: action: type: string enum: - - locked + - milestoned + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + milestone: + "$ref": "#/components/schemas/milestone" + number: + "$ref": "#/components/schemas/webhooks_number" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + "$ref": "#/components/schemas/webhooks_pull_request_5" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - number + - pull_request + - repository + webhook-pull-request-opened: + title: pull_request opened event + type: object + properties: + action: + type: string + enum: + - opened enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: - description: The pull request number. - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - title: Pull Request + "$ref": "#/components/schemas/pull-request-webhook" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - number + - pull_request + - repository + - sender + webhook-pull-request-ready-for-review: + title: pull_request ready_for_review event + type: object + properties: + action: + type: string + enum: + - ready_for_review + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: + "$ref": "#/components/schemas/webhooks_number" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + "$ref": "#/components/schemas/pull-request-webhook" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - number + - pull_request + - repository + - sender + webhook-pull-request-reopened: + title: pull_request reopened event + type: object + properties: + action: + type: string + enum: + - reopened + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: + "$ref": "#/components/schemas/webhooks_number" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + "$ref": "#/components/schemas/pull-request-webhook" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - number + - pull_request + - repository + - sender + webhook-pull-request-review-comment-created: + title: pull_request_review_comment created event + type: object + properties: + action: + type: string + enum: + - created + comment: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. type: object properties: _links: type: object properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href html: title: Link type: object @@ -149707,25 +145201,7 @@ components: format: uri-template required: - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: + pull_request: title: Link type: object properties: @@ -149743,37 +145219,165 @@ components: format: uri-template required: - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href required: - self - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment applies. The + last line of the range for a multi-line comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the comment applies. + type: string + original_line: + description: The line of the blob to which the comment applies. The + last line of the range for a multi-line comment + type: + - integer + - 'null' + original_position: + description: The index of the original line in the diff to which the + comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the comment applies. + type: string + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review comment belongs + to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for a multi-line + comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. type: - string - 'null' enum: - - resolved - - off-topic - - too heated - - spam + - LEFT + - RIGHT - - additions: - type: integer - assignee: + default: RIGHT + subject_type: + description: The level at which the comment is targeted, can be a diff + line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: title: User type: - object @@ -149842,6 +145446,205 @@ components: required: - login - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id assignees: type: array items: @@ -150631,41 +146434,28 @@ components: type: - string - 'null' - changed_files: - type: integer closed_at: type: - string - 'null' - format: date-time - comments: - type: integer comments_url: type: string format: uri - commits: - type: integer commits_url: type: string format: uri created_at: type: string - format: date-time - deletions: - type: integer diff_url: type: string format: uri draft: - description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: @@ -151176,7 +146966,6 @@ components: - has_downloads - has_wiki - has_pages - - has_discussions - forks_count - mirror_url - archived @@ -151310,98 +147099,14 @@ components: - description locked: type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull request. - type: boolean merge_commit_sha: type: - string - 'null' - mergeable: - type: - - boolean - - 'null' - mergeable_state: - type: string - merged: - type: - - boolean - - 'null' merged_at: type: - string - 'null' - format: date-time - merged_by: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -151482,6 +147187,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -151547,16 +147253,10 @@ components: node_id: type: string number: - description: Number uniquely identifying the pull request within its - repository. type: integer patch_url: type: string format: uri - rebaseable: - type: - - boolean - - 'null' requested_reviewers: type: array items: @@ -151848,13 +147548,10 @@ components: review_comment_url: type: string format: uri-template - review_comments: - type: integer review_comments_url: type: string format: uri state: - description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -151863,11 +147560,9 @@ components: type: string format: uri title: - description: The title of the pull request. type: string updated_at: type: string - format: date-time url: type: string format: uri @@ -151975,38 +147670,34 @@ components: - base - _links - author_association - - auto_merge - active_lock_reason - - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - number + - comment - pull_request - repository - sender - webhook-pull-request-milestoned: - title: pull_request milestoned event + webhook-pull-request-review-comment-deleted: + title: pull_request_review_comment deleted event type: object properties: action: type: string enum: - - milestoned + - deleted + comment: + "$ref": "#/components/schemas/webhooks_review_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" - milestone: - "$ref": "#/components/schemas/milestone" - number: - description: The pull request number. - type: integer + installation: + "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - title: Pull Request type: object properties: _links: @@ -152103,8 +147794,6 @@ components: - too heated - spam - - additions: - type: integer assignee: title: User type: @@ -152168,7 +147857,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -152240,7 +147928,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -152789,7 +148476,8 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. type: boolean default: false visibility: @@ -152963,33 +148651,22 @@ components: type: - string - 'null' - changed_files: - type: integer closed_at: type: - string - 'null' - format: date-time - comments: - type: integer comments_url: type: string format: uri - commits: - type: integer commits_url: type: string format: uri created_at: type: string - format: date-time - deletions: - type: integer diff_url: type: string format: uri draft: - description: Indicates whether or not the pull request is a draft. type: boolean head: type: object @@ -153001,7 +148678,9 @@ components: repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -153422,7 +149101,8 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. type: boolean default: false visibility: @@ -153637,259 +149317,168 @@ components: - description locked: type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull request. - type: boolean merge_commit_sha: type: - string - 'null' - mergeable: - type: - - boolean - - 'null' - mergeable_state: - type: string - merged: - type: - - boolean - - 'null' merged_at: type: - string - 'null' - format: date-time - merged_by: - title: User + milestone: + title: Milestone + description: A collection of related issues and pull requests. type: - object - 'null' properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + closed_at: type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: + format: date-time + closed_issues: + type: integer + created_at: type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time html_url: type: string format: uri id: type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: + labels_url: type: string format: uri - repos_url: + node_id: type: string - format: uri - site_admin: - type: boolean - starred_url: + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. type: string - format: uri-template - subscriptions_url: + enum: + - open + - closed + title: + description: The title of the milestone. type: string - format: uri - type: + updated_at: type: string - enum: - - Bot - - User - - Organization - - Mannequin + format: date-time url: type: string format: uri required: - - login + - url + - html_url + - labels_url - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within its - repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: - - boolean - - 'null' - requested_reviewers: - type: array - items: - oneOf: - - title: User + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User type: - object - 'null' @@ -154166,13 +149755,10 @@ components: review_comment_url: type: string format: uri-template - review_comments: - type: integer review_comments_url: type: string format: uri state: - description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -154181,11 +149767,9 @@ components: type: string format: uri title: - description: The title of the pull request. type: string updated_at: type: string - format: date-time url: type: string format: uri @@ -154293,585 +149877,29 @@ components: - base - _links - author_association - - auto_merge - active_lock_reason - - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - number - - pull_request - - repository - webhook-pull-request-opened: - title: pull_request opened event - type: object - properties: - action: - type: string - enum: - - opened - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - allOf: - - "$ref": "#/components/schemas/pull-request" - - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_update_branch: - description: Whether to allow updating the pull request's branch. - type: boolean - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged. - type: boolean - default: false - merge_commit_message: - description: |- - The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull request - title as default. **This property has been deprecated. Please use - `squash_merge_commit_title` instead.** - type: boolean - default: false - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - number - - pull_request - - repository - - sender - webhook-pull-request-ready-for-review: - title: pull_request ready_for_review event - type: object - properties: - action: - type: string - enum: - - ready_for_review - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - allOf: - - "$ref": "#/components/schemas/pull-request" - - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_update_branch: - description: Whether to allow updating the pull request's branch. - type: boolean - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged. - type: boolean - default: false - merge_commit_message: - description: |- - The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull request - title as default. **This property has been deprecated. Please use - `squash_merge_commit_title` instead.** - type: boolean - default: false - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - number - - pull_request - - repository - - sender - webhook-pull-request-reopened: - title: pull_request reopened event - type: object - properties: - action: - type: string - enum: - - reopened - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - allOf: - - "$ref": "#/components/schemas/pull-request" - - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_update_branch: - description: Whether to allow updating the pull request's branch. - type: boolean - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged. - type: boolean - default: false - merge_commit_message: - description: |- - The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull request - title as default. **This property has been deprecated. Please use - `squash_merge_commit_title` instead.** - type: boolean - default: false - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - number + - comment - pull_request - repository - sender - webhook-pull-request-review-comment-created: - title: pull_request_review_comment created event + webhook-pull-request-review-comment-edited: + title: pull_request_review_comment edited event type: object properties: action: type: string enum: - - created + - edited + changes: + "$ref": "#/components/schemas/webhooks_changes" comment: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment applies. - type: string - original_line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment - type: - - integer - - 'null' - original_position: - description: The index of the original line in the diff to which the - comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the comment applies. - type: string - position: - description: The line index in the diff to which the comment applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review comment belongs - to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be a diff - line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions + "$ref": "#/components/schemas/webhooks_review_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -155038,7 +150066,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -155110,7 +150137,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -156366,6 +151392,7 @@ components: - has_downloads - has_wiki - has_pages + - has_discussions - forks_count - mirror_url - archived @@ -156723,7 +151750,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -156832,15 +151858,6 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -157077,305 +152094,19 @@ components: "$ref": "#/components/schemas/simple-user-webhooks" required: - action + - changes - comment - pull_request - repository - sender - webhook-pull-request-review-comment-deleted: - title: pull_request_review_comment deleted event + webhook-pull-request-review-dismissed: + title: pull_request_review dismissed event type: object properties: action: type: string enum: - - deleted - comment: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment applies. - type: string - original_line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment - type: integer - original_position: - description: The index of the original line in the diff to which the - comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the comment applies. - type: string - position: - description: The line index in the diff to which the comment applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review comment belongs - to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be a diff - line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions + - dismissed enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -157383,6 +152114,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: + title: Simple Pull Request type: object properties: _links: @@ -157542,6 +152274,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -157613,6 +152346,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -159225,6 +153959,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -159333,6 +154068,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -159553,6 +154297,7 @@ components: - requested_teams - labels - milestone + - draft - commits_url - review_comments_url - review_comment_url @@ -159562,41 +154307,12 @@ components: - base - _links - author_association + - auto_merge - active_lock_reason repository: "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - comment - - pull_request - - repository - - sender - webhook-pull-request-review-comment-edited: - title: pull_request_review_comment edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: The changes to the comment. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from - comment: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. + review: + description: The review that was affected. type: object properties: _links: @@ -159620,17 +154336,7 @@ components: format: uri-template required: - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href required: - - self - html - pull_request author_association: @@ -159647,144 +154353,33 @@ components: - NONE - OWNER body: - description: The text of the comment. - type: string + description: The text of the review. + type: + - string + - 'null' commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. + description: A commit SHA for the review. type: string html_url: - description: HTML URL for the pull request review comment. type: string format: uri id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. + description: Unique identifier of the review type: integer - line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment - type: - - integer - - 'null' node_id: - description: The node ID of the pull request review comment. type: string - original_commit_id: - description: The SHA of the original commit to which the comment applies. - type: string - original_line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment - type: integer - original_position: - description: The index of the original line in the diff to which the - comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the comment applies. - type: string - position: - description: The line index in the diff to which the comment applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: - - integer - - 'null' pull_request_url: - description: URL for the pull request that the review comment belongs - to. type: string format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be a diff - line or a file. + state: type: string enum: - - line - - file - updated_at: + - dismissed + - approved + - changes_requested + submitted_at: type: string format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri user: title: User type: @@ -159848,6 +154443,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -159855,31 +154451,45 @@ components: - login - id required: - - url - - pull_request_review_id - id - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - user - body - - created_at - - updated_at + - commit_id + - submitted_at + - state - html_url - pull_request_url - author_association - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - review + - pull_request + - repository + - sender + webhook-pull-request-review-edited: + title: pull_request_review edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + type: object + properties: + body: + type: object + properties: + from: + description: The previous version of the body if the action was + `edited`. + type: string + required: + - from enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -159887,6 +154497,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: + title: Simple Pull Request type: object properties: _links: @@ -160046,6 +154657,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -160117,6 +154729,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -160374,10 +154987,6 @@ components: description: Whether the wiki is enabled. type: boolean default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false homepage: type: - string @@ -160442,28 +155051,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -160601,28 +155188,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -160663,12 +155228,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -160679,10 +155238,6 @@ components: type: integer watchers_count: type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean required: - id - node_id @@ -160747,7 +155302,6 @@ components: - has_downloads - has_wiki - has_pages - - has_discussions - forks_count - mirror_url - archived @@ -160999,10 +155553,6 @@ components: description: Whether the wiki is enabled. type: boolean default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false homepage: type: - string @@ -161067,28 +155617,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -161226,28 +155754,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -161288,12 +155794,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -161304,10 +155804,6 @@ components: type: integer watchers_count: type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean required: - id - node_id @@ -161372,7 +155868,6 @@ components: - has_downloads - has_wiki - has_pages - - has_discussions - forks_count - mirror_url - archived @@ -161730,6 +156225,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -161838,6 +156334,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -162058,6 +156563,7 @@ components: - requested_teams - labels - milestone + - draft - commits_url - review_comments_url - review_comment_url @@ -162067,203 +156573,140 @@ components: - base - _links - author_association + - auto_merge - active_lock_reason repository: "$ref": "#/components/schemas/repository-webhooks" + review: + "$ref": "#/components/schemas/webhooks_review" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - changes - - comment + - review - pull_request - repository - sender - webhook-pull-request-review-dismissed: - title: pull_request_review dismissed event - type: object - properties: - action: - type: string - enum: - - dismissed - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Simple Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + webhook-pull-request-review-request-removed: + title: pull_request review_request_removed event + oneOf: + - type: object + properties: + action: + type: string + enum: + - review_request_removed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: + description: The pull request number. + type: integer + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: title: User type: - object @@ -162326,44 +156769,15 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - login - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: - - object - - 'null' - properties: - commit_message: - description: Commit message for the merge commit. - type: - - string - - 'null' - commit_title: - description: Title for the merge commit message. - type: - - string - - 'null' - enabled_by: + assignees: + type: array + items: title: User type: - object @@ -162432,1316 +156846,2331 @@ components: required: - login - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: The default value for a squash merge commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: The default value for a squash merge commit title. + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: + url: type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: + - string + - 'null' + changed_files: + type: integer + closed_at: + type: + - string + - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + commits: + type: integer + commits_url: + type: string + format: uri + created_at: + type: string + format: date-time + deletions: + type: integer + diff_url: + type: string + format: uri + draft: + description: Indicates whether or not the pull request is a draft. + type: boolean + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object properties: - avatar_url: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - format: uri - deleted: + default: type: boolean - email: + description: type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri id: type: integer - login: - type: string name: + description: The name of the label. type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization url: + description: URL for the label type: string format: uri required: - - login - id - required: - - label - - ref - - sha - - user - - repo - body: - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: - - object - - 'null' - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + merge_commit_sha: + type: + - string + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within its + repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: + - boolean + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: type: boolean - default: false - homepage: + description: + description: Description of the team type: - string - 'null' - hooks_url: - type: string - format: uri html_url: type: string format: uri id: - description: Unique identifier of the repository + description: Unique identifier of the team type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: + members_url: type: string format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri name: - description: The name of the repository. + description: Name of the team type: string node_id: type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User + parent: type: - object - 'null' properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + description: + description: Description of the team type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string html_url: type: string format: uri id: + description: Unique identifier of the team type: integer - login: + members_url: type: string + format: uri-template name: + description: Name of the team type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: + permission: + description: Permission that the team will have for its + repositories type: string - format: uri - site_admin: - type: boolean - starred_url: + privacy: type: string - format: uri-template - subscriptions_url: + enum: + - open + - closed + - secret + repositories_url: type: string format: uri - type: + slug: type: string - enum: - - Bot - - User - - Organization url: + description: URL for the team type: string format: uri required: - - login + - name - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + privacy: type: string enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: + - open + - closed + - secret + repositories_url: type: string format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: + slug: type: string - format: date-time url: + description: URL for the team type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean required: + - name - id - node_id - - name - - full_name - - private - - owner - - html_url + - slug - description - - fork + - privacy - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + - html_url + - members_url + - repositories_url + - permission + review_comment_url: + type: string + format: uri-template + review_comments: + type: integer + review_comments_url: + type: string + format: uri + state: + description: State of this Pull Request. Either `open` or `closed`. + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft + repository: + "$ref": "#/components/schemas/repository-webhooks" + requested_reviewer: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - requested_reviewer + - action + - number + - pull_request + - repository + - sender + - type: object + properties: + action: + type: string + enum: + - review_request_removed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: + description: The pull request number. + type: integer + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Pull Request + type: object + properties: + _links: type: object properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: type: string - default: + format: uri + deleted: type: boolean - description: + email: type: - string - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer + login: + type: string name: - description: The name of the label. type: string node_id: type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: - description: URL for the label type: string format: uri required: + - login - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: - - string - - 'null' - merged_at: - type: - - string - - 'null' - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: + assignees: + type: array + items: title: User type: - object @@ -163810,2340 +159239,2387 @@ components: required: - login - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' properties: - deleted: - type: boolean - description: - description: Description of the team + commit_message: + description: Commit message for the merge commit. type: - string - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User type: - object - 'null' properties: - description: - description: Description of the team + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - string - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string html_url: type: string format: uri id: - description: Unique identifier of the team type: integer - members_url: + login: type: string - format: uri-template name: - description: Name of the team type: string node_id: type: string - permission: - description: Permission that the team will have for its repositories + organizations_url: type: string - privacy: + format: uri + received_events_url: type: string - enum: - - open - - closed - - secret - repositories_url: + format: uri + repos_url: type: string format: uri - slug: + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: - description: URL for the team type: string format: uri required: - - name + - login - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: + merge_method: + description: The merge method to use. type: string enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: type: string - url: - description: URL for the team + ref: type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: - "$ref": "#/components/schemas/repository-webhooks" - review: - description: The review that was affected. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the review. - type: - - string - - 'null' - commit_id: - description: A commit SHA for the review. - type: string - html_url: - type: string - format: uri - id: - description: Unique identifier of the review - type: integer - node_id: - type: string - pull_request_url: - type: string - format: uri - state: - type: string - enum: - - dismissed - - approved - - changes_requested - submitted_at: - type: string - format: date-time - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - id - - node_id - - user - - body - - commit_id - - submitted_at - - state - - html_url - - pull_request_url - - author_association - - _links - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - review - - pull_request - - repository - - sender - webhook-pull-request-review-edited: - title: pull_request_review edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body if the action was - `edited`. - type: string - required: - - from - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Simple Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User + - string + - 'null' + changed_files: + type: integer + closed_at: type: - - object + - string - 'null' + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + commits: + type: integer + commits_url: + type: string + format: uri + created_at: + type: string + format: date-time + deletions: + type: integer + diff_url: + type: string + format: uri + draft: + description: Indicates whether or not the pull request is a draft. + type: boolean + head: + type: object properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: + label: type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: + ref: type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: - - object - - 'null' - properties: - commit_message: - description: Commit message for the merge commit. - type: - - string - - 'null' - commit_title: - description: Title for the merge commit message. - type: - - string - - 'null' - enabled_by: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label type: object properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged + default: type: boolean - default: false - deployments_url: - type: string - format: uri description: type: - string - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri id: - description: Unique identifier of the repository type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri name: - description: The name of the repository. + description: The name of the label. type: string node_id: type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time url: + description: URL for the label type: string format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer required: - id - node_id + - url - name - - full_name - - private - - owner - - html_url + - color + - default - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + merge_commit_sha: + type: + - string + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + description: type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: - - object - - 'null' + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within its + repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: + - boolean + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged + deleted: type: boolean - default: false - deployments_url: - type: string - format: uri description: + description: Description of the team type: - string - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri html_url: type: string format: uri id: - description: Unique identifier of the repository + description: Unique identifier of the team type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: + members_url: type: string format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri name: - description: The name of the repository. + description: Name of the team type: string node_id: type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User + parent: type: - object - 'null' properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + description: + description: Description of the team type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string html_url: type: string format: uri id: + description: Unique identifier of the team type: integer - login: + members_url: type: string + format: uri-template name: + description: Name of the team type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: + permission: + description: Permission that the team will have for its + repositories type: string - format: uri - site_admin: - type: boolean - starred_url: + privacy: type: string - format: uri-template - subscriptions_url: + enum: + - open + - closed + - secret + repositories_url: type: string format: uri - type: + slug: type: string - enum: - - Bot - - User - - Organization url: + description: URL for the team type: string format: uri required: - - login + - name - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories type: string - format: uri - tags_url: + privacy: type: string - format: uri - teams_url: + enum: + - open + - closed + - secret + repositories_url: type: string format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: + slug: type: string - format: date-time url: + description: URL for the team type: string format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer required: + - name - id - node_id - - name - - full_name - - private - - owner - - html_url + - slug - description - - fork + - privacy - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object + - html_url + - members_url + - repositories_url + - permission + review_comment_url: + type: string + format: uri-template + review_comments: + type: integer + review_comments_url: + type: string + format: uri + state: + description: State of this Pull Request. Either `open` or `closed`. + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + avatar_url: type: string - default: + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft + repository: + "$ref": "#/components/schemas/repository-webhooks" + requested_team: + title: Team + description: Groups of organization members that gives permissions on + specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: description: + description: Description of the team type: - string - 'null' + html_url: + type: string + format: uri id: + description: Unique identifier of the team type: integer + members_url: + type: string + format: uri-template name: - description: The name of the label. + description: Name of the team type: string node_id: type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string url: - description: URL for the label + description: URL for the team type: string format: uri required: + - name - id - node_id - - url - - name - - color - - default + - slug - description - locked: - type: boolean - merge_commit_sha: - type: - - string - - 'null' - merged_at: - type: - - string - - 'null' - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + webhook-pull-request-review-requested: + title: pull_request review_requested event + oneOf: + - type: object + properties: + action: + type: string + enum: + - review_requested + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: + description: The pull request number. + type: integer + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: + title: User type: - object - 'null' @@ -166212,883 +161688,123 @@ components: required: - login - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' properties: - deleted: - type: boolean - description: - description: Description of the team + commit_message: + description: Commit message for the merge commit. type: - string - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User type: - object - 'null' properties: - description: - description: Description of the team + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - string - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string html_url: type: string format: uri id: - description: Unique identifier of the team type: integer - members_url: + login: type: string - format: uri-template name: - description: Name of the team type: string node_id: type: string - permission: - description: Permission that the team will have for its repositories + organizations_url: type: string - privacy: + format: uri + received_events_url: type: string - enum: - - open - - closed - - secret - repositories_url: + format: uri + repos_url: type: string format: uri - slug: + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string + enum: + - Bot + - User + - Organization url: - description: URL for the team type: string format: uri required: - - name + - login - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: + merge_method: + description: The merge method to use. type: string enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: - "$ref": "#/components/schemas/repository-webhooks" - review: - description: The review that was affected. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the review. - type: - - string - - 'null' - commit_id: - description: A commit SHA for the review. - type: string - html_url: - type: string - format: uri - id: - description: Unique identifier of the review - type: integer - node_id: - type: string - pull_request_url: - type: string - format: uri - state: - type: string - submitted_at: - type: - - string - - 'null' - format: date-time - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - id - - node_id - - user - - body - - commit_id - - submitted_at - - state - - html_url - - pull_request_url - - author_association - - _links - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - changes - - review - - pull_request - - repository - - sender - webhook-pull-request-review-request-removed: - title: pull_request review_request_removed event - oneOf: - - type: object - properties: - action: - type: string - enum: - - review_request_removed - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - additions: - type: integer - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: - - object - - 'null' - properties: - commit_message: - description: Commit message for the merge commit. - type: - - string - - 'null' - commit_title: - description: Title for the merge commit message. - type: - - string - - 'null' - enabled_by: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: + ref: type: string repo: title: Repository @@ -167451,14 +162167,23 @@ components: size: type: integer squash_merge_commit_message: - description: The default value for a squash merge commit message. + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_title: - description: The default value for a squash merge commit title. + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). type: string enum: - PR_TITLE @@ -168526,6 +163251,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -168889,15 +163615,6 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission review_comment_url: type: string format: uri-template @@ -168987,6 +163704,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -169095,6 +163813,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -169115,7 +163834,7 @@ components: action: type: string enum: - - review_request_removed + - review_requested enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -169288,6 +164007,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -169359,6 +164079,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -170395,10126 +165116,793 @@ components: gravatar_id: type: string html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull request. - type: boolean - merge_commit_sha: - type: - - string - - 'null' - mergeable: - type: - - boolean - - 'null' - mergeable_state: - type: string - merged: - type: - - boolean - - 'null' - merged_at: - type: - - string - - 'null' - format: date-time - merged_by: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within its - repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: - - boolean - - 'null' - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: - "$ref": "#/components/schemas/repository-webhooks" - requested_team: - title: Team - description: Groups of organization members that gives permissions on - specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - requested_team - - action - - number - - pull_request - - repository - - sender - webhook-pull-request-review-requested: - title: pull_request review_requested event - oneOf: - - type: object - properties: - action: - type: string - enum: - - review_requested - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - additions: - type: integer - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: - - object - - 'null' - properties: - commit_message: - description: Commit message for the merge commit. - type: - - string - - 'null' - commit_title: - description: Title for the merge commit message. - type: - - string - - 'null' - enabled_by: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: - - string - - 'null' - changed_files: - type: integer - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull request. - type: boolean - merge_commit_sha: - type: - - string - - 'null' - mergeable: - type: - - boolean - - 'null' - mergeable_state: - type: string - merged: - type: - - boolean - - 'null' - merged_at: - type: - - string - - 'null' - format: date-time - merged_by: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within its - repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: - - boolean - - 'null' - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: - "$ref": "#/components/schemas/repository-webhooks" - requested_reviewer: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - requested_reviewer - - action - - number - - pull_request - - repository - - sender - - type: object - properties: - action: - type: string - enum: - - review_requested - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - additions: - type: integer - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: - - object - - 'null' - properties: - commit_message: - description: Commit message for the merge commit. - type: - - string - - 'null' - commit_title: - description: Title for the merge commit message. - type: - - string - - 'null' - enabled_by: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: - - string - - 'null' - changed_files: - type: integer - closed_at: - type: - - string - - 'null' - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull request. - type: boolean - merge_commit_sha: - type: - - string - - 'null' - mergeable: - type: - - boolean - - 'null' - mergeable_state: - type: string - merged: - type: - - boolean - - 'null' - merged_at: - type: - - string - - 'null' - format: date-time - merged_by: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within its - repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: - - boolean - - 'null' - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: - "$ref": "#/components/schemas/repository-webhooks" - requested_team: - title: Team - description: Groups of organization members that gives permissions on - specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - requested_team - - action - - number - - pull_request - - repository - - sender - webhook-pull-request-review-submitted: - title: pull_request_review submitted event - type: object - properties: - action: - type: string - enum: - - submitted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Simple Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: - - object - - 'null' - properties: - commit_message: - description: Commit message for the merge commit. - type: - - string - - 'null' - commit_title: - description: Title for the merge commit message. - type: - - string - - 'null' - enabled_by: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: - - string - - 'null' - ref: - type: string - repo: - title: Repository - description: A git repository - type: - - object - - 'null' - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: - - string - - 'null' - merged_at: - type: - - string - - 'null' - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: - "$ref": "#/components/schemas/repository-webhooks" - review: - description: The review that was affected. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the review. - type: - - string - - 'null' - commit_id: - description: A commit SHA for the review. - type: string - html_url: - type: string - format: uri - id: - description: Unique identifier of the review - type: integer - node_id: - type: string - pull_request_url: - type: string - format: uri - state: - type: string - submitted_at: - type: - - string - - 'null' - format: date-time - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - id - - node_id - - user - - body - - commit_id - - submitted_at - - state - - html_url - - pull_request_url - - author_association - - _links - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - review - - pull_request - - repository - - sender - webhook-pull-request-review-thread-resolved: - title: pull_request_review_thread resolved event - type: object - properties: - action: - type: string - enum: - - resolved - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Simple Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: - - object - - 'null' - properties: - commit_message: - description: Commit message for the merge commit. - type: - - string - - 'null' - commit_title: - description: Title for the merge commit message. - type: - - string - - 'null' - enabled_by: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: - - string - - 'null' - closed_at: - type: - - string - - 'null' - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: - - string - - 'null' - ref: - type: string - repo: - title: Repository - description: A git repository - type: - - object - - 'null' - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: - - object - - 'null' + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object properties: - avatar_url: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - format: uri - deleted: + default: type: boolean - email: + description: type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri id: type: integer - login: - type: string name: + description: The name of the label. type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization url: + description: URL for the label type: string format: uri required: - - login - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + merge_commit_sha: + type: + - string + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + avatar_url: type: string - default: + format: uri + deleted: type: boolean - description: + email: type: - string - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer + login: + type: string name: - description: The name of the label. type: string node_id: type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: - description: URL for the label type: string format: uri required: + - login - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: - - string - - 'null' - merged_at: - type: - - string - - 'null' - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: - - object - - 'null' - properties: - closed_at: - type: - - string - - 'null' - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' + properties: + closed_at: type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: - - string - - 'null' - due_on: - type: - - string - - 'null' - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + - string + - 'null' + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + description: type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - - title: Team + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within its + repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: + - boolean + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + requested_teams: + type: array + items: + title: Team description: Groups of organization members that gives permissions on specified repositories. type: object @@ -180616,566 +166004,260 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object + review_comment_url: + type: string + format: uri-template + review_comments: + type: integer + review_comments_url: + type: string + format: uri + state: + description: State of this Pull Request. Either `open` or `closed`. + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' properties: + avatar_url: + type: string + format: uri deleted: type: boolean - description: - description: Description of the team + email: type: - string - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string html_url: type: string format: uri id: - description: Unique identifier of the team type: integer - members_url: + login: type: string - format: uri-template name: - description: Name of the team type: string node_id: type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories + organizations_url: type: string - privacy: + format: uri + received_events_url: type: string - enum: - - open - - closed - - secret - repositories_url: + format: uri + repos_url: type: string format: uri - slug: + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string + enum: + - Bot + - User + - Organization + - Mannequin url: - description: URL for the team type: string format: uri required: - - name + - login - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft + repository: + "$ref": "#/components/schemas/repository-webhooks" + requested_team: + title: Team + description: Groups of organization members that gives permissions on + specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string + description: + description: Description of the team + type: + - string + - 'null' html_url: - description: HTML URL for the pull request review comment. type: string format: uri id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. + description: Unique identifier of the team type: integer - line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. + members_url: type: string - original_commit_id: - description: The SHA of the original commit to which the comment - applies. + format: uri-template + name: + description: Name of the team type: string - original_line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: - - integer - - 'null' - original_position: - description: The index of the original line in the diff to which - the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the comment - applies. + node_id: type: string - position: - description: The line index in the diff to which the comment applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review comment - belongs to. + permission: + description: Permission that the team will have for its repositories type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. + privacy: type: string enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be - a diff line or a file. + - open + - closed + - secret + repositories_url: type: string - enum: - - line - - file - updated_at: + format: uri + slug: type: string - format: date-time url: - description: URL for the pull request review comment + description: URL for the team type: string format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id required: - - url - - pull_request_review_id + - name - id - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at + - slug + - description + - privacy + - url - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - required: - - action - - thread - - pull_request - - repository - webhook-pull-request-review-thread-unresolved: - title: pull_request_review_thread unresolved event + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + webhook-pull-request-review-submitted: + title: pull_request_review submitted event type: object properties: action: type: string enum: - - unresolved + - submitted enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -181343,6 +166425,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -181414,6 +166497,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -181447,7 +166531,9 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -181737,6 +166823,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -181874,6 +166982,28 @@ components: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -181914,6 +167044,12 @@ components: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false visibility: type: string enum: @@ -182106,13 +167242,17 @@ components: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -182310,6 +167450,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -182447,6 +167609,28 @@ components: - 'null' size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -182487,6 +167671,12 @@ components: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false visibility: type: string enum: @@ -182787,6 +167977,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -182922,6 +168113,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -183030,6 +168222,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -183156,541 +168357,6 @@ components: type: string format: uri user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: - - integer - - 'null' - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment - applies. - type: string - original_line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - original_position: - description: The index of the original line in the diff to which - the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - path: - description: The relative path of the file to which the comment - applies. - type: string - position: - description: The line index in the diff to which the comment applies. - type: - - integer - - 'null' - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: - - integer - - 'null' - pull_request_url: - description: URL for the pull request that the review comment - belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: - - integer - - 'null' - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: - - string - - 'null' - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be - a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - required: - - action - - thread - - pull_request - - repository - webhook-pull-request-synchronize: - title: pull_request synchronize event - type: object - properties: - action: - type: string - enum: - - synchronize - after: - type: string - before: - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: - - string - - 'null' - enum: - - resolved - - off-topic - - too heated - - spam - - - additions: - type: integer - assignee: title: User type: - object @@ -183760,6 +168426,236 @@ components: required: - login - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - draft + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + repository: + "$ref": "#/components/schemas/repository-webhooks" + review: + "$ref": "#/components/schemas/webhooks_review" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - review + - pull_request + - repository + - sender + webhook-pull-request-review-thread-resolved: + title: pull_request_review_thread resolved event + type: object + properties: + action: + type: string + enum: + - resolved + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Simple Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id assignees: type: array items: @@ -183825,7 +168721,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -184151,28 +169046,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -184310,28 +169183,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -184372,12 +169223,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -184549,45 +169394,38 @@ components: type: - string - 'null' - changed_files: - type: integer closed_at: type: - string - 'null' - format: date-time - comments: - type: integer comments_url: type: string format: uri - commits: - type: integer commits_url: type: string format: uri created_at: type: string - format: date-time - deletions: - type: integer diff_url: type: string format: uri draft: - description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: title: Repository description: A git repository - type: object + type: + - object + - 'null' properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -184785,19 +169623,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: The default value for a merge commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: The default value for a merge commit message title. - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -184935,28 +169760,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -184997,12 +169800,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -185215,97 +170012,14 @@ components: - description locked: type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull request. - type: boolean merge_commit_sha: type: - string - 'null' - mergeable: - type: - - boolean - - 'null' - mergeable_state: - type: string - merged: - type: - - boolean - - 'null' merged_at: type: - string - 'null' - format: date-time - merged_by: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -185386,7 +170100,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -185452,16 +170165,10 @@ components: node_id: type: string number: - description: Number uniquely identifying the pull request within its - repository. type: integer patch_url: type: string format: uri - rebaseable: - type: - - boolean - - 'null' requested_reviewers: type: array items: @@ -185753,13 +170460,10 @@ components: review_comment_url: type: string format: uri-template - review_comments: - type: integer review_comments_url: type: string format: uri state: - description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -185768,11 +170472,9 @@ components: type: string format: uri title: - description: The title of the pull request. type: string updated_at: type: string - format: date-time url: type: string format: uri @@ -185871,6 +170573,7 @@ components: - requested_teams - labels - milestone + - draft - commits_url - review_comments_url - review_comment_url @@ -185882,108 +170585,333 @@ components: - author_association - auto_merge - active_lock_reason - - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" + thread: + type: object + properties: + comments: + type: array + items: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the comment + applies. + type: string + original_line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + original_position: + description: The index of the original line in the diff to which + the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the comment + applies. + type: string + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review comment + belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for a multi-line + comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, can be + a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments required: - action - - number - - before - - after + - thread - pull_request - repository - - sender - webhook-pull-request-unassigned: - title: pull_request unassigned event + webhook-pull-request-review-thread-unresolved: + title: pull_request_review_thread unresolved event type: object properties: action: type: string enum: - - unassigned - assignee: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id + - unresolved enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - title: Pull Request + title: Simple Pull Request type: object properties: _links: @@ -186080,8 +171008,6 @@ components: - too heated - spam - - additions: - type: integer assignee: title: User type: @@ -186145,7 +171071,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -186217,7 +171142,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -186251,9 +171175,7 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: - - string - - 'null' + type: string enabled_by: title: User type: @@ -186339,9 +171261,7 @@ components: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: @@ -186545,28 +171465,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -186704,28 +171602,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -186766,12 +171642,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -186943,49 +171813,34 @@ components: type: - string - 'null' - changed_files: - type: integer closed_at: type: - string - 'null' - format: date-time - comments: - type: integer comments_url: type: string format: uri - commits: - type: integer commits_url: type: string format: uri created_at: type: string - format: date-time - deletions: - type: integer diff_url: type: string format: uri draft: - description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -187183,28 +172038,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -187342,28 +172175,6 @@ components: - 'null' size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -187404,12 +172215,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -187622,98 +172427,14 @@ components: - description locked: type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull request. - type: boolean merge_commit_sha: type: - string - 'null' - mergeable: - type: - - boolean - - 'null' - mergeable_state: - type: string - merged: - type: - - boolean - - 'null' merged_at: type: - string - 'null' - format: date-time - merged_by: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -187794,7 +172515,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -187860,16 +172580,10 @@ components: node_id: type: string number: - description: Number uniquely identifying the pull request within its - repository. type: integer patch_url: type: string format: uri - rebaseable: - type: - - boolean - - 'null' requested_reviewers: type: array items: @@ -187936,7 +172650,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -188045,15 +172758,6 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -188161,13 +172865,10 @@ components: review_comment_url: type: string format: uri-template - review_comments: - type: integer review_comments_url: type: string format: uri state: - description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -188176,11 +172877,9 @@ components: type: string format: uri title: - description: The title of the pull request. type: string updated_at: type: string - format: date-time url: type: string format: uri @@ -188247,7 +172946,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -188279,6 +172977,7 @@ components: - requested_teams - labels - milestone + - draft - commits_url - review_comments_url - review_comment_url @@ -188290,64 +172989,332 @@ components: - author_association - auto_merge - active_lock_reason - - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" + thread: + type: object + properties: + comments: + type: array + items: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: + - integer + - 'null' + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the comment + applies. + type: string + original_line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: integer + original_position: + description: The index of the original line in the diff to which + the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + path: + description: The relative path of the file to which the comment + applies. + type: string + position: + description: The line index in the diff to which the comment applies. + type: + - integer + - 'null' + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: + - integer + - 'null' + pull_request_url: + description: URL for the pull request that the review comment + belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for a multi-line + comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line comment. + type: + - integer + - 'null' + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: + - string + - 'null' + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, can be + a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments required: - action - - number + - thread - pull_request - repository - webhook-pull-request-unlabeled: - title: pull_request unlabeled event + webhook-pull-request-synchronize: + title: pull_request synchronize event type: object properties: action: type: string enum: - - unlabeled + - synchronize + after: + type: string + before: + type: string enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" - label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: - - string - - 'null' - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description number: - description: The pull request number. - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: @@ -189341,17 +174308,13 @@ components: type: object properties: label: - type: - - string - - 'null' + type: string ref: type: string repo: title: Repository description: A git repository - type: - - object - - 'null' + type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -190654,24 +175617,27 @@ components: required: - action - number + - before + - after - pull_request - repository - sender - webhook-pull-request-unlocked: - title: pull_request unlocked event + webhook-pull-request-unassigned: + title: pull_request unassigned event type: object properties: action: type: string enum: - - unlocked + - unassigned + assignee: + "$ref": "#/components/schemas/webhooks_user_mannequin" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: - description: The pull request number. - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: @@ -190837,6 +175803,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -190908,6 +175875,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -190941,7 +175909,9 @@ components: - 'null' commit_title: description: Title for the merge commit message. - type: string + type: + - string + - 'null' enabled_by: title: User type: @@ -191027,7 +175997,9 @@ components: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: @@ -191661,7 +176633,9 @@ components: type: object properties: label: - type: string + type: + - string + - 'null' ref: type: string repo: @@ -192391,6 +177365,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -192477,6 +177452,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -192618,6 +177594,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -192726,6 +177703,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -192919,6 +177905,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -192958,2166 +177945,1689 @@ components: - head - base - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - number - - pull_request - - repository - - sender - webhook-push: - title: push event - type: object - properties: - after: - description: The SHA of the most recent commit on `ref` after the push. - type: string - base_ref: - type: - - string - - 'null' - before: - description: The SHA of the most recent commit on `ref` before the push. - type: string - commits: - description: An array of commit objects describing the pushed commits. (Pushed - commits are all commits that are included in the `compare` between the - `before` commit and the `after` commit.) The array includes a maximum - of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) - to fetch additional commits. This limit is applied to timeline events - only and isn't applied to webhook deliveries. - type: array - items: - title: Commit - type: object - properties: - added: - description: An array of files added in the commit. - type: array - items: - type: string - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - distinct: - description: Whether this commit is distinct from any that have been - pushed before. - type: boolean - id: - type: string - message: - description: The commit message. - type: string - modified: - description: An array of files modified by the commit. - type: array - items: - type: string - removed: - description: An array of files removed in the commit. - type: array - items: - type: string - timestamp: - description: The ISO 8601 timestamp of the commit. - type: string - format: date-time - tree_id: - type: string - url: - description: URL that points to the commit API resource. - type: string - format: uri - required: - - id - - tree_id - - distinct - - message - - timestamp - - url - - author - - committer - compare: - description: URL that shows the changes in this `ref` update, from the `before` - commit to the `after` commit. For a newly created `ref` that is directly - based on the default branch, this is the comparison between the head of - the default branch and the `after` commit. Otherwise, this shows all commits - until the `after` commit. - type: string - created: - description: Whether this push created the `ref`. - type: boolean - deleted: - description: Whether this push deleted the `ref`. - type: boolean - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - forced: - description: Whether this push was a force push of the `ref`. - type: boolean - head_commit: - title: Commit - type: - - object - - 'null' - properties: - added: - description: An array of files added in the commit. - type: array - items: - type: string - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - distinct: - description: Whether this commit is distinct from any that have been - pushed before. - type: boolean - id: - type: string - message: - description: The commit message. - type: string - modified: - description: An array of files modified by the commit. - type: array - items: - type: string - removed: - description: An array of files removed in the commit. - type: array - items: - type: string - timestamp: - description: The ISO 8601 timestamp of the commit. - type: string - format: date-time - tree_id: - type: string - url: - description: URL that points to the commit API resource. - type: string - format: uri - required: - - id - - tree_id - - distinct - - message - - timestamp - - url - - author - - committer - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pusher: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - name - ref: - description: 'The full git ref that was pushed. Example: `refs/heads/main` - or `refs/tags/v3.14.1`.' - type: string - repository: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: - type: object - description: The custom properties that were defined for the repository. - The keys are the custom property names, and the values are the corresponding - custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: - - string - - 'null' - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: - - string - - 'null' - languages_url: - type: string - format: uri - license: - title: License - type: - - object - - 'null' - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: - - string - - 'null' - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: - - string - - 'null' - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - oneOf: - - type: integer - - type: string - format: date-time - type: - - 'null' - - integer - - string - releases_url: - type: string - format: uri-template - role_name: - type: - - string - - 'null' - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on web-based - commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility + - author_association + - auto_merge + - active_lock_reason + - draft + repository: + "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - - ref - - before - - after - - created - - deleted - - forced - - base_ref - - compare - - commits - - head_commit + - action + - number + - pull_request - repository - - pusher - webhook-registry-package-published: + webhook-pull-request-unlabeled: + title: pull_request unlabeled event type: object properties: action: type: string enum: - - published + - unlabeled enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + label: + "$ref": "#/components/schemas/webhooks_label" + number: + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" - registry_package: + pull_request: + title: Pull Request type: object properties: - created_at: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: type: - string - 'null' - description: + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User type: - - string + - object - 'null' - ecosystem: - type: string - html_url: - type: string - id: - type: integer - name: - type: string - namespace: - type: string - owner: - type: object properties: avatar_url: type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string + format: uri-template gravatar_id: type: string html_url: type: string + format: uri id: type: integer login: type: string + name: + type: string node_id: type: string organizations_url: type: string + format: uri received_events_url: type: string + format: uri repos_url: type: string + format: uri site_admin: type: boolean starred_url: type: string + format: uri-template subscriptions_url: type: string + format: uri type: type: string + enum: + - Bot + - User + - Organization + - Mannequin url: type: string + format: uri required: - login - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - package_type: + assignees: + type: array + items: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. type: string - package_version: + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. type: - object - 'null' properties: - author: - type: object + commit_message: + description: Commit message for the merge commit. + type: + - string + - 'null' + commit_title: + description: Title for the merge commit message. + type: + - string + - 'null' + enabled_by: + title: User + type: + - object + - 'null' properties: avatar_url: type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string + format: uri-template gravatar_id: type: string html_url: type: string + format: uri id: type: integer login: type: string + name: + type: string node_id: type: string organizations_url: type: string + format: uri received_events_url: type: string + format: uri repos_url: type: string + format: uri site_admin: type: boolean starred_url: type: string + format: uri-template subscriptions_url: type: string + format: uri type: type: string + enum: + - Bot + - User + - Organization url: type: string + format: uri required: - login - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - body: - oneOf: - - type: string - - type: object - body_html: - type: string - container_metadata: - type: object - properties: - labels: - type: - - object - - 'null' - manifest: - type: - - object - - 'null' - tag: - type: object - properties: - digest: - type: string - name: - type: string - created_at: - type: string - description: - type: string - docker_metadata: - type: array - items: - type: object - properties: - tags: - type: array - items: - type: string - draft: - type: boolean - html_url: - type: string - id: - type: integer - installation_command: + merge_method: + description: The merge method to use. type: string - manifest: + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: type: string - metadata: - type: array - items: - type: object - additionalProperties: true - name: + ref: type: string - npm_metadata: - type: - - object - - 'null' + repo: + title: Repository + description: A git repository + type: object properties: - name: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: type: string - version: + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: type: string - npm_user: + format: uri-template + blobs_url: type: string - author: + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: oneOf: + - type: integer - type: string - - type: object + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: type: - - 'null' - string - - object - bugs: - oneOf: - - type: string - - type: object - type: - 'null' - - string - - object - dependencies: - type: object - dev_dependencies: - type: object - peer_dependencies: - type: object - optional_dependencies: - type: object - description: + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: type: string - dist: - oneOf: - - type: string - - type: object + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: type: - - 'null' - string - - object - git_head: + - 'null' + hooks_url: type: string - homepage: + format: uri + html_url: type: string - license: + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: type: string - main: + format: uri-template + issue_events_url: type: string - repository: - oneOf: - - type: string - - type: object + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: type: - - 'null' - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: - object - scripts: - type: object - id: + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: type: string - node_version: + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. type: string - npm_version: + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). type: string - has_shrinkwrap: - type: boolean - maintainers: - type: array - items: - type: string - contributors: - type: array - items: - type: string - engines: - type: object - keywords: - type: array - items: - type: string - files: - type: array - items: - type: string - bin: - type: object - man: - type: object - directories: - oneOf: - - type: string - - type: object + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: type: - - 'null' - string - - object - os: - type: array - items: - type: string - cpu: - type: array - items: - type: string - readme: + - 'null' + format: uri + name: + description: The name of the repository. type: string - installation_command: + node_id: type: string - release_id: - type: integer - commit_oid: + notifications_url: type: string - published_via_actions: - type: boolean - deleted_by_id: + format: uri-template + open_issues: type: integer - nuget_metadata: - type: - - array - - 'null' - items: - type: object - properties: - id: - oneOf: - - type: string - - type: object - - type: integer - type: - - 'null' - - string - - object - - integer - name: - type: string - value: - oneOf: - - type: boolean - - type: string - - type: integer - - type: object - properties: - url: - type: string - branch: - type: string - commit: - type: string - type: - type: string - package_files: - type: array - items: - type: object - properties: - content_type: - type: string - created_at: - type: string - download_url: - type: string - id: - type: integer - md5: - type: - - string - - 'null' - name: - type: string - sha1: - type: - - string - - 'null' - sha256: - type: - - string - - 'null' - size: - type: integer - state: - type: - - string - - 'null' - updated_at: - type: string - required: - - download_url - - id - - name - - sha256 - - sha1 - - md5 - - content_type - - state - - size - - created_at - - updated_at - package_url: - type: string - prerelease: - type: boolean - release: - type: object - properties: - author: - type: object + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' properties: avatar_url: type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string + format: uri-template gravatar_id: type: string html_url: type: string + format: uri id: type: integer login: type: string + name: + type: string node_id: type: string organizations_url: type: string + format: uri received_events_url: type: string + format: uri repos_url: type: string + format: uri site_admin: type: boolean starred_url: type: string + format: uri-template subscriptions_url: type: string + format: uri type: type: string + enum: + - Bot + - User + - Organization url: type: string - created_at: + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: type: string - draft: + format: uri + deleted: type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string html_url: type: string + format: uri id: type: integer + login: + type: string name: - type: - - string - - 'null' - prerelease: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: type: boolean - published_at: + starred_url: type: string - tag_name: + format: uri-template + subscriptions_url: type: string - target_commitish: + format: uri + type: type: string + enum: + - Bot + - User + - Organization url: type: string - rubygems_metadata: - type: array - items: - "$ref": "#/components/schemas/webhook-rubygems-metadata" - summary: - type: string - tag_name: - type: string - target_commitish: - type: string - target_oid: - type: string - updated_at: - type: string - version: - type: string + format: uri + required: + - login + - id required: - - id - - version - - name - - description - - summary - - html_url - - metadata - - package_files - - installation_command - - package_url - registry: + - label + - ref + - sha + - user + - repo + body: type: - - object + - string - 'null' - properties: - about_url: - type: string - name: - type: string - type: - type: string - url: - type: string - vendor: - type: string - updated_at: + changed_files: + type: integer + closed_at: type: - string - 'null' - required: - - id - - name - - namespace - - description - - ecosystem - - package_type - - html_url - - created_at - - updated_at - - owner - - package_version - - registry - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - registry_package - - sender - webhook-registry-package-updated: - type: object - properties: - action: - type: string - enum: - - updated - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - registry_package: - type: object - properties: - created_at: + format: date-time + comments: + type: integer + comments_url: type: string - description: - type: - - 'null' - ecosystem: + format: uri + commits: + type: integer + commits_url: type: string - html_url: + format: uri + created_at: type: string - id: + format: date-time + deletions: type: integer - name: - type: string - namespace: + diff_url: type: string - owner: + format: uri + draft: + description: Indicates whether or not the pull request is a draft. + type: boolean + head: type: object properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: + label: + type: + - string + - 'null' + ref: type: string - required: - - login - - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - package_type: - type: string - package_version: - type: object - properties: - author: - type: object + repo: + title: Repository + description: A git repository + type: + - object + - 'null' properties: - avatar_url: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: type: string + format: uri events_url: type: string - followers_url: + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: type: string - following_url: + format: uri + full_name: type: string - gists_url: + git_commits_url: type: string - gravatar_id: + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: + - string + - 'null' + hooks_url: type: string + format: uri html_url: type: string + format: uri id: + description: Unique identifier of the repository type: integer - login: + is_template: + type: boolean + issue_comment_url: type: string - node_id: + format: uri-template + issue_events_url: type: string - organizations_url: + format: uri-template + issues_url: type: string - received_events_url: + format: uri-template + keys_url: type: string - repos_url: + format: uri-template + labels_url: type: string - site_admin: - type: boolean - starred_url: + format: uri-template + language: + type: + - string + - 'null' + languages_url: type: string - subscriptions_url: + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: type: string - type: + merge_commit_message: + description: The default value for a merge commit message. type: string - url: + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: The default value for a merge commit message title. type: string - required: - - login - - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - body: - type: string - body_html: - type: string - created_at: - type: string - description: - type: string - docker_metadata: - type: array - items: - type: - - object - - 'null' - properties: - tags: - type: array - items: - type: string - draft: - type: boolean - html_url: - type: string - id: - type: integer - installation_command: - type: string - manifest: - type: string - metadata: - type: array - items: - type: object - additionalProperties: true - name: - type: string - package_files: - type: array - items: - type: object - properties: - content_type: - type: string - created_at: - type: string - download_url: - type: string - id: - type: integer - md5: - type: - - string - - 'null' - name: - type: string - sha1: - type: - - string - - 'null' - sha256: - type: string - size: - type: integer - state: - type: string - updated_at: - type: string - package_url: - type: string - prerelease: - type: boolean - release: - type: object - properties: - author: - type: object + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: + - object + - 'null' properties: avatar_url: type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string + format: uri-template gravatar_id: type: string html_url: type: string + format: uri id: type: integer login: type: string + name: + type: string node_id: type: string organizations_url: type: string + format: uri received_events_url: type: string + format: uri repos_url: type: string + format: uri site_admin: type: boolean starred_url: type: string + format: uri-template subscriptions_url: type: string + format: uri type: type: string + enum: + - Bot + - User + - Organization url: type: string + format: uri required: - login - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - created_at: - type: string - draft: + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. type: boolean - html_url: + public: + type: boolean + pulls_url: type: string - id: + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: type: integer - name: + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. type: string - prerelease: - type: boolean - published_at: + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). type: string - tag_name: + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: type: string - target_commitish: + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: type: string + format: date-time url: type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean required: - - url - - html_url - id - - tag_name - - target_commitish + - node_id - name - - draft - - author - - prerelease - - created_at - - published_at - rubygems_metadata: - type: array - items: - "$ref": "#/components/schemas/webhook-rubygems-metadata" - summary: - type: string - tag_name: - type: string - target_commitish: - type: string - target_oid: - type: string - updated_at: - type: string - version: - type: string - required: - - id - - version - - name - - description - - summary - - body - - body_html - - html_url - - target_commitish - - target_oid - - created_at - - updated_at - - metadata - - package_files - - author - - installation_command - - package_url - registry: - type: - - object - - 'null' - updated_at: - type: string - required: - - id - - name - - namespace - - description - - ecosystem - - package_type - - html_url - - created_at - - updated_at - - owner - - package_version - - registry - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - registry_package - - sender - webhook-release-created: - title: release created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - release: - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: - type: array - items: - title: Release Asset - description: Data related to a release. - type: object - properties: - browser_download_url: - type: string - format: uri - content_type: - type: string - created_at: - type: string - format: date-time - download_count: - type: integer - id: - type: integer - label: - type: - - string - - 'null' - name: - description: The file name of the asset. - type: string - node_id: - type: string - size: - type: integer - state: - description: State of the release asset. - type: string - enum: - - uploaded - updated_at: - type: string - format: date-time - uploader: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - url: - type: string - format: uri - required: - - url - - browser_download_url - - id - - node_id - - name - - label - - state - - content_type - - size - - download_count - - created_at - - updated_at - assets_url: - type: string - format: uri - author: - title: User - type: - - object - - 'null' - properties: - avatar_url: + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: type: string - format: uri - deleted: - type: boolean - email: + user: + title: User type: - - string + - object - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id required: - - login - - id - body: - type: - - string - - 'null' - created_at: - type: - - string - - 'null' - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean + - label + - ref + - sha + - user + - repo html_url: type: string format: uri id: type: integer - name: - type: - - string - - 'null' - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease or a - full release. - type: boolean - published_at: - type: - - string - - 'null' - format: date-time - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: - - string - - 'null' - format: uri - target_commitish: - description: Specifies the commitish value that determines where the - Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - url: + issue_url: type: string format: uri - zipball_url: - type: - - string - - 'null' - format: uri - required: - - url - - assets_url - - upload_url - - html_url - - id - - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - - assets - - tarball_url - - zipball_url - - body - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - release - - repository - - sender - webhook-release-deleted: - title: release deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - release: - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: + labels: type: array items: - title: Release Asset - description: Data related to a release. + title: Label type: object properties: - browser_download_url: - type: string - format: uri - content_type: - type: string - created_at: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - format: date-time - download_count: - type: integer - id: - type: integer - label: + default: + type: boolean + description: type: - string - 'null' + id: + type: integer name: - description: The file name of the asset. + description: The name of the label. type: string node_id: type: string - size: - type: integer - state: - description: State of the release asset. - type: string - enum: - - uploaded - updated_at: - type: string - format: date-time - uploader: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id url: + description: URL for the label type: string format: uri required: - - url - - browser_download_url - id - node_id + - url - name - - label - - state - - content_type - - size - - download_count - - created_at - - updated_at - assets_url: + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + merge_commit_sha: + type: + - string + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: type: string - format: uri - author: + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: title: User type: - object @@ -195186,305 +179696,477 @@ components: required: - login - id - body: - type: - - string - - 'null' - created_at: - type: - - string - - 'null' - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: - - string - - 'null' - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease or a - full release. - type: boolean - published_at: + milestone: + title: Milestone + description: A collection of related issues and pull requests. type: - - string + - object - 'null' - format: date-time - reactions: - title: Reactions - type: object properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: + closed_at: + type: + - string + - 'null' + format: date-time + closed_issues: type: integer - laugh: + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + description: + type: + - string + - 'null' + due_on: + type: + - string + - 'null' + format: date-time + html_url: + type: string + format: uri + id: type: integer - rocket: + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. type: integer - total_count: + open_issues: type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time url: type: string format: uri required: - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: - - string - - 'null' - format: uri - target_commitish: - description: Specifies the commitish value that determines where the - Git tag is created from. - type: string - upload_url: + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: type: string - format: uri-template - url: + number: + description: Number uniquely identifying the pull request within its + repository. + type: integer + patch_url: type: string format: uri - zipball_url: + rebaseable: type: - - string + - boolean - 'null' - format: uri - required: - - url - - assets_url - - upload_url - - html_url - - id - - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - - assets - - tarball_url - - zipball_url - - body - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - release - - repository - - sender - webhook-release-edited: - title: release edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body if the action was - `edited`. - type: string - required: - - from - name: - type: object - properties: - from: - description: The previous version of the name if the action was - `edited`. - type: string - required: - - from - make_latest: - type: object - properties: - to: - description: Whether this release was explicitly `edited` to be - the latest. - type: boolean - required: - - to - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - release: - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: + requested_reviewers: type: array items: - title: Release Asset - description: Data related to a release. + oneOf: + - title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. type: object properties: - browser_download_url: + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: type: string format: uri - content_type: - type: string - created_at: - type: string - format: date-time - download_count: - type: integer id: + description: Unique identifier of the team type: integer - label: - type: - - string - - 'null' + members_url: + type: string + format: uri-template name: - description: The file name of the asset. + description: Name of the team type: string node_id: type: string - size: - type: integer - state: - description: State of the release asset. - type: string - enum: - - uploaded - updated_at: - type: string - format: date-time - uploader: - title: User + parent: type: - object - 'null' properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + description: + description: Description of the team type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string html_url: type: string format: uri id: + description: Unique identifier of the team type: integer - login: + members_url: type: string + format: uri-template name: + description: Name of the team type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: + permission: + description: Permission that the team will have for its repositories type: string - format: uri - type: + privacy: type: string enum: - - Bot - - User - - Organization + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string url: + description: URL for the team type: string format: uri required: - - login + - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string url: + description: URL for the team type: string format: uri required: - - url - - browser_download_url - - id - - node_id - name - - label - - state - - content_type - - size - - download_count - - created_at - - updated_at - assets_url: + - id + review_comment_url: + type: string + format: uri-template + review_comments: + type: integer + review_comments_url: type: string format: uri - author: + state: + description: State of this Pull Request. Either `open` or `closed`. + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: title: User type: - object @@ -195547,282 +180229,248 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri required: - login - id - body: - type: - - string - - 'null' - created_at: - type: - - string - - 'null' - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: - - string - - 'null' - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease or a - full release. - type: boolean - published_at: - type: - - string - - 'null' - format: date-time - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: - - string - - 'null' - format: uri - target_commitish: - description: Specifies the commitish value that determines where the - Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - url: - type: string - format: uri - zipball_url: - type: - - string - - 'null' - format: uri required: - url - - assets_url - - upload_url - - html_url - id - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - - assets - - tarball_url - - zipball_url + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - changes - - release + - number + - pull_request - repository - webhook-release-prereleased: - title: release prereleased event + - sender + webhook-pull-request-unlocked: + title: pull_request unlocked event type: object properties: action: type: string enum: - - prereleased + - unlocked enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + number: + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" - release: - allOf: - - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: - type: array - items: - title: Release Asset - description: Data related to a release. + pull_request: + title: Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link type: object properties: - browser_download_url: + href: type: string - format: uri - content_type: + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: type: string - created_at: + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: type: string - format: date-time - download_count: - type: integer - id: - type: integer - label: - type: - - string - - 'null' - name: - description: The file name of the asset. + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: type: string - node_id: + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: type: string - size: - type: integer - state: - description: State of the release asset. + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: type: string - enum: - - uploaded - updated_at: + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: type: string - format: date-time - uploader: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - url: + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: type: string - format: uri + format: uri-template required: - - url - - browser_download_url - - id - - node_id - - name - - label - - state - - content_type - - size - - download_count - - created_at - - updated_at - assets_url: - type: string - format: uri - author: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: + - string + - 'null' + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: title: User type: - object @@ -195891,282 +180539,371 @@ components: required: - login - id - body: - type: - - string - - 'null' - created_at: - type: - - string - - 'null' - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: - - string - - 'null' - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease or - a full release. - type: boolean - published_at: - type: - - string - - 'null' - format: date-time - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: - - string - - 'null' - format: uri - target_commitish: - description: Specifies the commitish value that determines where the - Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - url: - type: string - format: uri - zipball_url: - type: - - string - - 'null' - format: uri - required: - - url - - assets_url - - upload_url - - html_url - - id - - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - - assets - - tarball_url - - zipball_url - - body - - type: object - properties: - assets: - type: array - items: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: + - object + - 'null' + properties: + commit_message: + description: Commit message for the merge commit. type: - - object + - string - 'null' - assets_url: - type: string - author: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string + commit_title: + description: Title for the merge commit message. + type: string + enabled_by: + title: User type: - type: string - url: - type: string - body: - type: - - string - - 'null' - created_at: - type: string - draft: - type: boolean - html_url: - type: string - id: - type: integer - name: - type: - - string - - 'null' - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease or - a full release. - type: boolean - enum: - - true - published_at: - type: - - string - - 'null' - tag_name: - type: string - tarball_url: - type: - - string - - 'null' - target_commitish: - type: string - upload_url: - type: string - url: - type: string - zipball_url: - type: - - string - - 'null' - required: - - prerelease - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - release - - repository - webhook-release-published: - title: release published event - type: object - properties: - action: - type: string - enum: - - published - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - release: - allOf: - - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: - type: array - items: - title: Release Asset - description: Data related to a release. + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository type: object properties: - browser_download_url: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: type: string format: uri - content_type: + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: type: string + format: uri-template + contributors_url: + type: string + format: uri created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. type: string - format: date-time - download_count: + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri id: + description: Unique identifier of the repository type: integer - label: + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: type: - string - 'null' + format: uri name: - description: The file name of the asset. + description: The name of the repository. type: string node_id: type: string - size: - type: integer - state: - description: State of the release asset. + notifications_url: type: string - enum: - - uploaded - updated_at: + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: type: string - format: date-time - uploader: + owner: title: User type: - object @@ -196235,703 +180972,574 @@ components: required: - login - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean required: - - url - - browser_download_url - id - node_id - name - - label - - state - - content_type - - size - - download_count + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url - created_at - updated_at - assets_url: - type: string - format: uri - author: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - body: - type: - - string - - 'null' - created_at: - type: - - string - - 'null' - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: - - string - - 'null' - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease or - a full release. - type: boolean - published_at: - type: - - string - - 'null' - format: date-time - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: - - string - - 'null' - format: uri - target_commitish: - description: Specifies the commitish value that determines where the - Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - url: - type: string - format: uri - zipball_url: - type: - - string - - 'null' - format: uri - required: - - url - - assets_url - - upload_url - - html_url - - id - - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - - assets - - tarball_url - - zipball_url - - body - - type: object - properties: - assets: - type: array - items: + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User type: - object - 'null' - assets_url: - type: string - author: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - body: - type: - - string - - 'null' - created_at: - type: string - draft: - type: boolean - html_url: - type: string - id: - type: integer - name: - type: - - string - - 'null' - node_id: - type: string - prerelease: - type: boolean - published_at: - type: - - string - - 'null' - format: date-time - tag_name: - type: string - tarball_url: - type: - - string - - 'null' - target_commitish: - type: string - upload_url: - type: string - url: - type: string - zipball_url: - type: - - string - - 'null' - required: - - published_at - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - release - - repository - webhook-release-released: - title: release released event - type: object - properties: - action: - type: string - enum: - - released - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - release: - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: - type: array - items: - title: Release Asset - description: Data related to a release. - type: object - properties: - browser_download_url: - type: string - format: uri - content_type: - type: string - created_at: - type: string - format: date-time - download_count: - type: integer - id: - type: integer - label: - type: - - string - - 'null' - name: - description: The file name of the asset. - type: string - node_id: - type: string - size: - type: integer - state: - description: State of the release asset. - type: string - enum: - - uploaded - updated_at: - type: string - format: date-time - uploader: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - url: - type: string - format: uri - required: - - url - - browser_download_url - - id - - node_id - - name - - label - - state - - content_type - - size - - download_count - - created_at - - updated_at - assets_url: - type: string - format: uri - author: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id required: - - login - - id + - label + - ref + - sha + - user + - repo body: type: - string - 'null' - created_at: + changed_files: + type: integer + closed_at: type: - string - 'null' format: date-time - discussion_url: + comments: + type: integer + comments_url: type: string format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: + commits: + type: integer + commits_url: type: string format: uri - id: + created_at: + type: string + format: date-time + deletions: type: integer - name: - type: - - string - - 'null' - node_id: + diff_url: type: string - prerelease: - description: Whether the release is identified as a prerelease or a - full release. + format: uri + draft: + description: Indicates whether or not the pull request is a draft. type: boolean - published_at: - type: - - string - - 'null' - format: date-time - reactions: - title: Reactions + head: type: object properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: + label: type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: - - string - - 'null' - format: uri - target_commitish: - description: Specifies the commitish value that determines where the - Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - url: - type: string - format: uri - zipball_url: - type: - - string - - 'null' - format: uri - required: - - url - - assets_url - - upload_url - - html_url - - id - - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - - assets - - tarball_url - - zipball_url - - body - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - release - - repository - webhook-release-unpublished: - title: release unpublished event - type: object - properties: - action: - type: string - enum: - - unpublished - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - release: - allOf: - - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: - type: array - items: - title: Release Asset - description: Data related to a release. - type: object + ref: + type: string + repo: + title: Repository + description: A git repository + type: + - object + - 'null' properties: - browser_download_url: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: + - string + - 'null' + hooks_url: type: string format: uri - content_type: - type: string - created_at: + html_url: type: string - format: date-time - download_count: - type: integer + format: uri id: + description: Unique identifier of the repository type: integer - label: + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License + type: + - object + - 'null' + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: + - string + - 'null' + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: type: - string - 'null' + format: uri name: - description: The file name of the asset. + description: The name of the repository. type: string node_id: type: string - size: - type: integer - state: - description: State of the release asset. + notifications_url: type: string - enum: - - uploaded - updated_at: + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: type: string - format: date-time - uploader: + owner: title: User type: - object @@ -197000,2477 +181608,1476 @@ components: required: - login - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean required: - - url - - browser_download_url - id - node_id - name - - label - - state - - content_type - - size - - download_count + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url - created_at - updated_at - assets_url: - type: string - format: uri - author: - title: User - type: - - object - - 'null' + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label + type: object properties: - avatar_url: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - format: uri - deleted: + default: type: boolean - email: + description: type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri id: type: integer - login: - type: string name: + description: The name of the label. type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization url: + description: URL for the label type: string format: uri required: - - login - id - body: - type: - - string - - 'null' - created_at: - type: - - string - - 'null' - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: - - string - - 'null' - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease or - a full release. - type: boolean - published_at: - type: - - string - - 'null' - format: date-time - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: + - node_id - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: - - string - - 'null' - format: uri - target_commitish: - description: Specifies the commitish value that determines where the - Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - url: - type: string - format: uri - zipball_url: - type: - - string - - 'null' - format: uri - required: - - url - - assets_url - - upload_url - - html_url - - id - - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - - assets - - tarball_url - - zipball_url - - body - - type: object - properties: - assets: - type: array - items: + - name + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + merge_commit_sha: + type: + - string + - 'null' + mergeable: + type: + - boolean + - 'null' + mergeable_state: + type: string + merged: + type: + - boolean + - 'null' + merged_at: + type: + - string + - 'null' + format: date-time + merged_by: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - - object + - string - 'null' - assets_url: - type: string - author: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - body: - type: - - string - - 'null' - created_at: - type: string - draft: - type: boolean - html_url: - type: string - id: - type: integer - name: - type: - - string - - 'null' - node_id: - type: string - prerelease: - type: boolean - published_at: - type: - - string - - 'null' - tag_name: - type: string - tarball_url: - type: - - string - - 'null' - target_commitish: - type: string - upload_url: - type: string - url: - type: string - zipball_url: + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - required: - - published_at - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - release - - repository - webhook-repository-advisory-published: - title: Repository advisory published event - type: object - properties: - action: - type: string - enum: - - published - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_advisory: - "$ref": "#/components/schemas/repository-advisory" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - repository_advisory - webhook-repository-advisory-reported: - title: Repository advisory reported event - type: object - properties: - action: - type: string - enum: - - reported - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_advisory: - "$ref": "#/components/schemas/repository-advisory" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - repository_advisory - webhook-repository-archived: - title: repository archived event - type: object - properties: - action: - type: string - enum: - - archived - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-repository-created: - title: repository created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-repository-deleted: - title: repository deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-repository-dispatch-sample: - title: repository_dispatch event - type: object - properties: - action: - type: string - enum: - - sample.collected - branch: - type: string - client_payload: - type: - - object - - 'null' - additionalProperties: true - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - branch - - client_payload - - repository - - sender - - installation - webhook-repository-edited: - title: repository edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - default_branch: - type: object - properties: - from: type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri required: - - from - description: - type: object + - login + - id + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: + - object + - 'null' properties: - from: + closed_at: type: - string - 'null' - required: - - from - homepage: - type: object - properties: - from: + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + description: + type: + - string + - 'null' + due_on: type: - string - 'null' + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri required: - - from - topics: - type: object - properties: - from: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within its + repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: + - boolean + - 'null' + requested_reviewers: + type: array + items: + oneOf: + - title: User type: - - array + - object - 'null' - items: - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - changes - - repository - - sender - webhook-repository-import: - title: repository_import event - type: object - properties: - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - status: - type: string - enum: - - success - - cancelled - - failure - required: - - status - - repository - - sender - webhook-repository-privatized: - title: repository privatized event - type: object - properties: - action: - type: string - enum: - - privatized - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-repository-publicized: - title: repository publicized event - type: object - properties: - action: - type: string - enum: - - publicized - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-repository-renamed: - title: repository renamed event - type: object - properties: - action: - type: string - enum: - - renamed - changes: - type: object - properties: - repository: - type: object - properties: - name: - type: object properties: - from: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: type: string + format: uri required: - - from - required: - - name - required: - - repository - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - changes - - repository - - sender - webhook-repository-ruleset-created: - title: repository ruleset created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_ruleset: - "$ref": "#/components/schemas/repository-ruleset" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository_ruleset - - sender - webhook-repository-ruleset-deleted: - title: repository ruleset deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_ruleset: - "$ref": "#/components/schemas/repository-ruleset" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository_ruleset - - sender - webhook-repository-ruleset-edited: - title: repository ruleset edited event - type: object - properties: - action: - type: string - enum: - - edited - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_ruleset: - "$ref": "#/components/schemas/repository-ruleset" - changes: - type: object - properties: - name: - type: object - properties: - from: - type: string - enforcement: - type: object - properties: - from: - type: string - conditions: - type: object - properties: - added: - type: array - items: - "$ref": "#/components/schemas/repository-ruleset-conditions" - deleted: - type: array - items: - "$ref": "#/components/schemas/repository-ruleset-conditions" - updated: - type: array - items: - type: object - properties: - condition: - "$ref": "#/components/schemas/repository-ruleset-conditions" - changes: - type: object - properties: - condition_type: - type: object - properties: - from: - type: string - target: - type: object - properties: - from: - type: string - include: - type: object - properties: - from: - type: array - items: - type: string - exclude: - type: object - properties: - from: - type: array - items: - type: string - rules: - type: object - properties: - added: - type: array - items: - "$ref": "#/components/schemas/repository-rule" - deleted: - type: array - items: - "$ref": "#/components/schemas/repository-rule" - updated: - type: array - items: - type: object - properties: - rule: - "$ref": "#/components/schemas/repository-rule" - changes: - type: object - properties: - configuration: - type: object - properties: - from: - type: string - rule_type: - type: object - properties: - from: - type: string - pattern: - type: object - properties: - from: - type: string - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository_ruleset - - sender - webhook-repository-transferred: - title: repository transferred event - type: object - properties: - action: - type: string - enum: - - transferred - changes: - type: object - properties: - owner: - type: object - properties: - from: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. type: object properties: - organization: - title: Organization - type: object - properties: - avatar_url: - type: string - format: uri - description: - type: - - string - - 'null' - events_url: - type: string - format: uri - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - issues_url: - type: string - format: uri - login: - type: string - members_url: - type: string - format: uri-template - node_id: - type: string - public_members_url: - type: string - format: uri-template - repos_url: - type: string - format: uri - url: - type: string - format: uri - required: - - login - - id - - node_id - - url - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - user: - title: User + deleted: + type: boolean + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: type: - object - 'null' properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + description: + description: Description of the team type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string html_url: type: string format: uri id: + description: Unique identifier of the team type: integer - login: + members_url: type: string + format: uri-template name: + description: Name of the team type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: + permission: + description: Permission that the team will have for its + repositories type: string - format: uri - site_admin: - type: boolean - starred_url: + privacy: type: string - format: uri-template - subscriptions_url: + enum: + - open + - closed + - secret + repositories_url: type: string format: uri - type: + slug: type: string - enum: - - Bot - - User - - Organization url: + description: URL for the team type: string format: uri required: - - login + - name - id - required: - - from - required: - - owner - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - changes - - repository - - sender - webhook-repository-unarchived: - title: repository unarchived event - type: object - properties: - action: - type: string - enum: - - unarchived - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-repository-vulnerability-alert-create: - title: repository_vulnerability_alert create event - type: object - properties: - action: - type: string - enum: - - create - alert: - allOf: - - title: Repository Vulnerability Alert Alert - description: The security alert of the vulnerable dependency. - type: object - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - dismiss_reason: - type: string - dismissed_at: - type: string - dismisser: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - external_identifier: - type: string - external_reference: - type: - - string - - 'null' - format: uri - fix_reason: - type: string - fixed_at: - type: string - format: date-time - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - open - - dismissed - - fixed - required: - - id - - number - - node_id - - state - - affected_range - - affected_package_name - - ghsa_id - - severity - - external_reference - - external_identifier - - created_at - - type: object - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - external_identifier: - type: string - external_reference: - type: - - string - - 'null' - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - open - required: - - state - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-repository-vulnerability-alert-dismiss: - title: repository_vulnerability_alert dismiss event - type: object - properties: - action: - type: string - enum: - - dismiss - alert: - allOf: - - title: Repository Vulnerability Alert Alert - description: The security alert of the vulnerable dependency. - type: object - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - dismiss_comment: - type: - - string - - 'null' - dismiss_reason: - type: string - dismissed_at: - type: string - dismisser: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - external_identifier: - type: string - external_reference: - type: - - string - - 'null' - format: uri - fix_reason: - type: string - fixed_at: - type: string - format: date-time - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - open - - dismissed - - fixed - required: - - id - - number - - node_id - - state - - affected_range - - affected_package_name - - ghsa_id - - severity - - external_reference - - external_identifier - - created_at - - type: object - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - dismiss_comment: - type: - - string - - 'null' - dismiss_reason: - type: string - dismissed_at: - type: string - dismisser: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - external_identifier: - type: string - external_reference: - type: - - string - - 'null' - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - dismissed - required: - - dismisser - - dismiss_reason - - dismissed_at - - state - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-repository-vulnerability-alert-reopen: - title: repository_vulnerability_alert reopen event - type: object - properties: - action: - type: string - enum: - - reopen - alert: - allOf: - - title: Repository Vulnerability Alert Alert - description: The security alert of the vulnerable dependency. - type: object - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - dismiss_reason: - type: string - dismissed_at: - type: string - dismisser: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: deleted: type: boolean - email: + description: + description: Description of the team type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string html_url: type: string format: uri id: + description: Unique identifier of the team type: integer - login: + members_url: type: string + format: uri-template name: + description: Name of the team type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: + parent: + type: + - object + - 'null' + properties: + description: + description: Description of the team + type: + - string + - 'null' + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories type: string - format: uri - site_admin: - type: boolean - starred_url: + privacy: type: string - format: uri-template - subscriptions_url: + enum: + - open + - closed + - secret + repositories_url: type: string format: uri - type: + slug: type: string - enum: - - Bot - - User - - Organization url: + description: URL for the team type: string format: uri required: - - login + - name - id - external_identifier: - type: string - external_reference: - type: - - string - - 'null' - format: uri - fix_reason: - type: string - fixed_at: - type: string - format: date-time - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - open - - dismissed - - fixed - required: - - id - - number - - node_id - - state - - affected_range - - affected_package_name - - ghsa_id - - severity - - external_reference - - external_identifier - - created_at - - type: object - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - external_identifier: - type: string - external_reference: + review_comment_url: + type: string + format: uri-template + review_comments: + type: integer + review_comments_url: + type: string + format: uri + state: + description: State of this Pull Request. Either `open` or `closed`. + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - open - required: - - state - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - alert + - number + - pull_request - repository - sender - webhook-repository-vulnerability-alert-resolve: - title: repository_vulnerability_alert resolve event + webhook-push: + title: push event type: object properties: - action: + after: + description: The SHA of the most recent commit on `ref` after the push. type: string - enum: - - resolve - alert: - allOf: - - title: Repository Vulnerability Alert Alert - description: The security alert of the vulnerable dependency. + base_ref: + "$ref": "#/components/schemas/webhooks_nullable_string" + before: + description: The SHA of the most recent commit on `ref` before the push. + type: string + commits: + description: An array of commit objects describing the pushed commits. (Pushed + commits are all commits that are included in the `compare` between the + `before` commit and the `after` commit.) The array includes a maximum + of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) + to fetch additional commits. + type: array + items: + title: Commit type: object properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - dismiss_reason: - type: string - dismissed_at: - type: string - dismisser: - title: User - type: - - object - - 'null' + added: + description: An array of files added in the commit. A maximum of 3000 + changed files will be reported per commit. + type: array + items: + type: string + author: + title: Committer + description: Metaproperties for Git author/committer information. + type: object properties: - avatar_url: + date: type: string - format: uri - deleted: - type: boolean + format: date-time email: type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string + format: email name: + description: The git author's name. type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: + username: type: string - format: uri-template - subscriptions_url: + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: type: string - format: uri - type: + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. type: string - enum: - - Bot - - User - - Organization - url: + username: type: string - format: uri required: - - login - - id - external_identifier: - type: string - external_reference: - type: - - string - - 'null' - format: uri - fix_reason: - type: string - fixed_at: - type: string - format: date-time - fixed_in: - type: string - ghsa_id: - type: string + - email + - name + distinct: + description: Whether this commit is distinct from any that have been + pushed before. + type: boolean id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - open - - dismissed - - fixed - required: - - id - - number - - node_id - - state - - affected_range - - affected_package_name - - ghsa_id - - severity - - external_reference - - external_identifier - - created_at - - type: object - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - external_identifier: type: string - external_reference: - type: - - string - - 'null' - fix_reason: + message: + description: The commit message. type: string - fixed_at: + modified: + description: An array of files modified by the commit. A maximum of + 3000 changed files will be reported per commit. + type: array + items: + type: string + removed: + description: An array of files removed in the commit. A maximum of + 3000 changed files will be reported per commit. + type: array + items: + type: string + timestamp: + description: The ISO 8601 timestamp of the commit. type: string format: date-time - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: + tree_id: type: string - state: + url: + description: URL that points to the commit API resource. type: string - enum: - - fixed - - open + format: uri required: - - state - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-secret-scanning-alert-created: - title: secret_scanning_alert created event - type: object - properties: - action: - type: string - enum: - - created - alert: - "$ref": "#/components/schemas/secret-scanning-alert-webhook" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - webhook-secret-scanning-alert-location-created: - title: Secret Scanning Alert Location Created Event - type: object - properties: - action: - type: string - enum: - - created - alert: - "$ref": "#/components/schemas/secret-scanning-alert-webhook" - installation: - "$ref": "#/components/schemas/simple-installation" - location: - "$ref": "#/components/schemas/secret-scanning-location" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - location - - alert - - repository - - sender - webhook-secret-scanning-alert-location-created-form-encoded: - title: Secret Scanning Alert Location Created Event - type: object - properties: - payload: - description: A URL-encoded string of the secret_scanning_alert_location.created - JSON payload. The decoded payload is a JSON object. - type: string - required: - - payload - webhook-secret-scanning-alert-reopened: - title: secret_scanning_alert reopened event - type: object - properties: - action: - type: string - enum: - - reopened - alert: - "$ref": "#/components/schemas/secret-scanning-alert-webhook" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - webhook-secret-scanning-alert-resolved: - title: secret_scanning_alert resolved event - type: object - properties: - action: - type: string - enum: - - resolved - alert: - "$ref": "#/components/schemas/secret-scanning-alert-webhook" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - webhook-secret-scanning-alert-revoked: - title: secret_scanning_alert revoked event - type: object - properties: - action: - type: string - enum: - - revoked - alert: - "$ref": "#/components/schemas/secret-scanning-alert-webhook" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - webhook-security-advisory-published: - title: security_advisory published event - type: object - properties: - action: + - id + - tree_id + - distinct + - message + - timestamp + - url + - author + - committer + compare: + description: URL that shows the changes in this `ref` update, from the `before` + commit to the `after` commit. For a newly created `ref` that is directly + based on the default branch, this is the comparison between the head of + the default branch and the `after` commit. Otherwise, this shows all commits + until the `after` commit. type: string - enum: - - published + created: + description: Whether this push created the `ref`. + type: boolean + deleted: + description: Whether this push deleted the `ref`. + type: boolean enterprise: "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - security_advisory: - description: The details of the security advisory, including summary, description, - and severity. - type: object + forced: + description: Whether this push was a force push of the `ref`. + type: boolean + head_commit: + title: Commit + type: + - object + - 'null' properties: - cvss: - type: object - properties: - score: - type: number - vector_string: - type: - - string - - 'null' - required: - - vector_string - - score - cwes: - type: array - items: - type: object - properties: - cwe_id: - type: string - name: - type: string - required: - - cwe_id - - name - description: - type: string - ghsa_id: - type: string - identifiers: - type: array - items: - type: object - properties: - type: - type: string - value: - type: string - required: - - value - - type - published_at: - type: string - references: - type: array - items: - type: object - properties: - url: - type: string - format: uri - required: - - url - severity: - type: string - summary: - type: string - updated_at: - type: string - vulnerabilities: + added: + description: An array of files added in the commit. type: array items: - type: object - properties: - first_patched_version: - type: - - object - - 'null' - properties: - identifier: - type: string - required: - - identifier - package: - type: object - properties: - ecosystem: - type: string - name: - type: string - required: - - ecosystem - - name - severity: - type: string - vulnerable_version_range: - type: string - required: - - package - - severity - - vulnerable_version_range - - first_patched_version - withdrawn_at: - type: - - string - - 'null' - required: - - cvss - - cwes - - ghsa_id - - summary - - description - - severity - - identifiers - - references - - published_at - - updated_at - - withdrawn_at - - vulnerabilities - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - security_advisory - webhook-security-advisory-updated: - title: security_advisory updated event - type: object - properties: - action: - type: string - enum: - - updated - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - security_advisory: - description: The details of the security advisory, including summary, description, - and severity. - type: object - properties: - cvss: + type: string + author: + title: Committer + description: Metaproperties for Git author/committer information. type: object properties: - score: - type: number - vector_string: + date: + type: string + format: date-time + email: type: - string - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string required: - - vector_string - - score - cwes: - type: array - items: - type: object - properties: - cwe_id: - type: string - name: - type: string - required: - - cwe_id - - name - description: - type: string - ghsa_id: - type: string - identifiers: - type: array - items: - type: object - properties: - type: - type: string - value: - type: string - required: - - value - - type - published_at: - type: string - references: - type: array - items: - type: object - properties: - url: - type: string - format: uri - required: - - url - severity: - type: string - summary: - type: string - updated_at: - type: string - vulnerabilities: - type: array - items: - type: object - properties: - first_patched_version: - type: - - object - - 'null' - properties: - identifier: - type: string - required: - - identifier - package: - type: object - properties: - ecosystem: - type: string - name: - type: string - required: - - ecosystem - - name - severity: - type: string - vulnerable_version_range: - type: string - required: - - package - - severity - - vulnerable_version_range - - first_patched_version - withdrawn_at: - type: - - string - - 'null' - required: - - cvss - - cwes - - ghsa_id - - summary - - description - - severity - - identifiers - - references - - published_at - - updated_at - - withdrawn_at - - vulnerabilities - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - security_advisory - webhook-security-advisory-withdrawn: - title: security_advisory withdrawn event - type: object - properties: - action: - type: string - enum: - - withdrawn - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - security_advisory: - description: The details of the security advisory, including summary, description, - and severity. - type: object - properties: - cvss: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. type: object properties: - score: - type: number - vector_string: + date: + type: string + format: date-time + email: type: - string - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string required: - - vector_string - - score - cwes: - type: array - items: - type: object - properties: - cwe_id: - type: string - name: - type: string - required: - - cwe_id - - name - description: - type: string - ghsa_id: - type: string - identifiers: - type: array - items: - type: object - properties: - type: - type: string - value: - type: string - required: - - value - - type - published_at: - type: string - references: - type: array - items: - type: object - properties: - url: - type: string - format: uri - required: - - url - severity: - type: string - summary: + - email + - name + distinct: + description: Whether this commit is distinct from any that have been + pushed before. + type: boolean + id: type: string - updated_at: + message: + description: The commit message. type: string - vulnerabilities: + modified: + description: An array of files modified by the commit. type: array items: - type: object - properties: - first_patched_version: - type: - - object - - 'null' - properties: - identifier: - type: string - required: - - identifier - package: - type: object - properties: - ecosystem: - type: string - name: - type: string - required: - - ecosystem - - name - severity: - type: string - vulnerable_version_range: - type: string - required: - - package - - severity - - vulnerable_version_range - - first_patched_version - withdrawn_at: + type: string + removed: + description: An array of files removed in the commit. + type: array + items: + type: string + timestamp: + description: The ISO 8601 timestamp of the commit. + type: string + format: date-time + tree_id: + type: string + url: + description: URL that points to the commit API resource. type: string + format: uri required: - - cvss - - cwes - - ghsa_id - - summary - - description - - severity - - identifiers - - references - - published_at - - updated_at - - withdrawn_at - - vulnerabilities - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - security_advisory - webhook-security-and-analysis: - title: security_and_analysis event - type: object - properties: - changes: - type: object - properties: - from: - type: object - properties: - security_and_analysis: - "$ref": "#/components/schemas/security-and-analysis" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" + - id + - tree_id + - distinct + - message + - timestamp + - url + - author + - committer installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/full-repository" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - changes - - repository - webhook-sponsorship-cancelled: - title: sponsorship cancelled event - type: object - properties: - action: + pusher: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - name + ref: + description: 'The full git ref that was pushed. Example: `refs/heads/main` + or `refs/tags/v3.14.1`.' type: string - enum: - - cancelled - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - sponsorship: + title: Repository + description: A git repository type: object properties: - created_at: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: type: string - maintainer: + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + custom_properties: type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - node_id: + description: The custom properties that were defined for the repository. + The keys are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + default_branch: + description: The default branch of the repository. type: string - privacy_level: + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are + merged + type: boolean + default: false + deployments_url: type: string - sponsor: - title: User + format: uri + description: + type: + - string + - 'null' + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: + - string + - 'null' + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: + - string + - 'null' + languages_url: + type: string + format: uri + license: + title: License type: - object - 'null' properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: + key: type: string name: type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: + spdx_id: type: string - enum: - - Bot - - User - - Organization url: - type: string + type: + - string + - 'null' format: uri required: - - login - - id - sponsorable: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: + - string + - 'null' + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: title: User type: - object @@ -199539,74 +183146,229 @@ components: required: - login - id - tier: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more information, - see the pending tier change payload. + permissions: type: object properties: - created_at: - type: string - description: - type: string - is_custom_ammount: + admin: type: boolean - is_custom_amount: + maintain: type: boolean - is_one_time: + pull: + type: boolean + push: + type: boolean + triage: type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: - type: string - node_id: - type: string required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + oneOf: + - type: integer + - type: string + format: date-time + type: + - 'null' + - integer + - string + releases_url: + type: string + format: uri-template + role_name: + type: + - string + - 'null' + size: + type: integer + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based + commits + type: boolean required: + - id - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url - created_at - - sponsorable - - sponsor - - privacy_level - - tier + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sender: + "$ref": "#/components/schemas/simple-user-webhooks" required: - - action - - sponsorship - - sender - webhook-sponsorship-created: - title: sponsorship created event + - ref + - before + - after + - created + - deleted + - forced + - base_ref + - compare + - commits + - head_commit + - repository + - pusher + webhook-registry-package-published: type: object properties: action: type: string enum: - - created + - published enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - sponsorship: + registry_package: type: object properties: created_at: + type: + - string + - 'null' + description: + type: + - string + - 'null' + ecosystem: + type: string + html_url: + type: string + id: + type: integer + name: type: string - maintainer: + namespace: + type: string + owner: type: object properties: avatar_url: @@ -199645,598 +183407,1138 @@ components: type: string url: type: string - node_id: - type: string - privacy_level: + required: + - login + - id + - node_id + - avatar_url + - gravatar_id + - url + - html_url + - followers_url + - following_url + - gists_url + - starred_url + - subscriptions_url + - organizations_url + - repos_url + - events_url + - received_events_url + - type + - site_admin + package_type: type: string - sponsor: - title: User + package_version: type: - object - 'null' properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: + author: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - login + - id + - node_id + - avatar_url + - gravatar_id + - url + - html_url + - followers_url + - following_url + - gists_url + - starred_url + - subscriptions_url + - organizations_url + - repos_url + - events_url + - received_events_url + - type + - site_admin + body: + oneOf: + - type: string + - type: object + body_html: type: string - format: uri-template - gists_url: + container_metadata: + type: object + properties: + labels: + type: + - object + - 'null' + manifest: + type: + - object + - 'null' + tag: + type: object + properties: + digest: + type: string + name: + type: string + created_at: type: string - format: uri-template - gravatar_id: + description: type: string + docker_metadata: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: string + draft: + type: boolean html_url: type: string - format: uri id: type: integer - login: + installation_command: type: string - name: + manifest: type: string - node_id: + metadata: + type: array + items: + type: object + additionalProperties: true + name: type: string - organizations_url: + npm_metadata: + type: + - object + - 'null' + properties: + name: + type: string + version: + type: string + npm_user: + type: string + author: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + bugs: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + dependencies: + type: object + dev_dependencies: + type: object + peer_dependencies: + type: object + optional_dependencies: + type: object + description: + type: string + dist: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + git_head: + type: string + homepage: + type: string + license: + type: string + main: + type: string + repository: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + scripts: + type: object + id: + type: string + node_version: + type: string + npm_version: + type: string + has_shrinkwrap: + type: boolean + maintainers: + type: array + items: + type: string + contributors: + type: array + items: + type: string + engines: + type: object + keywords: + type: array + items: + type: string + files: + type: array + items: + type: string + bin: + type: object + man: + type: object + directories: + oneOf: + - type: string + - type: object + type: + - 'null' + - string + - object + os: + type: array + items: + type: string + cpu: + type: array + items: + type: string + readme: + type: string + installation_command: + type: string + release_id: + type: integer + commit_oid: + type: string + published_via_actions: + type: boolean + deleted_by_id: + type: integer + nuget_metadata: + type: + - array + - 'null' + items: + type: object + properties: + id: + oneOf: + - type: string + - type: object + - type: integer + type: + - 'null' + - string + - object + - integer + name: + type: string + value: + oneOf: + - type: boolean + - type: string + - type: integer + - type: object + properties: + url: + type: string + branch: + type: string + commit: + type: string + type: + type: string + package_files: + type: array + items: + type: object + properties: + content_type: + type: string + created_at: + type: string + download_url: + type: string + id: + type: integer + md5: + type: + - string + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + sha256: + type: + - string + - 'null' + size: + type: integer + state: + type: + - string + - 'null' + updated_at: + type: string + required: + - download_url + - id + - name + - sha256 + - sha1 + - md5 + - content_type + - state + - size + - created_at + - updated_at + package_url: type: string - format: uri - received_events_url: + prerelease: + type: boolean + release: + type: object + properties: + author: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + created_at: + type: string + draft: + type: boolean + html_url: + type: string + id: + type: integer + name: + type: + - string + - 'null' + prerelease: + type: boolean + published_at: + type: string + tag_name: + type: string + target_commitish: + type: string + url: + type: string + rubygems_metadata: + type: array + items: + "$ref": "#/components/schemas/webhook-rubygems-metadata" + summary: type: string - format: uri - repos_url: + tag_name: type: string - format: uri - site_admin: - type: boolean - starred_url: + target_commitish: type: string - format: uri-template - subscriptions_url: + target_oid: type: string - format: uri - type: + updated_at: type: string - enum: - - Bot - - User - - Organization - url: + version: type: string - format: uri required: - - login - id - sponsorable: - title: User + - version + - name + - description + - summary + - html_url + - metadata + - package_files + - installation_command + - package_url + registry: type: - object - 'null' properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: + about_url: type: string name: type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri type: type: string - enum: - - Bot - - User - - Organization url: type: string - format: uri - required: - - login - - id - tier: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more information, - see the pending tier change payload. - type: object - properties: - created_at: - type: string - description: - type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: - type: string - node_id: + vendor: type: string - required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time + updated_at: + type: + - string + - 'null' required: - - node_id + - id + - name + - namespace + - description + - ecosystem + - package_type + - html_url - created_at - - sponsorable - - sponsor - - privacy_level - - tier + - updated_at + - owner + - package_version + - registry + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - sponsorship + - registry_package - sender - webhook-sponsorship-edited: - title: sponsorship edited event + webhook-registry-package-updated: type: object properties: action: type: string enum: - - edited - changes: - type: object - properties: - privacy_level: - type: object - properties: - from: - description: The `edited` event types include the details about - the change when someone edits a sponsorship to change the privacy. - type: string - required: - - from + - updated enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - sponsorship: + registry_package: type: object properties: created_at: type: string - maintainer: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - node_id: - type: string - privacy_level: - type: string - sponsor: - title: User + description: type: - - object - 'null' + ecosystem: + type: string + html_url: + type: string + id: + type: integer + name: + type: string + namespace: + type: string + owner: + type: object properties: avatar_url: type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' events_url: type: string - format: uri-template followers_url: type: string - format: uri following_url: type: string - format: uri-template gists_url: type: string - format: uri-template gravatar_id: type: string html_url: type: string - format: uri id: type: integer login: type: string - name: - type: string node_id: type: string organizations_url: type: string - format: uri received_events_url: type: string - format: uri repos_url: type: string - format: uri site_admin: type: boolean starred_url: type: string - format: uri-template subscriptions_url: type: string - format: uri type: type: string - enum: - - Bot - - User - - Organization url: type: string - format: uri required: - login - id - sponsorable: - title: User - type: - - object - - 'null' + - node_id + - avatar_url + - gravatar_id + - url + - html_url + - followers_url + - following_url + - gists_url + - starred_url + - subscriptions_url + - organizations_url + - repos_url + - events_url + - received_events_url + - type + - site_admin + package_type: + type: string + package_version: + type: object properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: + author: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - login + - id + - node_id + - avatar_url + - gravatar_id + - url + - html_url + - followers_url + - following_url + - gists_url + - starred_url + - subscriptions_url + - organizations_url + - repos_url + - events_url + - received_events_url + - type + - site_admin + body: type: string - format: uri - following_url: + body_html: type: string - format: uri-template - gists_url: + created_at: type: string - format: uri-template - gravatar_id: + description: type: string + docker_metadata: + type: array + items: + type: + - object + - 'null' + properties: + tags: + type: array + items: + type: string + draft: + type: boolean html_url: type: string - format: uri id: type: integer - login: - type: string - name: - type: string - node_id: + installation_command: type: string - organizations_url: + manifest: type: string - format: uri - received_events_url: + metadata: + type: array + items: + type: object + additionalProperties: true + name: type: string - format: uri - repos_url: + package_files: + type: array + items: + type: object + properties: + content_type: + type: string + created_at: + type: string + download_url: + type: string + id: + type: integer + md5: + type: + - string + - 'null' + name: + type: string + sha1: + type: + - string + - 'null' + sha256: + type: string + size: + type: integer + state: + type: string + updated_at: + type: string + package_url: type: string - format: uri - site_admin: + prerelease: type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: + release: + type: object + properties: + author: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - login + - id + - node_id + - avatar_url + - gravatar_id + - url + - html_url + - followers_url + - following_url + - gists_url + - starred_url + - subscriptions_url + - organizations_url + - repos_url + - events_url + - received_events_url + - type + - site_admin + created_at: + type: string + draft: + type: boolean + html_url: + type: string + id: + type: integer + name: + type: string + prerelease: + type: boolean + published_at: + type: string + tag_name: + type: string + target_commitish: + type: string + url: + type: string + required: + - url + - html_url + - id + - tag_name + - target_commitish + - name + - draft + - author + - prerelease + - created_at + - published_at + rubygems_metadata: + type: array + items: + "$ref": "#/components/schemas/webhook-rubygems-metadata" + summary: type: string - enum: - - Bot - - User - - Organization - url: + tag_name: type: string - format: uri - required: - - login - - id - tier: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more information, - see the pending tier change payload. - type: object - properties: - created_at: + target_commitish: type: string - description: + target_oid: type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: + updated_at: type: string - node_id: + version: type: string required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars + - id + - version - name - - is_one_time + - description + - summary + - body + - body_html + - html_url + - target_commitish + - target_oid + - created_at + - updated_at + - metadata + - package_files + - author + - installation_command + - package_url + registry: + type: + - object + - 'null' + updated_at: + type: string required: - - node_id + - id + - name + - namespace + - description + - ecosystem + - package_type + - html_url - created_at - - sponsorable - - sponsor - - privacy_level - - tier + - updated_at + - owner + - package_version + - registry + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - changes - - sponsorship + - registry_package - sender - webhook-sponsorship-pending-cancellation: - title: sponsorship pending_cancellation event + webhook-release-created: + title: release created event type: object properties: action: type: string enum: - - pending_cancellation - effective_date: - description: The `pending_cancellation` and `pending_tier_change` event - types will include the date the cancellation or tier change will take - effect. + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + release: + "$ref": "#/components/schemas/webhooks_release" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - release + - repository + - sender + webhook-release-deleted: + title: release deleted event + type: object + properties: + action: type: string + enum: + - deleted enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" + release: + "$ref": "#/components/schemas/webhooks_release" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" - sponsorship: + required: + - action + - release + - repository + - sender + webhook-release-edited: + title: release edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: type: object properties: - created_at: - type: string - maintainer: + body: type: object properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: + from: + description: The previous version of the body if the action was + `edited`. type: string - node_id: - type: string - privacy_level: - type: string - sponsor: - title: User - type: - - object - - 'null' + required: + - from + name: + type: object properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: + from: + description: The previous version of the name if the action was + `edited`. type: string - format: uri - site_admin: + required: + - from + make_latest: + type: object + properties: + to: + description: Whether this release was explicitly `edited` to be + the latest. type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri required: - - login - - id - sponsorable: + - to + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + release: + "$ref": "#/components/schemas/webhooks_release" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - release + - repository + webhook-release-prereleased: + title: release prereleased event + type: object + properties: + action: + type: string + enum: + - prereleased + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + release: + title: Release + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) + object. + type: object + required: + - assets + - assets_url + - author + - body + - created_at + - draft + - html_url + - id + - name + - node_id + - prerelease + - published_at + - tag_name + - tarball_url + - target_commitish + - upload_url + - url + - zipball_url + properties: + assets: + type: array + items: + title: Release Asset + description: Data related to a release. + type: + - object + - 'null' + required: + - url + - browser_download_url + - id + - node_id + - name + - label + - state + - content_type + - size + - download_count + - created_at + - updated_at + properties: + browser_download_url: + type: string + format: uri + content_type: + type: string + created_at: + type: string + format: date-time + download_count: + type: integer + id: + type: integer + label: + type: + - string + - 'null' + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + url: + type: string + format: uri + assets_url: + type: string + format: uri + author: title: User type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -200298,109 +184600,506 @@ components: url: type: string format: uri - required: - - login - - id - tier: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more information, - see the pending tier change payload. + body: + type: + - string + - 'null' + created_at: + type: + - string + - 'null' + format: date-time + discussion_url: + type: string + format: uri + draft: + description: Whether the release is a draft or published + type: boolean + html_url: + type: string + format: uri + id: + type: integer + name: + type: + - string + - 'null' + node_id: + type: string + prerelease: + description: Whether the release is identified as a prerelease or a + full release. + type: boolean + enum: + - true + published_at: + type: + - string + - 'null' + format: date-time + reactions: + title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: - created_at: - type: string - description: - type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: + "+1": type: integer - monthly_price_in_dollars: + "-1": type: integer - name: + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: type: string - node_id: + format: uri + tag_name: + description: The name of the tag. + type: string + tarball_url: + type: + - string + - 'null' + format: uri + target_commitish: + description: Specifies the commitish value that determines where the + Git tag is created from. + type: string + upload_url: + type: string + format: uri-template + url: + type: string + format: uri + zipball_url: + type: + - string + - 'null' + format: uri + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - release + - repository + webhook-release-published: + title: release published event + type: object + properties: + action: + type: string + enum: + - published + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + release: + "$ref": "#/components/schemas/webhooks_release_1" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - release + - repository + webhook-release-released: + title: release released event + type: object + properties: + action: + type: string + enum: + - released + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + release: + "$ref": "#/components/schemas/webhooks_release" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - release + - repository + webhook-release-unpublished: + title: release unpublished event + type: object + properties: + action: + type: string + enum: + - unpublished + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + release: + "$ref": "#/components/schemas/webhooks_release_1" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - release + - repository + webhook-repository-advisory-published: + title: Repository advisory published event + type: object + properties: + action: + type: string + enum: + - published + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_advisory: + "$ref": "#/components/schemas/repository-advisory" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - repository_advisory + webhook-repository-advisory-reported: + title: Repository advisory reported event + type: object + properties: + action: + type: string + enum: + - reported + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_advisory: + "$ref": "#/components/schemas/repository-advisory" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - repository_advisory + webhook-repository-archived: + title: repository archived event + type: object + properties: + action: + type: string + enum: + - archived + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-repository-created: + title: repository created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-repository-deleted: + title: repository deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-repository-dispatch-sample: + title: repository_dispatch event + type: object + properties: + action: + type: string + description: The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` + request body. + branch: + type: string + client_payload: + type: + - object + - 'null' + additionalProperties: true + description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` + request body. + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - branch + - client_payload + - repository + - sender + - installation + webhook-repository-edited: + title: repository edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + type: object + properties: + default_branch: + type: object + properties: + from: type: string required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time - required: - - node_id - - created_at - - sponsorable - - sponsor - - privacy_level - - tier + - from + description: + type: object + properties: + from: + type: + - string + - 'null' + required: + - from + homepage: + type: object + properties: + from: + type: + - string + - 'null' + required: + - from + topics: + type: object + properties: + from: + type: + - array + - 'null' + items: + type: string + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - sponsorship + - changes + - repository - sender - webhook-sponsorship-pending-tier-change: - title: sponsorship pending_tier_change event + webhook-repository-import: + title: repository_import event + type: object + properties: + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + status: + type: string + enum: + - success + - cancelled + - failure + required: + - status + - repository + - sender + webhook-repository-privatized: + title: repository privatized event type: object properties: action: type: string enum: - - pending_tier_change + - privatized + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-repository-publicized: + title: repository publicized event + type: object + properties: + action: + type: string + enum: + - publicized + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-repository-renamed: + title: repository renamed event + type: object + properties: + action: + type: string + enum: + - renamed changes: type: object properties: - tier: + repository: type: object properties: - from: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more - information, see the pending tier change payload. + name: type: object properties: - created_at: - type: string - description: - type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: - type: string - node_id: + from: type: string required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time + - from required: - - from + - name required: - - tier - effective_date: - description: The `pending_cancellation` and `pending_tier_change` event - types will include the date the cancellation or tier change will take - effect. + - repository + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - repository + - sender + webhook-repository-ruleset-created: + title: repository ruleset created event + type: object + properties: + action: type: string + enum: + - created enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -200409,130 +185108,412 @@ components: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" + repository_ruleset: + "$ref": "#/components/schemas/repository-ruleset" sender: "$ref": "#/components/schemas/simple-user-webhooks" - sponsorship: + required: + - action + - repository_ruleset + - sender + webhook-repository-ruleset-deleted: + title: repository ruleset deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_ruleset: + "$ref": "#/components/schemas/repository-ruleset" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository_ruleset + - sender + webhook-repository-ruleset-edited: + title: repository ruleset edited event + type: object + properties: + action: + type: string + enum: + - edited + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_ruleset: + "$ref": "#/components/schemas/repository-ruleset" + changes: type: object properties: - created_at: - type: string - maintainer: + name: type: object properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: + from: type: string - url: + enforcement: + type: object + properties: + from: type: string - node_id: + conditions: + type: object + properties: + added: + type: array + items: + "$ref": "#/components/schemas/repository-ruleset-conditions" + deleted: + type: array + items: + "$ref": "#/components/schemas/repository-ruleset-conditions" + updated: + type: array + items: + type: object + properties: + condition: + "$ref": "#/components/schemas/repository-ruleset-conditions" + changes: + type: object + properties: + condition_type: + type: object + properties: + from: + type: string + target: + type: object + properties: + from: + type: string + include: + type: object + properties: + from: + type: array + items: + type: string + exclude: + type: object + properties: + from: + type: array + items: + type: string + rules: + type: object + properties: + added: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + deleted: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + updated: + type: array + items: + type: object + properties: + rule: + "$ref": "#/components/schemas/repository-rule" + changes: + type: object + properties: + configuration: + type: object + properties: + from: + type: string + rule_type: + type: object + properties: + from: + type: string + pattern: + type: object + properties: + from: + type: string + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository_ruleset + - sender + webhook-repository-transferred: + title: repository transferred event + type: object + properties: + action: + type: string + enum: + - transferred + changes: + type: object + properties: + owner: + type: object + properties: + from: + type: object + properties: + organization: + title: Organization + type: object + properties: + avatar_url: + type: string + format: uri + description: + type: + - string + - 'null' + events_url: + type: string + format: uri + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + issues_url: + type: string + format: uri + login: + type: string + members_url: + type: string + format: uri-template + node_id: + type: string + public_members_url: + type: string + format: uri-template + repos_url: + type: string + format: uri + url: + type: string + format: uri + required: + - login + - id + - node_id + - url + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + user: + title: User + type: + - object + - 'null' + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - from + required: + - owner + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - repository + - sender + webhook-repository-unarchived: + title: repository unarchived event + type: object + properties: + action: + type: string + enum: + - unarchived + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-repository-vulnerability-alert-create: + title: repository_vulnerability_alert create event + type: object + properties: + action: + type: string + enum: + - create + alert: + "$ref": "#/components/schemas/webhooks_alert" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-repository-vulnerability-alert-dismiss: + title: repository_vulnerability_alert dismiss event + type: object + properties: + action: + type: string + enum: + - dismiss + alert: + title: Repository Vulnerability Alert Alert + description: The security alert of the vulnerable dependency. + type: object + required: + - affected_package_name + - affected_range + - created_at + - dismiss_reason + - dismissed_at + - dismisser + - external_identifier + - external_reference + - ghsa_id + - id + - node_id + - number + - severity + - state + properties: + affected_package_name: type: string - privacy_level: + affected_range: type: string - sponsor: - title: User + created_at: + type: string + dismiss_comment: type: - - object + - string - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - sponsorable: + dismiss_reason: + type: string + dismissed_at: + type: string + dismisser: title: User type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -200594,105 +185575,59 @@ components: url: type: string format: uri - required: - - login - - id - tier: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more information, - see the pending tier change payload. - type: object - properties: - created_at: - type: string - description: - type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: - type: string - node_id: - type: string - required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time - required: - - node_id - - created_at - - sponsorable - - sponsor - - privacy_level - - tier + external_identifier: + type: string + external_reference: + type: + - string + - 'null' + format: uri + fix_reason: + type: string + fixed_at: + type: string + format: date-time + fixed_in: + type: string + ghsa_id: + type: string + id: + type: integer + node_id: + type: string + number: + type: integer + severity: + type: string + state: + type: string + enum: + - dismissed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - changes - - sponsorship + - alert + - repository - sender - webhook-sponsorship-tier-changed: - title: sponsorship tier_changed event + webhook-repository-vulnerability-alert-reopen: + title: repository_vulnerability_alert reopen event type: object properties: action: type: string enum: - - tier_changed - changes: - type: object - properties: - tier: - type: object - properties: - from: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more - information, see the pending tier change payload. - type: object - properties: - created_at: - type: string - description: - type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: - type: string - node_id: - type: string - required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time - required: - - from - required: - - tier + - reopen + alert: + "$ref": "#/components/schemas/webhooks_alert" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -200703,59 +185638,54 @@ components: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" - sponsorship: + required: + - action + - alert + - repository + - sender + webhook-repository-vulnerability-alert-resolve: + title: repository_vulnerability_alert resolve event + type: object + properties: + action: + type: string + enum: + - resolve + alert: + title: Repository Vulnerability Alert Alert + description: The security alert of the vulnerable dependency. type: object + required: + - affected_package_name + - affected_range + - created_at + - external_identifier + - external_reference + - ghsa_id + - id + - node_id + - number + - severity + - state properties: + affected_package_name: + type: string + affected_range: + type: string created_at: type: string - maintainer: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - node_id: + dismiss_reason: type: string - privacy_level: + dismissed_at: type: string - sponsor: + dismisser: title: User type: - object - 'null' + required: + - login + - id properties: avatar_url: type: string @@ -200817,118 +185747,570 @@ components: url: type: string format: uri - required: - - login - - id - sponsorable: - title: User + external_identifier: + type: string + external_reference: type: - - object + - string - 'null' + format: uri + fix_reason: + type: string + fixed_at: + type: string + format: date-time + fixed_in: + type: string + ghsa_id: + type: string + id: + type: integer + node_id: + type: string + number: + type: integer + severity: + type: string + state: + type: string + enum: + - fixed + - open + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-secret-scanning-alert-created: + title: secret_scanning_alert created event + type: object + properties: + action: + type: string + enum: + - created + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + webhook-secret-scanning-alert-location-created: + title: Secret Scanning Alert Location Created Event + type: object + properties: + action: + type: string + enum: + - created + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + installation: + "$ref": "#/components/schemas/simple-installation" + location: + "$ref": "#/components/schemas/secret-scanning-location" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - location + - alert + - repository + - sender + webhook-secret-scanning-alert-location-created-form-encoded: + title: Secret Scanning Alert Location Created Event + type: object + properties: + payload: + description: A URL-encoded string of the secret_scanning_alert_location.created + JSON payload. The decoded payload is a JSON object. + type: string + required: + - payload + webhook-secret-scanning-alert-reopened: + title: secret_scanning_alert reopened event + type: object + properties: + action: + type: string + enum: + - reopened + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + webhook-secret-scanning-alert-resolved: + title: secret_scanning_alert resolved event + type: object + properties: + action: + type: string + enum: + - resolved + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + webhook-secret-scanning-alert-revoked: + title: secret_scanning_alert revoked event + type: object + properties: + action: + type: string + enum: + - revoked + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + webhook-secret-scanning-alert-validated: + title: secret_scanning_alert validated event + type: object + properties: + action: + type: string + enum: + - validated + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + webhook-security-advisory-published: + title: security_advisory published event + type: object + properties: + action: + type: string + enum: + - published + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + security_advisory: + "$ref": "#/components/schemas/webhooks_security_advisory" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - security_advisory + webhook-security-advisory-updated: + title: security_advisory updated event + type: object + properties: + action: + type: string + enum: + - updated + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + security_advisory: + "$ref": "#/components/schemas/webhooks_security_advisory" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - security_advisory + webhook-security-advisory-withdrawn: + title: security_advisory withdrawn event + type: object + properties: + action: + type: string + enum: + - withdrawn + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + security_advisory: + description: The details of the security advisory, including summary, description, + and severity. + type: object + properties: + cvss: + type: object properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + score: + type: number + vector_string: type: - string - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri required: - - login - - id - tier: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more information, - see the pending tier change payload. + - vector_string + - score + cwes: + type: array + items: + type: object + properties: + cwe_id: + type: string + name: + type: string + required: + - cwe_id + - name + description: + type: string + ghsa_id: + type: string + identifiers: + type: array + items: + type: object + properties: + type: + type: string + value: + type: string + required: + - value + - type + published_at: + type: string + references: + type: array + items: + type: object + properties: + url: + type: string + format: uri + required: + - url + severity: + type: string + summary: + type: string + updated_at: + type: string + vulnerabilities: + type: array + items: + type: object + properties: + first_patched_version: + type: + - object + - 'null' + properties: + identifier: + type: string + required: + - identifier + package: + type: object + properties: + ecosystem: + type: string + name: + type: string + required: + - ecosystem + - name + severity: + type: string + vulnerable_version_range: + type: string + required: + - package + - severity + - vulnerable_version_range + - first_patched_version + withdrawn_at: + type: string + required: + - cvss + - cwes + - ghsa_id + - summary + - description + - severity + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + - vulnerabilities + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - security_advisory + webhook-security-and-analysis: + title: security_and_analysis event + type: object + properties: + changes: + type: object + properties: + from: type: object properties: - created_at: - type: string - description: - type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: - type: string - node_id: + security_and_analysis: + "$ref": "#/components/schemas/security-and-analysis" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/full-repository" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - changes + - repository + webhook-sponsorship-cancelled: + title: sponsorship cancelled event + type: object + properties: + action: + type: string + enum: + - cancelled + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + sponsorship: + "$ref": "#/components/schemas/webhooks_sponsorship" + required: + - action + - sponsorship + - sender + webhook-sponsorship-created: + title: sponsorship created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + sponsorship: + "$ref": "#/components/schemas/webhooks_sponsorship" + required: + - action + - sponsorship + - sender + webhook-sponsorship-edited: + title: sponsorship edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + type: object + properties: + privacy_level: + type: object + properties: + from: + description: The `edited` event types include the details about + the change when someone edits a sponsorship to change the privacy. type: string required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time - required: - - node_id - - created_at - - sponsorable - - sponsor - - privacy_level - - tier + - from + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + sponsorship: + "$ref": "#/components/schemas/webhooks_sponsorship" + required: + - action + - changes + - sponsorship + - sender + webhook-sponsorship-pending-cancellation: + title: sponsorship pending_cancellation event + type: object + properties: + action: + type: string + enum: + - pending_cancellation + effective_date: + "$ref": "#/components/schemas/webhooks_effective_date" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + sponsorship: + "$ref": "#/components/schemas/webhooks_sponsorship" + required: + - action + - sponsorship + - sender + webhook-sponsorship-pending-tier-change: + title: sponsorship pending_tier_change event + type: object + properties: + action: + type: string + enum: + - pending_tier_change + changes: + "$ref": "#/components/schemas/webhooks_changes_8" + effective_date: + "$ref": "#/components/schemas/webhooks_effective_date" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + sponsorship: + "$ref": "#/components/schemas/webhooks_sponsorship" + required: + - action + - changes + - sponsorship + - sender + webhook-sponsorship-tier-changed: + title: sponsorship tier_changed event + type: object + properties: + action: + type: string + enum: + - tier_changed + changes: + "$ref": "#/components/schemas/webhooks_changes_8" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + sponsorship: + "$ref": "#/components/schemas/webhooks_sponsorship" required: - action - changes @@ -201408,122 +186790,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when their - team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team_1" required: - team - repository @@ -202010,122 +187277,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when their - team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team_1" required: - action - team @@ -202612,122 +187764,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when their - team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team_1" required: - action - team @@ -203215,122 +188252,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when their - team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team_1" required: - action - team @@ -203882,122 +188804,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when their - team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team_1" required: - action - changes @@ -204486,122 +189293,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: - - object - - 'null' - properties: - description: - description: Description of the team - type: - - string - - 'null' - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when their - team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team_1" required: - action - team @@ -205592,1437 +190284,936 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" workflow: - title: Workflow - type: - - object - - 'null' - properties: - badge_url: - type: string - format: uri - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - node_id: - type: string - path: - type: string - state: - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri + "$ref": "#/components/schemas/webhooks_workflow" + workflow_run: + title: Workflow Run + type: object required: - - badge_url + - actor + - artifacts_url + - cancel_url + - check_suite_id + - check_suite_node_id + - check_suite_url + - conclusion - created_at + - event + - head_branch + - head_commit + - head_repository + - head_sha - html_url - id + - jobs_url + - logs_url - name - node_id - path - - state + - previous_attempt_url + - pull_requests + - repository + - rerun_url + - run_attempt + - run_number + - run_started_at + - status + - triggering_actor - updated_at - url - workflow_run: - allOf: - - title: Workflow Run - type: object - properties: - actor: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + - workflow_id + - workflow_url + properties: + actor: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - artifacts_url: - type: string - format: uri - cancel_url: - type: string - format: uri - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - format: uri - conclusion: - type: - - string - - 'null' - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - - - skipped - created_at: - type: string - format: date-time - event: - type: string - head_branch: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - head_commit: - title: SimpleCommit - type: object - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - required: - - id - - tree_id - - message - - timestamp - - author - - committer - head_repository: - title: Repository Lite - type: object - properties: - archive_url: - type: string - format: uri-template - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + artifacts_url: + type: string + format: uri + cancel_url: + type: string + format: uri + check_suite_id: + type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + format: uri + conclusion: + type: + - string + - 'null' + enum: + - action_required + - cancelled + - failure + - neutral + - skipped + - stale + - success + - timed_out + - + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: + - string + - 'null' + head_commit: + title: SimpleCommit + type: object + required: + - id + - tree_id + - message + - timestamp + - author + - committer + properties: + author: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + required: + - email + - name + properties: + date: + type: string + format: date-time + email: type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - private: - description: Whether the repository is private or public. - type: boolean - pulls_url: - type: string - format: uri-template - releases_url: - type: string - format: uri-template - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - format: uri-template - url: - type: string - format: uri - 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 - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - node_id - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - jobs_url: - type: string - format: uri - logs_url: - type: string - format: uri - name: - type: - - string - - 'null' - node_id: - type: string - path: - type: string - previous_attempt_url: - type: - - string - - 'null' - format: uri - pull_requests: - type: array - items: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + committer: + title: Committer + description: Metaproperties for Git author/committer information. type: object + required: + - email + - name properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: number - number: - type: number - url: + date: type: string - format: uri + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + id: + type: string + message: + type: string + timestamp: + type: string + tree_id: + type: string + head_repository: + title: Repository Lite + type: object + 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 + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - node_id + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + properties: + archive_url: + type: string + format: uri-template + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + languages_url: + type: string + format: uri + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + owner: + title: User + type: + - object + - 'null' required: - - url + - login - id - - number - - head - - base - referenced_workflows: - type: - - array - - 'null' - items: - type: object properties: - path: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: type: string - ref: + format: uri + repos_url: type: string - sha: + format: uri + site_admin: + type: boolean + starred_url: type: string - required: - - path - - sha - repository: - title: Repository Lite - type: object - properties: - archive_url: - type: string - format: uri-template - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - owner: - title: User + format: uri-template + subscriptions_url: + type: string + format: uri type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - private: - description: Whether the repository is private or public. - type: boolean - pulls_url: - type: string - format: uri-template - releases_url: - type: string - format: uri-template - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - format: uri-template - url: - type: string - format: uri - 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 - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - node_id - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - rerun_url: - type: string - format: uri - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: - type: string - enum: - - requested - - in_progress - - completed - - queued - - pending - - waiting - triggering_actor: - title: User + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + private: + description: Whether the repository is private or public. + type: boolean + pulls_url: + type: string + format: uri-template + releases_url: + type: string + format: uri-template + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + trees_url: + type: string + format: uri-template + url: + type: string + format: uri + head_sha: + type: string + html_url: + type: string + format: uri + id: + type: integer + jobs_url: + type: string + format: uri + logs_url: + type: string + format: uri + name: + type: + - string + - 'null' + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + format: uri + pull_requests: + type: array + items: type: - object - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri required: - - login + - url - id - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - format: uri - required: - - artifacts_url - - cancel_url - - check_suite_url - - check_suite_id - - check_suite_node_id - - conclusion - - created_at - - event - - head_branch - - head_commit - - head_repository - - head_sha - - html_url - - id - - jobs_url - - logs_url - - node_id - - name - - path - - pull_requests - - repository - - rerun_url - - run_number - - status - - updated_at - - url - - workflow_id - - workflow_url - - run_attempt - - run_started_at - - previous_attempt_url - - actor - - triggering_actor - - type: object - properties: - actor: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - conclusion: - type: string - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - skipped - created_at: - type: string - event: - type: string - head_branch: - type: - - string - - 'null' - head_commit: - type: object + - number + - head + - base properties: - author: + base: type: object + required: + - ref + - sha + - repo properties: - email: + ref: type: string - name: + repo: + title: Repo Ref + type: object + required: + - id + - url + - name + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + sha: type: string - committer: + head: type: object + required: + - ref + - sha + - repo properties: - email: + ref: type: string - name: + repo: + title: Repo Ref + type: object + required: + - id + - url + - name + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + sha: type: string id: + type: number + number: + type: number + url: type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - head_repository: + format: uri + referenced_workflows: + type: + - array + - 'null' + items: type: object + required: + - path + - sha properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: - - string - - 'null' - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: + path: type: string - trees_url: + ref: type: string - url: + sha: type: string - head_sha: - type: string - html_url: - type: string - id: - type: integer - jobs_url: - type: string - logs_url: - type: string - name: - type: - - string - - 'null' - node_id: - type: string - path: - type: string - previous_attempt_url: - type: - - string - - 'null' - pull_requests: - type: array - items: + repository: + title: Repository Lite + type: object + 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 + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - node_id + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + properties: + archive_url: + type: string + format: uri-template + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + languages_url: + type: string + format: uri + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + owner: + title: User type: - object - 'null' - referenced_workflows: - type: - - array - - 'null' - items: - type: object + required: + - login + - id properties: - path: + avatar_url: type: string - ref: + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: type: string - sha: + format: uri-template + followers_url: type: string - required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: - type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - status: - type: string - triggering_actor: - type: - - object - - 'null' - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + private: + description: Whether the repository is private or public. + type: boolean + pulls_url: + type: string + format: uri-template + releases_url: + type: string + format: uri-template + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + trees_url: + type: string + format: uri-template + url: + type: string + format: uri + rerun_url: + type: string + format: uri + run_attempt: + type: integer + run_number: + type: integer + run_started_at: + type: string + format: date-time + status: + type: string + enum: + - requested + - in_progress + - completed + - queued + - pending + - waiting + triggering_actor: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - type: string - url: - type: string - updated_at: - type: string - url: - type: string - workflow_id: - type: integer - workflow_url: - type: string - required: - - conclusion + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + format: uri + display_title: + type: string + description: The event-specific title associated with the run or the + run-name if set, or the value of `run-name` if it is set in the workflow. + examples: + - Simple Workflow required: - action - repository @@ -207048,1439 +191239,931 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" workflow: - title: Workflow - type: - - object - - 'null' - properties: - badge_url: - type: string - format: uri - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - node_id: - type: string - path: - type: string - state: - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri + "$ref": "#/components/schemas/webhooks_workflow" + workflow_run: + title: Workflow Run + type: object required: - - badge_url + - actor + - artifacts_url + - cancel_url + - check_suite_id + - check_suite_node_id + - check_suite_url + - conclusion - created_at + - event + - head_branch + - head_commit + - head_repository + - head_sha - html_url - id + - jobs_url + - logs_url - name - node_id - path - - state + - previous_attempt_url + - pull_requests + - repository + - rerun_url + - run_attempt + - run_number + - run_started_at + - status + - triggering_actor - updated_at - url - workflow_run: - allOf: - - title: Workflow Run - type: object - properties: - actor: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + - workflow_id + - workflow_url + properties: + actor: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - artifacts_url: - type: string - format: uri - cancel_url: - type: string - format: uri - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - format: uri - conclusion: - type: - - string - - 'null' - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - skipped - - - created_at: - type: string - format: date-time - event: - type: string - head_branch: - type: - - string - - 'null' - head_commit: - title: SimpleCommit - type: object - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: - - string - - 'null' - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - required: - - id - - tree_id - - message - - timestamp - - author - - committer - head_repository: - title: Repository Lite - type: object - properties: - archive_url: - type: string - format: uri-template - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - private: - description: Whether the repository is private or public. - type: boolean - pulls_url: - type: string - format: uri-template - releases_url: - type: string - format: uri-template - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - format: uri-template - url: - type: string - format: uri - 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 - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - node_id - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - jobs_url: - type: string - format: uri - logs_url: - type: string - format: uri - name: - type: - - string - - 'null' - node_id: - type: string - path: - type: string - previous_attempt_url: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - format: uri - pull_requests: - type: array - items: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + artifacts_url: + type: string + format: uri + cancel_url: + type: string + format: uri + check_suite_id: + type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + format: uri + conclusion: + type: + - string + - 'null' + enum: + - action_required + - cancelled + - failure + - neutral + - skipped + - stale + - success + - timed_out + - + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: + - string + - 'null' + head_commit: + title: SimpleCommit + type: object + required: + - id + - tree_id + - message + - timestamp + - author + - committer + properties: + author: + title: Committer + description: Metaproperties for Git author/committer information. type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: number - number: - type: number - url: - type: string - format: uri required: - - url - - id - - number - - head - - base - referenced_workflows: - type: - - array - - 'null' - items: - type: object + - email + - name properties: - path: + date: type: string - ref: + format: date-time + email: + type: + - string + - 'null' + format: email + name: + description: The git author's name. type: string - sha: + username: type: string + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object required: - - path - - sha - repository: - title: Repository Lite - type: object - properties: - archive_url: - type: string - format: uri-template - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: - - string - - 'null' - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - owner: - title: User - type: - - object - - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri + - email + - name + properties: + date: + type: string + format: date-time + email: type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - private: - description: Whether the repository is private or public. - type: boolean - pulls_url: - type: string - format: uri-template - releases_url: - type: string - format: uri-template - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - format: uri-template - url: - type: string - format: uri - 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 - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - node_id - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - rerun_url: - type: string - format: uri - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: - type: string - enum: - - requested - - in_progress - - completed - - queued - - pending - triggering_actor: - title: User + - string + - 'null' + format: email + name: + description: The git author's name. + type: string + username: + type: string + id: + type: string + message: + type: string + timestamp: + type: string + tree_id: + type: string + head_repository: + title: Repository Lite + type: object + 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 + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - node_id + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + properties: + archive_url: + type: string + format: uri-template + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + languages_url: + type: string + format: uri + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + name: + description: The name of the repository. + type: + - string + - 'null' + node_id: + type: string + notifications_url: + type: string + format: uri-template + owner: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + private: + description: Whether the repository is private or public. + type: boolean + pulls_url: + type: string + format: uri-template + releases_url: + type: string + format: uri-template + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + trees_url: + type: string + format: uri-template + url: + type: string + format: uri + head_sha: + type: string + html_url: + type: string + format: uri + id: + type: integer + jobs_url: + type: string + format: uri + logs_url: + type: string + format: uri + name: + type: + - string + - 'null' + node_id: + type: string + path: + type: string + previous_attempt_url: + type: + - string + - 'null' + format: uri + pull_requests: + type: array + items: type: - object - 'null' - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: - - string - - 'null' - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri required: - - login + - url - id - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - format: uri - required: - - artifacts_url - - cancel_url - - check_suite_url - - check_suite_id - - check_suite_node_id - - conclusion - - created_at - - event - - head_branch - - head_commit - - head_repository - - head_sha - - html_url - - id - - jobs_url - - logs_url - - node_id - - name - - path - - pull_requests - - repository - - rerun_url - - run_number - - status - - updated_at - - url - - workflow_id - - workflow_url - - run_attempt - - run_started_at - - previous_attempt_url - - actor - - triggering_actor - - type: object - properties: - actor: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - conclusion: - type: - - string - - 'null' - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - skipped - - stale - - - created_at: - type: string - event: - type: string - head_branch: - type: - - string - - 'null' - head_commit: - type: object + - number + - head + - base properties: - author: + base: type: object + required: + - ref + - sha + - repo properties: - email: + ref: type: string - name: + repo: + title: Repo Ref + type: object + required: + - id + - url + - name + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + sha: type: string - committer: + head: type: object + required: + - ref + - sha + - repo properties: - email: + ref: type: string - name: + repo: + title: Repo Ref + type: object + required: + - id + - url + - name + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + sha: type: string id: + type: number + number: + type: number + url: type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - head_repository: + format: uri + referenced_workflows: + type: + - array + - 'null' + items: type: object + required: + - path + - sha properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: - - string - - 'null' - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: - - string - - 'null' - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: + path: type: string - trees_url: + ref: type: string - url: + sha: type: string - head_sha: - type: string - html_url: - type: string - id: - type: integer - jobs_url: - type: string - logs_url: - type: string - name: - type: - - string - - 'null' - node_id: - type: string - path: - type: string - previous_attempt_url: - type: - - string - - 'null' - pull_requests: - type: array - items: + repository: + title: Repository Lite + type: object + 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 + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - node_id + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + properties: + archive_url: + type: string + format: uri-template + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + deployments_url: + type: string + format: uri + description: + type: + - string + - 'null' + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + languages_url: + type: string + format: uri + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + owner: + title: User type: - object - 'null' - referenced_workflows: - type: - - array - - 'null' - items: - type: object + required: + - login + - id properties: - path: + avatar_url: type: string - ref: + format: uri + deleted: + type: boolean + email: + type: + - string + - 'null' + events_url: type: string - sha: + format: uri-template + followers_url: type: string - required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri type: - - string - - 'null' - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: - type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - status: - type: string - triggering_actor: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + private: + description: Whether the repository is private or public. + type: boolean + pulls_url: + type: string + format: uri-template + releases_url: + type: string + format: uri-template + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + trees_url: + type: string + format: uri-template + url: + type: string + format: uri + rerun_url: + type: string + format: uri + run_attempt: + type: integer + run_number: + type: integer + run_started_at: + type: string + format: date-time + status: + type: string + enum: + - requested + - in_progress + - completed + - queued + - pending + triggering_actor: + title: User + type: + - object + - 'null' + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: - type: string - url: - type: string - updated_at: - type: string - url: - type: string - workflow_id: - type: integer - workflow_url: - type: string - required: - - conclusion + - string + - 'null' + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + format: uri required: - action - repository @@ -208506,47 +192189,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" workflow: - title: Workflow - type: - - object - - 'null' - properties: - badge_url: - type: string - format: uri - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - node_id: - type: string - path: - type: string - state: - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - badge_url - - created_at - - html_url - - id - - name - - node_id - - path - - state - - updated_at - - url + "$ref": "#/components/schemas/webhooks_workflow" workflow_run: title: Workflow Run type: object @@ -212250,6 +195893,70 @@ 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-usage-metrics-enterprise: + 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 dependabot-alerts-for-organization: value: - number: 2 @@ -214205,7 +197912,6 @@ components: members_can_fork_private_repositories: false web_commit_signoff_required: false updated_at: '2014-03-03T18:58:10Z' - archived_at: dependency_graph_enabled_for_new_repositories: false dependabot_alerts_enabled_for_new_repositories: false dependabot_security_updates_enabled_for_new_repositories: false @@ -215391,6 +199097,70 @@ components: received_events_url: https://api.github.com/users/octokitten/received_events type: User site_admin: 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 organization-dependabot-secret-paginated: value: total_count: 3 @@ -216830,6 +200600,7 @@ components: allowed_values: - production - development + values_editable_by: org_actors - property_name: service value_type: string - property_name: team @@ -216869,7 +200640,7 @@ components: value: web - property_name: team value: octocat - repository: + full-repository: value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -216941,25 +200712,24 @@ components: hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks svn_url: https://svn.github.com/octocat/Hello-World homepage: https://github.com - organization: + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit language: - forks: 9 forks_count: 9 + forks: 9 stargazers_count: 80 watchers_count: 80 watchers: 80 size: 108 default_branch: master - open_issues: 0 open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit + open_issues: 0 + is_template: false topics: - octocat - atom @@ -216977,18 +200747,389 @@ components: created_at: '2011-01-26T19:01:12Z' updated_at: '2011-01-26T19:14:43Z' permissions: - admin: false - push: false pull: true + push: false + admin: false allow_rebase_merge: true - template_repository: + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + 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-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O allow_squash_merge: true allow_auto_merge: false delete_branch_on_merge: true allow_merge_commit: true + allow_forking: true + web_commit_signoff_required: false subscribers_count: 42 network_count: 0 + organization: + 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: Organization + site_admin: false + parent: + 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} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + source: + 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} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 org-ruleset-items: value: - id: 21 @@ -218354,7 +202495,6 @@ components: hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks svn_url: https://svn.github.com/octocat/Hello-World homepage: https://github.com - language: forks_count: 9 forks: 9 stargazers_count: 80 @@ -218653,620 +202793,129 @@ components: forks: 1 open_issues: 1 watchers: 1 - source: - 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} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - security_and_analysis: - advanced_security: - status: enabled - secret_scanning: - status: enabled - secret_scanning_push_protection: - status: disabled - full-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} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - language: - forks_count: 9 - forks: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues_count: 0 - open_issues: 0 - is_template: false - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - pull: true - push: false - admin: false - allow_rebase_merge: true - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World-Template - full_name: octocat/Hello-World-Template - 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-Template - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World-Template - archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads - events_url: https://api.github.com/repos/octocat/Hello-World-Template/events - forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World-Template.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages - merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} - ssh_url: git@github.com:octocat/Hello-World-Template.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags - teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams - trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World-Template.git - mirror_url: git:git.example.com/octocat/Hello-World-Template - hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks - svn_url: https://svn.github.com/octocat/Hello-World-Template - homepage: https://github.com - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - allow_forking: true - web_commit_signoff_required: false - subscribers_count: 42 - network_count: 0 - organization: - 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: Organization - site_admin: false - parent: - 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} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - source: - 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} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 + source: + 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} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + security_and_analysis: + advanced_security: + status: enabled + secret_scanning: + status: enabled + secret_scanning_push_protection: + status: disabled artifact-paginated: value: total_count: 2 @@ -226865,8 +210514,12 @@ components: updated_at: '2014-02-10T19:00:51Z' page-deployment: value: + id: 4fd754f7e594640989b406850d0bc8f06a121251 status_url: https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status page_url: developer.github.com + pages-deployment-status: + value: + status: succeed pages-health-check: value: domain: @@ -226968,6 +210621,15 @@ components: value: web - property_name: team value: octocat + create-or-update-custom-properties-values: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -229407,6 +213069,17 @@ components: blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + - type: wiki_commit + details: + path: "/example/Home.md" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - type: issue_title details: issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 @@ -229416,6 +213089,30 @@ components: - type: issue_comment details: issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + - type: discussion_title + details: + discussion_title_url: https://github.com/community/community/discussions/39082 + - type: discussion_body + details: + discussion_body_url: https://github.com/community/community/discussions/39082#discussion-4566270 + - type: discussion_comment + details: + 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 + - type: pull_request_body + details: + pull_request_body_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + - type: pull_request_comment + details: + pull_request_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1825855898 + - type: pull_request_review + details: + pull_request_review_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + - type: pull_request_review_comment + details: + pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 repository-advisory: value: ghsa_id: GHSA-abcd-1234-efgh @@ -230387,118 +214084,6 @@ components: allow_forking: true subscribers_count: 42 network_count: 0 - repository-3: - 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} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - forks: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues_count: 0 - open_issues: 0 - is_template: false - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - allow_auto_merge: false - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit public-repository-items: value: - id: 1296269 @@ -235437,7 +219022,8 @@ components: pagination-before: name: 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 before this cursor. + 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)." in: query required: false schema: @@ -235445,7 +219031,8 @@ components: pagination-after: name: after 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. + 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)." in: query required: false schema: @@ -235470,7 +219057,8 @@ components: type: string per-page: name: per_page - description: The number of results per page (max 100). + 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 schema: type: integer @@ -235492,7 +219080,8 @@ components: type: integer page: name: page - description: Page number of the results to fetch. + 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)." in: query schema: type: integer @@ -235830,7 +219419,8 @@ components: type: string variables-per-page: name: per_page - description: The number of results per page (max 30). + description: The number of results per page (max 30). 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 @@ -236277,7 +219867,8 @@ components: name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can - be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. + be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, + or `requested`. in: query required: false schema: @@ -236474,7 +220065,8 @@ components: name: environment_name in: path required: true - description: The name of the environment. + description: The name of the environment. The name must be URL encoded. For + example, any slashes in the name must be replaced with `%2F`. schema: type: string branch-policy-id: @@ -236491,6 +220083,16 @@ components: required: true schema: type: integer + git-ref-only: + name: ref + description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. + in: path + required: true + example: heads/feature-a + schema: + type: string + x-multi-segment: true since-user: name: since description: A user ID. Only return users with an ID greater than this ID. @@ -236519,6 +220121,16 @@ components: required: true schema: type: integer + pages-deployment-id: + name: pages_deployment_id + description: The ID of the Pages deployment. You can also give the commit SHA + of the deployment. + in: path + required: true + schema: + oneOf: + - type: integer + - type: string pull-number: name: pull_number description: The number that identifies the pull request. @@ -236711,6 +220323,12 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + internal_error: + description: Internal Error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" service_unavailable: description: Service unavailable content: @@ -236814,12 +220432,6 @@ components: examples: default: "$ref": "#/components/examples/runner-labels-readonly" - internal_error: - description: Internal Error - 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. @@ -236871,6 +220483,12 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + unacceptable: + description: Unacceptable + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" headers: link: example: ; rel="next", ; diff --git a/packages/openapi-typescript/examples/github-api.ts b/packages/openapi-typescript/examples/github-api.ts index 323485cb1..24187b05b 100644 --- a/packages/openapi-typescript/examples/github-api.ts +++ b/packages/openapi-typescript/examples/github-api.ts @@ -231,9 +231,9 @@ export interface paths { }; /** * List installations for the authenticated app - * @description 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. + * @description The permissions the installation has are included under the `permissions` key. * - * The permissions the installation has are included under the `permissions` key. + * 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. */ get: operations["apps/list-installations"]; put?: never; @@ -283,7 +283,13 @@ export interface paths { put?: never; /** * Create an installation access token for an app - * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. + * @description Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. + * + * Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. + * + * 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. */ @@ -382,7 +388,15 @@ export interface paths { put?: never; /** * Create a scoped access token - * @description Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. + * @description Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify + * which repositories the token can access and which permissions are granted to the + * token. + * + * Invalid tokens will return `404 NOT FOUND`. + * + * You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) + * when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + * as the username and password. */ post: operations["apps/scope-token"]; delete?: never; @@ -401,8 +415,6 @@ export interface paths { /** * Get an app * @description **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - * - * If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ get: operations["apps/get-by-slug"]; put?: never; @@ -593,6 +605,39 @@ export interface paths { patch?: never; trace?: never; }; + "/enterprises/{enterprise}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for enterprise members + * @description **Note**: This endpoint is in beta 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 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 response contains metrics for the prior 28 days. 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. + * + * Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage + * metrics for the enterprise. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + */ + get: operations["copilot/usage-metrics-for-enterprise"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/enterprises/{enterprise}/dependabot/alerts": { parameters: { query?: never; @@ -603,9 +648,12 @@ export interface paths { /** * List Dependabot alerts for an enterprise * @description Lists Dependabot alerts for repositories that are owned by the specified enterprise. - * To use this endpoint, you must be a member of the enterprise, and you must use an - * access token with the `repo` scope or `security_events` scope. + * + * The authenticated user must be a member of the enterprise to use this endpoint. + * * 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 the `repo` or `security_events` scope to use this endpoint. */ get: operations["dependabot/list-alerts-for-enterprise"]; put?: never; @@ -626,7 +674,12 @@ export interface paths { /** * List secret scanning alerts for an enterprise * @description Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - * To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are 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). + * + * 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). + * + * 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 the `repo` scope or `security_events` scope to use this endpoint. */ get: operations["secret-scanning/list-alerts-for-enterprise"]; put?: never; @@ -666,16 +719,18 @@ export interface paths { }; /** * Get feeds - * @description GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: + * @description Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * * * **Timeline**: The GitHub global public timeline - * * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) + * * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * * **Current user public**: The public timeline for the authenticated user * * **Current user**: The private timeline for the authenticated user * * **Current user actor**: The private timeline for activity created by the authenticated user * * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. * + * By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + * * **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. */ get: operations["activity/get-feeds"]; @@ -762,7 +817,15 @@ export interface paths { path?: never; cookie?: never; }; - /** Get a gist */ + /** + * Get a gist + * @description Gets a specified gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ get: operations["gists/get"]; put?: never; post?: never; @@ -772,8 +835,16 @@ export interface paths { head?: never; /** * Update a gist - * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. + * @description Allows you to update a gist's description and to update, delete, or rename gist files. Files + * from the previous version of the gist that aren't explicitly changed during an edit + * are unchanged. + * * At least one of `description` or `files` is required. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. */ patch: operations["gists/update"]; trace?: never; @@ -785,10 +856,26 @@ export interface paths { path?: never; cookie?: never; }; - /** List gist comments */ + /** + * List gist comments + * @description Lists the comments on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ get: operations["gists/list-comments"]; put?: never; - /** Create a gist comment */ + /** + * Create a gist comment + * @description Creates a comment on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ post: operations["gists/create-comment"]; delete?: never; options?: never; @@ -803,7 +890,15 @@ export interface paths { path?: never; cookie?: never; }; - /** Get a gist comment */ + /** + * Get a gist comment + * @description Gets a comment on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ get: operations["gists/get-comment"]; put?: never; post?: never; @@ -811,7 +906,15 @@ export interface paths { delete: operations["gists/delete-comment"]; options?: never; head?: never; - /** Update a gist comment */ + /** + * Update a gist comment + * @description Updates a comment on a gist. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ patch: operations["gists/update-comment"]; trace?: never; }; @@ -861,7 +964,7 @@ export interface paths { get: operations["gists/check-is-starred"]; /** * Star a gist - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["gists/star"]; post?: never; @@ -879,7 +982,15 @@ export interface paths { path?: never; cookie?: never; }; - /** Get a gist revision */ + /** + * Get a gist revision + * @description Gets a specified gist revision. + * + * 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. This is the default if you do not pass any specific media type. + * - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. + */ get: operations["gists/get-revision"]; put?: never; post?: never; @@ -918,8 +1029,11 @@ export interface paths { }; /** * Get a gitignore template - * @description The API also allows fetching the source of a single template. - * Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. + * @description Get the content of a gitignore template. + * + * 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 .gitignore contents. */ get: operations["gitignore/get-template"]; put?: never; @@ -940,8 +1054,6 @@ export interface paths { /** * List repositories accessible to the app installation * @description List repositories that an app installation can access. - * - * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ get: operations["apps/list-repos-accessible-to-installation"]; put?: never; @@ -967,8 +1079,6 @@ export interface paths { * @description Revokes the installation token you're using to authenticate as an installation and access this endpoint. * * Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. - * - * You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. */ delete: operations["apps/revoke-installation-access-token"]; options?: never; @@ -989,11 +1099,17 @@ export interface paths { * repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not * necessarily assigned to you. * - * * **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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"]; put?: never; @@ -1294,7 +1410,11 @@ export interface paths { get: operations["activity/get-thread"]; put?: never; post?: never; - delete?: never; + /** + * Mark a thread as done + * @description Marks a thread as "done." Marking a thread as "done" is equivalent to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications. + */ + delete: operations["activity/mark-thread-as-done"]; options?: never; head?: never; /** @@ -1367,7 +1487,7 @@ export interface paths { }; /** * List organizations - * @description Lists all organizations, in the order that they were created on GitHub. + * @description Lists all organizations, in the order that they were created. * * **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. */ @@ -1389,9 +1509,26 @@ export interface paths { }; /** * Get an organization - * @description To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * @description Gets information about an organization. + * + * When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + * + * To see the full details about an organization, the authenticated user must be an organization owner. + * + * The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: * - * GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + * + * To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. */ get: operations["orgs/get"]; put?: never; @@ -1413,7 +1550,22 @@ export interface paths { * Update an organization * @description **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). * - * Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. + * Updates the organization's profile and member privileges. + * + * With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + * + * - advanced_security_enabled_for_new_repositories + * - dependabot_alerts_enabled_for_new_repositories + * - dependabot_security_updates_enabled_for_new_repositories + * - dependency_graph_enabled_for_new_repositories + * - secret_scanning_enabled_for_new_repositories + * - secret_scanning_push_protection_enabled_for_new_repositories + * + * For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + * + * The authenticated user must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. */ patch: operations["orgs/update"]; trace?: never; @@ -1429,7 +1581,8 @@ export interface paths { * Get GitHub Actions cache usage for an organization * @description Gets the total GitHub Actions cache usage for an organization. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-for-org"]; put?: never; @@ -1451,7 +1604,8 @@ export interface paths { * List repositories with GitHub Actions cache usage for an organization * @description Lists repositories and their GitHub Actions cache usage for an organization. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage-by-repo-for-org"]; put?: never; @@ -1472,15 +1626,15 @@ export interface paths { /** * Get the customization template for an OIDC subject claim for an organization * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `read:org` scope to use this endpoint. - * GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["oidc/get-oidc-custom-sub-template-for-org"]; /** * Set the customization template for an OIDC subject claim for an organization * @description Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `write:org` scope to use this endpoint. - * GitHub Apps must have the `admin:org` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ put: operations["oidc/update-oidc-custom-sub-template-for-org"]; post?: never; @@ -1501,14 +1655,14 @@ export interface paths { * Get GitHub Actions permissions for an organization * @description Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-github-actions-permissions-organization"]; /** * Set GitHub Actions permissions for an organization * @description Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-github-actions-permissions-organization"]; post?: never; @@ -1529,14 +1683,15 @@ export interface paths { * List selected repositories enabled for GitHub Actions in an organization * @description Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/list-selected-repositories-enabled-github-actions-organization"]; /** * Set selected repositories enabled for GitHub Actions in an organization * @description Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-selected-repositories-enabled-github-actions-organization"]; post?: never; @@ -1558,7 +1713,7 @@ export interface paths { * Enable a selected repository for GitHub Actions in an organization * @description Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/enable-selected-repository-github-actions-organization"]; post?: never; @@ -1566,7 +1721,7 @@ export interface paths { * Disable a selected repository for GitHub Actions in an organization * @description Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["actions/disable-selected-repository-github-actions-organization"]; options?: never; @@ -1583,16 +1738,16 @@ export interface paths { }; /** * Get allowed actions and reusable workflows for an organization - * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + * @description Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-allowed-actions-organization"]; /** * Set allowed actions and reusable workflows for an organization * @description Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-allowed-actions-organization"]; post?: never; @@ -1615,7 +1770,7 @@ export interface paths { * as well as whether GitHub Actions can submit approving pull request reviews. For more information, see * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-organization"]; /** @@ -1624,7 +1779,7 @@ export interface paths { * can submit approving pull request reviews. For more information, see * "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-organization"]; post?: never; @@ -1645,10 +1800,9 @@ export interface paths { * List self-hosted runners for an organization * @description Lists all self-hosted runners configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-self-hosted-runners-for-org"]; put?: never; @@ -1670,10 +1824,9 @@ export interface paths { * List runner applications for an organization * @description Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-runner-applications-for-org"]; put?: never; @@ -1697,10 +1850,9 @@ export interface paths { * Create configuration for a just-in-time runner for an organization * @description Generates a configuration that can be passed to the runner application at startup. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * The authenticated user must have admin access to the organization. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-org"]; delete?: never; @@ -1722,18 +1874,15 @@ export interface paths { * Create a registration token for an organization * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - * - * Example using registration token: - * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * * ``` * ./config.sh --url https://github.com/octo-org --token TOKEN * ``` + * + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-registration-token-for-org"]; delete?: never; @@ -1755,19 +1904,15 @@ export interface paths { * Create a remove token for an organization * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - * - * Example using remove token: - * - * To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this - * endpoint. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * * ``` * ./config.sh remove --token TOKEN * ``` + * + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-remove-token-for-org"]; delete?: never; @@ -1787,10 +1932,9 @@ export interface paths { * Get a self-hosted runner for an organization * @description Gets a specific self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/get-self-hosted-runner-for-org"]; put?: never; @@ -1799,10 +1943,9 @@ export interface paths { * Delete a self-hosted runner from an organization * @description Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-from-org"]; options?: never; @@ -1821,10 +1964,9 @@ export interface paths { * List labels for a self-hosted runner for an organization * @description Lists all labels for a self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-labels-for-self-hosted-runner-for-org"]; /** @@ -1832,20 +1974,18 @@ export interface paths { * @description Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-custom-labels-for-self-hosted-runner-for-org"]; /** * Add custom labels to a self-hosted runner for an organization - * @description Add custom labels to a self-hosted runner configured in an organization. + * @description Adds custom labels to a self-hosted runner configured in an organization. + * + * Authenticated users must have admin access to the organization to use this endpoint. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["actions/add-custom-labels-to-self-hosted-runner-for-org"]; /** @@ -1853,10 +1993,9 @@ export interface paths { * @description Remove all custom labels from a self-hosted runner configured in an * organization. Returns the remaining read-only labels from the runner. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-org"]; options?: never; @@ -1882,10 +2021,9 @@ export interface paths { * This endpoint returns a `404 Not Found` status if the custom label is not * present on the runner. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-org"]; options?: never; @@ -1905,10 +2043,9 @@ export interface paths { * @description Lists all secrets available in an organization without revealing their * encrypted values. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-org-secrets"]; put?: never; @@ -1931,10 +2068,9 @@ export interface paths { * @description Gets your public key, which you need to encrypt secrets. You need to * encrypt a secret before you can create or update secrets. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-public-key"]; put?: never; @@ -1956,10 +2092,9 @@ export interface paths { * Get an organization secret * @description Gets a single organization secret without revealing its encrypted value. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to a repository to create, update, or read secrets + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-secret"]; /** @@ -1967,10 +2102,9 @@ export interface paths { * @description Creates or updates an organization secret with an encrypted value. 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)." * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/create-or-update-org-secret"]; post?: never; @@ -1978,10 +2112,9 @@ export interface paths { * Delete an organization secret * @description Deletes a secret in an organization using the secret name. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-org-secret"]; options?: never; @@ -2001,10 +2134,9 @@ export interface paths { * @description Lists all repositories that have been selected when the `visibility` * for repository access to a secret is set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-selected-repos-for-org-secret"]; /** @@ -2013,10 +2145,9 @@ export interface paths { * for repository access is set to `selected`. The visibility is set when you [Create * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-selected-repos-for-org-secret"]; post?: never; @@ -2037,13 +2168,12 @@ export interface paths { /** * Add selected repository to an organization secret * @description Adds a repository to an organization secret when the `visibility` for - * repository access is set to `selected`. The visibility is set when you [Create or + * repository access is set to `selected`. For more information about setting the visibility, see [Create or * update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/add-selected-repo-to-org-secret"]; post?: never; @@ -2053,10 +2183,9 @@ export interface paths { * for repository access is set to `selected`. The visibility is set when you [Create * or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-selected-repo-from-org-secret"]; options?: never; @@ -2074,7 +2203,10 @@ export interface paths { /** * List organization variables * @description Lists all organization variables. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-org-variables"]; put?: never; @@ -2082,10 +2214,9 @@ export interface paths { * Create an organization variable * @description Creates an organization variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-org-variable"]; delete?: never; @@ -2105,10 +2236,9 @@ export interface paths { * Get an organization variable * @description Gets a specific variable in an organization. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-org-variable"]; put?: never; @@ -2117,10 +2247,9 @@ export interface paths { * Delete an organization variable * @description Deletes an organization variable using the variable name. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-org-variable"]; options?: never; @@ -2129,10 +2258,9 @@ export interface paths { * Update an organization variable * @description Updates an organization variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ patch: operations["actions/update-org-variable"]; trace?: never; @@ -2149,10 +2277,9 @@ export interface paths { * @description Lists all repositories that can access an organization variable * that is available to selected repositories. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ get: operations["actions/list-selected-repos-for-org-variable"]; /** @@ -2161,11 +2288,9 @@ export interface paths { * to selected repositories. Organization variables that are available to selected * repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this - * endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ put: operations["actions/set-selected-repos-for-org-variable"]; post?: never; @@ -2188,10 +2313,9 @@ export interface paths { * @description Adds a repository to an organization variable that is available to selected repositories. * Organization variables that are available to selected repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/add-selected-repo-to-org-variable"]; post?: never; @@ -2201,10 +2325,9 @@ export interface paths { * available to selected repositories. Organization variables that are available to * selected repositories have their `visibility` field set to `selected`. * - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. */ delete: operations["actions/remove-selected-repo-from-org-variable"]; options?: never; @@ -2271,9 +2394,9 @@ export interface paths { * List code scanning alerts for an organization * @description Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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)." * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * For public repositories, you may instead use the `public_repo` scope. + * OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope 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/list-alerts-for-org"]; put?: never; @@ -2295,7 +2418,7 @@ export interface paths { * List codespaces for the organization * @description Lists the codespaces associated to a specified organization. * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/list-in-organization"]; put?: never; @@ -2318,7 +2441,7 @@ export interface paths { * Manage access control for organization codespaces * @deprecated * @description Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/set-codespaces-access"]; post?: never; @@ -2345,7 +2468,7 @@ export interface paths { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["codespaces/set-codespaces-access-users"]; /** @@ -2356,7 +2479,7 @@ export interface paths { * To use this endpoint, the access settings for the organization must be set to `selected_members`. * For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/delete-codespaces-access-users"]; options?: never; @@ -2373,8 +2496,10 @@ export interface paths { }; /** * List organization secrets - * @description Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Lists all Codespaces development environment secrets 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["codespaces/list-org-secrets"]; put?: never; @@ -2394,7 +2519,8 @@ export interface paths { }; /** * Get an organization public key - * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/get-org-public-key"]; put?: never; @@ -2415,7 +2541,8 @@ export interface paths { /** * Get an organization secret * @description Gets an organization development environment secret without revealing its encrypted value. - * You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/get-org-secret"]; /** @@ -2423,14 +2550,15 @@ export interface paths { * @description Creates or updates an organization development environment secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/create-or-update-org-secret"]; post?: never; /** * Delete an organization secret - * @description Deletes an organization development environment secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Deletes an organization development environment secret using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/delete-org-secret"]; options?: never; @@ -2447,12 +2575,19 @@ export interface paths { }; /** * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Lists all repositories that have been selected when the `visibility` + * for repository access to a secret is set to `selected`. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Replaces all repositories for an organization development environment secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/set-selected-repos-for-org-secret"]; post?: never; @@ -2472,13 +2607,18 @@ export interface paths { get?: never; /** * Add selected repository to an organization secret - * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["codespaces/add-selected-repo-to-org-secret"]; post?: never; /** * Remove selected repository from an organization secret - * @description Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + * @description Removes a repository from an organization development environment secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/remove-selected-repo-from-org-secret"]; options?: never; @@ -2494,15 +2634,16 @@ export interface paths { cookie?: never; }; /** - * Get Copilot Business seat information and settings for an organization + * Get Copilot seat information and settings for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets information about an organization's Copilot Business subscription, including seat breakdown + * Gets information about an organization's Copilot subscription, including seat breakdown * and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - * For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". + * For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". + * + * Only organization owners can configure and view details about the organization's Copilot Business subscription. * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/get-copilot-organization-details"]; put?: never; @@ -2521,13 +2662,14 @@ export interface paths { cookie?: never; }; /** - * List all Copilot Business seat assignments for an organization + * List all Copilot seat assignments for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + * Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). * - * Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/list-copilot-seats"]; put?: never; @@ -2548,33 +2690,35 @@ export interface paths { get?: never; put?: never; /** - * Add teams to the Copilot Business subscription for an organization + * Add teams to the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot Business seat for all users within each specified team. - * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + * Purchases a GitHub Copilot seat for all users within each specified team. + * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * + * Only organization owners can configure GitHub Copilot in their organization. * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * 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. + * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * - * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ - post: operations["copilot/add-copilot-for-business-seats-for-teams"]; + post: operations["copilot/add-copilot-seats-for-teams"]; /** - * Remove teams from the Copilot Business subscription for an organization + * Remove teams from the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot Business seat assignment for all members of each team specified. + * Cancels the Copilot seat assignment for all members of each team specified. * This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can configure GitHub Copilot in their organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-teams"]; options?: never; @@ -2592,33 +2736,35 @@ export interface paths { get?: never; put?: never; /** - * Add users to the Copilot Business subscription for an organization + * Add users to the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Purchases a GitHub Copilot Business seat for each user specified. - * The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + * Purchases a GitHub Copilot seat for each user specified. + * The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + * + * Only organization owners can configure GitHub Copilot in their organization. * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * 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. + * For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". * - * In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. - * For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". - * For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ - post: operations["copilot/add-copilot-for-business-seats-for-users"]; + post: operations["copilot/add-copilot-seats-for-users"]; /** - * Remove users from the Copilot Business subscription for an organization + * Remove users from the Copilot subscription for an organization * @description **Note**: This endpoint is in beta and is subject to change. * - * Cancels the Copilot Business seat assignment for each user specified. + * Cancels the Copilot seat assignment for each user specified. * This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. * - * For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)" + * For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". * - * For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + * For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". * - * Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - * authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * Only organization owners can configure GitHub Copilot in their organization. + * + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ delete: operations["copilot/cancel-copilot-seat-assignment-for-users"]; options?: never; @@ -2626,6 +2772,39 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for organization members + * @description **Note**: This endpoint is in beta 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 + * across an organization, 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 the prior 28 days. 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. + * + * Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view + * Copilot usage metrics. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + */ + get: operations["copilot/usage-metrics-for-org"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/dependabot/alerts": { parameters: { query?: never; @@ -2637,11 +2816,9 @@ export interface paths { * List Dependabot alerts for an organization * @description Lists Dependabot alerts for an organization. * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. * - * For public repositories, you may instead use the `public_repo` scope. - * - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `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["dependabot/list-alerts-for-org"]; put?: never; @@ -2661,7 +2838,10 @@ export interface paths { }; /** * List organization secrets - * @description Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Lists all secrets available in an organization without revealing their + * encrypted values. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/list-org-secrets"]; put?: never; @@ -2681,7 +2861,10 @@ export interface paths { }; /** * Get an organization public key - * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/get-org-public-key"]; put?: never; @@ -2701,7 +2884,9 @@ export interface paths { }; /** * Get an organization secret - * @description Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Gets a single organization secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/get-org-secret"]; /** @@ -2709,15 +2894,15 @@ export interface paths { * @description Creates or updates an organization secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - * permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/create-or-update-org-secret"]; post?: never; /** * Delete an organization secret - * @description Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Deletes a secret in an organization using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["dependabot/delete-org-secret"]; options?: never; @@ -2734,12 +2919,19 @@ export interface paths { }; /** * List selected repositories for an organization secret - * @description Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Lists all repositories that have been selected when the `visibility` + * for repository access to a secret is set to `selected`. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["dependabot/list-selected-repos-for-org-secret"]; /** * Set selected repositories for an organization secret - * @description Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Replaces all repositories for an organization secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/set-selected-repos-for-org-secret"]; post?: never; @@ -2759,13 +2951,21 @@ export interface paths { get?: never; /** * Add selected repository to an organization secret - * @description Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Adds a repository to an organization secret when the `visibility` for + * repository access is set to `selected`. The visibility is set when you [Create or + * update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["dependabot/add-selected-repo-to-org-secret"]; post?: never; /** * Remove selected repository from an organization secret - * @description Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + * @description Removes a repository from an organization secret when the `visibility` + * for repository access is set to `selected`. The visibility is set when you [Create + * or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + * + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["dependabot/remove-selected-repo-from-org-secret"]; options?: never; @@ -2783,7 +2983,8 @@ export interface paths { /** * Get list of conflicting packages during Docker migration for organization * @description Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-organization"]; put?: never; @@ -2838,12 +3039,23 @@ export interface paths { path?: never; cookie?: never; }; - /** List organization webhooks */ + /** + * List organization webhooks + * @description You 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. + */ get: operations["orgs/list-webhooks"]; put?: never; /** * Create an organization webhook - * @description Here's how you can create a hook that posts payloads in JSON format: + * @description Create a hook that posts payloads in JSON format. + * + * You 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. */ post: operations["orgs/create-webhook"]; delete?: never; @@ -2861,18 +3073,39 @@ export interface paths { }; /** * Get an organization webhook - * @description Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)." + * @description Returns a webhook configured in an organization. To get only the webhook + * `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + * + * You 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. */ get: operations["orgs/get-webhook"]; put?: never; post?: never; - /** Delete an organization webhook */ + /** + * Delete an organization webhook + * @description You 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. + */ delete: operations["orgs/delete-webhook"]; options?: never; head?: never; /** * Update an organization webhook - * @description Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)." + * @description Updates a webhook configured in an organization. When you update a webhook, + * the `secret` will be overwritten. If you previously had a `secret` set, you must + * provide the same `secret` or set a new `secret` or the secret will be removed. If + * you are only updating individual webhook `config` properties, use "[Update a webhook + * configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". + * + * You 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. */ patch: operations["orgs/update-webhook"]; trace?: never; @@ -2888,7 +3121,10 @@ export interface paths { * Get a webhook configuration for an organization * @description Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." * - * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + * You 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. */ get: operations["orgs/get-webhook-config-for-org"]; put?: never; @@ -2900,7 +3136,10 @@ export interface paths { * Update a webhook configuration for an organization * @description Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." * - * Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + * You 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. */ patch: operations["orgs/update-webhook-config-for-org"]; trace?: never; @@ -2915,6 +3154,11 @@ export interface paths { /** * List deliveries for an organization webhook * @description Returns a list of webhook deliveries for a webhook configured in an organization. + * + * You 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. */ get: operations["orgs/list-webhook-deliveries"]; put?: never; @@ -2935,6 +3179,11 @@ export interface paths { /** * Get a webhook delivery for an organization webhook * @description Returns a delivery for a webhook configured in an organization. + * + * You 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. */ get: operations["orgs/get-webhook-delivery"]; put?: never; @@ -2957,6 +3206,11 @@ export interface paths { /** * Redeliver a delivery for an organization webhook * @description Redeliver a delivery for a webhook configured in an organization. + * + * You 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. */ post: operations["orgs/redeliver-webhook-delivery"]; delete?: never; @@ -2976,7 +3230,13 @@ export interface paths { put?: never; /** * Ping an organization webhook - * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + * @description This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) + * to be sent to the hook. + * + * You 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. */ post: operations["orgs/ping-webhook"]; delete?: never; @@ -3016,7 +3276,12 @@ export interface paths { }; /** * List app installations for an organization - * @description Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. + * @description Lists all GitHub Apps in an organization. The installation count includes + * all GitHub Apps installed on repositories in the organization. + * + * The authenticated user must be an organization owner to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. */ get: operations["orgs/list-app-installations"]; put?: never; @@ -3139,6 +3404,13 @@ export interface paths { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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-for-org"]; put?: never; @@ -3204,7 +3476,7 @@ export interface paths { * List codespaces for a user in organization * @description Lists the codespaces that a member of an organization has for repositories in that organization. * - * You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["codespaces/get-codespaces-for-user-in-org"]; put?: never; @@ -3229,10 +3501,7 @@ export interface paths { * Delete a codespace from the organization * @description Deletes a user's codespace. * - * To use this endpoint you must authenticate using one of the following methods: - * - * - An access token with the `admin:org` scope - * - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["codespaces/delete-from-organization"]; options?: never; @@ -3253,10 +3522,7 @@ export interface paths { * Stop a codespace for an organization user * @description Stops a user's codespace. * - * To use this endpoint you must authenticate using one of the following methods: - * - * - An access token with the `admin:org` scope - * - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["codespaces/stop-in-organization"]; delete?: never; @@ -3273,12 +3539,14 @@ export interface paths { cookie?: never; }; /** - * Get Copilot Business seat assignment details for a user + * Get Copilot seat assignment details for a user * @description **Note**: This endpoint is in beta and is subject to change. * - * Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + * + * Organization owners can view GitHub Copilot seat assignment details for members in their organization. * - * Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. */ get: operations["copilot/get-copilot-seat-details-for-user"]; put?: never; @@ -3453,9 +3721,7 @@ export interface paths { }; /** * List organization fine-grained permissions for an organization - * @description **Note**: This operation is in beta and subject to change. - * - * Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * @description Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." * @@ -3464,8 +3730,7 @@ export interface paths { * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-organization-fine-grained-permissions"]; put?: never; @@ -3485,33 +3750,27 @@ export interface paths { }; /** * Get all organization roles for an organization - * @description Lists the organization roles available in this organization. + * @description Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-roles"]; put?: never; /** * Create a custom organization role - * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + * @description Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - * - * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ post: operations["orgs/create-custom-organization-role"]; delete?: never; @@ -3532,12 +3791,11 @@ export interface paths { post?: never; /** * Remove all organization roles for a team - * @description Removes all assigned organization roles from a team. + * @description Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-all-org-roles-team"]; options?: never; @@ -3555,22 +3813,21 @@ export interface paths { get?: never; /** * Assign an organization role to a team - * @description Assigns an organization role to a team in an organization. - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * @description Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ put: operations["orgs/assign-team-to-org-role"]; post?: never; /** * Remove an organization role from a team - * @description Removes an organization role from a team. + * @description Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-org-role-team"]; options?: never; @@ -3590,12 +3847,11 @@ export interface paths { post?: never; /** * Remove all organization roles for a user - * @description Revokes all assigned organization roles from a user. + * @description Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-all-org-roles-user"]; options?: never; @@ -3613,22 +3869,21 @@ export interface paths { get?: never; /** * Assign an organization role to a user - * @description Assigns an organization role to a member of an organization. - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read-write permission to use this endpoint. + * @description Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * 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. */ put: operations["orgs/assign-user-to-org-role"]; post?: never; /** * Remove an organization role from a user - * @description Remove an organization role from a user. + * @description Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members:write` organization permission to use this endpoint. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/revoke-org-role-user"]; options?: never; @@ -3645,51 +3900,43 @@ export interface paths { }; /** * Get an organization role - * @description Gets an organization role that is available to this organization. + * @description Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/get-org-role"]; put?: never; post?: never; /** * Delete a custom organization role. - * @description Deletes a custom organization role. + * @description Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - * - * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/delete-custom-organization-role"]; options?: never; head?: never; /** * Update a custom organization role - * @description Updates an existing custom organization role. Permission changes will apply to all assignees. + * @description Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * * * To use this endpoint, the authenticated user must be one of: * * - An administrator for the organization. * - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. * - * The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - * GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - * - * For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ patch: operations["orgs/patch-custom-organization-role"]; trace?: never; @@ -3703,12 +3950,11 @@ export interface paths { }; /** * List teams that are assigned to an organization role - * @description Lists the teams that are assigned to an organization role. + * @description Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read permission to use this endpoint. + * To use this endpoint, you must be an administrator for the organization. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-role-teams"]; put?: never; @@ -3728,12 +3974,11 @@ export interface paths { }; /** * List users that are assigned to an organization role - * @description Lists organization members that are assigned to an organization role. + * @description Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - * GitHub Apps must have the `members` organization read permission to use this endpoint. + * To use this endpoint, you must be an administrator for the organization. * - * For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ get: operations["orgs/list-org-role-users"]; put?: never; @@ -3799,7 +4044,7 @@ export interface paths { * List packages for an organization * @description Lists packages in an organization readable by the user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-organization"]; put?: never; @@ -3821,7 +4066,7 @@ export interface paths { * Get a package for an organization * @description Gets a specific package in an organization. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-organization"]; put?: never; @@ -3830,9 +4075,9 @@ export interface paths { * Delete a package for an organization * @description Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-org"]; options?: never; @@ -3857,9 +4102,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-org"]; delete?: never; @@ -3879,7 +4124,7 @@ export interface paths { * List package versions for a package owned by an organization * @description Lists package versions for a package owned by an organization. * - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-org"]; put?: never; @@ -3901,7 +4146,7 @@ export interface paths { * Get a package version for an organization * @description Gets a specific package version in an organization. * - * You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-organization"]; put?: never; @@ -3910,9 +4155,9 @@ export interface paths { * Delete package version for an organization * @description Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-org"]; options?: never; @@ -3937,9 +4182,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-org"]; delete?: never; @@ -3957,19 +4202,17 @@ export interface paths { }; /** * List requests to access organization resources with fine-grained personal access tokens - * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: read` permission. + * @description Lists requests from organization members to access organization resources with a fine-grained personal access token. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-requests"]; put?: never; /** * Review requests to access organization resources with fine-grained personal access tokens - * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: write` permission. + * @description Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/review-pat-grant-requests-in-bulk"]; delete?: never; @@ -3989,10 +4232,9 @@ export interface paths { put?: never; /** * Review a request to access organization resources with a fine-grained personal access token - * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: write` permission. + * @description Approves or denies a pending request to access organization resources via a fine-grained personal access token. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/review-pat-grant-request"]; delete?: never; @@ -4010,10 +4252,9 @@ export interface paths { }; /** * List repositories requested to be accessed by a fine-grained personal access token - * @description Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API, - * using the `organization_personal_access_token_requests: read` permission. + * @description Lists the repositories a fine-grained personal access token request is requesting access to. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-request-repositories"]; put?: never; @@ -4033,19 +4274,17 @@ export interface paths { }; /** * List fine-grained personal access tokens with access to organization resources - * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: read` permission. + * @description Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grants"]; put?: never; /** * Update the access to organization resources via fine-grained personal access tokens - * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: write` permission. + * @description Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/update-pat-accesses"]; delete?: never; @@ -4065,10 +4304,9 @@ export interface paths { put?: never; /** * Update the access a fine-grained personal access token has to organization resources - * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: write` permission. + * @description Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ post: operations["orgs/update-pat-access"]; delete?: never; @@ -4086,10 +4324,9 @@ export interface paths { }; /** * List repositories a fine-grained personal access token has access to - * @description Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API, - * using the `organization_personal_access_tokens: read` permission. + * @description Lists the repositories a fine-grained personal access token has access to. * - * **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + * Only GitHub Apps can use this endpoint. */ get: operations["orgs/list-pat-grant-repositories"]; put?: never; @@ -4134,7 +4371,7 @@ export interface paths { /** * Get all custom properties for an organization * @description Gets all custom properties defined for an organization. - * You must be an organization owner to use this endpoint. + * Organization members can read these properties. */ get: operations["orgs/get-all-custom-properties"]; put?: never; @@ -4145,7 +4382,10 @@ export interface paths { /** * Create or update custom properties for an organization * @description Creates new or updates existing custom properties defined for an organization in a batch. - * Only organization owners (or users with the proper permissions granted by them) can update these properties + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ patch: operations["orgs/create-or-update-custom-properties"]; trace?: never; @@ -4160,20 +4400,26 @@ export interface paths { /** * Get a custom property for an organization * @description Gets a custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * Organization members can read these properties. */ get: operations["orgs/get-custom-property"]; /** * Create or update a custom property for an organization * @description Creates a new or updates an existing custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ put: operations["orgs/create-or-update-custom-property"]; post?: never; /** * Remove a custom property for an organization * @description Removes a custom property that is defined for an organization. - * You must be an organization owner to use this endpoint. + * + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. */ delete: operations["orgs/remove-custom-property"]; options?: never; @@ -4208,7 +4454,9 @@ export interface paths { * * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. * - * Only organization owners (or users with the proper permissions granted by them) can update these properties + * To use this endpoint, the authenticated user must be one of: + * - An administrator for the organization. + * - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. */ patch: operations["orgs/create-or-update-custom-properties-values-for-repos"]; trace?: never; @@ -4249,7 +4497,7 @@ export interface paths { * Set public organization membership for the authenticated user * @description The user can publicize their own membership. (A user cannot publicize the membership for another user.) * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["orgs/set-public-membership-for-authenticated-user"]; post?: never; @@ -4282,12 +4530,7 @@ export interface paths { * Create an organization repository * @description Creates a new repository in the specified organization. The authenticated user must be a member of the organization. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-in-org"]; delete?: never; @@ -4400,10 +4643,10 @@ export interface paths { /** * List secret scanning alerts for an organization * @description Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * 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 `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/list-alerts-for-org"]; put?: never; @@ -4425,7 +4668,9 @@ export interface paths { * List repository security advisories for an organization * @description Lists repository security advisories for an organization. * - * To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + * The authenticated user must be an owner or security manager for the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ get: operations["security-advisories/list-org-repository-advisories"]; put?: never; @@ -4447,9 +4692,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)." * - * To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope. + * The authenticated user must be an administrator or security manager for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. */ get: operations["orgs/list-security-manager-teams"]; put?: never; @@ -4472,9 +4717,9 @@ export interface paths { * 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." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ put: operations["orgs/add-security-manager-team"]; post?: never; @@ -4482,9 +4727,9 @@ export interface paths { * 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." * - * To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + * The authenticated user must be an administrator for the organization to use this endpoint. * - * GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. */ delete: operations["orgs/remove-security-manager-team"]; options?: never; @@ -4505,7 +4750,7 @@ export interface paths { * * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ get: operations["billing/get-github-actions-billing-org"]; put?: never; @@ -4529,7 +4774,7 @@ export interface paths { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ get: operations["billing/get-github-packages-billing-org"]; put?: never; @@ -4553,7 +4798,7 @@ export interface paths { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `repo` or `admin:org` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. */ get: operations["billing/get-shared-storage-billing-org"]; put?: never; @@ -4564,6 +4809,41 @@ export interface paths { patch?: never; trace?: never; }; + "/orgs/{org}/team/{team_slug}/copilot/usage": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get a summary of Copilot usage for a team + * @description **Note**: This endpoint is in beta 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 a 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 the prior 28 days. 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 team had five or more members on that day. + * + * Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, + * and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. + * + * OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + */ + get: operations["copilot/usage-metrics-for-team"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/orgs/{org}/teams": { parameters: { query?: never; @@ -4635,19 +4915,23 @@ export interface paths { }; /** * List discussions - * @description List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List all discussions on a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussions-in-org"]; put?: never; /** * Create a discussion - * @description Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Creates a new discussion post on a team's page. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-in-org"]; delete?: never; @@ -4665,27 +4949,33 @@ export interface paths { }; /** * Get a discussion - * @description Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Get a specific discussion on a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-in-org"]; put?: never; post?: never; /** * Delete a discussion - * @description Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Delete a discussion from a team's page. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-in-org"]; options?: never; head?: never; /** * Update a discussion - * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Edits the title and body text of a discussion post. Only the parameters you provide are updated. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-in-org"]; trace?: never; @@ -4699,19 +4989,23 @@ export interface paths { }; /** * List discussion comments - * @description List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List all comments on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussion-comments-in-org"]; put?: never; /** * Create a discussion comment - * @description Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Creates a new comment on a team discussion. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-comment-in-org"]; delete?: never; @@ -4729,27 +5023,33 @@ export interface paths { }; /** * Get a discussion comment - * @description Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Get a specific comment on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-comment-in-org"]; put?: never; post?: never; /** * Delete a discussion comment - * @description Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Deletes a comment on a team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-comment-in-org"]; options?: never; head?: never; /** * Update a discussion comment - * @description Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Edits the body text of a discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-comment-in-org"]; trace?: never; @@ -4763,17 +5063,23 @@ export interface paths { }; /** * List reactions for a team discussion comment - * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-in-org"]; put?: never; /** * Create reaction for a team discussion comment - * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * @description Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-comment-in-org"]; delete?: never; @@ -4796,7 +5102,9 @@ export interface paths { * Delete team discussion comment reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["reactions/delete-for-team-discussion-comment"]; options?: never; @@ -4813,17 +5121,23 @@ export interface paths { }; /** * List reactions for a team discussion - * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-in-org"]; put?: never; /** * Create reaction for a team discussion - * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * @description Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-in-org"]; delete?: never; @@ -4846,7 +5160,9 @@ export interface paths { * Delete team discussion reaction * @description **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. * - * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["reactions/delete-for-team-discussion"]; options?: never; @@ -5044,14 +5360,14 @@ export interface paths { * * If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. * - * If the repository is private, you must have at least `read` permission for that repository and your token must have the `repo` scope. Otherwise, you will receive a `404 Not Found` response status. + * If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. */ get: operations["teams/check-permissions-for-repo-in-org"]; /** * Add or update team repository permissions - * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. * @@ -5104,14 +5420,11 @@ export interface paths { put?: never; /** * Enable or disable a security feature for an organization - * @description Enables or disables the specified security feature for all eligible repositories in an organization. - * - * To use this endpoint, you must be an organization owner or be member of a team with the security manager role. - * A token with the 'write:org' scope is also required. + * @description Enables or disables the specified security feature for all eligible repositories in 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)." * - * GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + * The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. * - * 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)." + * OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. */ post: operations["orgs/enable-or-disable-security-product-on-all-org-repos"]; delete?: never; @@ -5354,7 +5667,7 @@ export interface paths { * * Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + * * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." * * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." * * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." @@ -5392,10 +5705,12 @@ export interface paths { post?: never; /** * Delete a repository - * @description Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + * @description Deleting a repository requires admin access. * * If an organization owner has configured the organization to prevent members from deleting organization-owned * repositories, you will get a `403 Forbidden` response. + * + * OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. */ delete: operations["repos/delete"]; options?: never; @@ -5416,7 +5731,11 @@ export interface paths { }; /** * List artifacts for a repository - * @description Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Lists all artifacts for a repository. + * + * 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. */ get: operations["actions/list-artifacts-for-repo"]; put?: never; @@ -5436,14 +5755,19 @@ export interface paths { }; /** * Get an artifact - * @description Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific artifact for a workflow run. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-artifact"]; put?: never; post?: never; /** * Delete an artifact - * @description Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * @description Deletes an artifact for a workflow run. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-artifact"]; options?: never; @@ -5463,8 +5787,7 @@ export interface paths { * @description Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in * the response header to find the URL for the download. The `:archive_format` must be `zip`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-artifact"]; put?: never; @@ -5486,7 +5809,10 @@ export interface paths { * Get GitHub Actions cache usage for a repository * @description Gets GitHub Actions cache usage for a repository. * The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-usage"]; put?: never; @@ -5507,8 +5833,8 @@ export interface paths { /** * List GitHub Actions caches for a repository * @description Lists the GitHub Actions caches for a repository. - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-actions-cache-list"]; put?: never; @@ -5517,9 +5843,7 @@ export interface paths { * Delete GitHub Actions caches for a repository (using a cache key) * @description Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-actions-cache-by-key"]; options?: never; @@ -5541,9 +5865,7 @@ export interface paths { * Delete a GitHub Actions cache for a repository (using a cache ID) * @description Deletes a GitHub Actions cache for a repository, using a cache ID. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-actions-cache-by-id"]; options?: never; @@ -5560,7 +5882,11 @@ export interface paths { }; /** * Get a job for a workflow run - * @description Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific job in a workflow run. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-job-for-workflow-run"]; put?: never; @@ -5581,9 +5907,11 @@ export interface paths { /** * Download job logs for a workflow run * @description Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look - * for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can - * use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must - * have the `actions:read` permission to use this endpoint. + * for `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-job-logs-for-workflow-run"]; put?: never; @@ -5607,8 +5935,7 @@ export interface paths { * Re-run a job from a workflow run * @description Re-run a job and its dependent jobs in a workflow run. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-job-for-workflow-run"]; delete?: never; @@ -5627,15 +5954,15 @@ export interface paths { /** * Get the customization template for an OIDC subject claim for a repository * @description Gets the customization template for an OpenID Connect (OIDC) subject claim. - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-custom-oidc-sub-claim-for-repo"]; /** * Set the customization template for an OIDC subject claim for a repository * @description Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - * You must authenticate using an access token with the `repo` scope to use this - * endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-custom-oidc-sub-claim-for-repo"]; post?: never; @@ -5657,9 +5984,9 @@ export interface paths { * @description Lists all organization secrets shared with a repository without revealing their encrypted * values. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-organization-secrets"]; put?: never; @@ -5679,11 +6006,11 @@ export interface paths { }; /** * List repository organization variables - * @description Lists all organiation variables shared with a repository. + * @description Lists all organization variables shared with a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-organization-variables"]; put?: never; @@ -5705,14 +6032,14 @@ export interface paths { * Get GitHub Actions permissions for a repository * @description Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-github-actions-permissions-repository"]; /** * Set GitHub Actions permissions for a repository * @description Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-github-actions-permissions-repository"]; post?: never; @@ -5735,8 +6062,7 @@ export interface paths { * This endpoint only applies to private repositories. * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - * repository `administration` permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-workflow-access-to-repository"]; /** @@ -5745,8 +6071,7 @@ export interface paths { * This endpoint only applies to private repositories. * For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - * repository `administration` permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-workflow-access-to-repository"]; post?: never; @@ -5767,14 +6092,14 @@ export interface paths { * Get allowed actions and reusable workflows for a repository * @description Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-allowed-actions-repository"]; /** * Set allowed actions and reusable workflows for a repository * @description Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-allowed-actions-repository"]; post?: never; @@ -5797,7 +6122,7 @@ export interface paths { * as well as if GitHub Actions can submit approving pull request reviews. * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-github-actions-default-workflow-permissions-repository"]; /** @@ -5806,7 +6131,7 @@ export interface paths { * can submit approving pull request reviews. * For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-github-actions-default-workflow-permissions-repository"]; post?: never; @@ -5827,9 +6152,9 @@ export interface paths { * List self-hosted runners for a repository * @description Lists all self-hosted runners configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-self-hosted-runners-for-repo"]; put?: never; @@ -5851,9 +6176,9 @@ export interface paths { * List runner applications for a repository * @description Lists binaries for the runner application that you can download and run. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-runner-applications-for-repo"]; put?: never; @@ -5877,9 +6202,9 @@ export interface paths { * Create configuration for a just-in-time runner for a repository * @description Generates a configuration that can be passed to the runner application at startup. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * The authenticated user must have admin access to the repository. + * + * OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. */ post: operations["actions/generate-runner-jitconfig-for-repo"]; delete?: never; @@ -5899,19 +6224,17 @@ export interface paths { put?: never; /** * Create a registration token for a repository - * @description Returns a token that you can pass to the `config` script. The token - * expires after one hour. + * @description Returns a token that you can pass to the `config` script. The token expires after one hour. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: * - * Example using registration token: + * ``` + * ./config.sh --url https://github.com/octo-org --token TOKEN + * ``` * - * Configure your self-hosted runner, replacing `TOKEN` with the registration token provided - * by this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-registration-token-for-repo"]; delete?: never; @@ -5931,19 +6254,17 @@ export interface paths { put?: never; /** * Create a remove token for a repository - * @description Returns a token that you can pass to remove a self-hosted runner from - * a repository. The token expires after one hour. + * @description Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: * - * Example using remove token: + * ``` + * ./config.sh remove --token TOKEN + * ``` * - * To remove your self-hosted runner from a repository, replace TOKEN with - * the remove token provided by this endpoint. + * Authenticated users must have admin access to the repository to use this endpoint. * - * ```config.sh remove --token TOKEN``` + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-remove-token-for-repo"]; delete?: never; @@ -5963,9 +6284,9 @@ export interface paths { * Get a self-hosted runner for a repository * @description Gets a specific self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-self-hosted-runner-for-repo"]; put?: never; @@ -5974,9 +6295,9 @@ export interface paths { * Delete a self-hosted runner from a repository * @description Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-self-hosted-runner-from-repo"]; options?: never; @@ -5995,9 +6316,9 @@ export interface paths { * List labels for a self-hosted runner for a repository * @description Lists all labels for a self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-labels-for-self-hosted-runner-for-repo"]; /** @@ -6005,18 +6326,18 @@ export interface paths { * @description Remove all previous custom labels and set the new custom labels for a specific * self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/set-custom-labels-for-self-hosted-runner-for-repo"]; /** * Add custom labels to a self-hosted runner for a repository - * @description Add custom labels to a self-hosted runner configured in a repository. + * @description Adds custom labels to a self-hosted runner configured in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the organization to use this endpoint. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/add-custom-labels-to-self-hosted-runner-for-repo"]; /** @@ -6024,9 +6345,9 @@ export interface paths { * @description Remove all custom labels from a self-hosted runner configured in a * repository. Returns the remaining read-only labels from the runner. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/remove-all-custom-labels-from-self-hosted-runner-for-repo"]; options?: never; @@ -6052,9 +6373,9 @@ export interface paths { * This endpoint returns a `404 Not Found` status if the custom label is not * present on the runner. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - * Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + * Authenticated users must have admin access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/remove-custom-label-from-self-hosted-runner-for-repo"]; options?: never; @@ -6071,9 +6392,13 @@ export interface paths { }; /** * List workflow runs for a repository - * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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 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`. */ get: operations["actions/list-workflow-runs-for-repo"]; put?: never; @@ -6093,16 +6418,22 @@ export interface paths { }; /** * Get a workflow run - * @description Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific workflow run. + * + * 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. */ get: operations["actions/get-workflow-run"]; put?: never; post?: never; /** * Delete a workflow run - * @description Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is - * private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use - * this endpoint. + * @description Deletes a specific workflow run. + * + * Anyone with write access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-workflow-run"]; options?: never; @@ -6119,7 +6450,9 @@ export interface paths { }; /** * Get the review history for a workflow run - * @description Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description 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. */ get: operations["actions/get-reviews-for-run"]; put?: never; @@ -6143,7 +6476,7 @@ export interface paths { * Approve a workflow run for a fork pull request * @description Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/approve-workflow-run"]; delete?: never; @@ -6161,7 +6494,11 @@ export interface paths { }; /** * List workflow run artifacts - * @description Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Lists artifacts for a workflow run. + * + * 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. */ get: operations["actions/list-workflow-run-artifacts"]; put?: never; @@ -6181,10 +6518,11 @@ export interface paths { }; /** * Get a workflow run attempt - * @description Gets a specific workflow run attempt. Anyone with read access to the repository - * can use this endpoint. If the repository is private you must use an access token - * with the `repo` scope. GitHub Apps must have the `actions:read` permission to - * use this endpoint. + * @description Gets a specific workflow run attempt. + * + * 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. */ get: operations["actions/get-workflow-run-attempt"]; put?: never; @@ -6204,7 +6542,12 @@ export interface paths { }; /** * List jobs for a workflow run attempt - * @description Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information + * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + * + * 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. */ get: operations["actions/list-jobs-for-workflow-run-attempt"]; put?: never; @@ -6225,9 +6568,11 @@ export interface paths { /** * Download workflow run attempt logs * @description Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - * 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to - * the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `actions:read` permission to use this endpoint. + * 1 minute. Look for `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-workflow-run-attempt-logs"]; put?: never; @@ -6251,8 +6596,7 @@ export interface paths { * Cancel a workflow run * @description Cancels a workflow run using its `id`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/cancel-workflow-run"]; delete?: never; @@ -6277,8 +6621,7 @@ export interface paths { * **Note:** GitHub Apps can only review their own custom deployment protection rules. * To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). * - * If the repository is private, you must use an access token with the `repo` scope. - * GitHub Apps must have read and write permission for **Deployments** to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ post: operations["actions/review-custom-gates-for-run"]; delete?: never; @@ -6301,8 +6644,7 @@ export interface paths { * @description Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. * You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/force-cancel-workflow-run"]; delete?: never; @@ -6320,7 +6662,12 @@ export interface paths { }; /** * List jobs for a workflow run - * @description Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information + * about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + * + * 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. */ get: operations["actions/list-jobs-for-workflow-run"]; put?: never; @@ -6341,16 +6688,20 @@ export interface paths { /** * Download workflow run logs * @description Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - * `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use - * this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have - * the `actions:read` permission to use this endpoint. + * `Location:` in the response header to find the URL for the download. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/download-workflow-run-logs"]; put?: never; post?: never; /** * Delete workflow run logs - * @description Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * @description Deletes all logs for a workflow run. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-workflow-run-logs"]; options?: never; @@ -6369,7 +6720,9 @@ export interface paths { * Get pending deployments for a workflow run * @description Get all deployment environments for a workflow run that are waiting for protection rules to pass. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-pending-deployments-for-run"]; put?: never; @@ -6377,7 +6730,9 @@ export interface paths { * Review pending deployments for a workflow run * @description Approve or reject pending deployments that are waiting on approval by a required reviewer. * - * Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint. + * Required reviewers with read access to the repository contents and deployments can use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/review-pending-deployments-for-run"]; delete?: never; @@ -6397,7 +6752,9 @@ export interface paths { put?: never; /** * Re-run a workflow - * @description Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * @description Re-runs your workflow run using its `id`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-workflow"]; delete?: never; @@ -6417,7 +6774,9 @@ export interface paths { put?: never; /** * Re-run failed jobs from a workflow run - * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. + * @description Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/re-run-workflow-failed-jobs"]; delete?: never; @@ -6437,7 +6796,9 @@ export interface paths { * Get workflow run usage * @description Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ get: operations["actions/get-workflow-run-usage"]; put?: never; @@ -6460,9 +6821,9 @@ export interface paths { * @description Lists all secrets available in a repository without revealing their encrypted * values. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-secrets"]; put?: never; @@ -6486,9 +6847,8 @@ export interface paths { * encrypt a secret before you can create or update secrets. * * Anyone with read access to the repository can use this endpoint. - * If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-public-key"]; put?: never; @@ -6510,9 +6870,9 @@ export interface paths { * Get a repository secret * @description Gets a single repository secret without revealing its encrypted value. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * The authenticated user must have collaborator access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-secret"]; /** @@ -6520,9 +6880,9 @@ export interface paths { * @description Creates or updates a repository secret with an encrypted value. 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)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/create-or-update-repo-secret"]; post?: never; @@ -6530,9 +6890,9 @@ export interface paths { * Delete a repository secret * @description Deletes a secret in a repository using the secret name. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-repo-secret"]; options?: never; @@ -6550,9 +6910,10 @@ export interface paths { /** * List repository variables * @description Lists all repository variables. - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + * * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/list-repo-variables"]; put?: never; @@ -6560,9 +6921,9 @@ export interface paths { * Create a repository variable * @description Creates a repository variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-repo-variable"]; delete?: never; @@ -6582,9 +6943,9 @@ export interface paths { * Get a repository variable * @description Gets a specific variable in a repository. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * The authenticated user must have collaborator access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["actions/get-repo-variable"]; put?: never; @@ -6593,9 +6954,9 @@ export interface paths { * Delete a repository variable * @description Deletes a repository variable using the variable name. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["actions/delete-repo-variable"]; options?: never; @@ -6604,9 +6965,9 @@ export interface paths { * Update a repository variable * @description Updates a repository variable that you can reference in a GitHub Actions workflow. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ patch: operations["actions/update-repo-variable"]; trace?: never; @@ -6620,7 +6981,11 @@ export interface paths { }; /** * List repository workflows - * @description Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Lists the workflows in a repository. + * + * 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. */ get: operations["actions/list-repo-workflows"]; put?: never; @@ -6640,7 +7005,12 @@ export interface paths { }; /** * Get a workflow - * @description Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * @description Gets a specific workflow. You can replace `workflow_id` with the workflow + * file name. For example, you could use `main.yaml`. + * + * 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. */ get: operations["actions/get-workflow"]; put?: never; @@ -6663,7 +7033,7 @@ export interface paths { * Disable a workflow * @description Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/disable-workflow"]; post?: never; @@ -6688,7 +7058,7 @@ export interface paths { * * You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["actions/create-workflow-dispatch"]; delete?: never; @@ -6709,7 +7079,7 @@ export interface paths { * Enable a workflow * @description Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["actions/enable-workflow"]; post?: never; @@ -6728,9 +7098,11 @@ export interface paths { }; /** * List workflow runs for a workflow - * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + * @description List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). * - * Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + * 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. */ get: operations["actions/list-workflow-runs"]; put?: never; @@ -6752,7 +7124,11 @@ export interface paths { * Get workflow usage * @description Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + * + * 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. */ get: operations["actions/get-workflow-usage"]; put?: never; @@ -6838,8 +7214,8 @@ export interface paths { cookie?: never; }; /** - * List all autolinks of a repository - * @description This returns a list of autolinks configured for the given repository. + * Get all autolinks of a repository + * @description Gets all autolinks that are configured for a repository. * * Information about autolinks are only available to repository administrators. */ @@ -7183,28 +7559,28 @@ export interface paths { * Get apps with access to the protected branch * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ get: operations["repos/get-apps-with-access-to-protected-branch"]; /** * Set app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ put: operations["repos/set-app-access-restrictions"]; /** * Add app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ post: operations["repos/add-app-access-restrictions"]; /** * Remove app access restrictions * @description Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + * Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. */ delete: operations["repos/remove-app-access-restrictions"]; options?: never; @@ -7319,17 +7695,9 @@ export interface paths { * * **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". * - * The permissions required to use this endpoint depends on whether you are renaming the default branch. - * - * To rename a non-default branch: - * - * * Users must have push access. - * * GitHub Apps must have the `contents:write` repository permission. + * The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. * - * To rename the default branch: - * - * * Users must have admin or owner permissions. - * * GitHub Apps must have the `administration:write` repository permission. + * In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. */ post: operations["repos/rename-branch"]; delete?: never; @@ -7349,11 +7717,13 @@ export interface paths { put?: never; /** * Create a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Creates a new check run for a specific commit in a repository. * - * Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + * To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. * * In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + * + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. */ post: operations["checks/create"]; delete?: never; @@ -7371,9 +7741,11 @@ export interface paths { }; /** * Get a check run - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * @description Gets a single check run using its `id`. * - * Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/get"]; put?: never; @@ -7383,9 +7755,11 @@ export interface paths { head?: never; /** * Update a check run - * @description Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + * @description Updates a check run for a specific commit in a repository. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ patch: operations["checks/update"]; trace?: never; @@ -7399,7 +7773,9 @@ export interface paths { }; /** * List check run annotations - * @description Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository. + * @description Lists annotations for a check run using the annotation `id`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-annotations"]; put?: never; @@ -7423,9 +7799,9 @@ export interface paths { * Rerequest a check run * @description Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. - * * For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + * + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-run"]; delete?: never; @@ -7445,9 +7821,11 @@ export interface paths { put?: never; /** * Create a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". * - * By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/create-suite"]; delete?: never; @@ -7471,7 +7849,8 @@ export interface paths { head?: never; /** * Update repository preferences for check suites - * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites. + * @description Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). + * You must have admin permissions in the repository to set preferences for check suites. */ patch: operations["checks/set-suites-preferences"]; trace?: never; @@ -7485,9 +7864,11 @@ export interface paths { }; /** * Get a check suite - * @description **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * @description Gets a single check suite using its `id`. + * + * **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. * - * Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/get-suite"]; put?: never; @@ -7507,9 +7888,11 @@ export interface paths { }; /** * List check runs in a check suite - * @description Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * @description Lists check runs for a check suite using its `id`. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-for-suite"]; put?: never; @@ -7533,7 +7916,7 @@ export interface paths { * Rerequest a check suite * @description Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. * - * To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository. + * OAuth apps and personal access tokens (classic) cannot use this endpoint. */ post: operations["checks/rerequest-suite"]; delete?: never; @@ -7553,11 +7936,11 @@ export interface paths { * List code scanning alerts for a repository * @description Lists code scanning alerts. * - * To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. - * * The response includes a `most_recent_instance` object. * This provides details of the most recent instance of this alert * for the default branch (or for the specified Git reference if you used `ref` in the request). + * + * 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/list-alerts-for-repo"]; put?: never; @@ -7577,7 +7960,9 @@ export interface paths { }; /** * Get a code scanning alert - * @description Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. + * @description Gets a single 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-alert"]; put?: never; @@ -7587,7 +7972,8 @@ export interface paths { head?: never; /** * Update a code scanning alert - * @description Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only. + * @description Updates the status of a single 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. */ patch: operations["code-scanning/update-alert"]; trace?: never; @@ -7602,8 +7988,8 @@ export interface paths { /** * List instances of a code scanning alert * @description Lists all instances of the specified code scanning alert. - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. + * + * 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/list-alert-instances"]; put?: never; @@ -7634,11 +8020,10 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. - * * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + * + * 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/list-recent-analyses"]; put?: never; @@ -7659,8 +8044,6 @@ export interface paths { /** * Get a code scanning analysis for a repository * @description Gets a specified code scanning analysis for a repository. - * You must use an access token with the `security_events` scope to use this endpoint with private repos, - * the `public_repo` scope also grants permission to read security events on public repos only. * * The default JSON response contains fields that describe the analysis. * This includes the Git reference and commit SHA to which the analysis relates, @@ -7672,20 +8055,18 @@ export interface paths { * For very old analyses this data is not available, * and `0` is returned in this field. * - * If you use the Accept header `application/sarif+json`, - * the response contains the analysis data that was uploaded. - * This is formatted as - * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + * 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/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + * + * 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-analysis"]; put?: never; post?: never; /** * Delete a code scanning analysis from a repository - * @description Deletes a specified code scanning analysis from a repository. For - * private repositories, you must use an access token with the `repo` scope. For public repositories, - * you must use an access token with `public_repo` scope. - * GitHub Apps must have the `security_events` write permission to use this endpoint. + * @description Deletes a specified code scanning analysis from a repository. * * You can delete one analysis at a time. * To delete a series of analyses, start with the most recent analysis and work backwards. @@ -7747,6 +8128,8 @@ export interface paths { * * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. * * The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + * + * 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. */ delete: operations["code-scanning/delete-analysis"]; options?: never; @@ -7765,8 +8148,7 @@ export interface paths { * List CodeQL databases for a repository * @description Lists the CodeQL databases that are available in a repository. * - * For private repositories, you must use an access token with the `security_events` scope. - * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + * 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/list-codeql-databases"]; put?: never; @@ -7794,8 +8176,7 @@ export interface paths { * your HTTP client is configured to follow redirects or use the `Location` header * to make a second request to get the redirect URL. * - * For private repositories, you must use an access token with the `security_events` scope. - * For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + * 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-codeql-database"]; put?: never; @@ -7816,8 +8197,8 @@ export interface paths { /** * Get a code scanning default setup configuration * @description Gets a code scanning default setup configuration. - * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. + * + * 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. */ get: operations["code-scanning/get-default-setup"]; put?: never; @@ -7828,8 +8209,8 @@ export interface paths { /** * Update a code scanning default setup configuration * @description Updates a code scanning default setup configuration. - * You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - * scope for public repos. + * + * 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. */ patch: operations["code-scanning/update-default-setup"]; trace?: never; @@ -7845,7 +8226,7 @@ export interface paths { put?: never; /** * Upload an analysis as SARIF data - * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." + * @description Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)." * * There are two places where you can upload code scanning results. * - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)." @@ -7856,7 +8237,7 @@ export interface paths { * ``` * gzip -c analysis-data.sarif | base64 -w0 * ``` - *
+ * * SARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable. * To get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see "[SARIF results exceed one or more limits](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif/results-exceed-limit)." * @@ -7875,6 +8256,8 @@ export interface paths { * The `202 Accepted` response includes an `id` value. * You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)." + * + * 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/upload-sarif"]; delete?: never; @@ -7892,7 +8275,8 @@ export interface paths { }; /** * Get information about a SARIF upload - * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repos, the `public_repo` scope also grants permission to read security events on public repos only. + * @description Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." + * 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-sarif"]; put?: never; @@ -7938,9 +8322,7 @@ export interface paths { * List codespaces in a repository for the authenticated user * @description Lists the codespaces associated to a specified repository and the authenticated user. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/list-in-repository-for-authenticated-user"]; put?: never; @@ -7948,9 +8330,7 @@ export interface paths { * Create a codespace in a repository * @description Creates a codespace owned by the authenticated user in the specified repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/create-with-repo-for-authenticated-user"]; delete?: never; @@ -7971,9 +8351,7 @@ export interface paths { * @description Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files * specify launchpoint configurations for codespaces created within the repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/list-devcontainers-in-repository-for-authenticated-user"]; put?: never; @@ -7995,9 +8373,7 @@ export interface paths { * List available machine types for a repository * @description List the machine types available for a given repository based on its configuration. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/repo-machines-for-authenticated-user"]; put?: never; @@ -8019,9 +8395,7 @@ export interface paths { * Get default attributes for a codespace * @description Gets the default attributes for codespaces created by the user with the repository. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/pre-flight-with-repo-for-authenticated-user"]; put?: never; @@ -8043,9 +8417,7 @@ export interface paths { * Check if permissions defined by a devcontainer have been accepted by the authenticated user * @description Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/check-permissions-for-devcontainer"]; put?: never; @@ -8065,7 +8437,10 @@ export interface paths { }; /** * List repository secrets - * @description Lists all development environment secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Lists all development environment secrets available in a repository without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/list-repo-secrets"]; put?: never; @@ -8085,7 +8460,12 @@ export interface paths { }; /** * Get a repository public key - * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/get-repo-public-key"]; put?: never; @@ -8105,7 +8485,9 @@ export interface paths { }; /** * Get a repository secret - * @description Gets a single repository development environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Gets a single repository development environment secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["codespaces/get-repo-secret"]; /** @@ -8113,15 +8495,15 @@ export interface paths { * @description Creates or updates a repository development environment secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - * repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["codespaces/create-or-update-repo-secret"]; post?: never; /** * Delete a repository secret - * @description Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + * @description Deletes a development environment secret in a repository using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["codespaces/delete-repo-secret"]; options?: never; @@ -8143,9 +8525,9 @@ export interface paths { * * Team members will include the members of child teams. * - * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - * endpoint. + * The authenticated user must have push access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/list-collaborators"]; put?: never; @@ -8169,9 +8551,9 @@ export interface paths { * * Team members will include the members of child teams. * - * You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - * endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - * endpoint. + * The authenticated user must have push access to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. */ get: operations["repos/check-collaborator"]; /** @@ -8186,7 +8568,7 @@ export interface paths { * Cannot assign {member} permission of {role name} * ``` * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * * The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). * @@ -8265,9 +8647,14 @@ export interface paths { }; /** * List commit comments for a repository - * @description Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + * @description Lists the commit comments for a specified repository. Comments are ordered by ascending ID. + * + * 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)." * - * Comments are ordered by ascending ID. + * - **`application/vnd.github-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-commit-comments-for-repo"]; put?: never; @@ -8285,7 +8672,17 @@ export interface paths { path?: never; cookie?: never; }; - /** Get a commit comment */ + /** + * Get a commit comment + * @description Gets a specified commit comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ get: operations["repos/get-commit-comment"]; put?: never; post?: never; @@ -8293,7 +8690,17 @@ export interface paths { delete: operations["repos/delete-commit-comment"]; options?: never; head?: never; - /** Update a commit comment */ + /** + * Update a commit comment + * @description Updates the contents of a specified commit comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. + */ patch: operations["repos/update-commit-comment"]; trace?: never; }; @@ -8421,7 +8828,14 @@ export interface paths { }; /** * List commit comments - * @description Use the `:commit_sha` to specify the commit that will have its comments listed. + * @description Lists the comments for a specified commit. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["repos/list-comments-for-commit"]; put?: never; @@ -8430,6 +8844,13 @@ export interface paths { * @description Create a comment for a commit using its `:commit_sha`. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["repos/create-commit-comment"]; delete?: never; @@ -8471,11 +8892,13 @@ export interface paths { * Get a commit * @description Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. * - * **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + * **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. * - * You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property. + * 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)." Pagination query parameters are not supported for these media types. * - * To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. + * - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. * * **Signature verification object** * @@ -8524,11 +8947,13 @@ export interface paths { }; /** * List check runs for a Git reference - * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + * @description Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. * * If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-for-ref"]; put?: never; @@ -8548,9 +8973,11 @@ export interface paths { }; /** * List check suites for a Git reference - * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + * @description Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. * * **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. */ get: operations["checks/list-suites-for-ref"]; put?: never; @@ -8649,9 +9076,14 @@ export interface paths { }; /** * Compare two commits - * @description Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * @description Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + * + * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. + * + * 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)." * - * This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * - **`application/vnd.github.diff`**: Returns the diff of the commit. + * - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. * * The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. * @@ -8713,50 +9145,40 @@ export interface paths { }; /** * Get repository content - * @description Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit - * `:path`, you will receive the contents of the repository's root directory. See the description below regarding what the API response includes for directories. + * @description Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. + * + * 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 file contents for files and symlinks. + * - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + * - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + * + * If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". * - * Files and symlinks support [a custom media type](https://docs.github.com/rest/overview/media-types) for - * retrieving the raw content or rendered HTML (when supported). All content types support [a custom media - * type](https://docs.github.com/rest/overview/media-types) to ensure the content is returned in a consistent - * object format. + * If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + * + * If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. * * **Notes**: - * * To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). - * * This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees - * API](https://docs.github.com/rest/git/trees#get-a-tree). - * * Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. - * Size limits: - * If the requested file's size is: - * * 1 MB or smaller: All features of this endpoint are supported. - * * Between 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. - * * Greater than 100 MB: This endpoint is not supported. - * - * If the content is a directory: - * The response will be an array of objects, one object for each item in the directory. - * When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value - * _should_ be "submodule". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). - * In the next major version of the API, the type will be returned as "submodule". - * - * If the content is a symlink: - * If the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the - * API responds with the content of the file (in the format shown in the example. Otherwise, the API responds with an object - * describing the symlink itself. - * - * If the content is a submodule: - * The `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific - * commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out - * the submodule at that specific commit. - * - * If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the - * github.com URLs (`html_url` and `_links["html"]`) will have null values. + * + * - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). + * - This API has an upper limit of 1,000 files for a directory. If you need to retrieve + * more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). + * - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + * - If the requested file's size is: + * - 1 MB or smaller: All features of this endpoint are supported. + * - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + * string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + * - Greater than 100 MB: This endpoint is not supported. */ get: operations["repos/get-content"]; /** * Create or update file contents - * @description Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. + * @description Creates a new file or replaces an existing file in a repository. * * **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. */ put: operations["repos/create-or-update-file-contents"]; post?: never; @@ -8809,9 +9231,7 @@ export interface paths { }; /** * List Dependabot alerts for a repository - * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * @description OAuth app tokens and personal access tokens (classic) need the `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["dependabot/list-alerts-for-repo"]; put?: never; @@ -8831,9 +9251,7 @@ export interface paths { }; /** * Get a Dependabot alert - * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + * @description OAuth app tokens and personal access tokens (classic) need the `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["dependabot/get-alert"]; put?: never; @@ -8843,11 +9261,9 @@ export interface paths { head?: never; /** * Update a Dependabot alert - * @description You must use an access token with the `security_events` scope to use this endpoint with private repositories. - * You can also use tokens with the `public_repo` scope for public repositories only. - * GitHub Apps must have **Dependabot alerts** write permission to use this endpoint. + * @description The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." * - * To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + * OAuth app tokens and personal access tokens (classic) need the `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. */ patch: operations["dependabot/update-alert"]; trace?: never; @@ -8861,7 +9277,10 @@ export interface paths { }; /** * List repository secrets - * @description Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Lists all secrets available in a repository without revealing their encrypted + * values. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["dependabot/list-repo-secrets"]; put?: never; @@ -8881,7 +9300,11 @@ export interface paths { }; /** * Get a repository public key - * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Gets your public key, which you need to encrypt secrets. You need to + * encrypt a secret before you can create or update secrets. 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 if the repository is private. */ get: operations["dependabot/get-repo-public-key"]; put?: never; @@ -8901,7 +9324,9 @@ export interface paths { }; /** * Get a repository secret - * @description Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Gets a single repository secret without revealing its encrypted value. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["dependabot/get-repo-secret"]; /** @@ -8909,15 +9334,15 @@ export interface paths { * @description Creates or updates a repository secret with an encrypted value. 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)." * - * You must authenticate using an access - * token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository - * permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["dependabot/create-or-update-repo-secret"]; post?: never; /** * Delete a repository secret - * @description Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + * @description Deletes a secret in a repository using the secret name. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["dependabot/delete-repo-secret"]; options?: never; @@ -8976,7 +9401,11 @@ export interface paths { put?: never; /** * Create a snapshot of dependencies for a repository - * @description Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to. + * @description Create a new snapshot of a repository's dependencies. + * + * The authenticated user must have access to the repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["dependency-graph/create-repository-snapshot"]; delete?: never; @@ -9026,8 +9455,6 @@ export interface paths { * be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an * application with debugging enabled. * - * Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. - * * Merged branch response: * * You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating @@ -9048,6 +9475,8 @@ export interface paths { * * This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` * status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ post: operations["repos/create-deployment"]; delete?: never; @@ -9069,7 +9498,7 @@ export interface paths { post?: never; /** * Delete a deployment - * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. + * @description If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. * * To set a deployment as inactive, you must: * @@ -9077,6 +9506,8 @@ export interface paths { * * Mark the active deployment as inactive by adding any non-successful deployment status. * * For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. */ delete: operations["repos/delete-deployment"]; options?: never; @@ -9101,7 +9532,7 @@ export interface paths { * Create a deployment status * @description Users with `push` access can create deployment statuses for a given deployment. * - * GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. + * OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. */ post: operations["repos/create-deployment-status"]; delete?: never; @@ -9145,12 +9576,9 @@ export interface paths { * * The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. * - * This endpoint requires write access to the repository by providing either: - * - * - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - * - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. - * * This input example shows how you can use the `client_payload` as a test to debug your workflow. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-dispatch-event"]; delete?: never; @@ -9170,7 +9598,9 @@ export interface paths { * List environments * @description Lists the environments for a repository. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ get: operations["repos/get-all-environments"]; put?: never; @@ -9192,9 +9622,9 @@ export interface paths { * Get an environment * @description **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." * - * Anyone with read access to the repository can use this endpoint. If the - * repository is private, you must use an access token with the `repo` scope. GitHub - * Apps must have the `actions:read` permission to use this endpoint. + * 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. */ get: operations["repos/get-environment"]; /** @@ -9205,13 +9635,13 @@ export interface paths { * * **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/create-or-update-environment"]; post?: never; /** * Delete an environment - * @description You must authenticate using an access token with the repo scope to use this endpoint. + * @description OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-an-environment"]; options?: never; @@ -9230,7 +9660,9 @@ export interface paths { * List deployment branch policies * @description Lists the deployment branch policies for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ get: operations["repos/list-deployment-branch-policies"]; put?: never; @@ -9238,7 +9670,7 @@ export interface paths { * Create a deployment branch policy * @description Creates a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-deployment-branch-policy"]; delete?: never; @@ -9258,14 +9690,16 @@ export interface paths { * Get a deployment branch policy * @description Gets a deployment branch or tag policy for an environment. * - * Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + * 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. */ get: operations["repos/get-deployment-branch-policy"]; /** * Update a deployment branch policy * @description Updates a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/update-deployment-branch-policy"]; post?: never; @@ -9273,7 +9707,7 @@ export interface paths { * Delete a deployment branch policy * @description Deletes a deployment branch or tag policy for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-deployment-branch-policy"]; options?: never; @@ -9290,9 +9724,11 @@ export interface paths { }; /** * Get all deployment protection rules for an environment - * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-all-deployment-protection-rules"]; put?: never; @@ -9300,9 +9736,11 @@ export interface paths { * Create a custom deployment protection rule on an environment * @description Enable a custom deployment protection rule for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. * * For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-deployment-protection-rule"]; delete?: never; @@ -9320,11 +9758,13 @@ export interface paths { }; /** * List custom deployment rule integrations available for an environment - * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. + * @description Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. * - * For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-custom-deployment-rule-integrations"]; put?: never; @@ -9344,9 +9784,11 @@ export interface paths { }; /** * Get a custom deployment protection rule - * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + * @description Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." * * For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. */ get: operations["repos/get-custom-deployment-protection-rule"]; put?: never; @@ -9355,7 +9797,9 @@ export interface paths { * Disable a custom protection rule for an environment * @description Disables a custom deployment protection rule for an environment. * - * You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)". + * The authenticated user must have admin or owner permissions to the repository to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/disable-deployment-protection-rule"]; options?: never; @@ -9363,6 +9807,169 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List environment secrets + * @description Lists all secrets available in an environment without revealing their + * encrypted values. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-secrets"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an environment public key + * @description Get the public key for an environment, which you need to encrypt environment + * secrets. You need to encrypt a secret before you can create or update secrets. + * + * Anyone with read access to the repository can use this endpoint. + * + * If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-public-key"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an environment secret + * @description Gets a single environment secret without revealing its encrypted value. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-secret"]; + /** + * Create or update an environment secret + * @description Creates or updates an environment secret with an encrypted value. 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)." + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + put: operations["actions/create-or-update-environment-secret"]; + post?: never; + /** + * Delete an environment secret + * @description Deletes a secret in an environment using the secret name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read secrets. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-secret"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * List environment variables + * @description Lists all environment variables. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/list-environment-variables"]; + put?: never; + /** + * Create an environment variable + * @description Create an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + post: operations["actions/create-environment-variable"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get an environment variable + * @description Gets a specific variable in an environment. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + get: operations["actions/get-environment-variable"]; + put?: never; + post?: never; + /** + * Delete an environment variable + * @description Deletes an environment variable using the variable name. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + delete: operations["actions/delete-environment-variable"]; + options?: never; + head?: never; + /** + * Update an environment variable + * @description Updates an environment variable that you can reference in a GitHub Actions workflow. + * + * Authenticated users must have collaborator access to a repository to create, update, or read variables. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + */ + patch: operations["actions/update-environment-variable"]; + trace?: never; + }; "/repos/{owner}/{repo}/events": { parameters: { query?: never; @@ -9437,7 +10044,12 @@ export interface paths { * Get a blob * @description The `content` in the response will always be Base64 encoded. * - * _Note_: This API supports blobs up to 100 megabytes in size. + * 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 blob data. + * - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + * + * **Note** This endpoint supports blobs up to 100 megabytes in size. */ get: operations["git/get-blob"]; put?: never; @@ -9626,11 +10238,17 @@ export interface paths { get?: never; put?: never; post?: never; - /** Delete a reference */ + /** + * Delete a reference + * @description Deletes the provided reference. + */ delete: operations["git/delete-ref"]; options?: never; head?: never; - /** Update a reference */ + /** + * Update a reference + * @description Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + */ patch: operations["git/update-ref"]; trace?: never; }; @@ -9840,7 +10458,7 @@ export interface paths { * Get a webhook configuration for a repository * @description Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." * - * Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. */ get: operations["repos/get-webhook-config-for-repo"]; put?: never; @@ -9852,7 +10470,7 @@ export interface paths { * Update a webhook configuration for a repository * @description Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." * - * Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + * OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. */ patch: operations["repos/update-webhook-config-for-repo"]; trace?: never; @@ -10250,6 +10868,13 @@ export interface paths { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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-for-repo"]; put?: never; @@ -10259,6 +10884,13 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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/create"]; delete?: never; @@ -10279,6 +10911,13 @@ export interface paths { * @description You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. * * By default, issue comments are ordered by ascending ID. + * + * 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-comments-for-repo"]; put?: never; @@ -10299,6 +10938,13 @@ export interface paths { /** * Get an issue comment * @description You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + * + * 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/get-comment"]; put?: never; @@ -10313,6 +10959,13 @@ export interface paths { /** * Update an issue comment * @description You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + * + * 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`. */ patch: operations["issues/update-comment"]; trace?: never; @@ -10412,7 +11065,7 @@ export interface paths { }; /** * Get an issue - * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was + * @description The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was * [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If * the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API * returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read @@ -10423,6 +11076,13 @@ export interface paths { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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/get"]; put?: never; @@ -10433,6 +11093,13 @@ export interface paths { /** * Update an issue * @description Issue owners and users with push access can edit 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`. */ patch: operations["issues/update"]; trace?: never; @@ -10497,18 +11164,31 @@ export interface paths { * @description You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * * Issue comments are ordered by ascending ID. + * + * 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-comments"]; put?: never; /** * Create an issue comment - * @description - * You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + * @description You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). * 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/overview/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/create-comment"]; delete?: never; @@ -10601,7 +11281,7 @@ export interface paths { * Lock an issue * @description Users with push access can lock an issue or pull request's conversation. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["issues/lock"]; post?: never; @@ -10806,7 +11486,10 @@ export interface paths { * Get the license for a repository * @description This method returns the contents of the repository's license file, if one is detected. * - * Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. + * 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 contents of the license. + * - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["licenses/get-for-repo"]; put?: never; @@ -10958,28 +11641,34 @@ export interface paths { * Get a GitHub Pages site * @description Gets information about a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages"]; /** * Update information about a GitHub Pages site * @description Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ put: operations["repos/update-information-about-pages-site"]; /** * Create a GitHub Pages site * @description Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ post: operations["repos/create-pages-site"]; /** * Delete a GitHub Pages site * @description Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ delete: operations["repos/delete-pages-site"]; options?: never; @@ -10998,7 +11687,7 @@ export interface paths { * List GitHub Pages builds * @description Lists builts of a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/list-pages-builds"]; put?: never; @@ -11026,7 +11715,7 @@ export interface paths { * Get latest Pages build * @description Gets information about the single most recent build of a GitHub Pages site. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-latest-pages-build"]; put?: never; @@ -11048,7 +11737,7 @@ export interface paths { * Get GitHub Pages build * @description Gets information about a GitHub Pages build. * - * A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages-build"]; put?: never; @@ -11059,7 +11748,7 @@ export interface paths { patch?: never; trace?: never; }; - "/repos/{owner}/{repo}/pages/deployment": { + "/repos/{owner}/{repo}/pages/deployments": { parameters: { query?: never; header?: never; @@ -11072,7 +11761,7 @@ export interface paths { * Create a GitHub Pages deployment * @description Create a GitHub Pages deployment for a repository. * - * Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint. + * The authenticated user must have write permission to the repository. */ post: operations["repos/create-pages-deployment"]; delete?: never; @@ -11081,6 +11770,50 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** + * Get the status of a GitHub Pages deployment + * @description Gets the current status of a GitHub Pages deployment. + * + * The authenticated user must have read permission for the GitHub Pages site. + */ + get: operations["repos/get-pages-deployment"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Cancel a GitHub Pages deployment + * @description Cancels a GitHub Pages deployment. + * + * The authenticated user must have write permissions for the GitHub Pages site. + */ + post: operations["repos/cancel-pages-deployment"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/pages/health": { parameters: { query?: never; @@ -11094,7 +11827,9 @@ export interface paths { * * The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. * - * To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions. + * The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["repos/get-pages-health-check"]; put?: never; @@ -11112,7 +11847,11 @@ export interface paths { path?: never; cookie?: never; }; - get?: never; + /** + * Check if private vulnerability reporting is enabled for a repository + * @description Returns a boolean indicating whether or not private vulnerability reporting is enabled for the repository. For more information, see "[Evaluating the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + */ + get: operations["repos/check-private-vulnerability-reporting"]; /** * Enable private vulnerability reporting for a repository * @description Enables private vulnerability reporting for a repository. The authenticated user must have admin access to the repository. For more information, see "[Privately reporting a security vulnerability](https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)." @@ -11171,7 +11910,14 @@ export interface paths { delete?: never; options?: never; head?: never; - patch?: never; + /** + * Create or update custom property values for a repository + * @description Create new or update existing custom property values for a repository. + * Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + * + * Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + */ + patch: operations["repos/create-or-update-custom-properties-values"]; trace?: never; }; "/repos/{owner}/{repo}/pulls": { @@ -11183,7 +11929,20 @@ export interface paths { }; /** * List pull requests - * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + * @description Lists pull requests in a specified repository. + * + * Draft pull requests are available in public repositories with GitHub + * Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing + * plans, and in public and private repositories with GitHub Team and GitHub Enterprise + * Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) + * in the GitHub Help documentation. + * + * 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["pulls/list"]; put?: never; @@ -11194,6 +11953,13 @@ export interface paths { * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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["pulls/create"]; delete?: never; @@ -11211,7 +11977,15 @@ export interface paths { }; /** * List review comments in a repository - * @description Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. + * @description Lists review comments for all pull requests in a repository. By default, + * review comments are in ascending order by ID. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments-for-repo"]; put?: never; @@ -11231,7 +12005,14 @@ export interface paths { }; /** * Get a review comment for a pull request - * @description Provides details for a review comment. + * @description Provides details for a specified review comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review-comment"]; put?: never; @@ -11245,7 +12026,14 @@ export interface paths { head?: never; /** * Update a review comment for a pull request - * @description Enables you to edit a review comment. + * @description Edits the content of a specified review comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ patch: operations["pulls/update-review-comment"]; trace?: never; @@ -11320,6 +12108,14 @@ export interface paths { * * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. * * Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + * + * 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`. + * - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. */ get: operations["pulls/get"]; put?: never; @@ -11332,6 +12128,13 @@ export interface paths { * @description Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + * + * 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`. */ patch: operations["pulls/update"]; trace?: never; @@ -11349,9 +12152,7 @@ export interface paths { * Create a codespace from a pull request * @description Creates a codespace owned by the authenticated user for the specified pull request. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/create-with-pr-for-authenticated-user"]; delete?: never; @@ -11369,21 +12170,35 @@ export interface paths { }; /** * List review comments on a pull request - * @description Lists all review comments for a pull request. By default, review comments are in ascending order by ID. + * @description Lists all review comments for a specified pull request. By default, review comments + * are in ascending order by ID. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-review-comments"]; put?: never; /** * Create a review comment for a pull request - * @description - * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. + * @description Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." * - * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. + * If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. * - * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review-comment"]; delete?: never; @@ -11407,6 +12222,13 @@ export interface paths { * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-reply-for-review-comment"]; delete?: never; @@ -11424,7 +12246,16 @@ export interface paths { }; /** * List commits on a pull request - * @description Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. + * @description Lists a maximum of 250 commits for a pull request. To receive a complete + * commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) + * endpoint. + * + * 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["pulls/list-commits"]; put?: never; @@ -11444,7 +12275,17 @@ export interface paths { }; /** * List pull requests files - * @description **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. + * @description Lists the files in a specified pull request. + * + * **Note:** Responses include a maximum of 3000 files. The paginated response + * returns 30 files per page by default. + * + * 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["pulls/list-files"]; put?: never; @@ -11518,19 +12359,35 @@ export interface paths { }; /** * List reviews for a pull request - * @description The list of reviews returns in chronological order. + * @description Lists all reviews for a specified pull request. The list of reviews returns in chronological order. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-reviews"]; put?: never; /** * Create a review for a pull request - * @description This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + * @description Creates a review on a specified pull request. + * + * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." * * Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." * - * **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + * **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. * * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/create-review"]; delete?: never; @@ -11549,17 +12406,38 @@ export interface paths { /** * Get a review for a pull request * @description Retrieves a pull request review by its ID. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/get-review"]; /** * Update a review for a pull request - * @description Update the review summary comment with new text. + * @description Updates the contents of a specified review summary comment. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/update-review"]; post?: never; /** * Delete a pending review for a pull request * @description Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ delete: operations["pulls/delete-pending-review"]; options?: never; @@ -11576,7 +12454,14 @@ export interface paths { }; /** * List comments for a pull request review - * @description List comments for a specific pull request review. + * @description Lists comments for a specific pull request review. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ get: operations["pulls/list-comments-for-review"]; put?: never; @@ -11597,7 +12482,18 @@ export interface paths { get?: never; /** * Dismiss a review for a pull request - * @description **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. + * @description Dismisses a specified review on a pull request. + * + * **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), + * you must be a repository administrator or be included in the list of people or teams + * who can dismiss pull request reviews. + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ put: operations["pulls/dismiss-review"]; post?: never; @@ -11619,6 +12515,13 @@ export interface paths { /** * Submit a review for a pull request * @description Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." + * + * 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + * - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + * - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. */ post: operations["pulls/submit-review"]; delete?: never; @@ -11658,7 +12561,10 @@ export interface paths { * Get a repository README * @description Gets the preferred README for a repository. * - * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + * 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 file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme"]; put?: never; @@ -11680,7 +12586,10 @@ export interface paths { * Get a repository README for a directory * @description Gets the README from a repository directory. * - * READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + * 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 file contents. This is the default if you do not specify a media type. + * - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). */ get: operations["repos/get-readme-in-directory"]; put?: never; @@ -11815,7 +12724,11 @@ export interface paths { }; /** * Get a release - * @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). + * @description Gets a public release with the specified release ID. + * + * **Note:** This returns an `upload_url` key corresponding to the endpoint + * for uploading release assets. This key is a hypermedia resource. For more information, see + * "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ get: operations["repos/get-release"]; put?: never; @@ -11846,7 +12759,7 @@ export interface paths { put?: never; /** * Upload a release asset - * @description This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in + * @description This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in * the response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) to upload a release asset. * * You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. @@ -12046,10 +12959,10 @@ export interface paths { /** * List secret scanning alerts for a repository * @description Lists secret scanning alerts for an eligible repository, from newest to oldest. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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/list-alerts-for-repo"]; put?: never; @@ -12070,10 +12983,10 @@ export interface paths { /** * Get a secret scanning alert * @description Gets a single secret scanning alert detected in an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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-alert"]; put?: never; @@ -12084,10 +12997,10 @@ export interface paths { /** * Update a secret scanning alert * @description Updates the status of a secret scanning alert in an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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. */ patch: operations["secret-scanning/update-alert"]; trace?: never; @@ -12102,10 +13015,10 @@ export interface paths { /** * List locations for a secret scanning alert * @description Lists all locations for a given secret scanning alert for an eligible repository. - * To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - * For public repositories, you may instead use the `public_repo` scope. * - * GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + * The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + * + * 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/list-locations-for-alert"]; put?: never; @@ -12126,19 +13039,20 @@ export interface paths { /** * List repository security advisories * @description Lists security advisories in a repository. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - * in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to. * - * You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory. + * The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ get: operations["security-advisories/list-repository-advisories"]; put?: never; /** * Create a repository security advisory * @description Creates a new repository security advisory. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. * - * In order to create a draft repository security advisory, you must be a security manager or administrator of that repository. + * In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ post: operations["security-advisories/create-repository-advisory"]; delete?: never; @@ -12178,12 +13092,13 @@ export interface paths { /** * Get a repository security advisory * @description Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - * You can access any published security advisory on a public repository. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - * in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to. * - * You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a + * Anyone can access any published security advisory on a public repository. + * + * The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a * collaborator on the security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. */ get: operations["security-advisories/get-repository-advisory"]; put?: never; @@ -12194,10 +13109,11 @@ export interface paths { /** * Update a repository security advisory * @description Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. * - * In order to update any security advisory, you must be a security manager or administrator of that repository, + * In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, * or a collaborator on the repository security advisory. + * + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ patch: operations["security-advisories/update-repository-advisory"]; trace?: never; @@ -12217,9 +13133,9 @@ export interface paths { * * You may request a CVE for public repositories, but cannot do so for private repositories. * - * You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + * In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. * - * In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + * OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. */ post: operations["security-advisories/create-repository-advisory-cve-request"]; delete?: never; @@ -12228,6 +13144,28 @@ export interface paths { patch?: never; trace?: never; }; + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** + * Create a temporary private fork + * @description Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. + * + * **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + */ + post: operations["security-advisories/create-fork"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/repos/{owner}/{repo}/stargazers": { parameters: { query?: never; @@ -12239,7 +13177,9 @@ export interface paths { * List stargazers * @description Lists the people that have starred the repository. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * 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.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-stargazers-for-repo"]; put?: never; @@ -12259,7 +13199,12 @@ export interface paths { }; /** * Get the weekly commit activity - * @description Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * @description + * Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + * + * **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains + * 10,000 or more commits, a 422 status code will be returned. + * */ get: operations["repos/get-code-frequency-stats"]; put?: never; @@ -12302,10 +13247,12 @@ export interface paths { * @description * Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: * - * * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + * * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). * * `a` - Number of additions * * `d` - Number of deletions * * `c` - Number of commits + * + * **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. */ get: operations["repos/get-contributors-stats"]; put?: never; @@ -12537,11 +13484,7 @@ export interface paths { * * For a public repository, a team is listed only if that team added the public repository explicitly. * - * Personal access tokens require the following scopes: - * * `public_repo` to call this endpoint on a public repository - * * `repo` to call this endpoint on a private repository (this scope also includes public repositories) - * - * This endpoint is not compatible with fine-grained personal access tokens. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. */ get: operations["repos/list-teams"]; put?: never; @@ -12662,7 +13605,6 @@ export interface paths { /** * Transfer a repository * @description A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). - * You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. */ post: operations["repos/transfer"]; delete?: never; @@ -12738,12 +13680,7 @@ export interface paths { * Create a repository using a template * @description Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-using-template"]; delete?: never; @@ -12776,170 +13713,6 @@ export interface paths { patch?: never; trace?: never; }; - "/repositories/{repository_id}/environments/{environment_name}/secrets": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List environment secrets - * @description Lists all secrets available in an environment without revealing their - * encrypted values. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - get: operations["actions/list-environment-secrets"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get an environment public key - * @description Get the public key for an environment, which you need to encrypt environment - * secrets. You need to encrypt a secret before you can create or update secrets. - * - * Anyone with read access to the repository can use this endpoint. - * If the repository is private you must use an access token with the `repo` scope. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - get: operations["actions/get-environment-public-key"]; - put?: never; - post?: never; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get an environment secret - * @description Gets a single environment secret without revealing its encrypted value. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - get: operations["actions/get-environment-secret"]; - /** - * Create or update an environment secret - * @description Creates or updates an environment secret with an encrypted value. 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)." - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - put: operations["actions/create-or-update-environment-secret"]; - post?: never; - /** - * Delete an environment secret - * @description Deletes a secret in an environment using the secret name. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `secrets` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read secrets. - */ - delete: operations["actions/delete-environment-secret"]; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * List environment variables - * @description Lists all environment variables. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environments:read` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - get: operations["actions/list-environment-variables"]; - put?: never; - /** - * Create an environment variable - * @description Create an environment variable that you can reference in a GitHub Actions workflow. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - post: operations["actions/create-environment-variable"]; - delete?: never; - options?: never; - head?: never; - patch?: never; - trace?: never; - }; - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": { - parameters: { - query?: never; - header?: never; - path?: never; - cookie?: never; - }; - /** - * Get an environment variable - * @description Gets a specific variable in an environment. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environments:read` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - get: operations["actions/get-environment-variable"]; - put?: never; - post?: never; - /** - * Delete an environment variable - * @description Deletes an environment variable using the variable name. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - delete: operations["actions/delete-environment-variable"]; - options?: never; - head?: never; - /** - * Update an environment variable - * @description Updates an environment variable that you can reference in a GitHub Actions workflow. - * - * You must authenticate using an access token with the `repo` scope to use this endpoint. - * GitHub Apps must have the `environment:write` repository permission to use this endpoint. - * Authenticated users must have collaborator access to a repository to create, update, or read variables. - */ - patch: operations["actions/update-environment-variable"]; - trace?: never; - }; "/search/code": { parameters: { query?: never; @@ -13202,7 +13975,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. * - * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List all discussions on a team's page. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussions-legacy"]; put?: never; @@ -13211,9 +13986,11 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. * - * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Creates a new discussion post on a team's page. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-legacy"]; delete?: never; @@ -13234,7 +14011,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. * - * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Get a specific discussion on a team's page. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-legacy"]; put?: never; @@ -13244,7 +14023,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. * - * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Delete a discussion from a team's page. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-legacy"]; options?: never; @@ -13254,7 +14035,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Edits the title and body text of a discussion post. Only the parameters you provide are updated. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-legacy"]; trace?: never; @@ -13271,7 +14054,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. * - * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List all comments on a team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/list-discussion-comments-legacy"]; put?: never; @@ -13280,9 +14065,11 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. * - * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Creates a new comment on a team discussion. * * This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["teams/create-discussion-comment-legacy"]; delete?: never; @@ -13303,7 +14090,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. * - * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Get a specific comment on a team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["teams/get-discussion-comment-legacy"]; put?: never; @@ -13313,7 +14102,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. * - * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Deletes a comment on a team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ delete: operations["teams/delete-discussion-comment-legacy"]; options?: never; @@ -13323,7 +14114,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. * - * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * Edits the body text of a discussion comment. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ patch: operations["teams/update-discussion-comment-legacy"]; trace?: never; @@ -13340,7 +14133,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. * - * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-comment-legacy"]; put?: never; @@ -13349,7 +14144,11 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. * - * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-comment-legacy"]; delete?: never; @@ -13370,7 +14169,9 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. * - * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. */ get: operations["reactions/list-for-team-discussion-legacy"]; put?: never; @@ -13379,7 +14180,11 @@ export interface paths { * @deprecated * @description **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. * - * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + * + * A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + * + * OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. */ post: operations["reactions/create-for-team-discussion-legacy"]; delete?: never; @@ -13464,7 +14269,7 @@ export interface paths { * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-member-legacy"]; post?: never; @@ -13648,7 +14453,7 @@ export interface paths { * * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["teams/add-or-update-repo-permissions-legacy"]; post?: never; @@ -13695,9 +14500,7 @@ export interface paths { }; /** * Get the authenticated user - * @description If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information. - * - * If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + * @description OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. */ get: operations["users/get-authenticated"]; put?: never; @@ -13771,9 +14574,7 @@ export interface paths { * List codespaces for the authenticated user * @description Lists the authenticated user's codespaces. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/list-for-authenticated-user"]; put?: never; @@ -13783,9 +14584,7 @@ export interface paths { * * This endpoint requires either a `repository_id` OR a `pull_request` but not both. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/create-for-authenticated-user"]; delete?: never; @@ -13806,9 +14605,9 @@ export interface paths { * @description Lists all development environment secrets available for a user's codespaces without revealing their * encrypted values. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/list-secrets-for-authenticated-user"]; put?: never; @@ -13830,9 +14629,9 @@ export interface paths { * Get public key for the authenticated user * @description Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/get-public-key-for-authenticated-user"]; put?: never; @@ -13854,9 +14653,9 @@ export interface paths { * Get a secret for the authenticated user * @description Gets a development environment secret available to a user's codespaces without revealing its encrypted value. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/get-secret-for-authenticated-user"]; /** @@ -13864,9 +14663,9 @@ export interface paths { * @description Creates or updates a development environment secret for a user's codespace with an encrypted value. 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)." * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ put: operations["codespaces/create-or-update-secret-for-authenticated-user"]; post?: never; @@ -13874,9 +14673,9 @@ export interface paths { * Delete a secret for the authenticated user * @description Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ delete: operations["codespaces/delete-secret-for-authenticated-user"]; options?: never; @@ -13895,18 +14694,18 @@ export interface paths { * List selected repositories for a user secret * @description List the repositories that have been granted the ability to use a user's development environment secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ get: operations["codespaces/list-repositories-for-secret-for-authenticated-user"]; /** * Set selected repositories for a user secret * @description Select the repositories that will use a user's development environment secret. * - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + * The authenticated user must have Codespaces access to use this endpoint. * - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ put: operations["codespaces/set-repositories-for-secret-for-authenticated-user"]; post?: never; @@ -13927,16 +14726,20 @@ export interface paths { /** * Add a selected repository to a user secret * @description Adds a repository to the selected repositories for a user's development environment secret. - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. + * + * The authenticated user must have Codespaces access to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ put: operations["codespaces/add-repository-for-secret-for-authenticated-user"]; post?: never; /** * Remove a selected repository from a user secret * @description Removes a repository from the selected repositories for a user's development environment secret. - * You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - * GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + * + * The authenticated user must have Codespaces access to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. */ delete: operations["codespaces/remove-repository-for-secret-for-authenticated-user"]; options?: never; @@ -13955,9 +14758,7 @@ export interface paths { * Get a codespace for the authenticated user * @description Gets information about a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/get-for-authenticated-user"]; put?: never; @@ -13966,9 +14767,7 @@ export interface paths { * Delete a codespace for the authenticated user * @description Deletes a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ delete: operations["codespaces/delete-for-authenticated-user"]; options?: never; @@ -13979,9 +14778,7 @@ export interface paths { * * If you specify a new machine type it will be applied the next time your codespace is started. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ patch: operations["codespaces/update-for-authenticated-user"]; trace?: never; @@ -14001,9 +14798,7 @@ export interface paths { * * If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/export-for-authenticated-user"]; delete?: never; @@ -14023,9 +14818,7 @@ export interface paths { * Get details about a codespace export * @description Gets information about an export of a codespace. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/get-export-details-for-authenticated-user"]; put?: never; @@ -14047,9 +14840,7 @@ export interface paths { * List machine types for a codespace * @description List the machine types a codespace can transition to use. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ get: operations["codespaces/codespace-machines-for-authenticated-user"]; put?: never; @@ -14077,9 +14868,7 @@ export interface paths { * * This will fail for a codespace that is already published, meaning it has an associated repository. * - * You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/publish-for-authenticated-user"]; delete?: never; @@ -14101,9 +14890,7 @@ export interface paths { * Start a codespace for the authenticated user * @description Starts a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/start-for-authenticated-user"]; delete?: never; @@ -14125,9 +14912,7 @@ export interface paths { * Stop a codespace for the authenticated user * @description Stops a user's codespace. * - * You must authenticate using an access token with the `codespace` scope to use this endpoint. - * - * GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + * OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. */ post: operations["codespaces/stop-for-authenticated-user"]; delete?: never; @@ -14146,7 +14931,8 @@ export interface paths { /** * Get list of conflicting packages during Docker migration for authenticated-user * @description Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-authenticated-user"]; put?: never; @@ -14186,18 +14972,21 @@ export interface paths { }; /** * List email addresses for the authenticated user - * @description Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. + * @description Lists all of your email addresses, and specifies which one is visible + * to the public. + * + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ get: operations["users/list-emails-for-authenticated-user"]; put?: never; /** * Add an email address for the authenticated user - * @description This endpoint is accessible with the `user` scope. + * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ post: operations["users/add-email-for-authenticated-user"]; /** * Delete an email address for the authenticated user - * @description This endpoint is accessible with the `user` scope. + * @description OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ delete: operations["users/delete-email-for-authenticated-user"]; options?: never; @@ -14256,15 +15045,15 @@ export interface paths { get: operations["users/check-person-is-followed-by-authenticated"]; /** * Follow a user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * - * Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + * OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ put: operations["users/follow"]; post?: never; /** * Unfollow a user - * @description Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + * @description OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. */ delete: operations["users/unfollow"]; options?: never; @@ -14281,13 +15070,17 @@ export interface paths { }; /** * List GPG keys for the authenticated user - * @description Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Lists the current user's GPG keys. + * + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ get: operations["users/list-gpg-keys-for-authenticated-user"]; put?: never; /** * Create a GPG key for the authenticated user - * @description Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Adds a GPG key to the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ post: operations["users/create-gpg-key-for-authenticated-user"]; delete?: never; @@ -14305,14 +15098,18 @@ export interface paths { }; /** * Get a GPG key for the authenticated user - * @description View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description View extended details for a single GPG key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. */ get: operations["users/get-gpg-key-for-authenticated-user"]; put?: never; post?: never; /** * Delete a GPG key for the authenticated user - * @description Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Removes a GPG key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. */ delete: operations["users/delete-gpg-key-for-authenticated-user"]; options?: never; @@ -14331,8 +15128,6 @@ export interface paths { * List app installations accessible to the user access token * @description Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. * - * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * * You can find the permissions for the installation under the `permissions` key. @@ -14359,8 +15154,6 @@ export interface paths { * * The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. * - * You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - * * The access the user has to each repository is included in the hash under the `permissions` key. */ get: operations["apps/list-installation-repos-for-authenticated-user"]; @@ -14383,16 +15176,12 @@ export interface paths { /** * Add a repository to an app installation * @description Add a single repository to an installation. The authenticated user must have admin access to the repository. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ put: operations["apps/add-repo-to-installation-for-authenticated-user"]; post?: never; /** * Remove a repository from an app installation * @description Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. - * - * You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. */ delete: operations["apps/remove-repo-from-installation-for-authenticated-user"]; options?: never; @@ -14443,6 +15232,13 @@ export interface paths { * reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by * the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull * request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + * + * 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-for-authenticated-user"]; put?: never; @@ -14462,13 +15258,17 @@ export interface paths { }; /** * List public SSH keys for the authenticated user - * @description Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Lists the public SSH keys for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ get: operations["users/list-public-ssh-keys-for-authenticated-user"]; put?: never; /** * Create a public SSH key for the authenticated user - * @description Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Adds a public SSH key to the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. */ post: operations["users/create-public-ssh-key-for-authenticated-user"]; delete?: never; @@ -14486,14 +15286,18 @@ export interface paths { }; /** * Get a public SSH key for the authenticated user - * @description View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description View extended details for a single public SSH key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. */ get: operations["users/get-public-ssh-key-for-authenticated-user"]; put?: never; post?: never; /** * Delete a public SSH key for the authenticated user - * @description Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + * @description Removes a public SSH key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. */ delete: operations["users/delete-public-ssh-key-for-authenticated-user"]; options?: never; @@ -14510,7 +15314,7 @@ export interface paths { }; /** * List subscriptions for the authenticated user - * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + * @description Lists the active subscriptions for the authenticated user. */ get: operations["apps/list-subscriptions-for-authenticated-user"]; put?: never; @@ -14530,7 +15334,7 @@ export interface paths { }; /** * List subscriptions for the authenticated user (stubbed) - * @description Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + * @description Lists the active subscriptions for the authenticated user. */ get: operations["apps/list-subscriptions-for-authenticated-user-stubbed"]; put?: never; @@ -14731,9 +15535,7 @@ export interface paths { * List organizations for the authenticated user * @description List organizations for the authenticated user. * - * **OAuth scope requirements** - * - * This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + * For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. */ get: operations["orgs/list-for-authenticated-user"]; put?: never; @@ -14755,7 +15557,7 @@ export interface paths { * List packages for the authenticated user's namespace * @description Lists packages owned by the authenticated user within the user's namespace. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-authenticated-user"]; put?: never; @@ -14777,7 +15579,7 @@ export interface paths { * Get a package for the authenticated user * @description Gets a specific package for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-authenticated-user"]; put?: never; @@ -14786,8 +15588,7 @@ export interface paths { * Delete a package for the authenticated user * @description Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-authenticated-user"]; options?: never; @@ -14812,7 +15613,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-authenticated-user"]; delete?: never; @@ -14832,7 +15633,7 @@ export interface paths { * List package versions for a package owned by the authenticated user * @description Lists package versions for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-authenticated-user"]; put?: never; @@ -14854,7 +15655,7 @@ export interface paths { * Get a package version for the authenticated user * @description Gets a specific package version for a package owned by the authenticated user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-authenticated-user"]; put?: never; @@ -14863,8 +15664,9 @@ export interface paths { * Delete a package version for the authenticated user * @description Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. - * If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * The authenticated user must have admin permissions in the organization to use this endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-authenticated-user"]; options?: never; @@ -14889,7 +15691,7 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-authenticated-user"]; delete?: never; @@ -14927,7 +15729,11 @@ export interface paths { }; /** * List public email addresses for the authenticated user - * @description Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + * @description Lists your publicly visible email address, which you can set with the + * [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + * endpoint. + * + * OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. */ get: operations["users/list-public-emails-for-authenticated-user"]; put?: never; @@ -14957,12 +15763,7 @@ export interface paths { * Create a repository for the authenticated user * @description Creates a new repository for the authenticated user. * - * **OAuth scope requirements** - * - * When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - * - * * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * * `repo` scope to create a private repository. + * OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. */ post: operations["repos/create-for-authenticated-user"]; delete?: never; @@ -15024,12 +15825,16 @@ export interface paths { put?: never; /** * Add social accounts for the authenticated user - * @description Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope. + * @description Add one or more social accounts to the authenticated user's profile. + * + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ post: operations["users/add-social-account-for-authenticated-user"]; /** * Delete social accounts for the authenticated user - * @description Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope. + * @description Deletes one or more social accounts from the authenticated user's profile. + * + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ delete: operations["users/delete-social-account-for-authenticated-user"]; options?: never; @@ -15046,13 +15851,17 @@ export interface paths { }; /** * List SSH signing keys for the authenticated user - * @description Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Lists the SSH signing keys for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ get: operations["users/list-ssh-signing-keys-for-authenticated-user"]; put?: never; /** * Create a SSH signing key for the authenticated user - * @description Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Creates an SSH signing key for the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. */ post: operations["users/create-ssh-signing-key-for-authenticated-user"]; delete?: never; @@ -15070,14 +15879,18 @@ export interface paths { }; /** * Get an SSH signing key for the authenticated user - * @description Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Gets extended details for an SSH signing key. + * + * OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. */ get: operations["users/get-ssh-signing-key-for-authenticated-user"]; put?: never; post?: never; /** * Delete an SSH signing key for the authenticated user - * @description Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + * @description Deletes an SSH signing key from the authenticated user's GitHub account. + * + * OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. */ delete: operations["users/delete-ssh-signing-key-for-authenticated-user"]; options?: never; @@ -15096,7 +15909,9 @@ export interface paths { * List repositories starred by the authenticated user * @description Lists repositories the authenticated user has starred. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * 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.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-authenticated-user"]; put?: never; @@ -15121,7 +15936,7 @@ export interface paths { get: operations["activity/check-repo-is-starred-by-authenticated-user"]; /** * Star a repository for the authenticated user - * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." */ put: operations["activity/star-repo-for-authenticated-user"]; post?: never; @@ -15164,7 +15979,12 @@ export interface paths { }; /** * List teams for the authenticated user - * @description List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token. + * @description List all of the teams across all of the organizations to which the authenticated + * user belongs. + * + * OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + * + * When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. */ get: operations["teams/list-for-authenticated-user"]; put?: never; @@ -15208,9 +16028,7 @@ export interface paths { * Get a user * @description Provides publicly available information about someone with a GitHub account. * - * GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" - * - * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). + * The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). * * The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". */ @@ -15233,7 +16051,8 @@ export interface paths { /** * Get list of conflicting packages during Docker migration for user * @description Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. */ get: operations["packages/list-docker-migration-conflicting-packages-for-user"]; put?: never; @@ -15407,14 +16226,11 @@ export interface paths { }; /** * Get contextual information for a user - * @description Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + * @description Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. * - * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: + * The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). * - * ```shell - * curl -u username:token - * https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - * ``` + * OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. */ get: operations["users/get-context-for-user"]; put?: never; @@ -15500,7 +16316,7 @@ export interface paths { * List packages for a user * @description Lists all packages in a user's namespace for which the requesting user has access. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/list-packages-for-user"]; put?: never; @@ -15522,7 +16338,7 @@ export interface paths { * Get a package for a user * @description Gets a specific package metadata for a public package owned by a user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-for-user"]; put?: never; @@ -15531,9 +16347,9 @@ export interface paths { * Delete a package for a user * @description Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-for-user"]; options?: never; @@ -15558,9 +16374,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-for-user"]; delete?: never; @@ -15580,7 +16396,7 @@ export interface paths { * List package versions for a package owned by a user * @description Lists package versions for a public package owned by a specified user. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-all-package-versions-for-package-owned-by-user"]; put?: never; @@ -15602,7 +16418,7 @@ export interface paths { * Get a package version for a user * @description Gets a specific package version for a public package owned by a specified user. * - * At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + * OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ get: operations["packages/get-package-version-for-user"]; put?: never; @@ -15611,9 +16427,9 @@ export interface paths { * Delete package version for a user * @description Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ delete: operations["packages/delete-package-version-for-user"]; options?: never; @@ -15638,9 +16454,9 @@ export interface paths { * - The package was deleted within the last 30 days. * - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. * - * To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - * - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - * - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + * + * OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." */ post: operations["packages/restore-package-version-for-user"]; delete?: never; @@ -15678,7 +16494,7 @@ export interface paths { }; /** * List events received by the authenticated user - * @description These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. + * @description These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. */ get: operations["activity/list-received-events-for-user"]; put?: never; @@ -15715,7 +16531,7 @@ export interface paths { }; /** * List repositories for a user - * @description Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user. + * @description Lists public repositories for the specified user. */ get: operations["repos/list-for-user"]; put?: never; @@ -15739,7 +16555,7 @@ export interface paths { * * Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ get: operations["billing/get-github-actions-billing-user"]; put?: never; @@ -15763,7 +16579,7 @@ export interface paths { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ get: operations["billing/get-github-packages-billing-user"]; put?: never; @@ -15787,7 +16603,7 @@ export interface paths { * * Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." * - * Access tokens must have the `user` scope. + * OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. */ get: operations["billing/get-shared-storage-billing-user"]; put?: never; @@ -15849,7 +16665,9 @@ export interface paths { * List repositories starred by a user * @description Lists repositories a user has starred. * - * You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + * 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.star+json`**: Includes a timestamp of when the star was created. */ get: operations["activity/list-repos-starred-by-user"]; put?: never; @@ -15949,8 +16767,11 @@ export interface components { following_url: string; /** Format: uri-template */ gists_url: string; - /** Format: uri-template */ - hub_url: string; + /** + * Format: uri-template + * @deprecated + */ + hub_url?: string; /** Format: uri-template */ issue_search_url: string; /** Format: uri-template */ @@ -15997,210 +16818,212 @@ export interface components { * @enum {string} */ "security-advisory-ecosystems": "rubygems" | "npm" | "pip" | "maven" | "nuget" | "composer" | "go" | "rust" | "erlang" | "actions" | "pub" | "other" | "swift"; - /** - * Simple User - * @description A GitHub user. - */ - "simple-user": { - name?: string | null; - email?: string | null; - /** @example octocat */ - login: string; - /** @example 1 */ - id: number; - /** @example MDQ6VXNlcjE= */ - node_id: string; - /** - * Format: uri - * @example https://github.com/images/error/octocat_happy.gif - */ - avatar_url: string; - /** @example 41d064eb2195891e12d0413f63227ea7 */ - gravatar_id: string | null; - /** - * Format: uri - * @example https://api.github.com/users/octocat - */ - url: string; - /** - * Format: uri - * @example https://github.com/octocat - */ - html_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/followers - */ - followers_url: string; - /** @example https://api.github.com/users/octocat/following{/other_user} */ - following_url: string; - /** @example https://api.github.com/users/octocat/gists{/gist_id} */ - gists_url: string; - /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ - starred_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/subscriptions - */ - subscriptions_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/orgs - */ - organizations_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/repos - */ - repos_url: string; - /** @example https://api.github.com/users/octocat/events{/privacy} */ - events_url: string; - /** - * Format: uri - * @example https://api.github.com/users/octocat/received_events - */ - received_events_url: string; - /** @example User */ - type: string; - site_admin: boolean; - /** @example "2020-07-09T00:17:55Z" */ - starred_at?: string; - }; - /** - * @description The type of credit the user is receiving. - * @enum {string} - */ - "security-advisory-credit-types": "analyst" | "finder" | "reporter" | "coordinator" | "remediation_developer" | "remediation_reviewer" | "remediation_verifier" | "tool" | "sponsor" | "other"; - /** @description A GitHub Security Advisory. */ - "global-advisory": { - /** @description The GitHub Security Advisory ID. */ - readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - readonly cve_id: string | null; - /** @description The API URL for the advisory. */ - readonly url: string; - /** - * Format: uri - * @description The URL for the advisory. - */ - readonly html_url: string; - /** - * Format: uri - * @description The API URL for the repository advisory. - */ - readonly repository_advisory_url: string | null; - /** @description A short summary of the advisory. */ - summary: string; - /** @description A detailed description of what the advisory entails. */ - description: string | null; - /** - * @description The type of advisory. - * @enum {string} - */ - readonly type: "reviewed" | "unreviewed" | "malware"; - /** - * @description The severity of the advisory. - * @enum {string} - */ - severity: "critical" | "high" | "medium" | "low" | "unknown"; - /** - * Format: uri - * @description The URL of the advisory's source code. - */ - source_code_location: string | null; - readonly identifiers: { - /** - * @description The type of identifier. - * @enum {string} - */ - type: "CVE" | "GHSA"; - /** @description The identifier value. */ - value: string; - }[] | null; - references: string[] | null; - /** - * Format: date-time - * @description The date and time of when the advisory was published, in ISO 8601 format. - */ - readonly published_at: string; - /** - * Format: date-time - * @description The date and time of when the advisory was last updated, in ISO 8601 format. - */ - readonly updated_at: string; - /** - * Format: date-time - * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. - */ - readonly github_reviewed_at: string | null; - /** - * Format: date-time - * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. - * This field is only populated when the advisory is imported from the National Vulnerability Database. - */ - readonly nvd_published_at: string | null; - /** - * Format: date-time - * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. - */ - readonly withdrawn_at: string | null; - /** @description The products and respective version ranges affected by the advisory. */ - vulnerabilities: { - /** @description The name of the package affected by the vulnerability. */ - package: { - ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ - name: string | null; - } | null; - /** @description The range of the package versions affected by the vulnerability. */ - vulnerable_version_range: string | null; - /** @description The package version that resolve the vulnerability. */ - first_patched_version: string | null; - /** @description The functions in the package that are affected by the vulnerability. */ - readonly vulnerable_functions: string[] | null; - }[] | null; - cvss: { - /** @description The CVSS vector. */ - vector_string: string | null; - /** @description The CVSS score. */ - readonly score: number | null; + /** @description A vulnerability describing the product and its affected versions within a GitHub Security Advisory. */ + vulnerability: { + /** @description The name of the package affected by the vulnerability. */ + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + name: string | null; } | null; - cwes: { - /** @description The Common Weakness Enumeration (CWE) identifier. */ - cwe_id: string; - /** @description The name of the CWE. */ - readonly name: string; - }[] | null; - /** @description The users who contributed to the advisory. */ - readonly credits: { - user: components["schemas"]["simple-user"]; - type: components["schemas"]["security-advisory-credit-types"]; - }[] | null; - }; - /** - * Basic Error - * @description Basic Error - */ - "basic-error": { - message?: string; - documentation_url?: string; - url?: string; - status?: string; - }; - /** - * Validation Error Simple - * @description Validation Error Simple - */ - "validation-error-simple": { - message: string; - documentation_url: string; - errors?: string[]; + /** @description The range of the package versions affected by the vulnerability. */ + vulnerable_version_range: string | null; + /** @description The package version that resolves the vulnerability. */ + first_patched_version: string | null; + /** @description The functions in the package that are affected by the vulnerability. */ + readonly vulnerable_functions: string[] | null; }; /** * Simple User * @description A GitHub user. */ - "nullable-simple-user": { + "simple-user": { + name?: string | null; + email?: string | null; + /** @example octocat */ + login: string; + /** @example 1 */ + id: number; + /** @example MDQ6VXNlcjE= */ + node_id: string; + /** + * Format: uri + * @example https://github.com/images/error/octocat_happy.gif + */ + avatar_url: string; + /** @example 41d064eb2195891e12d0413f63227ea7 */ + gravatar_id: string | null; + /** + * Format: uri + * @example https://api.github.com/users/octocat + */ + url: string; + /** + * Format: uri + * @example https://github.com/octocat + */ + html_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/followers + */ + followers_url: string; + /** @example https://api.github.com/users/octocat/following{/other_user} */ + following_url: string; + /** @example https://api.github.com/users/octocat/gists{/gist_id} */ + gists_url: string; + /** @example https://api.github.com/users/octocat/starred{/owner}{/repo} */ + starred_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/subscriptions + */ + subscriptions_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/orgs + */ + organizations_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/repos + */ + repos_url: string; + /** @example https://api.github.com/users/octocat/events{/privacy} */ + events_url: string; + /** + * Format: uri + * @example https://api.github.com/users/octocat/received_events + */ + received_events_url: string; + /** @example User */ + type: string; + site_admin: boolean; + /** @example "2020-07-09T00:17:55Z" */ + starred_at?: string; + }; + /** + * @description The type of credit the user is receiving. + * @enum {string} + */ + "security-advisory-credit-types": "analyst" | "finder" | "reporter" | "coordinator" | "remediation_developer" | "remediation_reviewer" | "remediation_verifier" | "tool" | "sponsor" | "other"; + /** @description A GitHub Security Advisory. */ + "global-advisory": { + /** @description The GitHub Security Advisory ID. */ + readonly ghsa_id: string; + /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + readonly cve_id: string | null; + /** @description The API URL for the advisory. */ + readonly url: string; + /** + * Format: uri + * @description The URL for the advisory. + */ + readonly html_url: string; + /** + * Format: uri + * @description The API URL for the repository advisory. + */ + readonly repository_advisory_url: string | null; + /** @description A short summary of the advisory. */ + summary: string; + /** @description A detailed description of what the advisory entails. */ + description: string | null; + /** + * @description The type of advisory. + * @enum {string} + */ + readonly type: "reviewed" | "unreviewed" | "malware"; + /** + * @description The severity of the advisory. + * @enum {string} + */ + severity: "critical" | "high" | "medium" | "low" | "unknown"; + /** + * Format: uri + * @description The URL of the advisory's source code. + */ + source_code_location: string | null; + readonly identifiers: { + /** + * @description The type of identifier. + * @enum {string} + */ + type: "CVE" | "GHSA"; + /** @description The identifier value. */ + value: string; + }[] | null; + references: string[] | null; + /** + * Format: date-time + * @description The date and time of when the advisory was published, in ISO 8601 format. + */ + readonly published_at: string; + /** + * Format: date-time + * @description The date and time of when the advisory was last updated, in ISO 8601 format. + */ + readonly updated_at: string; + /** + * Format: date-time + * @description The date and time of when the advisory was reviewed by GitHub, in ISO 8601 format. + */ + readonly github_reviewed_at: string | null; + /** + * Format: date-time + * @description The date and time when the advisory was published in the National Vulnerability Database, in ISO 8601 format. + * This field is only populated when the advisory is imported from the National Vulnerability Database. + */ + readonly nvd_published_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + */ + readonly withdrawn_at: string | null; + /** @description The products and respective version ranges affected by the advisory. */ + vulnerabilities: components["schemas"]["vulnerability"][] | null; + cvss: { + /** @description The CVSS vector. */ + vector_string: string | null; + /** @description The CVSS score. */ + readonly score: number | null; + } | null; + cwes: { + /** @description The Common Weakness Enumeration (CWE) identifier. */ + cwe_id: string; + /** @description The name of the CWE. */ + readonly name: string; + }[] | null; + /** @description The users who contributed to the advisory. */ + readonly credits: { + user: components["schemas"]["simple-user"]; + type: components["schemas"]["security-advisory-credit-types"]; + }[] | null; + }; + /** + * Basic Error + * @description Basic Error + */ + "basic-error": { + message?: string; + documentation_url?: string; + url?: string; + status?: string; + }; + /** + * Validation Error Simple + * @description Validation Error Simple + */ + "validation-error-simple": { + message: string; + documentation_url: string; + errors?: string[]; + }; + /** + * Simple User + * @description A GitHub user. + */ + "nullable-simple-user": { name?: string | null; email?: string | null; /** @example octocat */ @@ -16346,7 +17169,7 @@ export interface components { webhook_secret?: string | null; /** @example "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n" */ pem?: string; - }; + } | null; /** * Format: uri * @description The URL to which the payloads will be delivered. @@ -16642,11 +17465,21 @@ export interface components { * @enum {string} */ checks?: "read" | "write"; + /** + * @description The level of permission to grant the access token to create, edit, delete, and list Codespaces. + * @enum {string} + */ + codespaces?: "read" | "write"; /** * @description The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges. * @enum {string} */ contents?: "read" | "write"; + /** + * @description The leve of permission to grant the access token to manage Dependabot secrets. + * @enum {string} + */ + dependabot_secrets?: "read" | "write"; /** * @description The level of permission to grant the access token for deployments and deployment statuses. * @enum {string} @@ -16682,6 +17515,11 @@ export interface components { * @enum {string} */ pull_requests?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property. + * @enum {string} + */ + repository_custom_properties?: "read" | "write"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for a repository. * @enum {string} @@ -16738,20 +17576,35 @@ export interface components { */ organization_administration?: "read" | "write"; /** - * @description The level of permission to grant the access token for custom repository roles management. This property is in beta and is subject to change. + * @description The level of permission to grant the access token for custom repository roles management. * @enum {string} */ organization_custom_roles?: "read" | "write"; + /** + * @description The level of permission to grant the access token for custom organization roles management. + * @enum {string} + */ + organization_custom_org_roles?: "read" | "write"; /** * @description The level of permission to grant the access token for custom property management. * @enum {string} */ organization_custom_properties?: "read" | "write" | "admin"; + /** + * @description The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change. + * @enum {string} + */ + organization_copilot_seat_management?: "write"; /** * @description The level of permission to grant the access token to view and manage announcement banners for an organization. * @enum {string} */ organization_announcement_banners?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view events triggered by an activity in an organization. + * @enum {string} + */ + organization_events?: "read"; /** * @description The level of permission to grant the access token to manage the post-receive hooks for an organization. * @enum {string} @@ -16802,6 +17655,41 @@ export interface components { * @enum {string} */ team_discussions?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the email addresses belonging to a user. + * @enum {string} + */ + email_addresses?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the followers belonging to a user. + * @enum {string} + */ + followers?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage git SSH keys. + * @enum {string} + */ + git_ssh_keys?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and manage GPG keys belonging to a user. + * @enum {string} + */ + gpg_keys?: "read" | "write"; + /** + * @description The level of permission to grant the access token to view and manage interaction limits on a repository. + * @enum {string} + */ + interaction_limits?: "read" | "write"; + /** + * @description The level of permission to grant the access token to manage the profile settings belonging to a user. + * @enum {string} + */ + profile?: "write"; + /** + * @description The level of permission to grant the access token to list and manage repositories a user is starring. + * @enum {string} + */ + starring?: "read" | "write"; }; /** * Installation @@ -16904,7 +17792,6 @@ export interface components { /** @example octocat/Hello-World */ full_name: string; license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; forks: number; permissions?: { admin: boolean; @@ -17072,7 +17959,7 @@ export interface components { /** @example 80 */ watchers_count: number; /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ size: number; @@ -17155,150 +18042,6 @@ export interface components { * @example true */ allow_rebase_merge: boolean; - template_repository?: { - id?: number; - node_id?: string; - name?: string; - full_name?: string; - owner?: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - }; - private?: boolean; - html_url?: string; - description?: string; - fork?: boolean; - url?: string; - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - downloads_url?: string; - events_url?: string; - forks_url?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - git_url?: string; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - notifications_url?: string; - pulls_url?: string; - releases_url?: string; - ssh_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - clone_url?: string; - mirror_url?: string; - hooks_url?: string; - svn_url?: string; - homepage?: string; - language?: string; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; - pushed_at?: string; - created_at?: string; - updated_at?: string; - permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; - allow_rebase_merge?: boolean; - temp_clone_token?: string; - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_update_branch?: boolean; - use_squash_pr_title_as_default?: boolean; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - allow_merge_commit?: boolean; - subscribers_count?: number; - network_count?: number; - } | null; temp_clone_token?: string; /** * @description Whether to allow squash merges for pull requests. @@ -17377,8 +18120,6 @@ export interface components { * @default false */ web_commit_signoff_required: boolean; - subscribers_count?: number; - network_count?: number; open_issues: number; watchers: number; master_branch?: string; @@ -17907,6 +18648,51 @@ export interface components { /** Format: uri */ html_url: string | null; }; + /** + * 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; + }; /** @description The security alert number. */ "alert-number": number; /** @description Details for the vulnerable package. */ @@ -19314,6 +20100,7 @@ export interface components { codespaces?: string[]; copilot?: string[]; packages?: string[]; + actions?: string[]; }; }; "security-and-analysis": { @@ -19487,7 +20274,7 @@ export interface components { forks_count?: number; stargazers_count?: number; watchers_count?: number; - /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */ + /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */ size?: number; default_branch?: string; open_issues_count?: number; @@ -20122,11 +20909,13 @@ export interface components { "code-scanning-alert-dismissed-reason": null | "false positive" | "won't fix" | "used in tests"; /** @description The dismissal comment associated with the dismissal of the alert. */ "code-scanning-alert-dismissed-comment": string | null; - "code-scanning-alert-rule": { + "code-scanning-alert-rule-summary": { /** @description A unique identifier for the rule used to detect the alert. */ id?: string | null; /** @description The name of the rule used to detect the alert. */ name?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; /** * @description The severity of the alert. * @enum {string|null} @@ -20139,14 +20928,6 @@ export interface components { security_severity_level?: "low" | "medium" | "high" | "critical"; /** @description A short description of the rule used to detect the alert. */ description?: string; - /** @description description of the rule used to detect the alert. */ - full_description?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; - /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ - help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri?: string | null; }; /** @description The version of the tool used to generate the code scanning analysis. */ "code-scanning-analysis-tool-version": string | null; @@ -20206,7 +20987,7 @@ export interface components { dismissed_at: components["schemas"]["alert-dismissed-at"]; dismissed_reason: components["schemas"]["code-scanning-alert-dismissed-reason"]; dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - rule: components["schemas"]["code-scanning-alert-rule"]; + rule: components["schemas"]["code-scanning-alert-rule-summary"]; tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; repository: components["schemas"]["simple-repository"]; @@ -20496,7 +21277,17 @@ export interface components { * @description The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. * @enum {string} */ - copilot_chat?: "enabled" | "disabled" | "unconfigured"; + 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} @@ -20902,7 +21693,7 @@ export interface components { forks_count?: number; stargazers_count?: number; watchers_count?: number; - /** @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. */ + /** @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. */ size?: number; default_branch?: string; open_issues_count?: number; @@ -21433,11 +22224,18 @@ export interface components { /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ - default_value?: string | null; + default_value?: (string | string[]) | null; /** @description Short description of the property */ description?: string | null; - /** @description Ordered list of allowed values of the property */ + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; + /** + * @description Who can edit the values of the property + * @example org_actors + * @enum {string|null} + */ + values_editable_by?: "org_actors" | "org_and_repo_actors"; }; /** * Custom Property Value @@ -21447,7 +22245,7 @@ export interface components { /** @description The name of the property */ property_name: string; /** @description The value assigned to the property */ - value: string | null; + value: (string | string[]) | null; }; /** * Organization Repository Custom Property Values @@ -21464,1150 +22262,395 @@ export interface components { properties: components["schemas"]["custom-property-value"][]; }; /** - * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). - * @enum {string} - */ - "repository-rule-enforcement": "disabled" | "active" | "evaluate"; - /** - * Repository Ruleset Bypass Actor - * @description An actor that can bypass rules in a ruleset + * Repository + * @description A repository on GitHub. */ - "repository-ruleset-bypass-actor": { - /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. */ - actor_id: number; + "nullable-repository": { /** - * @description The type of actor that can bypass a ruleset - * @enum {string} + * @description Unique identifier of the repository + * @example 42 */ - actor_type: "RepositoryRole" | "Team" | "Integration" | "OrganizationAdmin"; + id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + node_id: string; /** - * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. - * @enum {string} + * @description The name of the repository. + * @example Team Environment */ - bypass_mode: "always" | "pull_request"; - }; - /** - * Repository ruleset conditions for ref names - * @description Parameters for a repository ruleset ref name condition - */ - "repository-ruleset-conditions": { - ref_name?: { - /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */ - include?: string[]; - /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */ - exclude?: string[]; - }; - }; - /** - * Repository ruleset conditions for repository names - * @description Parameters for a repository name condition - */ - "repository-ruleset-conditions-repository-name-target": { - repository_name: { - /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */ - include?: string[]; - /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */ - exclude?: string[]; - /** @description Whether renaming of target repositories is prevented. */ - protected?: boolean; - }; - }; - /** - * Repository ruleset conditions for repository IDs - * @description Parameters for a repository ID condition - */ - "repository-ruleset-conditions-repository-id-target": { - repository_id: { - /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */ - repository_ids?: number[]; - }; - }; - /** - * Organization ruleset conditions - * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. - * - */ - "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"]); - /** - * creation - * @description Only allow users with bypass permission to create matching refs. - */ - "repository-rule-creation": { - /** @enum {string} */ - type: "creation"; - }; - /** - * update - * @description Only allow users with bypass permission to update matching refs. - */ - "repository-rule-update": { - /** @enum {string} */ - type: "update"; - parameters?: { - /** @description Branch can pull changes from its upstream repository */ - update_allows_fetch_and_merge: boolean; - }; - }; - /** - * deletion - * @description Only allow users with bypass permissions to delete matching refs. - */ - "repository-rule-deletion": { - /** @enum {string} */ - type: "deletion"; - }; - /** - * required_linear_history - * @description Prevent merge commits from being pushed to matching refs. - */ - "repository-rule-required-linear-history": { - /** @enum {string} */ - type: "required_linear_history"; - }; - /** - * required_deployments - * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. - */ - "repository-rule-required-deployments": { - /** @enum {string} */ - type: "required_deployments"; - parameters?: { - /** @description The environments that must be successfully deployed to before branches can be merged. */ - required_deployment_environments: string[]; - }; - }; - /** - * required_signatures - * @description Commits pushed to matching refs must have verified signatures. - */ - "repository-rule-required-signatures": { - /** @enum {string} */ - type: "required_signatures"; - }; - /** - * pull_request - * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. - */ - "repository-rule-pull-request": { - /** @enum {string} */ - type: "pull_request"; - parameters?: { - /** @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. */ - require_code_owner_review: boolean; - /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */ - require_last_push_approval: boolean; - /** @description The number of approving reviews that are required before a pull request can be merged. */ - required_approving_review_count: number; - /** @description All conversations on code must be resolved before a pull request can be merged. */ - required_review_thread_resolution: boolean; - }; - }; - /** - * StatusCheckConfiguration - * @description Required status check - */ - "repository-rule-params-status-check-configuration": { - /** @description The status check context name that must be present on the commit. */ - context: string; - /** @description The optional integration ID that this status check must originate from. */ - integration_id?: number; - }; - /** - * required_status_checks - * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. - */ - "repository-rule-required-status-checks": { - /** @enum {string} */ - type: "required_status_checks"; - parameters?: { - /** @description Status checks that are required. */ - required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; - /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ - strict_required_status_checks_policy: boolean; - }; - }; - /** - * non_fast_forward - * @description Prevent users with push access from force pushing to refs. - */ - "repository-rule-non-fast-forward": { - /** @enum {string} */ - type: "non_fast_forward"; - }; - /** - * commit_message_pattern - * @description Parameters to be used for the commit_message_pattern rule - */ - "repository-rule-commit-message-pattern": { - /** @enum {string} */ - type: "commit_message_pattern"; - parameters?: { - /** @description How this rule will appear to users. */ - name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - pattern: string; - }; - }; - /** - * commit_author_email_pattern - * @description Parameters to be used for the commit_author_email_pattern rule - */ - "repository-rule-commit-author-email-pattern": { - /** @enum {string} */ - type: "commit_author_email_pattern"; - parameters?: { - /** @description How this rule will appear to users. */ - name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - pattern: string; - }; - }; - /** - * committer_email_pattern - * @description Parameters to be used for the committer_email_pattern rule - */ - "repository-rule-committer-email-pattern": { - /** @enum {string} */ - type: "committer_email_pattern"; - parameters?: { - /** @description How this rule will appear to users. */ - name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - pattern: string; - }; - }; - /** - * branch_name_pattern - * @description Parameters to be used for the branch_name_pattern rule - */ - "repository-rule-branch-name-pattern": { - /** @enum {string} */ - type: "branch_name_pattern"; - parameters?: { - /** @description How this rule will appear to users. */ - name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - pattern: string; - }; - }; - /** - * tag_name_pattern - * @description Parameters to be used for the tag_name_pattern rule - */ - "repository-rule-tag-name-pattern": { - /** @enum {string} */ - type: "tag_name_pattern"; - parameters?: { - /** @description How this rule will appear to users. */ - name?: string; - /** @description If true, the rule will fail if the pattern matches. */ - negate?: boolean; - /** - * @description The operator to use for matching. - * @enum {string} - */ - operator: "starts_with" | "ends_with" | "contains" | "regex"; - /** @description The pattern to match with. */ - pattern: string; - }; - }; - /** - * WorkflowFileReference - * @description A workflow that must run for this rule to pass - */ - "repository-rule-params-workflow-file-reference": { - /** @description The path to the workflow file */ - path: string; - /** @description The ref (branch or tag) of the workflow file to use */ - ref?: string; - /** @description The ID of the repository where the workflow is defined */ - repository_id: number; - /** @description The commit SHA of the workflow file to use */ - sha?: string; - }; - /** - * workflows - * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged. - */ - "repository-rule-workflows": { - /** @enum {string} */ - type: "workflows"; - parameters?: { - /** @description Workflows that must pass for this rule to pass. */ - workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; - }; - }; - /** - * Repository Rule - * @description A repository rule. - */ - "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | components["schemas"]["repository-rule-workflows"]; - /** - * Repository ruleset - * @description A set of rules to apply when specified conditions are met. - */ - "repository-ruleset": { - /** @description The ID of the ruleset */ - id: number; - /** @description The name of the ruleset */ name: string; + /** @example octocat/Hello-World */ + full_name: string; + license: components["schemas"]["nullable-license-simple"]; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + }; + owner: components["schemas"]["simple-user"]; /** - * @description The target of the ruleset - * @enum {string} + * @description Whether the repository is private or public. + * @default false */ - target?: "branch" | "tag"; + private: boolean; /** - * @description The type of the source of the ruleset - * @enum {string} + * Format: uri + * @example https://github.com/octocat/Hello-World */ - source_type?: "Repository" | "Organization"; - /** @description The name of the source */ - source: string; - 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"][]; + html_url: string; + /** @example This your first repo! */ + description: string | null; + fork: boolean; /** - * @description The bypass type of the user making the API request for this ruleset. This field is only returned when - * querying the repository-level endpoint. - * @enum {string} + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World */ - current_user_can_bypass?: "always" | "pull_requests_only" | "never"; - node_id?: string; - _links?: { - self?: { - /** @description The URL of the ruleset */ - href?: string; - }; - html?: { - /** @description The html URL of the ruleset */ - href?: string; - }; - }; - conditions?: components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]; - rules?: components["schemas"]["repository-rule"][]; - /** Format: date-time */ - created_at?: string; - /** Format: date-time */ - updated_at?: string; - }; - /** - * Rule Suites - * @description Response - */ - "rule-suites": { - /** @description The unique identifier of the rule insight. */ - id?: number; - /** @description The number that identifies the user. */ - actor_id?: number; - /** @description The handle for the GitHub user account. */ - actor_name?: string; - /** @description The first commit sha before the push evaluation. */ - before_sha?: string; - /** @description The last commit sha in the push evaluation. */ - after_sha?: string; - /** @description The ref name that the evaluation ran on. */ - ref?: string; - /** @description The ID of the repository associated with the rule evaluation. */ - repository_id?: number; - /** @description The name of the repository without the `.git` extension. */ - repository_name?: string; + url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ + archive_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ + assignees_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ + blobs_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ + branches_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ + collaborators_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ + comments_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ + commits_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ + compare_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ + contents_url: string; /** - * Format: date-time - * @example 2011-01-26T19:06:43Z + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/contributors */ - pushed_at?: string; + contributors_url: string; /** - * @description The result of the rule evaluations for rules with the `active` enforcement status. - * @enum {string} + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/deployments */ - result?: "pass" | "fail" | "bypass"; + deployments_url: string; /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/downloads */ - evaluation_result?: "pass" | "fail"; - }[]; - /** - * Rule Suite - * @description Response - */ - "rule-suite": { - /** @description The unique identifier of the rule insight. */ - id?: number; - /** @description The number that identifies the user. */ - actor_id?: number; - /** @description The handle for the GitHub user account. */ - actor_name?: string; - /** @description The first commit sha before the push evaluation. */ - before_sha?: string; - /** @description The last commit sha in the push evaluation. */ - after_sha?: string; - /** @description The ref name that the evaluation ran on. */ - ref?: string; - /** @description The ID of the repository associated with the rule evaluation. */ - repository_id?: number; - /** @description The name of the repository without the `.git` extension. */ - repository_name?: string; + downloads_url: string; /** - * Format: date-time - * @example 2011-01-26T19:06:43Z + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/events */ - pushed_at?: string; + events_url: string; /** - * @description The result of the rule evaluations for rules with the `active` enforcement status. - * @enum {string} + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/forks */ - result?: "pass" | "fail" | "bypass"; - /** - * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. - * @enum {string} - */ - evaluation_result?: "pass" | "fail"; - /** @description Details on the evaluated rules. */ - rule_evaluations?: { - rule_source?: { - /** @description The type of rule source. */ - type?: string; - /** @description The ID of the rule source. */ - id?: number | null; - /** @description The name of the rule source. */ - name?: string | null; - }; - /** - * @description The enforcement level of this rule source. - * @enum {string} - */ - enforcement?: "active" | "evaluate" | "deleted ruleset"; - /** - * @description The result of the evaluation of the individual rule. - * @enum {string} - */ - result?: "pass" | "fail"; - /** @description The type of rule. */ - rule_type?: string; - /** @description Any associated details with the rule evaluation. */ - details?: string; - }[]; - }; - /** @description A product affected by the vulnerability detailed in a repository security advisory. */ - "repository-advisory-vulnerability": { - /** @description The name of the package affected by the vulnerability. */ - package: { - ecosystem: components["schemas"]["security-advisory-ecosystems"]; - /** @description The unique package name within its ecosystem. */ - name: string | null; - } | null; - /** @description The range of the package versions affected by the vulnerability. */ - vulnerable_version_range: string | null; - /** @description The package version(s) that resolve the vulnerability. */ - patched_versions: string | null; - /** @description The functions in the package that are affected. */ - vulnerable_functions: string[] | null; - }; - /** @description A credit given to a user for a repository security advisory. */ - "repository-advisory-credit": { - user: components["schemas"]["simple-user"]; - type: components["schemas"]["security-advisory-credit-types"]; - /** - * @description The state of the user's acceptance of the credit. - * @enum {string} - */ - state: "accepted" | "declined" | "pending"; - }; - /** @description A repository security advisory. */ - "repository-advisory": { - /** @description The GitHub Security Advisory ID. */ - readonly ghsa_id: string; - /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ - cve_id: string | null; + forks_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ + git_commits_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ + git_refs_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ + git_tags_url: string; + /** @example git:github.com/octocat/Hello-World.git */ + git_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ + issue_comment_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ + issue_events_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ + issues_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ + keys_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ + labels_url: string; /** * Format: uri - * @description The API URL for the advisory. + * @example http://api.github.com/repos/octocat/Hello-World/languages */ - readonly url: string; + languages_url: string; /** * Format: uri - * @description The URL for the advisory. - */ - readonly html_url: string; - /** @description A short summary of the advisory. */ - summary: string; - /** @description A detailed description of what the advisory entails. */ - description: string | null; - /** - * @description The severity of the advisory. - * @enum {string|null} + * @example http://api.github.com/repos/octocat/Hello-World/merges */ - severity: "critical" | "high" | "medium" | "low"; - /** @description The author of the advisory. */ - readonly author: components["schemas"]["simple-user"] | null; - /** @description The publisher of the advisory. */ - readonly publisher: components["schemas"]["simple-user"] | null; - readonly identifiers: { - /** - * @description The type of identifier. - * @enum {string} - */ - type: "CVE" | "GHSA"; - /** @description The identifier value. */ - value: string; - }[]; + merges_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ + milestones_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ + notifications_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ + pulls_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ + releases_url: string; + /** @example git@github.com:octocat/Hello-World.git */ + ssh_url: string; /** - * @description The state of the advisory. - * @enum {string} + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/stargazers */ - state: "published" | "closed" | "withdrawn" | "draft" | "triage"; + stargazers_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ + statuses_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was created, in ISO 8601 format. + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/subscribers */ - readonly created_at: string | null; + subscribers_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was last updated, in ISO 8601 format. + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/subscription */ - readonly updated_at: string | null; + subscription_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was published, in ISO 8601 format. + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/tags */ - readonly published_at: string | null; + tags_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was closed, in ISO 8601 format. + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/teams */ - readonly closed_at: string | null; + teams_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ + trees_url: string; + /** @example https://github.com/octocat/Hello-World.git */ + clone_url: string; /** - * Format: date-time - * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + * Format: uri + * @example git:git.example.com/octocat/Hello-World */ - readonly withdrawn_at: string | null; - readonly submission: { - /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ - readonly accepted: boolean; - } | null; - vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; - cvss: { - /** @description The CVSS vector. */ - vector_string: string | null; - /** @description The CVSS score. */ - readonly score: number | null; - } | null; - readonly cwes: { - /** @description The Common Weakness Enumeration (CWE) identifier. */ - cwe_id: string; - /** @description The name of the CWE. */ - readonly name: string; - }[] | null; - /** @description A list of only the CWE IDs. */ - cwe_ids: string[] | null; - credits: { - /** @description The username of the user credited. */ - login?: string; - type?: components["schemas"]["security-advisory-credit-types"]; - }[] | null; - readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null; - /** @description A list of users that collaborate on the advisory. */ - collaborating_users: components["schemas"]["simple-user"][] | null; - /** @description A list of teams that collaborate on the advisory. */ - collaborating_teams: components["schemas"]["team"][] | null; - /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ - readonly private_fork: components["schemas"]["simple-repository"] | null; - }; - /** - * Team Simple - * @description Groups of organization members that gives permissions on specified repositories. - */ - "team-simple": { + mirror_url: string | null; /** - * @description Unique identifier of the team - * @example 1 + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/hooks */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; + hooks_url: string; /** * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @example https://svn.github.com/octocat/Hello-World */ - url: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; + svn_url: string; /** - * @description Name of the team - * @example Justice League + * Format: uri + * @example https://github.com */ - name: string; + homepage: string | null; + language: string | null; + /** @example 9 */ + forks_count: number; + /** @example 80 */ + stargazers_count: number; + /** @example 80 */ + watchers_count: number; /** - * @description Description of the team - * @example A great team. + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + * @example 108 */ - description: string | null; + size: number; /** - * @description Permission that the team will have for its repositories - * @example admin + * @description The default branch of the repository. + * @example master */ - permission: string; + default_branch: string; + /** @example 0 */ + open_issues_count: number; /** - * @description The level of privacy this team should have - * @example closed + * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false + * @example true */ - privacy?: string; + is_template: boolean; + topics?: string[]; /** - * @description The notification setting the team has set - * @example notifications_enabled + * @description Whether issues are enabled. + * @default true + * @example true */ - notification_setting?: string; + has_issues: boolean; /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description Whether projects are enabled. + * @default true + * @example true */ - html_url: string; + has_projects: boolean; /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos + * @description Whether the wiki is enabled. + * @default true + * @example true */ - repositories_url: string; - /** @example justice-league */ - slug: string; + has_wiki: boolean; + has_pages: boolean; /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com + * @deprecated + * @description Whether downloads are enabled. + * @default true + * @example true */ - ldap_dn?: string; - }; - "actions-billing-usage": { - /** @description The sum of the free and paid GitHub Actions minutes used. */ - total_minutes_used: number; - /** @description The total paid GitHub Actions minutes used. */ - total_paid_minutes_used: number; - /** @description The amount of free GitHub Actions minutes available. */ - included_minutes: number; - minutes_used_breakdown: { - /** @description Total minutes used on Ubuntu runner machines. */ - UBUNTU?: number; - /** @description Total minutes used on macOS runner machines. */ - MACOS?: number; - /** @description Total minutes used on Windows runner machines. */ - WINDOWS?: number; - /** @description Total minutes used on Ubuntu 4 core runner machines. */ - ubuntu_4_core?: number; - /** @description Total minutes used on Ubuntu 8 core runner machines. */ - ubuntu_8_core?: number; - /** @description Total minutes used on Ubuntu 16 core runner machines. */ - ubuntu_16_core?: number; - /** @description Total minutes used on Ubuntu 32 core runner machines. */ - ubuntu_32_core?: number; - /** @description Total minutes used on Ubuntu 64 core runner machines. */ - ubuntu_64_core?: number; - /** @description Total minutes used on Windows 4 core runner machines. */ - windows_4_core?: number; - /** @description Total minutes used on Windows 8 core runner machines. */ - windows_8_core?: number; - /** @description Total minutes used on Windows 16 core runner machines. */ - windows_16_core?: number; - /** @description Total minutes used on Windows 32 core runner machines. */ - windows_32_core?: number; - /** @description Total minutes used on Windows 64 core runner machines. */ - windows_64_core?: number; - /** @description Total minutes used on macOS 12 core runner machines. */ - macos_12_core?: number; - /** @description Total minutes used on all runner machines. */ - total?: number; - }; - }; - "packages-billing-usage": { - /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ - total_gigabytes_bandwidth_used: number; - /** @description Total paid storage space (GB) for GitHuub Packages. */ - total_paid_gigabytes_bandwidth_used: number; - /** @description Free storage space (GB) for GitHub Packages. */ - included_gigabytes_bandwidth: number; - }; - "combined-billing-usage": { - /** @description Numbers of days left in billing cycle. */ - days_left_in_billing_cycle: number; - /** @description Estimated storage space (GB) used in billing cycle. */ - estimated_paid_storage_for_month: number; - /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ - estimated_storage_for_month: number; - }; - /** - * Team Organization - * @description Team Organization - */ - "team-organization": { - /** @example github */ - login: string; - /** @example 1 */ - id: number; - /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ - node_id: string; + has_downloads: boolean; /** - * Format: uri - * @example https://api.github.com/orgs/github + * @description Whether discussions are enabled. + * @default false + * @example true */ - url: string; + has_discussions: boolean; /** - * Format: uri - * @example https://api.github.com/orgs/github/repos + * @description Whether the repository is archived. + * @default false */ - repos_url: string; + archived: boolean; + /** @description Returns whether or not this repository disabled. */ + disabled: boolean; /** - * Format: uri - * @example https://api.github.com/orgs/github/events + * @description The repository visibility: public, private, or internal. + * @default public */ - 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; - /** @example github */ - name?: string; - /** @example GitHub */ - company?: string; + visibility: string; /** - * Format: uri - * @example https://github.com/blog + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - blog?: string; - /** @example San Francisco */ - location?: string; + pushed_at: string | null; /** - * Format: email - * @example octocat@github.com + * Format: date-time + * @example 2011-01-26T19:01:12Z */ - email?: string; - /** @example github */ - twitter_username?: string | null; - /** @example true */ - is_verified?: boolean; - /** @example true */ - has_organization_projects: boolean; - /** @example true */ - has_repository_projects: boolean; - /** @example 2 */ - public_repos: number; - /** @example 1 */ - public_gists: number; - /** @example 20 */ - followers: number; - /** @example 0 */ - following: number; + created_at: string | null; /** - * Format: uri - * @example https://github.com/octocat + * Format: date-time + * @example 2011-01-26T19:14:43Z */ - html_url: string; + updated_at: string | null; /** - * Format: date-time - * @example 2008-01-14T04:33:35Z + * @description Whether to allow rebase merges for pull requests. + * @default true + * @example true */ - created_at: string; - /** @example Organization */ - type: string; - /** @example 100 */ - total_private_repos?: number; - /** @example 100 */ - owned_private_repos?: number; - /** @example 81 */ - private_gists?: number | null; - /** @example 10000 */ - disk_usage?: number | null; - /** @example 8 */ - collaborators?: number | null; + allow_rebase_merge: boolean; + temp_clone_token?: string; /** - * Format: email - * @example org@example.com + * @description Whether to allow squash merges for pull requests. + * @default true + * @example true */ - billing_email?: string | null; - plan?: { - name: string; - space: number; - private_repos: number; - filled_seats?: number; - seats?: number; - }; - default_repository_permission?: string | null; - /** @example true */ - members_can_create_repositories?: boolean | null; - /** @example true */ - two_factor_requirement_enabled?: boolean | null; - /** @example all */ - members_allowed_repository_creation_type?: string; - /** @example true */ - members_can_create_public_repositories?: boolean; - /** @example true */ - members_can_create_private_repositories?: boolean; - /** @example true */ - members_can_create_internal_repositories?: boolean; - /** @example true */ - members_can_create_pages?: boolean; - /** @example true */ - members_can_create_public_pages?: boolean; - /** @example true */ - members_can_create_private_pages?: boolean; - /** @example false */ - members_can_fork_private_repositories?: boolean | null; - /** @example false */ - web_commit_signoff_required?: boolean; - /** Format: date-time */ - updated_at: string; - /** Format: date-time */ - archived_at: string | null; - }; - /** - * Full Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - "team-full": { + allow_squash_merge: boolean; /** - * @description Unique identifier of the team - * @example 42 + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false */ - id: number; - /** @example MDQ6VGVhbTE= */ - node_id: string; + allow_auto_merge: boolean; /** - * Format: uri - * @description URL for the team - * @example https://api.github.com/organizations/1/team/1 + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false */ - url: string; + delete_branch_on_merge: boolean; /** - * Format: uri - * @example https://github.com/orgs/rails/teams/core + * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + * @default false + * @example false */ - html_url: string; + allow_update_branch: boolean; /** - * @description Name of the team - * @example Developers + * @deprecated + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false */ - name: string; - /** @example justice-league */ - slug: string; - /** @example A great team. */ - description: string | null; + use_squash_pr_title_as_default: boolean; /** - * @description The level of privacy this team should have - * @example closed + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ - privacy?: "closed" | "secret"; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description The notification setting the team has set - * @example notifications_enabled + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** - * @description Permission that the team will have for its repositories - * @example push - */ - permission: string; - /** @example https://api.github.com/organizations/1/team/1/members{/member} */ - members_url: string; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/1/repos - */ - repositories_url: string; - parent?: components["schemas"]["nullable-team-simple"]; - /** @example 3 */ - members_count: number; - /** @example 10 */ - repos_count: number; - /** - * Format: date-time - * @example 2017-07-14T16:53:42Z - */ - created_at: string; - /** - * Format: date-time - * @example 2017-08-17T12:37:15Z - */ - updated_at: string; - organization: components["schemas"]["team-organization"]; - /** - * @description Distinguished Name (DN) that team maps to within LDAP environment - * @example uid=example,ou=users,dc=github,dc=com - */ - ldap_dn?: string; - }; - /** - * Team Discussion - * @description A team discussion is a persistent record of a free-form conversation within a team. - */ - "team-discussion": { - author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the discussion. - * @example Please suggest improvements to our workflow in comments. - */ - body: string; - /** @example

Hi! This is an area for us to collaborate as a team

*/ - body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - body_version: string; - /** @example 0 */ - comments_count: number; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments - */ - comments_url: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - created_at: string; - /** Format: date-time */ - last_edited_at: string | null; - /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1 - */ - html_url: string; - /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ - node_id: string; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The unique sequence number of a team discussion. - * @example 42 + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} */ - number: number; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** - * @description Whether or not this discussion should be pinned for easy retrieval. - * @example true + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} */ - pinned: boolean; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; /** - * @description Whether or not this discussion should be restricted to team members and organization owners. + * @description Whether to allow merge commits for pull requests. + * @default true * @example true */ - private: boolean; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027 - */ - team_url: string; - /** - * @description The title of the discussion. - * @example How can we improve our workflow? - */ - title: string; - /** - * Format: date-time - * @example 2018-01-25T18:56:31Z - */ - updated_at: string; + allow_merge_commit: boolean; + /** @description Whether to allow forking this repo */ + allow_forking?: boolean; /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2343027/discussions/1 + * @description Whether to require contributors to sign off on web-based commits + * @default false */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; + web_commit_signoff_required: boolean; + open_issues: number; + watchers: number; + master_branch?: string; + /** @example "2020-07-09T00:17:42Z" */ + starred_at?: string; + /** @description Whether anonymous git access is enabled for this repository */ + anonymous_access_enabled?: boolean; + } | null; /** - * Team Discussion Comment - * @description A reply to a discussion within a team. + * Code Of Conduct Simple + * @description Code of Conduct Simple */ - "team-discussion-comment": { - author: components["schemas"]["nullable-simple-user"]; - /** - * @description The main text of the comment. - * @example I agree with this suggestion. - */ - body: string; - /** @example

Do you like apples?

*/ - body_html: string; - /** - * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. - * @example 0307116bbf7ced493b8d8a346c650b71 - */ - body_version: string; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - created_at: string; - /** Format: date-time */ - last_edited_at: string | null; - /** - * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1 - */ - discussion_url: string; - /** - * Format: uri - * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 - */ - html_url: string; - /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ - node_id: string; - /** - * @description The unique sequence number of a team discussion comment. - * @example 42 - */ - number: number; - /** - * Format: date-time - * @example 2018-01-15T23:53:58Z - */ - updated_at: string; + "code-of-conduct-simple": { /** * Format: uri - * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - */ - url: string; - reactions?: components["schemas"]["reaction-rollup"]; - }; - /** - * Reaction - * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. - */ - reaction: { - /** @example 1 */ - id: number; - /** @example MDg6UmVhY3Rpb24x */ - node_id: string; - user: components["schemas"]["nullable-simple-user"]; - /** - * @description The reaction to use - * @example heart - * @enum {string} - */ - content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** - * Format: date-time - * @example 2016-05-20T20:09:31Z + * @example https://api.github.com/repos/github/docs/community/code_of_conduct */ - created_at: string; - }; - /** - * Team Membership - * @description Team Membership - */ - "team-membership": { - /** Format: uri */ url: string; + /** @example citizen_code_of_conduct */ + key: string; + /** @example Citizen Code of Conduct */ + name: string; /** - * @description The role of the user in the team. - * @default member - * @example member - * @enum {string} - */ - role: "member" | "maintainer"; - /** - * @description The state of the user's membership in the team. - * @enum {string} + * Format: uri + * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md */ - state: "active" | "pending"; - }; - /** - * Team Project - * @description A team's access to a project. - */ - "team-project": { - owner_url: string; - url: string; - html_url: string; - columns_url: string; - id: number; - node_id: string; - name: string; - body: string | null; - number: number; - state: string; - creator: components["schemas"]["simple-user"]; - created_at: string; - updated_at: string; - /** @description The organization permission for this project. Only present when owner is an organization. */ - organization_permission?: string; - /** @description Whether the project is private or not. Only present when owner is an organization. */ - private?: boolean; - permissions: { - read: boolean; - write: boolean; - admin: boolean; - }; + html_url: string | null; }; /** - * Team Repository - * @description A team's access to a repository. + * Full Repository + * @description Full Repository */ - "team-repository": { - /** - * @description Unique identifier of the repository - * @example 42 - */ + "full-repository": { + /** @example 1296269 */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; - /** - * @description The name of the repository. - * @example Team Environment - */ + /** @example Hello-World */ name: string; /** @example octocat/Hello-World */ full_name: string; - license: components["schemas"]["nullable-license-simple"]; - forks: number; - permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - }; - /** @example admin */ - role_name?: string; - owner: components["schemas"]["nullable-simple-user"]; - /** - * @description Whether the repository is private or public. - * @default false - */ + owner: components["schemas"]["simple-user"]; private: boolean; /** * Format: uri @@ -22761,790 +22804,1375 @@ export interface components { stargazers_count: number; /** @example 80 */ watchers_count: number; - /** @example 108 */ - size: number; /** - * @description The default branch of the repository. - * @example master + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + * @example 108 */ + size: number; + /** @example master */ default_branch: string; /** @example 0 */ open_issues_count: number; - /** - * @description Whether this repository acts as a template that can be used to generate new repositories. - * @default false - * @example true - */ - is_template: boolean; + /** @example true */ + is_template?: boolean; + /** @example [ + * "octocat", + * "atom", + * "electron", + * "API" + * ] */ topics?: string[]; - /** - * @description Whether issues are enabled. - * @default true - * @example true - */ + /** @example true */ has_issues: boolean; - /** - * @description Whether projects are enabled. - * @default true - * @example true - */ + /** @example true */ has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - * @example true - */ + /** @example true */ has_wiki: boolean; has_pages: boolean; - /** - * @description Whether downloads are enabled. - * @default true - * @example true - */ - has_downloads: boolean; - /** - * @description Whether the repository is archived. - * @default false - */ + /** @example true */ + has_downloads?: boolean; + /** @example true */ + has_discussions: boolean; archived: boolean; /** @description Returns whether or not this repository disabled. */ disabled: boolean; /** * @description The repository visibility: public, private, or internal. - * @default public + * @example public */ - visibility: string; + visibility?: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string | null; + pushed_at: string; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string | null; + created_at: string; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string | null; + updated_at: string; + permissions?: { + admin: boolean; + maintain?: boolean; + push: boolean; + triage?: boolean; + pull: boolean; + }; + /** @example true */ + allow_rebase_merge?: boolean; + template_repository?: components["schemas"]["nullable-repository"]; + temp_clone_token?: string | null; + /** @example true */ + allow_squash_merge?: boolean; + /** @example false */ + allow_auto_merge?: boolean; + /** @example false */ + delete_branch_on_merge?: boolean; + /** @example true */ + allow_merge_commit?: boolean; + /** @example true */ + allow_update_branch?: boolean; + /** @example false */ + use_squash_pr_title_as_default?: boolean; /** - * @description Whether to allow rebase merges for pull requests. - * @default true - * @example true + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @example PR_TITLE + * @enum {string} */ - allow_rebase_merge: boolean; - temp_clone_token?: string; + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; /** - * @description Whether to allow squash merges for pull requests. - * @default true - * @example true + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @example PR_BODY + * @enum {string} */ - allow_squash_merge: boolean; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description Whether to allow Auto-merge to be used on pull requests. - * @default false - * @example false + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @example PR_TITLE + * @enum {string} */ - allow_auto_merge: boolean; + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** - * @description Whether to delete head branches when pull requests are merged - * @default false - * @example false + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @example PR_BODY + * @enum {string} */ - delete_branch_on_merge: boolean; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** @example true */ + allow_forking?: boolean; + /** @example false */ + web_commit_signoff_required?: boolean; + /** @example 42 */ + subscribers_count: number; + /** @example 0 */ + network_count: number; + license: components["schemas"]["nullable-license-simple"]; + organization?: components["schemas"]["nullable-simple-user"]; + parent?: components["schemas"]["repository"]; + source?: components["schemas"]["repository"]; + forks: number; + master_branch?: string; + open_issues: number; + watchers: number; /** - * @description Whether to allow merge commits for pull requests. + * @description Whether anonymous git access is allowed. * @default true - * @example true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow forking this repo - * @default false - * @example false */ - allow_forking: boolean; - /** - * @description Whether to require contributors to sign off on web-based commits - * @default false - * @example false - */ - web_commit_signoff_required: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; + anonymous_access_enabled: boolean; + code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; + security_and_analysis?: components["schemas"]["security-and-analysis"]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; }; /** - * Project Card - * @description Project cards represent a scope of work. + * @description The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page (`evaluate` is only available with GitHub Enterprise). + * @enum {string} */ - "project-card": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/cards/1478 - */ - url: string; - /** - * @description The project card's ID - * @example 42 - */ - id: number; - /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ - node_id: string; - /** @example Add payload for delete Project column */ - note: string | null; - creator: components["schemas"]["nullable-simple-user"]; + "repository-rule-enforcement": "disabled" | "active" | "evaluate"; + /** + * Repository Ruleset Bypass Actor + * @description An actor that can bypass rules in a ruleset + */ + "repository-ruleset-bypass-actor": { + /** @description The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. `OrganizationAdmin` is not applicable for personal repositories. + * */ + actor_id?: number | null; /** - * Format: date-time - * @example 2016-09-05T14:21:06Z + * @description The type of actor that can bypass a ruleset. + * + * @enum {string} */ - created_at: string; + actor_type: "Integration" | "OrganizationAdmin" | "RepositoryRole" | "Team" | "DeployKey"; /** - * Format: date-time - * @example 2016-09-05T14:20:22Z + * @description When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. + * + * @enum {string} */ - updated_at: string; - /** - * @description Whether or not the card is archived - * @example false - */ - archived?: boolean; - column_name?: string; - project_id?: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - column_url: string; - /** - * Format: uri - * @example https://api.github.com/repos/api-playground/projects-test/issues/3 - */ - content_url?: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - project_url: string; + bypass_mode: "always" | "pull_request"; }; /** - * Project Column - * @description Project columns contain cards of work. + * Repository ruleset conditions for ref names + * @description Parameters for a repository ruleset ref name condition */ - "project-column": { - /** - * Format: uri - * @example https://api.github.com/projects/columns/367 - */ - url: string; - /** - * Format: uri - * @example https://api.github.com/projects/120 - */ - project_url: string; - /** - * Format: uri - * @example https://api.github.com/projects/columns/367/cards - */ - cards_url: string; - /** - * @description The unique identifier of the project column - * @example 42 - */ - id: number; - /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ - node_id: string; - /** - * @description Name of the project column - * @example Remaining tasks - */ + "repository-ruleset-conditions": { + ref_name?: { + /** @description Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches. */ + include?: string[]; + /** @description Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match. */ + exclude?: string[]; + }; + }; + /** + * Repository ruleset conditions for repository names + * @description Parameters for a repository name condition + */ + "repository-ruleset-conditions-repository-name-target": { + repository_name: { + /** @description Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories. */ + include?: string[]; + /** @description Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match. */ + exclude?: string[]; + /** @description Whether renaming of target repositories is prevented. */ + protected?: boolean; + }; + }; + /** + * Repository ruleset conditions for repository IDs + * @description Parameters for a repository ID condition + */ + "repository-ruleset-conditions-repository-id-target": { + repository_id: { + /** @description The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass. */ + repository_ids?: number[]; + }; + }; + /** + * Repository ruleset property targeting definition + * @description Parameters for a targeting a repository property + */ + "repository-ruleset-conditions-repository-property-spec": { + /** @description The name of the repository property to target */ name: string; - /** - * Format: date-time - * @example 2016-09-05T14:18:44Z - */ - created_at: string; - /** - * Format: date-time - * @example 2016-09-05T14:22:28Z - */ - updated_at: string; + /** @description The values to match for the repository property */ + property_values: string[]; }; /** - * Project Collaborator Permission - * @description Project Collaborator Permission + * Repository ruleset conditions for repository properties + * @description Parameters for a repository property condition */ - "project-collaborator-permission": { - permission: string; - user: components["schemas"]["nullable-simple-user"]; + "repository-ruleset-conditions-repository-property-target": { + repository_property: { + /** @description The repository properties and values to include. All of these properties must match for the condition to pass. */ + include?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + /** @description The repository properties and values to exclude. The condition will not pass if any of these properties match. */ + exclude?: components["schemas"]["repository-ruleset-conditions-repository-property-spec"][]; + }; }; - /** Rate Limit */ - "rate-limit": { - limit: number; - remaining: number; - reset: number; - used: number; + /** + * Organization ruleset conditions + * @description Conditions for an organization ruleset. The conditions object should contain both `repository_name` and `ref_name` properties or both `repository_id` and `ref_name` properties. + * + */ + "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"]); + /** + * creation + * @description Only allow users with bypass permission to create matching refs. + */ + "repository-rule-creation": { + /** @enum {string} */ + type: "creation"; }; /** - * Rate Limit Overview - * @description Rate Limit Overview + * update + * @description Only allow users with bypass permission to update matching refs. */ - "rate-limit-overview": { - resources: { - core: components["schemas"]["rate-limit"]; - graphql?: components["schemas"]["rate-limit"]; - search: components["schemas"]["rate-limit"]; - code_search?: components["schemas"]["rate-limit"]; - source_import?: components["schemas"]["rate-limit"]; - integration_manifest?: components["schemas"]["rate-limit"]; - code_scanning_upload?: components["schemas"]["rate-limit"]; - actions_runner_registration?: components["schemas"]["rate-limit"]; - scim?: components["schemas"]["rate-limit"]; - dependency_snapshots?: components["schemas"]["rate-limit"]; + "repository-rule-update": { + /** @enum {string} */ + type: "update"; + parameters?: { + /** @description Branch can pull changes from its upstream repository */ + update_allows_fetch_and_merge: boolean; }; - rate: components["schemas"]["rate-limit"]; }; /** - * Repository - * @description A repository on GitHub. + * deletion + * @description Only allow users with bypass permissions to delete matching refs. */ - "nullable-repository": { + "repository-rule-deletion": { + /** @enum {string} */ + type: "deletion"; + }; + /** + * required_linear_history + * @description Prevent merge commits from being pushed to matching refs. + */ + "repository-rule-required-linear-history": { + /** @enum {string} */ + type: "required_linear_history"; + }; + /** + * required_deployments + * @description Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule. + */ + "repository-rule-required-deployments": { + /** @enum {string} */ + type: "required_deployments"; + parameters?: { + /** @description The environments that must be successfully deployed to before branches can be merged. */ + required_deployment_environments: string[]; + }; + }; + /** + * required_signatures + * @description Commits pushed to matching refs must have verified signatures. + */ + "repository-rule-required-signatures": { + /** @enum {string} */ + type: "required_signatures"; + }; + /** + * pull_request + * @description Require all commits be made to a non-target branch and submitted via a pull request before they can be merged. + */ + "repository-rule-pull-request": { + /** @enum {string} */ + type: "pull_request"; + parameters?: { + /** @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. */ + require_code_owner_review: boolean; + /** @description Whether the most recent reviewable push must be approved by someone other than the person who pushed it. */ + require_last_push_approval: boolean; + /** @description The number of approving reviews that are required before a pull request can be merged. */ + required_approving_review_count: number; + /** @description All conversations on code must be resolved before a pull request can be merged. */ + required_review_thread_resolution: boolean; + }; + }; + /** + * StatusCheckConfiguration + * @description Required status check + */ + "repository-rule-params-status-check-configuration": { + /** @description The status check context name that must be present on the commit. */ + context: string; + /** @description The optional integration ID that this status check must originate from. */ + integration_id?: number; + }; + /** + * required_status_checks + * @description Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass. + */ + "repository-rule-required-status-checks": { + /** @enum {string} */ + type: "required_status_checks"; + parameters?: { + /** @description Status checks that are required. */ + required_status_checks: components["schemas"]["repository-rule-params-status-check-configuration"][]; + /** @description Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled. */ + strict_required_status_checks_policy: boolean; + }; + }; + /** + * non_fast_forward + * @description Prevent users with push access from force pushing to refs. + */ + "repository-rule-non-fast-forward": { + /** @enum {string} */ + type: "non_fast_forward"; + }; + /** + * commit_message_pattern + * @description Parameters to be used for the commit_message_pattern rule + */ + "repository-rule-commit-message-pattern": { + /** @enum {string} */ + type: "commit_message_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * commit_author_email_pattern + * @description Parameters to be used for the commit_author_email_pattern rule + */ + "repository-rule-commit-author-email-pattern": { + /** @enum {string} */ + type: "commit_author_email_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * committer_email_pattern + * @description Parameters to be used for the committer_email_pattern rule + */ + "repository-rule-committer-email-pattern": { + /** @enum {string} */ + type: "committer_email_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * branch_name_pattern + * @description Parameters to be used for the branch_name_pattern rule + */ + "repository-rule-branch-name-pattern": { + /** @enum {string} */ + type: "branch_name_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * tag_name_pattern + * @description Parameters to be used for the tag_name_pattern rule + */ + "repository-rule-tag-name-pattern": { + /** @enum {string} */ + type: "tag_name_pattern"; + parameters?: { + /** @description How this rule will appear to users. */ + name?: string; + /** @description If true, the rule will fail if the pattern matches. */ + negate?: boolean; + /** + * @description The operator to use for matching. + * @enum {string} + */ + operator: "starts_with" | "ends_with" | "contains" | "regex"; + /** @description The pattern to match with. */ + pattern: string; + }; + }; + /** + * RestrictedCommits + * @description Restricted commit + */ + "repository-rule-params-restricted-commits": { + /** @description Full or abbreviated commit hash to reject */ + oid: string; + /** @description Reason for restriction */ + reason?: string; + }; + /** + * WorkflowFileReference + * @description A workflow that must run for this rule to pass + */ + "repository-rule-params-workflow-file-reference": { + /** @description The path to the workflow file */ + path: string; + /** @description The ref (branch or tag) of the workflow file to use */ + ref?: string; + /** @description The ID of the repository where the workflow is defined */ + repository_id: number; + /** @description The commit SHA of the workflow file to use */ + sha?: string; + }; + /** + * workflows + * @description Require all changes made to a targeted branch to pass the specified workflows before they can be merged. + */ + "repository-rule-workflows": { + /** @enum {string} */ + type: "workflows"; + parameters?: { + /** @description Workflows that must pass for this rule to pass. */ + workflows: components["schemas"]["repository-rule-params-workflow-file-reference"][]; + }; + }; + /** + * CodeScanningTool + * @description A tool that must provide code scanning results for this rule to pass. + */ + "repository-rule-params-code-scanning-tool": { /** - * @description Unique identifier of the repository - * @example 42 + * @description The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + * @enum {string} */ - id: number; - /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ - node_id: string; + alerts_threshold: "none" | "errors" | "errors_and_warnings" | "all"; /** - * @description The name of the repository. - * @example Team Environment + * @description The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + * @enum {string} */ - name: string; - /** @example octocat/Hello-World */ - full_name: string; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - forks: number; - permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; + security_alerts_threshold: "none" | "critical" | "high_or_higher" | "medium_or_higher" | "all"; + /** @description The name of a code scanning tool */ + tool: string; + }; + /** + * Repository Rule + * @description A repository rule. + */ + "repository-rule": components["schemas"]["repository-rule-creation"] | components["schemas"]["repository-rule-update"] | components["schemas"]["repository-rule-deletion"] | components["schemas"]["repository-rule-required-linear-history"] | components["schemas"]["repository-rule-required-deployments"] | components["schemas"]["repository-rule-required-signatures"] | components["schemas"]["repository-rule-pull-request"] | components["schemas"]["repository-rule-required-status-checks"] | components["schemas"]["repository-rule-non-fast-forward"] | components["schemas"]["repository-rule-commit-message-pattern"] | components["schemas"]["repository-rule-commit-author-email-pattern"] | components["schemas"]["repository-rule-committer-email-pattern"] | components["schemas"]["repository-rule-branch-name-pattern"] | components["schemas"]["repository-rule-tag-name-pattern"] | { + /** @enum {string} */ + type: "file_path_restriction"; + parameters?: { + /** @description The file paths that are restricted from being pushed to the commit graph. */ + restricted_file_paths: string[]; }; - owner: components["schemas"]["simple-user"]; + } | { + /** @enum {string} */ + type: "max_file_path_length"; + parameters?: { + /** @description The maximum amount of characters allowed in file paths */ + max_file_path_length: number; + }; + } | { + /** @enum {string} */ + type: "file_extension_restriction"; + parameters?: { + /** @description The file extensions that are restricted from being pushed to the commit graph. */ + restricted_file_extensions: string[]; + }; + } | { + /** @enum {string} */ + type: "max_file_size"; + parameters?: { + /** @description The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS). */ + max_file_size: number; + }; + } | components["schemas"]["repository-rule-workflows"]; + /** + * Repository ruleset + * @description A set of rules to apply when specified conditions are met. + */ + "repository-ruleset": { + /** @description The ID of the ruleset */ + id: number; + /** @description The name of the ruleset */ + name: string; /** - * @description Whether the repository is private or public. - * @default false + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. + * @enum {string} */ - private: boolean; + target?: "branch" | "tag" | "push"; /** - * Format: uri - * @example https://github.com/octocat/Hello-World + * @description The type of the source of the ruleset + * @enum {string} */ - html_url: string; - /** @example This your first repo! */ - description: string | null; - fork: boolean; + source_type?: "Repository" | "Organization"; + /** @description The name of the source */ + source: string; + 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"][]; /** - * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World + * @description The bypass type of the user making the API request for this ruleset. This field is only returned when + * querying the repository-level endpoint. + * @enum {string} */ - url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + current_user_can_bypass?: "always" | "pull_requests_only" | "never"; + node_id?: string; + _links?: { + self?: { + /** @description The URL of the ruleset */ + href?: string; + }; + html?: { + /** @description The html URL of the ruleset */ + href?: string; + }; + }; + conditions?: (components["schemas"]["repository-ruleset-conditions"] | components["schemas"]["org-ruleset-conditions"]) | null; + rules?: components["schemas"]["repository-rule"][]; + /** Format: date-time */ + created_at?: string; + /** Format: date-time */ + updated_at?: string; + }; + /** + * Rule Suites + * @description Response + */ + "rule-suites": { + /** @description The unique identifier of the rule insight. */ + id?: number; + /** @description The number that identifies the user. */ + actor_id?: number; + /** @description The handle for the GitHub user account. */ + actor_name?: string; + /** @description The first commit sha before the push evaluation. */ + before_sha?: string; + /** @description The last commit sha in the push evaluation. */ + after_sha?: string; + /** @description The ref name that the evaluation ran on. */ + ref?: string; + /** @description The ID of the repository associated with the rule evaluation. */ + repository_id?: number; + /** @description The name of the repository without the `.git` extension. */ + repository_name?: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/contributors + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - contributors_url: string; + pushed_at?: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/deployments + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} */ - deployments_url: string; + result?: "pass" | "fail" | "bypass"; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + * @enum {string} */ - downloads_url: string; + evaluation_result?: "pass" | "fail"; + }[]; + /** + * Rule Suite + * @description Response + */ + "rule-suite": { + /** @description The unique identifier of the rule insight. */ + id?: number; + /** @description The number that identifies the user. */ + actor_id?: number | null; + /** @description The handle for the GitHub user account. */ + actor_name?: string | null; + /** @description The first commit sha before the push evaluation. */ + before_sha?: string; + /** @description The last commit sha in the push evaluation. */ + after_sha?: string; + /** @description The ref name that the evaluation ran on. */ + ref?: string; + /** @description The ID of the repository associated with the rule evaluation. */ + repository_id?: number; + /** @description The name of the repository without the `.git` extension. */ + repository_name?: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/events + * Format: date-time + * @example 2011-01-26T19:06:43Z */ - events_url: string; + pushed_at?: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/forks + * @description The result of the rule evaluations for rules with the `active` enforcement status. + * @enum {string} */ - forks_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; - /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ - labels_url: string; + result?: "pass" | "fail" | "bypass"; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/languages + * @description The result of the rule evaluations for rules with the `active` and `evaluate` enforcement statuses, demonstrating whether rules would pass or fail if all rules in the rule suite were `active`. + * @enum {string} */ - languages_url: string; + evaluation_result?: "pass" | "fail"; + /** @description Details on the evaluated rules. */ + rule_evaluations?: { + rule_source?: { + /** @description The type of rule source. */ + type?: string; + /** @description The ID of the rule source. */ + id?: number | null; + /** @description The name of the rule source. */ + name?: string | null; + }; + /** + * @description The enforcement level of this rule source. + * @enum {string} + */ + enforcement?: "active" | "evaluate" | "deleted ruleset"; + /** + * @description The result of the evaluation of the individual rule. + * @enum {string} + */ + result?: "pass" | "fail"; + /** @description The type of rule. */ + rule_type?: string; + /** @description Any associated details with the rule evaluation. */ + details?: string; + }[]; + }; + /** @description A product affected by the vulnerability detailed in a repository security advisory. */ + "repository-advisory-vulnerability": { + /** @description The name of the package affected by the vulnerability. */ + package: { + ecosystem: components["schemas"]["security-advisory-ecosystems"]; + /** @description The unique package name within its ecosystem. */ + name: string | null; + } | null; + /** @description The range of the package versions affected by the vulnerability. */ + vulnerable_version_range: string | null; + /** @description The package version(s) that resolve the vulnerability. */ + patched_versions: string | null; + /** @description The functions in the package that are affected. */ + vulnerable_functions: string[] | null; + }; + /** @description A credit given to a user for a repository security advisory. */ + "repository-advisory-credit": { + user: components["schemas"]["simple-user"]; + type: components["schemas"]["security-advisory-credit-types"]; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/merges + * @description The state of the user's acceptance of the credit. + * @enum {string} */ - merges_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; - /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; + state: "accepted" | "declined" | "pending"; + }; + /** @description A repository security advisory. */ + "repository-advisory": { + /** @description The GitHub Security Advisory ID. */ + readonly ghsa_id: string; + /** @description The Common Vulnerabilities and Exposures (CVE) ID. */ + cve_id: string | null; /** * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/stargazers + * @description The API URL for the advisory. */ - stargazers_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; + readonly url: string; /** * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/subscribers + * @description The URL for the advisory. */ - subscribers_url: string; + readonly html_url: string; + /** @description A short summary of the advisory. */ + summary: string; + /** @description A detailed description of what the advisory entails. */ + description: string | null; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/subscription + * @description The severity of the advisory. + * @enum {string|null} */ - subscription_url: string; + severity: "critical" | "high" | "medium" | "low"; + /** @description The author of the advisory. */ + readonly author: components["schemas"]["simple-user"] | null; + /** @description The publisher of the advisory. */ + readonly publisher: components["schemas"]["simple-user"] | null; + readonly identifiers: { + /** + * @description The type of identifier. + * @enum {string} + */ + type: "CVE" | "GHSA"; + /** @description The identifier value. */ + value: string; + }[]; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/tags + * @description The state of the advisory. + * @enum {string} */ - tags_url: string; + state: "published" | "closed" | "withdrawn" | "draft" | "triage"; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/teams + * Format: date-time + * @description The date and time of when the advisory was created, in ISO 8601 format. */ - teams_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; - /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; + readonly created_at: string | null; /** - * Format: uri - * @example git:git.example.com/octocat/Hello-World + * Format: date-time + * @description The date and time of when the advisory was last updated, in ISO 8601 format. */ - mirror_url: string | null; + readonly updated_at: string | null; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/hooks + * Format: date-time + * @description The date and time of when the advisory was published, in ISO 8601 format. */ - hooks_url: string; + readonly published_at: string | null; /** - * Format: uri - * @example https://svn.github.com/octocat/Hello-World + * Format: date-time + * @description The date and time of when the advisory was closed, in ISO 8601 format. */ - svn_url: string; + readonly closed_at: string | null; + /** + * Format: date-time + * @description The date and time of when the advisory was withdrawn, in ISO 8601 format. + */ + readonly withdrawn_at: string | null; + readonly submission: { + /** @description Whether a private vulnerability report was accepted by the repository's administrators. */ + readonly accepted: boolean; + } | null; + vulnerabilities: components["schemas"]["repository-advisory-vulnerability"][] | null; + cvss: { + /** @description The CVSS vector. */ + vector_string: string | null; + /** @description The CVSS score. */ + readonly score: number | null; + } | null; + readonly cwes: { + /** @description The Common Weakness Enumeration (CWE) identifier. */ + cwe_id: string; + /** @description The name of the CWE. */ + readonly name: string; + }[] | null; + /** @description A list of only the CWE IDs. */ + cwe_ids: string[] | null; + credits: { + /** @description The username of the user credited. */ + login?: string; + type?: components["schemas"]["security-advisory-credit-types"]; + }[] | null; + readonly credits_detailed: components["schemas"]["repository-advisory-credit"][] | null; + /** @description A list of users that collaborate on the advisory. */ + collaborating_users: components["schemas"]["simple-user"][] | null; + /** @description A list of teams that collaborate on the advisory. */ + collaborating_teams: components["schemas"]["team"][] | null; + /** @description A temporary private fork of the advisory's repository for collaborating on a fix. */ + readonly private_fork: components["schemas"]["simple-repository"] | null; + }; + /** + * Team Simple + * @description Groups of organization members that gives permissions on specified repositories. + */ + "team-simple": { + /** + * @description Unique identifier of the team + * @example 1 + */ + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; /** * Format: uri - * @example https://github.com + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 */ - homepage: string | null; - language: string | null; - /** @example 9 */ - forks_count: number; - /** @example 80 */ - stargazers_count: number; - /** @example 80 */ - watchers_count: number; + url: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. - * @example 108 + * @description Name of the team + * @example Justice League */ - size: number; + name: string; /** - * @description The default branch of the repository. - * @example master + * @description Description of the team + * @example A great team. */ - default_branch: string; - /** @example 0 */ - open_issues_count: number; + description: string | null; /** - * @description Whether this repository acts as a template that can be used to generate new repositories. - * @default false - * @example true + * @description Permission that the team will have for its repositories + * @example admin */ - is_template: boolean; - topics?: string[]; + permission: string; /** - * @description Whether issues are enabled. - * @default true - * @example true + * @description The level of privacy this team should have + * @example closed */ - has_issues: boolean; + privacy?: string; /** - * @description Whether projects are enabled. - * @default true - * @example true + * @description The notification setting the team has set + * @example notifications_enabled */ - has_projects: boolean; + notification_setting?: string; /** - * @description Whether the wiki is enabled. - * @default true - * @example true + * Format: uri + * @example https://github.com/orgs/rails/teams/core */ - has_wiki: boolean; - has_pages: boolean; + html_url: string; /** - * @deprecated - * @description Whether downloads are enabled. - * @default true - * @example true + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos */ - has_downloads: boolean; + repositories_url: string; + /** @example justice-league */ + slug: string; /** - * @description Whether discussions are enabled. - * @default false - * @example true + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com */ - has_discussions: boolean; + ldap_dn?: string; + }; + "actions-billing-usage": { + /** @description The sum of the free and paid GitHub Actions minutes used. */ + total_minutes_used: number; + /** @description The total paid GitHub Actions minutes used. */ + total_paid_minutes_used: number; + /** @description The amount of free GitHub Actions minutes available. */ + included_minutes: number; + minutes_used_breakdown: { + /** @description Total minutes used on Ubuntu runner machines. */ + UBUNTU?: number; + /** @description Total minutes used on macOS runner machines. */ + MACOS?: number; + /** @description Total minutes used on Windows runner machines. */ + WINDOWS?: number; + /** @description Total minutes used on Ubuntu 4 core runner machines. */ + ubuntu_4_core?: number; + /** @description Total minutes used on Ubuntu 8 core runner machines. */ + ubuntu_8_core?: number; + /** @description Total minutes used on Ubuntu 16 core runner machines. */ + ubuntu_16_core?: number; + /** @description Total minutes used on Ubuntu 32 core runner machines. */ + ubuntu_32_core?: number; + /** @description Total minutes used on Ubuntu 64 core runner machines. */ + ubuntu_64_core?: number; + /** @description Total minutes used on Windows 4 core runner machines. */ + windows_4_core?: number; + /** @description Total minutes used on Windows 8 core runner machines. */ + windows_8_core?: number; + /** @description Total minutes used on Windows 16 core runner machines. */ + windows_16_core?: number; + /** @description Total minutes used on Windows 32 core runner machines. */ + windows_32_core?: number; + /** @description Total minutes used on Windows 64 core runner machines. */ + windows_64_core?: number; + /** @description Total minutes used on macOS 12 core runner machines. */ + macos_12_core?: number; + /** @description Total minutes used on all runner machines. */ + total?: number; + }; + }; + "packages-billing-usage": { + /** @description Sum of the free and paid storage space (GB) for GitHuub Packages. */ + total_gigabytes_bandwidth_used: number; + /** @description Total paid storage space (GB) for GitHuub Packages. */ + total_paid_gigabytes_bandwidth_used: number; + /** @description Free storage space (GB) for GitHub Packages. */ + included_gigabytes_bandwidth: number; + }; + "combined-billing-usage": { + /** @description Numbers of days left in billing cycle. */ + days_left_in_billing_cycle: number; + /** @description Estimated storage space (GB) used in billing cycle. */ + estimated_paid_storage_for_month: number; + /** @description Estimated sum of free and paid storage space (GB) used in billing cycle. */ + estimated_storage_for_month: number; + }; + /** + * Team Organization + * @description Team Organization + */ + "team-organization": { + /** @example github */ + login: string; + /** @example 1 */ + id: number; + /** @example MDEyOk9yZ2FuaXphdGlvbjE= */ + node_id: string; /** - * @description Whether the repository is archived. - * @default false + * Format: uri + * @example https://api.github.com/orgs/github */ - archived: boolean; - /** @description Returns whether or not this repository disabled. */ - disabled: boolean; + url: string; /** - * @description The repository visibility: public, private, or internal. - * @default public + * Format: uri + * @example https://api.github.com/orgs/github/repos */ - visibility: string; + repos_url: string; /** - * Format: date-time - * @example 2011-01-26T19:06:43Z + * Format: uri + * @example https://api.github.com/orgs/github/events */ - pushed_at: string | null; + 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; + /** @example github */ + name?: string; + /** @example GitHub */ + company?: string; /** - * Format: date-time - * @example 2011-01-26T19:01:12Z + * Format: uri + * @example https://github.com/blog */ - created_at: string | null; + blog?: string; + /** @example San Francisco */ + location?: string; + /** + * Format: email + * @example octocat@github.com + */ + email?: string; + /** @example github */ + twitter_username?: string | null; + /** @example true */ + is_verified?: boolean; + /** @example true */ + has_organization_projects: boolean; + /** @example true */ + has_repository_projects: boolean; + /** @example 2 */ + public_repos: number; + /** @example 1 */ + public_gists: number; + /** @example 20 */ + followers: number; + /** @example 0 */ + following: number; + /** + * Format: uri + * @example https://github.com/octocat + */ + html_url: string; /** * Format: date-time - * @example 2011-01-26T19:14:43Z + * @example 2008-01-14T04:33:35Z */ - updated_at: string | null; + created_at: string; + /** @example Organization */ + type: string; + /** @example 100 */ + total_private_repos?: number; + /** @example 100 */ + owned_private_repos?: number; + /** @example 81 */ + private_gists?: number | null; + /** @example 10000 */ + disk_usage?: number | null; + /** @example 8 */ + collaborators?: number | null; /** - * @description Whether to allow rebase merges for pull requests. - * @default true - * @example true + * Format: email + * @example org@example.com */ - allow_rebase_merge: boolean; - template_repository?: { - id?: number; - node_id?: string; - name?: string; - full_name?: string; - owner?: { - login?: string; - id?: number; - node_id?: string; - avatar_url?: string; - gravatar_id?: string; - url?: string; - html_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - starred_url?: string; - subscriptions_url?: string; - organizations_url?: string; - repos_url?: string; - events_url?: string; - received_events_url?: string; - type?: string; - site_admin?: boolean; - }; - private?: boolean; - html_url?: string; - description?: string; - fork?: boolean; - url?: string; - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - downloads_url?: string; - events_url?: string; - forks_url?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - git_url?: string; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - notifications_url?: string; - pulls_url?: string; - releases_url?: string; - ssh_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - clone_url?: string; - mirror_url?: string; - hooks_url?: string; - svn_url?: string; - homepage?: string; - language?: string; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; - pushed_at?: string; - created_at?: string; - updated_at?: string; - permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; - allow_rebase_merge?: boolean; - temp_clone_token?: string; - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_update_branch?: boolean; - use_squash_pr_title_as_default?: boolean; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - allow_merge_commit?: boolean; - subscribers_count?: number; - network_count?: number; - } | null; - temp_clone_token?: string; + billing_email?: string | null; + plan?: { + name: string; + space: number; + private_repos: number; + filled_seats?: number; + seats?: number; + }; + default_repository_permission?: string | null; + /** @example true */ + members_can_create_repositories?: boolean | null; + /** @example true */ + two_factor_requirement_enabled?: boolean | null; + /** @example all */ + members_allowed_repository_creation_type?: string; + /** @example true */ + members_can_create_public_repositories?: boolean; + /** @example true */ + members_can_create_private_repositories?: boolean; + /** @example true */ + members_can_create_internal_repositories?: boolean; + /** @example true */ + members_can_create_pages?: boolean; + /** @example true */ + members_can_create_public_pages?: boolean; + /** @example true */ + members_can_create_private_pages?: boolean; + /** @example false */ + members_can_fork_private_repositories?: boolean | null; + /** @example false */ + web_commit_signoff_required?: boolean; + /** Format: date-time */ + updated_at: string; + /** Format: date-time */ + archived_at: string | null; + }; + /** + * Full Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + "team-full": { /** - * @description Whether to allow squash merges for pull requests. - * @default true - * @example true + * @description Unique identifier of the team + * @example 42 */ - allow_squash_merge: boolean; + id: number; + /** @example MDQ6VGVhbTE= */ + node_id: string; /** - * @description Whether to allow Auto-merge to be used on pull requests. - * @default false - * @example false + * Format: uri + * @description URL for the team + * @example https://api.github.com/organizations/1/team/1 */ - allow_auto_merge: boolean; + url: string; /** - * @description Whether to delete head branches when pull requests are merged - * @default false - * @example false + * Format: uri + * @example https://github.com/orgs/rails/teams/core */ - delete_branch_on_merge: boolean; + html_url: string; /** - * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. - * @default false - * @example false + * @description Name of the team + * @example Developers */ - allow_update_branch: boolean; + name: string; + /** @example justice-league */ + slug: string; + /** @example A great team. */ + description: string | null; /** - * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false + * @description The level of privacy this team should have + * @example closed + * @enum {string} */ - use_squash_pr_title_as_default: boolean; + privacy?: "closed" | "secret"; /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @description The notification setting the team has set + * @example notifications_enabled * @enum {string} */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + notification_setting?: "notifications_enabled" | "notifications_disabled"; /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} + * @description Permission that the team will have for its repositories + * @example push */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + permission: string; + /** @example https://api.github.com/organizations/1/team/1/members{/member} */ + members_url: string; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} + * Format: uri + * @example https://api.github.com/organizations/1/team/1/repos */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + repositories_url: string; + parent?: components["schemas"]["nullable-team-simple"]; + /** @example 3 */ + members_count: number; + /** @example 10 */ + repos_count: number; /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} + * Format: date-time + * @example 2017-07-14T16:53:42Z */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + created_at: string; /** - * @description Whether to allow merge commits for pull requests. - * @default true - * @example true + * Format: date-time + * @example 2017-08-17T12:37:15Z */ - allow_merge_commit: boolean; - /** @description Whether to allow forking this repo */ - allow_forking?: boolean; + updated_at: string; + organization: components["schemas"]["team-organization"]; /** - * @description Whether to require contributors to sign off on web-based commits - * @default false + * @description Distinguished Name (DN) that team maps to within LDAP environment + * @example uid=example,ou=users,dc=github,dc=com */ - web_commit_signoff_required: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; - /** @example "2020-07-09T00:17:42Z" */ - starred_at?: string; - /** @description Whether anonymous git access is enabled for this repository */ - anonymous_access_enabled?: boolean; - } | null; + ldap_dn?: string; + }; /** - * Code Of Conduct Simple - * @description Code of Conduct Simple + * Team Discussion + * @description A team discussion is a persistent record of a free-form conversation within a team. */ - "code-of-conduct-simple": { + "team-discussion": { + author: components["schemas"]["nullable-simple-user"]; + /** + * @description The main text of the discussion. + * @example Please suggest improvements to our workflow in comments. + */ + body: string; + /** @example

Hi! This is an area for us to collaborate as a team

*/ + body_html: string; + /** + * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. + * @example 0307116bbf7ced493b8d8a346c650b71 + */ + body_version: string; + /** @example 0 */ + comments_count: number; /** * Format: uri - * @example https://api.github.com/repos/github/docs/community/code_of_conduct + * @example https://api.github.com/organizations/1/team/2343027/discussions/1/comments + */ + comments_url: string; + /** + * Format: date-time + * @example 2018-01-25T18:56:31Z + */ + created_at: string; + /** Format: date-time */ + last_edited_at: string | null; + /** + * Format: uri + * @example https://github.com/orgs/github/teams/justice-league/discussions/1 + */ + html_url: string; + /** @example MDE0OlRlYW1EaXNjdXNzaW9uMQ== */ + node_id: string; + /** + * @description The unique sequence number of a team discussion. + * @example 42 + */ + number: number; + /** + * @description Whether or not this discussion should be pinned for easy retrieval. + * @example true + */ + pinned: boolean; + /** + * @description Whether or not this discussion should be restricted to team members and organization owners. + * @example true + */ + private: boolean; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/2343027 + */ + team_url: string; + /** + * @description The title of the discussion. + * @example How can we improve our workflow? + */ + title: string; + /** + * Format: date-time + * @example 2018-01-25T18:56:31Z + */ + updated_at: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/2343027/discussions/1 */ url: string; - /** @example citizen_code_of_conduct */ - key: string; - /** @example Citizen Code of Conduct */ - name: string; + reactions?: components["schemas"]["reaction-rollup"]; + }; + /** + * Team Discussion Comment + * @description A reply to a discussion within a team. + */ + "team-discussion-comment": { + author: components["schemas"]["nullable-simple-user"]; + /** + * @description The main text of the comment. + * @example I agree with this suggestion. + */ + body: string; + /** @example

Do you like apples?

*/ + body_html: string; + /** + * @description The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server. + * @example 0307116bbf7ced493b8d8a346c650b71 + */ + body_version: string; + /** + * Format: date-time + * @example 2018-01-15T23:53:58Z + */ + created_at: string; + /** Format: date-time */ + last_edited_at: string | null; /** * Format: uri - * @example https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md + * @example https://api.github.com/organizations/1/team/2403582/discussions/1 */ - html_url: string | null; + discussion_url: string; + /** + * Format: uri + * @example https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + */ + html_url: string; + /** @example MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= */ + node_id: string; + /** + * @description The unique sequence number of a team discussion comment. + * @example 42 + */ + number: number; + /** + * Format: date-time + * @example 2018-01-15T23:53:58Z + */ + updated_at: string; + /** + * Format: uri + * @example https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + */ + url: string; + reactions?: components["schemas"]["reaction-rollup"]; }; /** - * Full Repository - * @description Full Repository + * Reaction + * @description Reactions to conversations provide a way to help people express their feelings more simply and effectively. */ - "full-repository": { - /** @example 1296269 */ + reaction: { + /** @example 1 */ + id: number; + /** @example MDg6UmVhY3Rpb24x */ + node_id: string; + user: components["schemas"]["nullable-simple-user"]; + /** + * @description The reaction to use + * @example heart + * @enum {string} + */ + content: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; + /** + * Format: date-time + * @example 2016-05-20T20:09:31Z + */ + created_at: string; + }; + /** + * Team Membership + * @description Team Membership + */ + "team-membership": { + /** Format: uri */ + url: string; + /** + * @description The role of the user in the team. + * @default member + * @example member + * @enum {string} + */ + role: "member" | "maintainer"; + /** + * @description The state of the user's membership in the team. + * @enum {string} + */ + state: "active" | "pending"; + }; + /** + * Team Project + * @description A team's access to a project. + */ + "team-project": { + owner_url: string; + url: string; + html_url: string; + columns_url: string; + id: number; + node_id: string; + name: string; + body: string | null; + number: number; + state: string; + creator: components["schemas"]["simple-user"]; + created_at: string; + updated_at: string; + /** @description The organization permission for this project. Only present when owner is an organization. */ + organization_permission?: string; + /** @description Whether the project is private or not. Only present when owner is an organization. */ + private?: boolean; + permissions: { + read: boolean; + write: boolean; + admin: boolean; + }; + }; + /** + * Team Repository + * @description A team's access to a repository. + */ + "team-repository": { + /** + * @description Unique identifier of the repository + * @example 42 + */ id: number; /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ node_id: string; - /** @example Hello-World */ + /** + * @description The name of the repository. + * @example Team Environment + */ name: string; /** @example octocat/Hello-World */ full_name: string; - owner: components["schemas"]["simple-user"]; + license: components["schemas"]["nullable-license-simple"]; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; + }; + /** @example admin */ + role_name?: string; + owner: components["schemas"]["nullable-simple-user"]; + /** + * @description Whether the repository is private or public. + * @default false + */ private: boolean; /** * Format: uri @@ -23698,142 +24326,252 @@ export interface components { stargazers_count: number; /** @example 80 */ watchers_count: number; + /** @example 108 */ + size: number; /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. - * @example 108 + * @description The default branch of the repository. + * @example master */ - size: number; - /** @example master */ default_branch: string; /** @example 0 */ open_issues_count: number; - /** @example true */ - is_template?: boolean; - /** @example [ - * "octocat", - * "atom", - * "electron", - * "API" - * ] */ + /** + * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false + * @example true + */ + is_template: boolean; topics?: string[]; - /** @example true */ + /** + * @description Whether issues are enabled. + * @default true + * @example true + */ has_issues: boolean; - /** @example true */ + /** + * @description Whether projects are enabled. + * @default true + * @example true + */ has_projects: boolean; - /** @example true */ + /** + * @description Whether the wiki is enabled. + * @default true + * @example true + */ has_wiki: boolean; has_pages: boolean; - /** @example true */ - has_downloads?: boolean; - /** @example true */ - has_discussions: boolean; + /** + * @description Whether downloads are enabled. + * @default true + * @example true + */ + has_downloads: boolean; + /** + * @description Whether the repository is archived. + * @default false + */ archived: boolean; /** @description Returns whether or not this repository disabled. */ disabled: boolean; /** * @description The repository visibility: public, private, or internal. - * @example public + * @default public */ - visibility?: string; + visibility: string; /** * Format: date-time * @example 2011-01-26T19:06:43Z */ - pushed_at: string; + pushed_at: string | null; /** * Format: date-time * @example 2011-01-26T19:01:12Z */ - created_at: string; + created_at: string | null; /** * Format: date-time * @example 2011-01-26T19:14:43Z */ - updated_at: string; - permissions?: { - admin: boolean; - maintain?: boolean; - push: boolean; - triage?: boolean; - pull: boolean; - }; - /** @example true */ - allow_rebase_merge?: boolean; - template_repository?: components["schemas"]["nullable-repository"]; - temp_clone_token?: string | null; - /** @example true */ - allow_squash_merge?: boolean; - /** @example false */ - allow_auto_merge?: boolean; - /** @example false */ - delete_branch_on_merge?: boolean; - /** @example true */ - allow_merge_commit?: boolean; - /** @example true */ - allow_update_branch?: boolean; - /** @example false */ - use_squash_pr_title_as_default?: boolean; + updated_at: string | null; /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @example PR_TITLE - * @enum {string} + * @description Whether to allow rebase merges for pull requests. + * @default true + * @example true */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + allow_rebase_merge: boolean; + temp_clone_token?: string; /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @example PR_BODY - * @enum {string} + * @description Whether to allow squash merges for pull requests. + * @default true + * @example true */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + allow_squash_merge: boolean; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @example PR_TITLE - * @enum {string} + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + allow_auto_merge: boolean; /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @example PR_BODY - * @enum {string} + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** @example true */ - allow_forking?: boolean; - /** @example false */ - web_commit_signoff_required?: boolean; - /** @example 42 */ - subscribers_count: number; - /** @example 0 */ - network_count: number; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - parent?: components["schemas"]["repository"]; - source?: components["schemas"]["repository"]; - forks: number; - master_branch?: string; + delete_branch_on_merge: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + * @example true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow forking this repo + * @default false + * @example false + */ + allow_forking: boolean; + /** + * @description Whether to require contributors to sign off on web-based commits + * @default false + * @example false + */ + web_commit_signoff_required: boolean; + subscribers_count?: number; + network_count?: number; open_issues: number; watchers: number; + master_branch?: string; + }; + /** + * Project Card + * @description Project cards represent a scope of work. + */ + "project-card": { /** - * @description Whether anonymous git access is allowed. - * @default true + * Format: uri + * @example https://api.github.com/projects/columns/cards/1478 */ - anonymous_access_enabled: boolean; - code_of_conduct?: components["schemas"]["code-of-conduct-simple"]; - security_and_analysis?: components["schemas"]["security-and-analysis"]; + url: string; + /** + * @description The project card's ID + * @example 42 + */ + id: number; + /** @example MDExOlByb2plY3RDYXJkMTQ3OA== */ + node_id: string; + /** @example Add payload for delete Project column */ + note: string | null; + creator: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @example 2016-09-05T14:21:06Z + */ + created_at: string; + /** + * Format: date-time + * @example 2016-09-05T14:20:22Z + */ + updated_at: string; + /** + * @description Whether or not the card is archived + * @example false + */ + archived?: boolean; + column_name?: string; + project_id?: string; + /** + * Format: uri + * @example https://api.github.com/projects/columns/367 + */ + column_url: string; + /** + * Format: uri + * @example https://api.github.com/repos/api-playground/projects-test/issues/3 + */ + content_url?: string; + /** + * Format: uri + * @example https://api.github.com/projects/120 + */ + project_url: string; + }; + /** + * Project Column + * @description Project columns contain cards of work. + */ + "project-column": { + /** + * Format: uri + * @example https://api.github.com/projects/columns/367 + */ + url: string; + /** + * Format: uri + * @example https://api.github.com/projects/120 + */ + project_url: string; + /** + * Format: uri + * @example https://api.github.com/projects/columns/367/cards + */ + cards_url: string; + /** + * @description The unique identifier of the project column + * @example 42 + */ + id: number; + /** @example MDEzOlByb2plY3RDb2x1bW4zNjc= */ + node_id: string; + /** + * @description Name of the project column + * @example Remaining tasks + */ + name: string; + /** + * Format: date-time + * @example 2016-09-05T14:18:44Z + */ + created_at: string; + /** + * Format: date-time + * @example 2016-09-05T14:22:28Z + */ + updated_at: string; + }; + /** + * Project Collaborator Permission + * @description Project Collaborator Permission + */ + "project-collaborator-permission": { + permission: string; + user: components["schemas"]["nullable-simple-user"]; + }; + /** Rate Limit */ + "rate-limit": { + limit: number; + remaining: number; + reset: number; + used: number; + }; + /** + * Rate Limit Overview + * @description Rate Limit Overview + */ + "rate-limit-overview": { + resources: { + core: components["schemas"]["rate-limit"]; + graphql?: components["schemas"]["rate-limit"]; + search: components["schemas"]["rate-limit"]; + code_search?: components["schemas"]["rate-limit"]; + source_import?: components["schemas"]["rate-limit"]; + integration_manifest?: components["schemas"]["rate-limit"]; + code_scanning_upload?: components["schemas"]["rate-limit"]; + actions_runner_registration?: components["schemas"]["rate-limit"]; + scim?: components["schemas"]["rate-limit"]; + dependency_snapshots?: components["schemas"]["rate-limit"]; + }; + rate: components["schemas"]["rate-limit"]; }; /** * Artifact @@ -23951,7 +24689,7 @@ export interface components { * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed" | "waiting"; + status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @description The outcome of the job. * @example success @@ -24118,7 +24856,7 @@ export interface components { * @description Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the * repository. * - * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization. + * `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. * @enum {string} */ access_level: "none" | "user" | "organization"; @@ -25284,11 +26022,11 @@ export interface components { /** @example https://example.com */ details_url: string | null; /** - * @description The phase of the lifecycle that the check is currently in. + * @description The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs. * @example queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @example neutral * @enum {string|null} @@ -25419,10 +26157,11 @@ export interface components { */ head_sha: string; /** + * @description The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites. * @example completed * @enum {string|null} */ - status: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @example neutral * @enum {string|null} @@ -25460,21 +26199,6 @@ export interface components { }; repository: components["schemas"]["minimal-repository"]; }; - "code-scanning-alert-rule-summary": { - /** @description A unique identifier for the rule used to detect the alert. */ - id?: string | null; - /** @description The name of the rule used to detect the alert. */ - name?: string; - /** @description A set of tags applicable for the rule. */ - tags?: string[] | null; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity?: "none" | "note" | "warning" | "error"; - /** @description A short description of the rule used to detect the alert. */ - description?: string; - }; "code-scanning-alert-items": { number: components["schemas"]["alert-number"]; created_at: components["schemas"]["alert-created-at"]; @@ -25492,6 +26216,32 @@ export interface components { tool: components["schemas"]["code-scanning-analysis-tool"]; most_recent_instance: components["schemas"]["code-scanning-alert-instance"]; }; + "code-scanning-alert-rule": { + /** @description A unique identifier for the rule used to detect the alert. */ + id?: string | null; + /** @description The name of the rule used to detect the alert. */ + name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity?: "none" | "note" | "warning" | "error"; + /** + * @description The security severity of the alert. + * @enum {string|null} + */ + security_severity_level?: "low" | "medium" | "high" | "critical"; + /** @description A short description of the rule used to detect the alert. */ + description?: string; + /** @description description of the rule used to detect the alert. */ + full_description?: string; + /** @description A set of tags applicable for the rule. */ + tags?: string[] | null; + /** @description Detailed documentation for the rule as GitHub Flavored Markdown. */ + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; + }; "code-scanning-alert": { number: components["schemas"]["alert-number"]; created_at: components["schemas"]["alert-created-at"]; @@ -25659,7 +26409,7 @@ export interface components { }; /** * @description The full Git reference, formatted as `refs/heads/`, - * `refs/pull//merge`, or `refs/pull//head`. + * `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. * @example refs/heads/main */ "code-scanning-ref-full": string; @@ -27447,24 +28197,7 @@ export interface components { * ] */ events: string[]; - config: { - /** @example "foo@bar.com" */ - email?: string; - /** @example "foo" */ - password?: string; - /** @example "roomer" */ - room?: string; - /** @example "foo" */ - subdomain?: string; - url?: components["schemas"]["webhook-config-url"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - /** @example "sha256" */ - digest?: string; - secret?: components["schemas"]["webhook-config-secret"]; - /** @example "abc" */ - token?: string; - }; + config: components["schemas"]["webhook-config"]; /** * Format: date-time * @example 2011-09-06T20:39:23Z @@ -28772,10 +29505,12 @@ export interface components { * @description The GitHub Pages deployment status. */ "page-deployment": { + /** @description The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit. */ + id: number | string; /** * Format: uri * @description The URI to monitor GitHub Pages deployment status. - * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status + * @example https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 */ status_url: string; /** @@ -28791,6 +29526,14 @@ export interface components { */ preview_url?: string; }; + /** GitHub Pages deployment status */ + "pages-deployment-status": { + /** + * @description The current status of the deployment. + * @enum {string} + */ + status?: "deployment_in_progress" | "syncing_files" | "finished_file_sync" | "updating_pages" | "purging_cdn" | "deployment_cancelled" | "deployment_failed" | "deployment_content_failed" | "deployment_attempt_error" | "deployment_lost" | "succeed"; + }; /** * Pages Health Check Status * @description Pages Health Check Status @@ -29728,6 +30471,42 @@ export interface components { /** @description The API URL to get the associated commit resource */ commit_url: string; }; + /** @description Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki. */ + "secret-scanning-location-wiki-commit": { + /** + * @description The file path of the wiki page + * @example /example/Home.md + */ + path: string; + /** @description Line number at which the secret starts in the file */ + start_line: number; + /** @description Line number at which the secret ends in the file */ + end_line: number; + /** @description The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII. */ + start_column: number; + /** @description The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII. */ + end_column: number; + /** + * @description SHA-1 hash ID of the associated blob + * @example af5626b4a114abcb82d63db7c8082c3c4756e51b + */ + blob_sha: string; + /** + * @description The GitHub URL to get the associated wiki page + * @example https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + page_url: string; + /** + * @description SHA-1 hash ID of the associated commit + * @example 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_sha: string; + /** + * @description The GitHub URL to get the associated wiki commit + * @example https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + */ + commit_url: string; + }; /** @description Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. */ "secret-scanning-location-issue-title": { /** @@ -29755,14 +30534,86 @@ export interface components { */ issue_comment_url: string; }; + /** @description Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. */ + "secret-scanning-location-discussion-title": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082 + */ + discussion_title_url: string; + }; + /** @description Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. */ + "secret-scanning-location-discussion-body": { + /** + * Format: uri + * @description The URL to the discussion where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussion-4566270 + */ + discussion_body_url: string; + }; + /** @description Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. */ + "secret-scanning-location-discussion-comment": { + /** + * Format: uri + * @description The API URL to get the discussion comment where the secret was detected. + * @example https://github.com/community/community/discussions/39082#discussioncomment-4158232 + */ + discussion_comment_url: string; + }; + /** @description Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. */ + "secret-scanning-location-pull-request-title": { + /** + * 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 + */ + pull_request_title_url: string; + }; + /** @description Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. */ + "secret-scanning-location-pull-request-body": { + /** + * 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 + */ + pull_request_body_url: string; + }; + /** @description Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. */ + "secret-scanning-location-pull-request-comment": { + /** + * Format: uri + * @description The API URL to get the pull request comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + */ + pull_request_comment_url: string; + }; + /** @description Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. */ + "secret-scanning-location-pull-request-review": { + /** + * Format: uri + * @description The API URL to get the pull request review where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + */ + pull_request_review_url: string; + }; + /** @description Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. */ + "secret-scanning-location-pull-request-review-comment": { + /** + * Format: uri + * @description The API URL to get the pull request review comment where the secret was detected. + * @example https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + */ + pull_request_review_comment_url: string; + }; "secret-scanning-location": { /** - * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues), this field identifies the type of resource where the secret was found. + * @description The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. * @example commit * @enum {string} */ - type: "commit" | "issue_title" | "issue_body" | "issue_comment"; - details: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"]; + type?: "commit" | "wiki_commit" | "issue_title" | "issue_body" | "issue_comment" | "discussion_title" | "discussion_body" | "discussion_comment" | "pull_request_title" | "pull_request_body" | "pull_request_comment" | "pull_request_review" | "pull_request_review_comment"; + details?: components["schemas"]["secret-scanning-location-commit"] | components["schemas"]["secret-scanning-location-wiki-commit"] | components["schemas"]["secret-scanning-location-issue-title"] | components["schemas"]["secret-scanning-location-issue-body"] | components["schemas"]["secret-scanning-location-issue-comment"] | components["schemas"]["secret-scanning-location-discussion-title"] | components["schemas"]["secret-scanning-location-discussion-body"] | components["schemas"]["secret-scanning-location-discussion-comment"] | components["schemas"]["secret-scanning-location-pull-request-title"] | components["schemas"]["secret-scanning-location-pull-request-body"] | components["schemas"]["secret-scanning-location-pull-request-comment"] | components["schemas"]["secret-scanning-location-pull-request-review"] | components["schemas"]["secret-scanning-location-pull-request-review-comment"]; }; "repository-advisory-create": { /** @description A short summary of the advisory. */ @@ -29801,6 +30652,11 @@ export interface components { severity?: "critical" | "high" | "medium" | "low"; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ cvss_vector_string?: string | null; + /** + * @description Whether to create a temporary private fork of the repository to collaborate on a fix. + * @default false + */ + start_private_fork: boolean; }; "private-vulnerability-report-create": { /** @description A short summary of the advisory. */ @@ -29831,6 +30687,11 @@ export interface components { severity?: "critical" | "high" | "medium" | "low"; /** @description The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. */ cvss_vector_string?: string | null; + /** + * @description Whether to create a temporary private fork of the repository to collaborate on a fix. + * @default false + */ + start_private_fork: boolean; }; "repository-advisory-update": { /** @description A short summary of the advisory. */ @@ -31311,7 +32172,7 @@ export interface components { /** @example 80 */ watchers_count: number; /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. * @example 108 */ size: number; @@ -31698,6 +32559,50 @@ export interface components { /** @example "2020-07-09T00:17:55Z" */ starred_at?: string; }; + /** + * branch protection rule + * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + */ + webhooks_rule: { + admin_enforced: boolean; + /** @enum {string} */ + allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; + authorized_actor_names: string[]; + authorized_actors_only: boolean; + authorized_dismissal_actors_only: boolean; + create_protected?: boolean; + /** Format: date-time */ + created_at: string; + dismiss_stale_reviews_on_push: boolean; + id: number; + ignore_approvals_from_contributors: boolean; + /** @enum {string} */ + linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + name: string; + /** @enum {string} */ + pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; + repository_id: number; + require_code_owner_review: boolean; + /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ + require_last_push_approval?: boolean; + required_approving_review_count: number; + /** @enum {string} */ + required_conversation_resolution_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; + required_status_checks: string[]; + /** @enum {string} */ + required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; + /** @enum {string} */ + signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; + strict_required_status_checks_policy: boolean; + /** Format: date-time */ + updated_at: string; + }; /** @description A suite of checks performed on the code of a given code change */ "simple-check-suite": { /** @example d6fde92930d4715a2b49857d24b940956b26d2d3 */ @@ -31799,15 +32704,68 @@ export interface components { /** @example https://api.github.com/repos/github/hello-world/check-runs/4 */ url: string; }; - /** - * Discussion - * @description A Discussion in a repository. - */ - discussion: { - active_lock_reason: string | null; - answer_chosen_at: string | null; + /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + webhooks_code_scanning_commit_oid: string; + /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + webhooks_code_scanning_ref: string; + /** @description The pusher type for the event. Can be either `user` or a deploy key. */ + webhooks_deploy_pusher_type: string; + /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ + webhooks_ref_0: string; + /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ + webhooks_deploy_key: { + added_by?: string | null; + created_at: string; + id: number; + key: string; + last_used?: string | null; + read_only: boolean; + title: string; + /** Format: uri */ + url: string; + verified: boolean; + }; + /** Workflow */ + webhooks_workflow: { + /** Format: uri */ + badge_url: string; + /** Format: date-time */ + created_at: string; + /** Format: uri */ + html_url: string; + id: number; + name: string; + node_id: string; + path: string; + state: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } | null; + webhooks_approver: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + webhooks_reviewers: { /** User */ - answer_chosen_by: { + reviewer?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -31843,7 +32801,57 @@ export interface components { /** Format: uri */ url?: string; } | null; - answer_html_url: string | null; + /** @enum {string} */ + type?: "User"; + }[]; + webhooks_workflow_job_run: { + conclusion: unknown; + created_at: string; + environment: string; + html_url: string; + id: number; + name: unknown; + status: string; + updated_at: string; + }; + /** User */ + webhooks_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; + 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; + webhooks_answer: { /** * AuthorAssociation * @description How the author is associated with the repository. @@ -31851,27 +32859,14 @@ export interface components { */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; body: string; - category: { - /** Format: date-time */ - created_at: string; - description: string; - emoji: string; - id: number; - is_answerable: boolean; - name: string; - node_id?: string; - repository_id: number; - slug: string; - updated_at: string; - }; - comments: number; + child_comment_count: number; /** Format: date-time */ created_at: string; + discussion_id: number; html_url: string; id: number; - locked: boolean; node_id: string; - number: number; + parent_id: unknown; /** Reactions */ reactions?: { "+1": number; @@ -31887,21 +32882,6 @@ export interface components { url: string; }; repository_url: string; - /** - * @description The current state of the discussion. - * `converting` means that the discussion is being converted from an issue. - * `transferring` means that the discussion is being transferred from another repository. - * @enum {string} - */ - state: "open" | "closed" | "locked" | "converting" | "transferring"; - /** - * @description The reason for the current state - * @example resolved - * @enum {string|null} - */ - state_reason: "resolved" | "outdated" | "duplicate" | "reopened"; - timeline_url?: string; - title: string; /** Format: date-time */ updated_at: string; /** User */ @@ -31943,11797 +32923,2518 @@ export interface components { } | null; }; /** - * Merge Group - * @description A group of pull requests that the merge queue has grouped together to be merged. - * - */ - "merge-group": { - /** @description The SHA of the merge group. */ - head_sha: string; - /** @description The full ref of the merge group. */ - head_ref: string; - /** @description The SHA of the merge group's parent commit. */ - base_sha: string; - /** @description The full ref of the branch the merge group will be merged into. */ - base_ref: string; - head_commit: components["schemas"]["simple-commit"]; - }; - /** - * Repository - * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - * when the event occurs from activity in a repository. + * Discussion + * @description A Discussion in a repository. */ - "nullable-repository-webhooks": { + discussion: { + active_lock_reason: string | null; + answer_chosen_at: string | null; + /** User */ + answer_chosen_by: { + /** 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; + answer_html_url: string | null; /** - * @description Unique identifier of the repository - * @example 42 + * 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"; + body: string; + category: { + /** Format: date-time */ + created_at: string; + description: string; + emoji: string; + id: number; + is_answerable: boolean; + name: string; + node_id?: string; + repository_id: number; + slug: string; + updated_at: string; + }; + comments: number; + /** Format: date-time */ + created_at: string; + html_url: string; id: number; - /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + locked: boolean; node_id: string; + number: 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; + }; + repository_url: string; /** - * @description The name of the repository. - * @example Team Environment + * @description The current state of the discussion. + * `converting` means that the discussion is being converted from an issue. + * `transferring` means that the discussion is being transferred from another repository. + * @enum {string} */ - name: string; - /** @example octocat/Hello-World */ - full_name: string; - license: components["schemas"]["nullable-license-simple"]; - organization?: components["schemas"]["nullable-simple-user"]; - forks: number; - permissions?: { - admin: boolean; - pull: boolean; - triage?: boolean; - push: boolean; - maintain?: boolean; - }; - owner: components["schemas"]["simple-user"]; + state: "open" | "closed" | "locked" | "converting" | "transferring"; /** - * @description Whether the repository is private or public. - * @default false + * @description The reason for the current state + * @example resolved + * @enum {string|null} */ - private: boolean; + state_reason: "resolved" | "outdated" | "duplicate" | "reopened"; + timeline_url?: string; + title: string; + /** Format: date-time */ + updated_at: 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; + 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; + }; + webhooks_comment: { /** - * Format: uri - * @example https://github.com/octocat/Hello-World + * 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"; + body: string; + child_comment_count: number; + created_at: string; + discussion_id: number; html_url: string; - /** @example This your first repo! */ + id: number; + node_id: string; + parent_id: number | null; + /** 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; + }; + repository_url: string; + updated_at: 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; + 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; + }; + /** Label */ + webhooks_label: { + /** @description 6-character hex code, without the leading #, identifying the color */ + color: string; + default: boolean; description: string | null; - fork: boolean; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; /** * Format: uri - * @example https://api.github.com/repos/octocat/Hello-World + * @description URL for the label */ url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ - archive_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ - assignees_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ - blobs_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ - branches_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ - collaborators_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ - comments_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ - commits_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ - compare_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ - contents_url: string; + }; + /** @description An array of repository objects that the installation can access. */ + webhooks_repositories: { + full_name: string; + /** @description Unique identifier of the repository */ + id: number; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** @description Whether the repository is private or public. */ + private: boolean; + }[]; + /** @description An array of repository objects, which were added to the installation. */ + webhooks_repositories_added: { + full_name: string; + /** @description Unique identifier of the repository */ + id: number; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** @description Whether the repository is private or public. */ + private: boolean; + }[]; + /** + * @description Describe whether all repositories have been selected or there's a selection involved + * @enum {string} + */ + webhooks_repository_selection: "all" | "selected"; + /** + * issue comment + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. + */ + webhooks_issue_comment: { /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/contributors + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} */ - contributors_url: string; + author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; + /** @description Contents of the issue comment */ + body: string; + /** Format: date-time */ + created_at: string; + /** Format: uri */ + html_url: string; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/deployments + * Format: int64 + * @description Unique identifier of the issue comment */ - deployments_url: string; + id: number; + /** Format: uri */ + issue_url: string; + node_id: string; + performed_via_github_app: components["schemas"]["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 - * @example http://api.github.com/repos/octocat/Hello-World/downloads + * @description URL for the issue comment */ - downloads_url: string; + 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; + 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; + } | null; + }; + /** @description The changes to the comment. */ + webhooks_changes: { + body?: { + /** @description The previous version of the body. */ + from: string; + }; + }; + /** + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + */ + webhooks_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; + } | 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; + } | null)[]; /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/events + * 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 - * @example http://api.github.com/repos/octocat/Hello-World/forks - */ - forks_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ - git_commits_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ - git_refs_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ - git_tags_url: string; - /** @example git:github.com/octocat/Hello-World.git */ - git_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ - issue_comment_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ - issue_events_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ - issues_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ - keys_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ + /** 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: uri - * @example http://api.github.com/repos/octocat/Hello-World/languages - */ - languages_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/merges + * Milestone + * @description A collection of related issues and pull requests. */ - merges_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ - milestones_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ - notifications_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ - pulls_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ - releases_url: string; - /** @example git@github.com:octocat/Hello-World.git */ - ssh_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/stargazers - */ - stargazers_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ - statuses_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/subscribers - */ - subscribers_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/subscription - */ - subscription_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/tags - */ - tags_url: string; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/teams - */ - teams_url: string; - /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ - trees_url: string; - /** @example https://github.com/octocat/Hello-World.git */ - clone_url: string; - /** - * Format: uri - * @example git:git.example.com/octocat/Hello-World - */ - mirror_url: string | null; - /** - * Format: uri - * @example http://api.github.com/repos/octocat/Hello-World/hooks - */ - hooks_url: string; - /** - * Format: uri - * @example https://svn.github.com/octocat/Hello-World - */ - svn_url: string; - /** - * Format: uri - * @example https://github.com - */ - homepage: string | null; - language: string | null; - /** @example 9 */ - forks_count: number; - /** @example 80 */ - stargazers_count: number; - /** @example 80 */ - watchers_count: number; - /** - * @description The size of the repository. Size is calculated hourly. When a repository is initially created, the size is 0. - * @example 108 - */ - size: number; - /** - * @description The default branch of the repository. - * @example master - */ - default_branch: string; - /** @example 0 */ - open_issues_count: number; - /** - * @description Whether this repository acts as a template that can be used to generate new repositories. - * @default false - * @example true - */ - is_template: boolean; - topics?: string[]; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; - /** - * @description Whether issues are enabled. - * @default true - * @example true - */ - has_issues: boolean; - /** - * @description Whether projects are enabled. - * @default true - * @example true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - * @example true - */ - has_wiki: boolean; - has_pages: boolean; - /** - * @description Whether downloads are enabled. - * @default true - * @example true - */ - has_downloads: boolean; - /** - * @description Whether discussions are enabled. - * @default false - * @example true - */ - has_discussions: boolean; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** @description Returns whether or not this repository disabled. */ - disabled: boolean; - /** - * @description The repository visibility: public, private, or internal. - * @default public - */ - visibility: string; - /** - * Format: date-time - * @example 2011-01-26T19:06:43Z - */ - pushed_at: string | null; - /** - * Format: date-time - * @example 2011-01-26T19:01:12Z - */ - created_at: string | null; - /** - * Format: date-time - * @example 2011-01-26T19:14:43Z - */ - updated_at: string | null; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - * @example true - */ - allow_rebase_merge: boolean; - template_repository?: { - id?: number; - node_id?: string; - name?: string; - full_name?: string; - owner?: { - login?: string; - id?: number; - node_id?: 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; - gravatar_id?: string; - url?: string; - html_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; - starred_url?: string; - subscriptions_url?: string; + gravatar_id?: string; + /** Format: uri */ + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; + /** Format: uri */ organizations_url?: string; - repos_url?: string; - events_url?: string; + /** Format: uri */ received_events_url?: string; - type?: string; + /** Format: uri */ + repos_url?: string; site_admin?: boolean; - }; - private?: boolean; - html_url?: string; - description?: string; - fork?: boolean; - url?: string; - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - downloads_url?: string; - events_url?: string; - forks_url?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - git_url?: string; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - notifications_url?: string; - pulls_url?: string; - releases_url?: string; - ssh_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - clone_url?: string; - mirror_url?: string; - hooks_url?: string; - svn_url?: string; - homepage?: string; - language?: string; - forks_count?: number; - stargazers_count?: number; - watchers_count?: number; - size?: number; - default_branch?: string; - open_issues_count?: number; - is_template?: boolean; - topics?: string[]; - has_issues?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - has_pages?: boolean; - has_downloads?: boolean; - archived?: boolean; - disabled?: boolean; - visibility?: string; - pushed_at?: string; - created_at?: string; - updated_at?: string; - permissions?: { - admin?: boolean; - maintain?: boolean; - push?: boolean; - triage?: boolean; - pull?: boolean; - }; - allow_rebase_merge?: boolean; - temp_clone_token?: string; - allow_squash_merge?: boolean; - allow_auto_merge?: boolean; - delete_branch_on_merge?: boolean; - allow_update_branch?: boolean; - use_squash_pr_title_as_default?: boolean; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri-template */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: 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 default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. + * @description The state of the milestone. * @enum {string} */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - allow_merge_commit?: boolean; - subscribers_count?: number; - network_count?: number; + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; } | null; - temp_clone_token?: string; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - * @example true - */ - allow_squash_merge: boolean; - /** - * @description Whether to allow Auto-merge to be used on pull requests. - * @default false - * @example false - */ - allow_auto_merge: boolean; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - * @example false - */ - delete_branch_on_merge: boolean; - /** - * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. - * @default false - * @example false - */ - allow_update_branch: boolean; - /** - * @deprecated - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; + node_id: string; + number: number; /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} + * 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. */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + 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; + } | 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; + }; + /** 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 The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + 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; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} + * Format: uri + * @description URL for the issue */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - * @example true - */ - allow_merge_commit: boolean; - /** @description Whether to allow forking this repo */ - allow_forking?: boolean; - /** - * @description Whether to require contributors to sign off on web-based commits - * @default false - */ - web_commit_signoff_required: boolean; - subscribers_count?: number; - network_count?: number; - open_issues: number; - watchers: number; - master_branch?: string; - /** @example "2020-07-09T00:17:42Z" */ - starred_at?: string; - /** @description Whether anonymous git access is enabled for this repository */ - anonymous_access_enabled?: boolean; - } | null; - /** - * Personal Access Token Request - * @description Details of a Personal Access Token Request. - */ - "personal-access-token-request": { - /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */ - id: number; - owner: components["schemas"]["simple-user"]; - /** @description New requested permissions, categorized by type of permission. */ - permissions_added: { - organization?: { - [key: string]: string | undefined; - }; - repository?: { - [key: string]: string | undefined; - }; - other?: { - [key: string]: string | undefined; - }; - }; - /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ - permissions_upgraded: { - organization?: { - [key: string]: string | undefined; - }; - repository?: { - [key: string]: string | undefined; - }; - other?: { - [key: string]: string | undefined; - }; - }; - /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ - permissions_result: { - organization?: { - [key: string]: string | undefined; - }; - repository?: { - [key: string]: string | undefined; - }; - other?: { - [key: string]: string | undefined; - }; - }; - /** - * @description Type of repository selection requested. - * @enum {string} - */ - repository_selection: "none" | "all" | "subset"; - /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ - repository_count: number | null; - /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ - repositories: { - full_name: string; - /** @description Unique identifier of the repository */ + 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; id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[] | null; - /** @description Date and time when the request for access was created. */ - created_at: string; - /** @description Whether the associated fine-grained personal access token has expired. */ - token_expired: boolean; - /** @description Date and time when the associated fine-grained personal access token expires. */ - token_expires_at: string | null; - /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ - token_last_used_at: string | null; + 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; + } | null; }; /** - * Projects v2 Project - * @description A projects v2 project + * Milestone + * @description A collection of related issues and pull requests. */ - "projects-v2": { - id: number; - node_id: string; - owner: components["schemas"]["simple-user"]; - creator: components["schemas"]["simple-user"]; - title: string; - description: string | null; - public: boolean; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ + webhooks_milestone: { + /** Format: date-time */ closed_at: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ + closed_issues: number; + /** Format: date-time */ created_at: string; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - updated_at: string; - number: number; - short_description: string | null; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - deleted_at: string | null; - deleted_by: components["schemas"]["nullable-simple-user"]; - }; - /** - * Projects v2 Item Content Type - * @description The type of content tracked in a project item - * @enum {string} - */ - "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; - /** - * Projects v2 Item - * @description An item belonging to a project - */ - "projects-v2-item": { + /** 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; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ + html_url: string; id: number; - node_id?: string; - project_node_id?: string; - content_node_id: string; - content_type: components["schemas"]["projects-v2-item-content-type"]; - creator?: components["schemas"]["simple-user"]; - /** - * Format: date-time - * @example 2022-04-28T12:00:00Z - */ - created_at: string; + /** Format: uri */ + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; /** - * Format: date-time - * @example 2022-04-28T12:00:00Z + * @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: date-time - * @example 2022-04-28T12:00:00Z - */ - archived_at: string | null; + /** Format: uri */ + url: string; }; /** - * @description The reason for resolving the alert. - * @enum {string|null} + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited"; - "secret-scanning-alert-webhook": { - number?: components["schemas"]["alert-number"]; - created_at?: components["schemas"]["alert-created-at"]; - updated_at?: components["schemas"]["nullable-alert-updated-at"]; - url?: components["schemas"]["alert-url"]; - html_url?: components["schemas"]["alert-html-url"]; - /** - * Format: uri - * @description The REST API URL of the code locations for this alert. - */ - locations_url?: string; - resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; - /** - * Format: date-time - * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - resolved_at?: string | null; - resolved_by?: components["schemas"]["nullable-simple-user"]; - /** @description An optional comment to resolve an alert. */ - resolution_comment?: string | null; - /** @description The type of secret that secret scanning detected. */ - secret_type?: string; - /** @description Whether push protection was bypassed for the detected secret. */ - push_protection_bypassed?: boolean | null; - push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; - /** - * Format: date-time - * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - push_protection_bypassed_at?: string | null; - }; - /** branch protection configuration disabled event */ - "webhook-branch-protection-configuration-disabled": { - /** @enum {string} */ - action: "disabled"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection configuration enabled event */ - "webhook-branch-protection-configuration-enabled": { - /** @enum {string} */ - action: "enabled"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection rule created event */ - "webhook-branch-protection-rule-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. - */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; + webhooks_issue_2: { + /** @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; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; - required_status_checks: string[]; + 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} */ - required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; + 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} */ - signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection rule deleted event */ - "webhook-branch-protection-rule-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null)[]; /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; - /** Format: date-time */ - created_at: string; - dismiss_stale_reviews_on_push: boolean; + 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; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; + /** @description The name of the label. */ name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - strict_required_status_checks_policy: boolean; - /** Format: date-time */ - updated_at: string; - }; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** branch protection rule edited event */ - "webhook-branch-protection-rule-edited": { - /** @enum {string} */ - action: "edited"; - /** @description If the action was `edited`, the changes to the rule. */ - changes?: { - admin_enforced?: { - from: boolean | null; - }; - authorized_actor_names?: { - from: string[]; - }; - authorized_actors_only?: { - from: boolean | null; - }; - authorized_dismissal_actors_only?: { - from: boolean | null; - }; - linear_history_requirement_enforcement_level?: { - /** @enum {string} */ - from: "off" | "non_admins" | "everyone"; - }; - required_status_checks?: { - from: string[]; - }; - required_status_checks_enforcement_level?: { - /** @enum {string} */ - from: "off" | "non_admins" | "everyone"; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; + node_id: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + /** Format: uri-template */ + labels_url: string; + locked?: boolean; /** - * branch protection rule - * @description The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. + * Milestone + * @description A collection of related issues and pull requests. */ - rule: { - admin_enforced: boolean; - /** @enum {string} */ - allow_deletions_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - allow_force_pushes_enforcement_level: "off" | "non_admins" | "everyone"; - authorized_actor_names: string[]; - authorized_actors_only: boolean; - authorized_dismissal_actors_only: boolean; - create_protected?: boolean; + milestone: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; /** Format: date-time */ created_at: string; - dismiss_stale_reviews_on_push: boolean; - id: number; - ignore_approvals_from_contributors: boolean; - /** @enum {string} */ - linear_history_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - merge_queue_enforcement_level: "off" | "non_admins" | "everyone"; - name: string; - /** @enum {string} */ - pull_request_reviews_enforcement_level: "off" | "non_admins" | "everyone"; - repository_id: number; - require_code_owner_review: boolean; - /** @description Whether the most recent push must be approved by someone other than the person who pushed it */ - require_last_push_approval?: boolean; - required_approving_review_count: number; - /** @enum {string} */ - required_conversation_resolution_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - required_deployments_enforcement_level: "off" | "non_admins" | "everyone"; - required_status_checks: string[]; - /** @enum {string} */ - required_status_checks_enforcement_level: "off" | "non_admins" | "everyone"; - /** @enum {string} */ - signature_requirement_enforcement_level: "off" | "non_admins" | "everyone"; - strict_required_status_checks_policy: boolean; + /** 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"; + /** Format: uri */ + url?: 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")[]; + /** 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; + } | 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"; + /** @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; }; - sender: components["schemas"]["simple-user-webhooks"]; + /** 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} + */ + 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; + 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; }; - /** Check Run Completed Event */ - "webhook-check-run-completed": { + /** User */ + webhooks_user_mannequin: { + /** 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} */ - action?: "completed"; - check_run: components["schemas"]["check-run-with-simple-check-suite"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** - * Check Run Completed Event - * @description The check_run.completed webhook encoded with URL encoding - */ - "webhook-check-run-completed-form-encoded": { - /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */ - payload: string; + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + } | null; + /** Marketplace Purchase */ + webhooks_marketplace_purchase: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: string | null; + next_billing_date: string | null; + on_free_trial: boolean; + plan: { + bullets: (string | null)[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; + /** @enum {string} */ + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; + }; + unit_count: number; }; - /** Check Run Created Event */ - "webhook-check-run-created": { - /** @enum {string} */ - action?: "created"; - check_run: components["schemas"]["check-run-with-simple-check-suite"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + /** Marketplace Purchase */ + webhooks_previous_marketplace_purchase: { + account: { + id: number; + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: unknown; + next_billing_date?: string | null; + on_free_trial: boolean; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; + /** @enum {string} */ + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; + }; + unit_count: number; }; /** - * Check Run Created Event - * @description The check_run.created webhook encoded with URL encoding + * Team + * @description Groups of organization members that gives permissions on specified repositories. */ - "webhook-check-run-created-form-encoded": { - /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */ - payload: string; - }; - /** Check Run Requested Action Event */ - "webhook-check-run-requested-action": { + webhooks_team: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** + * @description Whether team members will receive notifications when their team is @mentioned + * @enum {string} + */ + notification_setting: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; /** @enum {string} */ - action: "requested_action"; - check_run: components["schemas"]["check-run-with-simple-check-suite"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - /** @description The action requested by the user. */ - requested_action?: { - /** @description The integrator reference of the action requested by the user. */ - identifier?: string; - }; - sender: components["schemas"]["simple-user-webhooks"]; + privacy?: "open" | "closed" | "secret"; + /** @enum {string} */ + notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; }; /** - * Check Run Requested Action Event - * @description The check_run.requested_action webhook encoded with URL encoding + * Merge Group + * @description A group of pull requests that the merge queue has grouped together to be merged. + * */ - "webhook-check-run-requested-action-form-encoded": { - /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */ - payload: string; - }; - /** Check Run Re-Requested Event */ - "webhook-check-run-rerequested": { - /** @enum {string} */ - action?: "rerequested"; - check_run: components["schemas"]["check-run-with-simple-check-suite"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + "merge-group": { + /** @description The SHA of the merge group. */ + head_sha: string; + /** @description The full ref of the merge group. */ + head_ref: string; + /** @description The SHA of the merge group's parent commit. */ + base_sha: string; + /** @description The full ref of the branch the merge group will be merged into. */ + base_ref: string; + head_commit: components["schemas"]["simple-commit"]; }; /** - * Check Run Re-Requested Event - * @description The check_run.rerequested webhook encoded with URL encoding + * Repository + * @description The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property + * when the event occurs from activity in a repository. */ - "webhook-check-run-rerequested-form-encoded": { - /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */ - payload: string; - }; - /** check_suite completed event */ - "webhook-check-suite-completed": { - /** @enum {string} */ - action: "completed"; - /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - check_suite: { - after: string | null; - /** - * 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. - */ - 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" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; - /** 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; - } | 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; - }; - before: string | null; - /** Format: uri */ - check_runs_url: string; - /** - * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. - * @enum {string|null} - */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; - /** Format: date-time */ - created_at: string; - /** @description The head branch name the changes are on. */ - head_branch: string | null; - /** SimpleCommit */ - head_commit: { - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - author: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - committer: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - id: string; - message: string; - timestamp: string; - tree_id: string; - }; - /** @description The SHA of the head commit that is being checked. */ - head_sha: string; - id: number; - latest_check_runs_count: number; - node_id: string; - /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - id: number; - number: number; - /** Format: uri */ - url: string; - }[]; - rerequestable?: boolean; - runs_rerequestable?: boolean; - /** - * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - * @enum {string|null} - */ - status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL that points to the check suite API resource. - */ - url: string; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** check_suite requested event */ - "webhook-check-suite-requested": { - /** @enum {string} */ - action: "requested"; - /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - check_suite: { - after: string | null; - /** - * 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. - */ - 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" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; - /** 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; - } | 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; - }; - before: string | null; - /** Format: uri */ - check_runs_url: string; - /** - * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. - * @enum {string|null} - */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; - /** Format: date-time */ - created_at: string; - /** @description The head branch name the changes are on. */ - head_branch: string | null; - /** SimpleCommit */ - head_commit: { - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - author: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - committer: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - id: string; - message: string; - timestamp: string; - tree_id: string; - }; - /** @description The SHA of the head commit that is being checked. */ - head_sha: string; - id: number; - latest_check_runs_count: number; - node_id: string; - /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - id: number; - number: number; - /** Format: uri */ - url: string; - }[]; - rerequestable?: boolean; - runs_rerequestable?: boolean; - /** - * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - * @enum {string|null} - */ - status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL that points to the check suite API resource. - */ - url: string; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** check_suite rerequested event */ - "webhook-check-suite-rerequested": { - /** @enum {string} */ - action: "rerequested"; - /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ - check_suite: { - after: string | null; - /** - * 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. - */ - 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" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job")[]; - /** 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; - } | 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; - }; - before: string | null; - /** Format: uri */ - check_runs_url: string; - /** - * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. - * @enum {string|null} - */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - created_at: string; - /** @description The head branch name the changes are on. */ - head_branch: string | null; - /** SimpleCommit */ - head_commit: { - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - author: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - committer: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - id: string; - message: string; - timestamp: string; - tree_id: string; - }; - /** @description The SHA of the head commit that is being checked. */ - head_sha: string; - id: number; - latest_check_runs_count: number; - node_id: string; - /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - id: number; - number: number; - /** Format: uri */ - url: string; - }[]; - rerequestable?: boolean; - runs_rerequestable?: boolean; - /** - * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. - * @enum {string|null} - */ - status: "requested" | "in_progress" | "completed" | "queued" | null; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL that points to the check suite API resource. - */ - url: string; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert appeared_in_branch event */ - "webhook-code-scanning-alert-appeared-in-branch": { - /** @enum {string} */ - action: "appeared_in_branch"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - dismissed_at: string | null; - /** User */ - dismissed_by: { - /** 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; - /** - * @description The reason for dismissing or closing the alert. - * @enum {string|null} - */ - dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - html_url: string; - /** Alert Instance */ - most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - number: number; - rule: { - /** @description A short description of the rule used to detect the alert. */ - description: string; - /** @description A unique identifier for the rule used to detect the alert. */ - id: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity: "none" | "note" | "warning" | "error" | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - tool: { - /** @description The name of the tool used to generate the code scanning analysis alert. */ - name: string; - /** @description The version of the tool used to detect the alert. */ - version: string | null; - }; - /** Format: uri */ - url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - commit_oid: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - ref: string; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert closed_by_user event */ - "webhook-code-scanning-alert-closed-by-user": { - /** @enum {string} */ - action: "closed_by_user"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - dismissed_at: string; - /** User */ - dismissed_by: { - /** 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; - /** - * @description The reason for dismissing or closing the alert. - * @enum {string|null} - */ - dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - html_url: string; - /** Alert Instance */ - most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - number: number; - rule: { - /** @description A short description of the rule used to detect the alert. */ - description: string; - full_description?: string; - help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - id: string; - name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity: "none" | "note" | "warning" | "error" | null; - tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "dismissed" | "fixed"; - tool: { - guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - name: string; - /** @description The version of the tool used to detect the alert. */ - version: string | null; - }; - /** Format: uri */ - url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - commit_oid: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - ref: string; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert created event */ - "webhook-code-scanning-alert-created": { - /** @enum {string} */ - action: "created"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string | null; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - dismissed_at: unknown; - dismissed_by: unknown; - dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - dismissed_reason: unknown; - fixed_at?: unknown; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - html_url: string; - instances_url?: string; - /** Alert Instance */ - most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - number: number; - rule: { - /** @description A short description of the rule used to detect the alert. */ - description: string; - full_description?: string; - help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - id: string; - name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity: "none" | "note" | "warning" | "error" | null; - tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed"; - tool: { - guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - name: string; - /** @description The version of the tool used to detect the alert. */ - version: string | null; - } | null; - updated_at?: string | null; - /** Format: uri */ - url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - commit_oid: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - ref: string; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert fixed event */ - "webhook-code-scanning-alert-fixed": { - /** @enum {string} */ - action: "fixed"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string; - /** - * Format: date-time - * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - dismissed_at: string | null; - /** User */ - dismissed_by: { - /** 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; - /** - * @description The reason for dismissing or closing the alert. - * @enum {string|null} - */ - dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - html_url: string; - /** Format: uri */ - instances_url?: string; - /** Alert Instance */ - most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - number: number; - rule: { - /** @description A short description of the rule used to detect the alert. */ - description: string; - full_description?: string; - help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - id: string; - name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity: "none" | "note" | "warning" | "error" | null; - tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "fixed"; - tool: { - guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - name: string; - /** @description The version of the tool used to detect the alert. */ - version: string | null; - }; - /** Format: uri */ - url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - commit_oid: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - ref: string; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert reopened event */ - "webhook-code-scanning-alert-reopened": { - /** @enum {string} */ - action: "reopened"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - dismissed_at: string | null; - dismissed_by: Record; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - dismissed_reason: string | null; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - html_url: string; - /** Alert Instance */ - most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - number: number; - rule: { - /** @description A short description of the rule used to detect the alert. */ - description: string; - full_description?: string; - help?: string | null; - /** @description A link to the documentation for the rule used to detect the alert. */ - help_uri?: string | null; - /** @description A unique identifier for the rule used to detect the alert. */ - id: string; - name?: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity: "none" | "note" | "warning" | "error" | null; - tags?: string[] | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - tool: { - guid?: string | null; - /** @description The name of the tool used to generate the code scanning analysis alert. */ - name: string; - /** @description The version of the tool used to detect the alert. */ - version: string | null; - }; - /** Format: uri */ - url: string; - } | null; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - commit_oid: string | null; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - ref: string | null; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** code_scanning_alert reopened_by_user event */ - "webhook-code-scanning-alert-reopened-by-user": { - /** @enum {string} */ - action: "reopened_by_user"; - /** @description The code scanning alert involved in the event. */ - alert: { - /** - * Format: date-time - * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` - */ - created_at: string; - /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ - dismissed_at: unknown; - dismissed_by: unknown; - /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ - dismissed_reason: unknown; - /** - * Format: uri - * @description The GitHub URL of the alert resource. - */ - html_url: string; - /** Alert Instance */ - most_recent_instance?: { - /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ - analysis_key: string; - /** @description Identifies the configuration under which the analysis was executed. */ - category?: string; - classifications?: string[]; - commit_sha?: string; - /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ - environment: string; - location?: { - end_column?: number; - end_line?: number; - path?: string; - start_column?: number; - start_line?: number; - }; - message?: { - text?: string; - }; - /** @description The full Git reference, formatted as `refs/heads/`. */ - ref: string; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "dismissed" | "fixed"; - } | null; - /** @description The code scanning alert number. */ - number: number; - rule: { - /** @description A short description of the rule used to detect the alert. */ - description: string; - /** @description A unique identifier for the rule used to detect the alert. */ - id: string; - /** - * @description The severity of the alert. - * @enum {string|null} - */ - severity: "none" | "note" | "warning" | "error" | null; - }; - /** - * @description State of a code scanning alert. - * @enum {string} - */ - state: "open" | "fixed"; - tool: { - /** @description The name of the tool used to generate the code scanning analysis alert. */ - name: string; - /** @description The version of the tool used to detect the alert. */ - version: string | null; - }; - /** Format: uri */ - url: string; - }; - /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - commit_oid: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ - ref: string; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** commit_comment created event */ - "webhook-commit-comment-created": { - /** - * @description The action performed. Can be `created`. - * @enum {string} - */ - action: "created"; - /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ - comment: { - /** - * 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 The text of the comment. */ - body: string; - /** @description The SHA of the commit to which the comment applies. */ - commit_id: string; - created_at: string; - /** Format: uri */ - html_url: string; - /** @description The ID of the commit comment. */ - id: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - line: number | null; - /** @description The node ID of the commit comment. */ - node_id: string; - /** @description The relative path of the file to which the comment applies. */ - path: string | null; - /** @description The line index in the diff to which the comment applies. */ - position: number | null; - /** 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; - }; - updated_at: string; - /** Format: uri */ - 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; - 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; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** create event */ - "webhook-create": { - /** @description The repository's current description. */ - description: string | null; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The name of the repository's default branch (usually `main`). */ - master_branch: string; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The pusher type for the event. Can be either `user` or a deploy key. */ - pusher_type: string; - /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ - ref: string; - /** - * @description The type of Git ref object created in the repository. - * @enum {string} - */ - ref_type: "tag" | "branch"; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** custom property created event */ - "webhook-custom-property-created": { - /** @enum {string} */ - action: "created"; - definition: components["schemas"]["org-custom-property"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** custom property deleted event */ - "webhook-custom-property-deleted": { - /** @enum {string} */ - action: "deleted"; - definition: { - /** @description The name of the property that was deleted. */ - property_name: string; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** custom property updated event */ - "webhook-custom-property-updated": { - /** @enum {string} */ - action: "updated"; - definition: components["schemas"]["org-custom-property"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** Custom property values updated event */ - "webhook-custom-property-values-updated": { - /** @enum {string} */ - action: "updated"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - repository: components["schemas"]["repository-webhooks"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - /** @description The new custom property values for the repository. */ - new_property_values: components["schemas"]["custom-property-value"][]; - /** @description The old custom property values for the repository. */ - old_property_values: components["schemas"]["custom-property-value"][]; - }; - /** delete event */ - "webhook-delete": { - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The pusher type for the event. Can be either `user` or a deploy key. */ - pusher_type: string; - /** @description The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. */ - ref: string; - /** - * @description The type of Git ref object deleted in the repository. - * @enum {string} - */ - ref_type: "tag" | "branch"; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert auto-dismissed event */ - "webhook-dependabot-alert-auto-dismissed": { - /** @enum {string} */ - action: "auto_dismissed"; - alert: components["schemas"]["dependabot-alert"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert auto-reopened event */ - "webhook-dependabot-alert-auto-reopened": { - /** @enum {string} */ - action: "auto_reopened"; - alert: components["schemas"]["dependabot-alert"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert created event */ - "webhook-dependabot-alert-created": { - /** @enum {string} */ - action: "created"; - alert: components["schemas"]["dependabot-alert"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert dismissed event */ - "webhook-dependabot-alert-dismissed": { - /** @enum {string} */ - action: "dismissed"; - alert: components["schemas"]["dependabot-alert"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert fixed event */ - "webhook-dependabot-alert-fixed": { - /** @enum {string} */ - action: "fixed"; - alert: components["schemas"]["dependabot-alert"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert reintroduced event */ - "webhook-dependabot-alert-reintroduced": { - /** @enum {string} */ - action: "reintroduced"; - alert: components["schemas"]["dependabot-alert"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Dependabot alert reopened event */ - "webhook-dependabot-alert-reopened": { - /** @enum {string} */ - action: "reopened"; - alert: components["schemas"]["dependabot-alert"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** deploy_key created event */ - "webhook-deploy-key-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ - key: { - added_by?: string | null; - created_at: string; - id: number; - key: string; - last_used?: string | null; - read_only: boolean; - title: string; - /** Format: uri */ - url: string; - verified: boolean; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** deploy_key deleted event */ - "webhook-deploy-key-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. */ - key: { - added_by?: string | null; - created_at: string; - id: number; - key: string; - last_used?: string | null; - read_only: boolean; - title: string; - /** Format: uri */ - url: string; - verified: boolean; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** deployment created event */ - "webhook-deployment-created": { - /** @enum {string} */ - action: "created"; - /** - * Deployment - * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). - */ - deployment: { - 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"; - /** Format: uri */ - url?: string; - } | null; - description: string | null; - environment: string; - id: number; - node_id: string; - original_environment: string; - payload: Record | string; - /** - * 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" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; - /** 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; - } | 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"; - /** @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; - production_environment?: boolean; - ref: string; - /** Format: uri */ - repository_url: string; - sha: string; - /** Format: uri */ - statuses_url: string; - task: string; - transient_environment?: boolean; - updated_at: string; - /** Format: uri */ - url: string; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - workflow: { - /** Format: uri */ - badge_url: string; - /** Format: date-time */ - created_at: string; - /** Format: uri */ - html_url: string; - id: number; - name: string; - node_id: string; - path: string; - state: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - } | null; - /** Deployment Workflow Run */ - workflow_run: { - /** User */ - actor: { - /** 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; - artifacts_url?: string; - cancel_url?: string; - check_suite_id: number; - check_suite_node_id: string; - check_suite_url?: string; - /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - created_at: string; - display_title: string; - event: string; - head_branch: string; - head_commit?: unknown; - head_repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: unknown; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - head_sha: string; - /** Format: uri */ - html_url: string; - id: number; - jobs_url?: string; - logs_url?: string; - name: string; - node_id: string; - path: string; - previous_attempt_url?: unknown; - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - id: number; - number: number; - /** Format: uri */ - url: string; - }[]; - referenced_workflows?: { - path: string; - ref?: string; - sha: string; - }[] | null; - repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: unknown; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - rerun_url?: string; - run_attempt: number; - run_number: number; - /** Format: date-time */ - run_started_at: string; - /** @enum {string} */ - status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ - triggering_actor?: { - /** 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; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - workflow_id: number; - workflow_url?: string; - } | null; - }; - /** deployment protection rule requested event */ - "webhook-deployment-protection-rule-requested": { - /** @enum {string} */ - action?: "requested"; - /** @description The name of the environment that has the deployment protection rule. */ - environment?: string; - /** @description The event that triggered the deployment protection rule. */ - event?: string; - /** - * Format: uri - * @description The URL to review the deployment protection rule. - */ - deployment_callback_url?: string; - deployment?: components["schemas"]["deployment"]; - pull_requests?: components["schemas"]["pull-request"][]; - repository?: components["schemas"]["repository-webhooks"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - "webhook-deployment-review-approved": { - /** @enum {string} */ - action: "approved"; - approver?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - comment?: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - reviewers?: { - /** User */ - reviewer?: { - /** 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; - /** @enum {string} */ - type?: "User"; - }[]; - sender: components["schemas"]["simple-user-webhooks"]; - since: string; - workflow_job_run?: { - conclusion: unknown; - created_at: string; - environment: string; - html_url: string; - id: number; - name: unknown; - status: string; - updated_at: string; - }; - workflow_job_runs?: { - conclusion?: unknown; - created_at?: string; - environment?: string; - html_url?: string; - id?: number; - name?: string | null; - status?: string; - updated_at?: string; - }[]; - /** Deployment Workflow Run */ - workflow_run: { - /** User */ - actor: { - /** 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; - artifacts_url?: string; - cancel_url?: string; - check_suite_id: number; - check_suite_node_id: string; - check_suite_url?: string; - /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - created_at: string; - display_title: string; - event: string; - head_branch: string; - head_commit?: Record; - head_repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - head_sha: string; - /** Format: uri */ - html_url: string; - id: number; - jobs_url?: string; - logs_url?: string; - name: string; - node_id: string; - path: string; - previous_attempt_url?: string | null; - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - id: number; - number: number; - /** Format: uri */ - url: string; - }[]; - referenced_workflows?: { - path: string; - ref?: string; - sha: string; - }[] | null; - repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - rerun_url?: string; - run_attempt: number; - run_number: number; - /** Format: date-time */ - run_started_at: string; - /** @enum {string} */ - status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ - triggering_actor: { - /** 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; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - workflow_id: number; - workflow_url?: string; - } | null; - }; - "webhook-deployment-review-rejected": { - /** @enum {string} */ - action: "rejected"; - approver?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - comment?: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - reviewers?: { - /** User */ - reviewer?: { - /** 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; - /** @enum {string} */ - type?: "User"; - }[]; - sender: components["schemas"]["simple-user-webhooks"]; - since: string; - workflow_job_run?: { - conclusion: unknown; - created_at: string; - environment: string; - html_url: string; - id: number; - name: unknown; - status: string; - updated_at: string; - }; - workflow_job_runs?: { - conclusion?: string | null; - created_at?: string; - environment?: string; - html_url?: string; - id?: number; - name?: string | null; - status?: string; - updated_at?: string; - }[]; - /** Deployment Workflow Run */ - workflow_run: { - /** User */ - actor: { - /** 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; - artifacts_url?: string; - cancel_url?: string; - check_suite_id: number; - check_suite_node_id: string; - check_suite_url?: string; - /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - created_at: string; - event: string; - head_branch: string; - head_commit?: Record; - head_repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - head_sha: string; - /** Format: uri */ - html_url: string; - id: number; - jobs_url?: string; - logs_url?: string; - name: string; - node_id: string; - path: string; - previous_attempt_url?: string | null; - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - id: number; - number: number; - /** Format: uri */ - url: string; - }[]; - referenced_workflows?: { - path: string; - ref?: string; - sha: string; - }[] | null; - repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - rerun_url?: string; - run_attempt: number; - run_number: number; - /** Format: date-time */ - run_started_at: string; - /** @enum {string} */ - status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; - /** User */ - triggering_actor: { - /** 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; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - workflow_id: number; - workflow_url?: string; - display_title: string; - } | null; - }; - "webhook-deployment-review-requested": { - /** @enum {string} */ - action: "requested"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - environment: string; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - /** User */ - requestor: { - /** 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; - reviewers: { - /** User */ - reviewer?: { - /** 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; - /** @enum {string} */ - type?: "User" | "Team"; - }[]; - sender: components["schemas"]["simple-user-webhooks"]; - since: string; - workflow_job_run: { - conclusion: unknown; - created_at: string; - environment: string; - html_url: string; - id: number; - name: string | null; - status: string; - updated_at: string; - }; - /** Deployment Workflow Run */ - workflow_run: { - /** User */ - actor: { - /** 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; - artifacts_url?: string; - cancel_url?: string; - check_suite_id: number; - check_suite_node_id: string; - check_suite_url?: string; - /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; - /** Format: date-time */ - created_at: string; - event: string; - head_branch: string; - head_commit?: Record; - head_repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - head_sha: string; - /** Format: uri */ - html_url: string; - id: number; - jobs_url?: string; - logs_url?: string; - name: string; - node_id: string; - path: string; - previous_attempt_url?: string | null; - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - id: number; - number: number; - /** Format: uri */ - url: string; - }[]; - referenced_workflows?: { - path: string; - ref?: string; - sha: string; - }[] | null; - repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - rerun_url?: string; - run_attempt: number; - run_number: number; - /** Format: date-time */ - run_started_at: string; - /** @enum {string} */ - status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ - triggering_actor: { - /** 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; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - workflow_id: number; - workflow_url?: string; - display_title: string; - } | null; - }; - /** deployment_status created event */ - "webhook-deployment-status-created": { - /** @enum {string} */ - action: "created"; - check_run?: { - /** Format: date-time */ - completed_at: string | null; - /** - * @description The result of the completed check run. This value will be `null` until the check run has completed. - * @enum {string|null} - */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; - /** Format: uri */ - details_url: string; - external_id: string; - /** @description The SHA of the commit that is being checked. */ - head_sha: string; - /** Format: uri */ - html_url: string; - /** @description The id of the check. */ - id: number; - /** @description The name of the check run. */ - name: string; - node_id: string; - /** Format: date-time */ - started_at: string; - /** - * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. - * @enum {string} - */ - status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; - /** Format: uri */ - url: string; - } | null; - /** - * Deployment - * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). - */ - deployment: { - 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"; - /** Format: uri */ - url?: string; - } | null; - description: string | null; - environment: string; - id: number; - node_id: string; - original_environment: string; - payload: (string | Record) | null; - /** - * 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" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; - /** 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; - } | 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"; - /** @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; - production_environment?: boolean; - ref: string; - /** Format: uri */ - repository_url: string; - sha: string; - /** Format: uri */ - statuses_url: string; - task: string; - transient_environment?: boolean; - updated_at: string; - /** Format: uri */ - url: string; - }; - /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ - deployment_status: { - 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"; - /** Format: uri */ - url?: string; - } | null; - /** Format: uri */ - deployment_url: string; - /** @description The optional human-readable description added to the status. */ - description: string; - environment: string; - /** Format: uri */ - environment_url?: string; - id: number; - /** Format: uri */ - log_url?: string; - node_id: string; - /** - * 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" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; - /** 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; - } | 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"; - /** @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; - /** Format: uri */ - repository_url: string; - /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ - state: string; - /** @description The optional link added to the status. */ - target_url: string; - updated_at: string; - /** Format: uri */ - url: string; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - workflow?: { - /** Format: uri */ - badge_url: string; - /** Format: date-time */ - created_at: string; - /** Format: uri */ - html_url: string; - id: number; - name: string; - node_id: string; - path: string; - state: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - } | null; - /** Deployment Workflow Run */ - workflow_run?: { - /** User */ - actor: { - /** 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; - artifacts_url?: string; - cancel_url?: string; - check_suite_id: number; - check_suite_node_id: string; - check_suite_url?: string; - /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; - /** Format: date-time */ - created_at: string; - display_title: string; - event: string; - head_branch: string; - head_commit?: unknown; - head_repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: unknown; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - head_sha: string; - /** Format: uri */ - html_url: string; - id: number; - jobs_url?: string; - logs_url?: string; - name: string; - node_id: string; - path: string; - previous_attempt_url?: unknown; - pull_requests: { - base: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - head: { - ref: string; - /** Repo Ref */ - repo: { - id: number; - name: string; - /** Format: uri */ - url: string; - }; - sha: string; - }; - id: number; - number: number; - /** Format: uri */ - url: string; - }[]; - referenced_workflows?: { - path: string; - ref?: string; - sha: string; - }[] | null; - repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: unknown; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - rerun_url?: string; - run_attempt: number; - run_number: number; - /** Format: date-time */ - run_started_at: string; - /** @enum {string} */ - status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; - /** User */ - triggering_actor: { - /** 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; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - workflow_id: number; - workflow_url?: string; - } | null; - }; - /** discussion answered event */ - "webhook-discussion-answered": { - /** @enum {string} */ - action: "answered"; - answer: { - /** - * 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"; - body: string; - child_comment_count: number; - /** Format: date-time */ - created_at: string; - discussion_id: number; - html_url: string; - id: number; - node_id: string; - parent_id: unknown; - /** 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; - }; - repository_url: string; - /** Format: date-time */ - updated_at: 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; - 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; - }; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion category changed event */ - "webhook-discussion-category-changed": { - /** @enum {string} */ - action: "category_changed"; - changes: { - category: { - from: { - /** Format: date-time */ - created_at: string; - description: string; - emoji: string; - id: number; - is_answerable: boolean; - name: string; - node_id?: string; - repository_id: number; - slug: string; - updated_at: string; - }; - }; - }; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion closed event */ - "webhook-discussion-closed": { - /** @enum {string} */ - action: "closed"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion_comment created event */ - "webhook-discussion-comment-created": { - /** @enum {string} */ - action: "created"; - comment: { - /** - * 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"; - body: string; - child_comment_count: number; - created_at: string; - discussion_id: number; - html_url: string; - id: number; - node_id: string; - parent_id: number | null; - /** 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; - }; - repository_url: string; - updated_at: 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; - 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; - }; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion_comment deleted event */ - "webhook-discussion-comment-deleted": { - /** @enum {string} */ - action: "deleted"; - comment: { - /** - * 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"; - body: string; - child_comment_count: number; - created_at: string; - discussion_id: number; - html_url: string; - id: number; - node_id: string; - parent_id: number | null; - /** 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; - }; - repository_url: string; - updated_at: 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; - 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; - }; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion_comment edited event */ - "webhook-discussion-comment-edited": { - /** @enum {string} */ - action: "edited"; - changes: { - body: { - from: string; - }; - }; - comment: { - /** - * 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"; - body: string; - child_comment_count: number; - created_at: string; - discussion_id: number; - html_url: string; - id: number; - node_id: string; - parent_id: number | null; - /** 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; - }; - repository_url: string; - updated_at: 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; - 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; - }; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion created event */ - "webhook-discussion-created": { - /** @enum {string} */ - action: "created"; - discussion: { - active_lock_reason: string | null; - answer_chosen_at: string | null; - /** User */ - answer_chosen_by: { - /** 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; - answer_html_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"; - body: string | null; - category: { - /** Format: date-time */ - created_at: string; - description: string; - emoji: string; - id: number; - is_answerable: boolean; - name: string; - node_id?: string; - repository_id: number; - slug: string; - updated_at: string; - }; - comments: number; - /** Format: date-time */ - created_at: string; - html_url: string; - id: number; - locked: boolean; - node_id: string; - number: 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; - }; - repository_url: string; - /** @enum {string} */ - state: "open" | "locked" | "converting" | "transferring"; - timeline_url?: string; - title: string; - /** Format: date-time */ - updated_at: 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; - 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; - } & { - active_lock_reason?: unknown; - answer_chosen_at: unknown; - answer_chosen_by: unknown; - answer_html_url: string | null; - author_association?: string; - body?: string | null; - category?: { - created_at?: string; - description?: string; - emoji?: string; - id?: number; - is_answerable?: boolean; - name?: string; - node_id?: string; - repository_id?: number; - slug?: string; - updated_at?: string; - }; - comments?: number; - created_at?: string; - html_url?: string; - id?: number; - /** @enum {boolean} */ - locked: false; - node_id?: string; - number?: number; - 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: "open" | "converting" | "transferring"; - timeline_url?: string; - title?: string; - updated_at?: string; - user?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion deleted event */ - "webhook-discussion-deleted": { - /** @enum {string} */ - action: "deleted"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion edited event */ - "webhook-discussion-edited": { - /** @enum {string} */ - action: "edited"; - changes?: { - body?: { - from: string; - }; - title?: { - from: string; - }; - }; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion labeled event */ - "webhook-discussion-labeled": { - /** @enum {string} */ - action: "labeled"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** Label */ - label: { - /** @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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion locked event */ - "webhook-discussion-locked": { - /** @enum {string} */ - action: "locked"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion pinned event */ - "webhook-discussion-pinned": { - /** @enum {string} */ - action: "pinned"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion reopened event */ - "webhook-discussion-reopened": { - /** @enum {string} */ - action: "reopened"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion transferred event */ - "webhook-discussion-transferred": { - /** @enum {string} */ - action: "transferred"; - changes: { - new_discussion: components["schemas"]["discussion"]; - new_repository: components["schemas"]["repository-webhooks"]; - }; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unanswered event */ - "webhook-discussion-unanswered": { - /** @enum {string} */ - action: "unanswered"; - discussion: components["schemas"]["discussion"]; - old_answer: { - /** - * 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"; - body: string; - child_comment_count: number; - /** Format: date-time */ - created_at: string; - discussion_id: number; - html_url: string; - id: number; - node_id: string; - parent_id: unknown; - /** 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; - }; - repository_url: string; - /** Format: date-time */ - updated_at: 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; - 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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unlabeled event */ - "webhook-discussion-unlabeled": { - /** @enum {string} */ - action: "unlabeled"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** Label */ - label: { - /** @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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unlocked event */ - "webhook-discussion-unlocked": { - /** @enum {string} */ - action: "unlocked"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** discussion unpinned event */ - "webhook-discussion-unpinned": { - /** @enum {string} */ - action: "unpinned"; - discussion: components["schemas"]["discussion"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** - * fork event - * @description A user forks a repository. - */ - "webhook-fork": { - enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */ - forkee: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: (number | string) | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - } & { - allow_forking?: boolean; - archive_url?: string; - archived?: boolean; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - clone_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - created_at?: string; - default_branch?: string; - deployments_url?: string; - description?: string | null; - disabled?: boolean; - downloads_url?: string; - events_url?: string; - /** @enum {boolean} */ - fork?: true; - forks?: number; - forks_count?: number; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - git_url?: string; - has_downloads?: boolean; - has_issues?: boolean; - has_pages?: boolean; - has_projects?: boolean; - has_wiki?: boolean; - homepage?: string | null; - hooks_url?: string; - html_url?: string; - id?: number; - is_template?: boolean; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - language?: unknown; - languages_url?: string; - license?: Record; - merges_url?: string; - milestones_url?: string; - mirror_url?: unknown; - name?: string; - node_id?: string; - notifications_url?: string; - open_issues?: number; - open_issues_count?: number; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - public?: boolean; - pulls_url?: string; - pushed_at?: string; - releases_url?: string; - size?: number; - ssh_url?: string; - stargazers_count?: number; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - svn_url?: string; - tags_url?: string; - teams_url?: string; - topics?: unknown[]; - trees_url?: string; - updated_at?: string; - url?: string; - visibility?: string; - watchers?: number; - watchers_count?: number; - }; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** github_app_authorization revoked event */ - "webhook-github-app-authorization-revoked": { - /** @enum {string} */ - action: "revoked"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** gollum event */ - "webhook-gollum": { - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description The pages that were updated. */ - pages: { - /** - * @description The action that was performed on the page. Can be `created` or `edited`. - * @enum {string} - */ - action: "created" | "edited"; - /** - * Format: uri - * @description Points to the HTML wiki page. - */ - html_url: string; - /** @description The name of the page. */ - page_name: string; - /** @description The latest commit SHA of the page. */ - sha: string; - summary: string | null; - /** @description The current page title. */ - title: string; - }[]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation created event */ - "webhook-installation-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - repositories?: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - repository?: components["schemas"]["repository-webhooks"]; - /** User */ - requester?: { - /** 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; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation deleted event */ - "webhook-installation-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - repositories?: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - repository?: components["schemas"]["repository-webhooks"]; - requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation new_permissions_accepted event */ - "webhook-installation-new-permissions-accepted": { - /** @enum {string} */ - action: "new_permissions_accepted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - repositories?: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - repository?: components["schemas"]["repository-webhooks"]; - requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation_repositories added event */ - "webhook-installation-repositories-added": { - /** @enum {string} */ - action: "added"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects, which were added to the installation. */ - repositories_added: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - /** @description An array of repository objects, which were removed from the installation. */ - repositories_removed: { - full_name?: string; - /** @description Unique identifier of the repository */ - id?: number; - /** @description The name of the repository. */ - name?: string; - node_id?: string; - /** @description Whether the repository is private or public. */ - private?: boolean; - }[]; - repository?: components["schemas"]["repository-webhooks"]; - /** - * @description Describe whether all repositories have been selected or there's a selection involved - * @enum {string} - */ - repository_selection: "all" | "selected"; - /** User */ - requester: { - /** 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; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation_repositories removed event */ - "webhook-installation-repositories-removed": { - /** @enum {string} */ - action: "removed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects, which were added to the installation. */ - repositories_added: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - /** @description An array of repository objects, which were removed from the installation. */ - repositories_removed: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - repository?: components["schemas"]["repository-webhooks"]; - /** - * @description Describe whether all repositories have been selected or there's a selection involved - * @enum {string} - */ - repository_selection: "all" | "selected"; - /** User */ - requester: { - /** 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; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** installation suspend event */ - "webhook-installation-suspend": { - /** @enum {string} */ - action: "suspend"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - repositories?: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - repository?: components["schemas"]["repository-webhooks"]; - requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; - }; - "webhook-installation-target-renamed": { - account: { - archived_at?: string | null; - avatar_url: string; - created_at?: string; - description?: unknown; - events_url?: string; - followers?: number; - followers_url?: string; - following?: number; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - has_organization_projects?: boolean; - has_repository_projects?: boolean; - hooks_url?: string; - html_url: string; - id: number; - is_verified?: boolean; - issues_url?: string; - login?: string; - members_url?: string; - name?: string; - node_id: string; - organizations_url?: string; - public_gists?: number; - public_members_url?: string; - public_repos?: number; - received_events_url?: string; - repos_url?: string; - site_admin?: boolean; - slug?: string; - starred_url?: string; - subscriptions_url?: string; - type?: string; - updated_at?: string; - url?: string; - website_url?: unknown; - }; - /** @enum {string} */ - action: "renamed"; - changes: { - login?: { - from: string; - }; - slug?: { - from: string; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - target_type: string; - }; - /** installation unsuspend event */ - "webhook-installation-unsuspend": { - /** @enum {string} */ - action: "unsuspend"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description An array of repository objects that the installation can access. */ - repositories?: { - full_name: string; - /** @description Unique identifier of the repository */ - id: number; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** @description Whether the repository is private or public. */ - private: boolean; - }[]; - repository?: components["schemas"]["repository-webhooks"]; - requester?: unknown; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issue_comment created event */ - "webhook-issue-comment-created": { - /** @enum {string} */ - action: "created"; - /** - * issue comment - * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. - */ - comment: { - /** - * 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 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; - 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; - }; - 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; - } | 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; - } | 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; - /** - * 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; - } | 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" | "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; - } | 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; - "-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} - */ - 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; - 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; - } | 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; - } | 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; - 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-webhooks"]; - }; - /** issue_comment deleted event */ - "webhook-issue-comment-deleted": { - /** @enum {string} */ - action: "deleted"; - /** - * issue comment - * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. - */ - comment: { - /** - * 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 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; - 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; - } | 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; - } | 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; - } | 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; - /** - * 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; - } | 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")[]; - /** 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; - } | 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"; - /** @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; - }; - /** 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} - */ - 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; - 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; - } | 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; - } | 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; - 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-webhooks"]; - }; - /** issue_comment edited event */ - "webhook-issue-comment-edited": { - /** @enum {string} */ - action: "edited"; - /** @description The changes to the comment. */ - changes: { - body?: { - /** @description The previous version of the body. */ - from: string; - }; - }; - /** - * issue comment - * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. - */ - comment: { - /** - * 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 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; - 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; - } | 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; - } | 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; - } | 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; - /** - * 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; - } | 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" | "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; - } | 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; - }; - /** 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} - */ - 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; - 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; - } | 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; - } | 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; - 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-webhooks"]; - }; - /** issues assigned event */ - "webhook-issues-assigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "assigned"; - /** 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; - 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" | "Mannequin"; - /** 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" | "Mannequin"; - /** 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; - }[]; - /** 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; - } | 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" | "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; - } | 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; - }; - /** 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} - */ - 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; - 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; - } | null; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** 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; - /** 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; - } | 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; - } | 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; - /** - * 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; - } | 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" | "security_and_analysis" | "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; - } | 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; - }; - /** 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} - */ - 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; - 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; - } | 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; - 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-webhooks"]; - }; - /** issues deleted event */ - "webhook-issues-deleted": { - /** @enum {string} */ - action: "deleted"; - 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; - }[]; - /** 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"; - /** Format: uri */ - url?: 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; - } | 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"; - /** @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; - }; - /** 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} - */ - 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; - 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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues demilestoned event */ - "webhook-issues-demilestoned": { - /** @enum {string} */ - action: "demilestoned"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - 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; - } | 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; - } | 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; - /** - * 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; - } | 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")[]; - /** 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; - } | 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; - }; - /** 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} - */ - 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; - 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; - } | 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 - * @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; - } | 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; - 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; - state?: string; - 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; - 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; - }; - }; - /** - * 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; - } | 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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues edited event */ - "webhook-issues-edited": { - /** @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; - }; - }; - 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" | "Mannequin"; - /** 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" | "Mannequin"; - /** 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; - }[]; - /** 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; - } | 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" | "security_and_analysis" | "pull_request_review_thread" | "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; - } | 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; - }; - /** 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} - */ - 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; - 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; - } | null; + "nullable-repository-webhooks": { + /** + * @description Unique identifier of the repository + * @example 42 + */ + id: number; + /** @example MDEwOlJlcG9zaXRvcnkxMjk2MjY5 */ + node_id: string; + /** + * @description The name of the repository. + * @example Team Environment + */ + name: string; + /** @example octocat/Hello-World */ + full_name: string; + license: components["schemas"]["nullable-license-simple"]; + organization?: components["schemas"]["nullable-simple-user"]; + forks: number; + permissions?: { + admin: boolean; + pull: boolean; + triage?: boolean; + push: boolean; + maintain?: boolean; }; - /** Label */ - label?: { - /** @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; + owner: components["schemas"]["simple-user"]; + /** + * @description Whether the repository is private or public. + * @default false + */ + private: boolean; + /** + * Format: uri + * @example https://github.com/octocat/Hello-World + */ + html_url: string; + /** @example This your first repo! */ + description: string | null; + fork: boolean; + /** + * Format: uri + * @example https://api.github.com/repos/octocat/Hello-World + */ + url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} */ + archive_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/assignees{/user} */ + assignees_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} */ + blobs_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/branches{/branch} */ + branches_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} */ + collaborators_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/comments{/number} */ + comments_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/commits{/sha} */ + commits_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} */ + compare_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/contents/{+path} */ + contents_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/contributors + */ + contributors_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/deployments + */ + deployments_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/downloads + */ + downloads_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/events + */ + events_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/forks + */ + forks_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} */ + git_commits_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} */ + git_refs_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} */ + git_tags_url: string; + /** @example git:github.com/octocat/Hello-World.git */ + git_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} */ + issue_comment_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues/events{/number} */ + issue_events_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/issues{/number} */ + issues_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/keys{/key_id} */ + keys_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/labels{/name} */ + labels_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/languages + */ + languages_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/merges + */ + merges_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/milestones{/number} */ + milestones_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} */ + notifications_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/pulls{/number} */ + pulls_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/releases{/id} */ + releases_url: string; + /** @example git@github.com:octocat/Hello-World.git */ + ssh_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/stargazers + */ + stargazers_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/statuses/{sha} */ + statuses_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/subscribers + */ + subscribers_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/subscription + */ + subscription_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/tags + */ + tags_url: string; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/teams + */ + teams_url: string; + /** @example http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} */ + trees_url: string; + /** @example https://github.com/octocat/Hello-World.git */ + clone_url: string; + /** + * Format: uri + * @example git:git.example.com/octocat/Hello-World + */ + mirror_url: string | null; + /** + * Format: uri + * @example http://api.github.com/repos/octocat/Hello-World/hooks + */ + hooks_url: string; + /** + * Format: uri + * @example https://svn.github.com/octocat/Hello-World + */ + svn_url: string; + /** + * Format: uri + * @example https://github.com + */ + homepage: string | null; + language: string | null; + /** @example 9 */ + forks_count: number; + /** @example 80 */ + stargazers_count: number; + /** @example 80 */ + watchers_count: number; + /** + * @description The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. + * @example 108 + */ + size: number; + /** + * @description The default branch of the repository. + * @example master + */ + default_branch: string; + /** @example 0 */ + open_issues_count: number; + /** + * @description Whether this repository acts as a template that can be used to generate new repositories. + * @default false + * @example true + */ + is_template: boolean; + topics?: string[]; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues labeled event */ - "webhook-issues-labeled": { - /** @enum {string} */ - action: "labeled"; - 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. + * @description Whether issues are enabled. + * @default true + * @example true */ - issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - /** User */ - assignee?: { - /** Format: uri */ + has_issues: boolean; + /** + * @description Whether projects are enabled. + * @default true + * @example true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + * @example true + */ + has_wiki: boolean; + has_pages: boolean; + /** + * @description Whether downloads are enabled. + * @default true + * @example true + */ + has_downloads: boolean; + /** + * @description Whether discussions are enabled. + * @default false + * @example true + */ + has_discussions: boolean; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** @description Returns whether or not this repository disabled. */ + disabled: boolean; + /** + * @description The repository visibility: public, private, or internal. + * @default public + */ + visibility: string; + /** + * Format: date-time + * @example 2011-01-26T19:06:43Z + */ + pushed_at: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:01:12Z + */ + created_at: string | null; + /** + * Format: date-time + * @example 2011-01-26T19:14:43Z + */ + updated_at: string | null; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + * @example true + */ + allow_rebase_merge: boolean; + template_repository?: { + id?: number; + node_id?: string; + name?: string; + full_name?: string; + owner?: { + login?: string; + id?: number; + node_id?: string; 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; - } | null; - assignees: ({ - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; - /** Format: uri */ + html_url?: string; 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 */ + starred_url?: string; + subscriptions_url?: string; organizations_url?: string; - /** Format: uri */ - received_events_url?: string; - /** Format: uri */ repos_url?: string; + events_url?: string; + received_events_url?: string; + type?: 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; - } | null)[]; + }; + private?: boolean; + html_url?: string; + description?: string; + fork?: boolean; + url?: string; + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + downloads_url?: string; + events_url?: string; + forks_url?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + notifications_url?: string; + pulls_url?: string; + releases_url?: string; + ssh_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + clone_url?: string; + mirror_url?: string; + hooks_url?: string; + svn_url?: string; + homepage?: string; + language?: string; + forks_count?: number; + stargazers_count?: number; + watchers_count?: number; + size?: number; + default_branch?: string; + open_issues_count?: number; + is_template?: boolean; + topics?: string[]; + has_issues?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + has_pages?: boolean; + has_downloads?: boolean; + archived?: boolean; + disabled?: boolean; + visibility?: string; + pushed_at?: string; + created_at?: string; + updated_at?: string; + permissions?: { + admin?: boolean; + maintain?: boolean; + push?: boolean; + triage?: boolean; + pull?: boolean; + }; + allow_rebase_merge?: boolean; + temp_clone_token?: string; + allow_squash_merge?: boolean; + allow_auto_merge?: boolean; + delete_branch_on_merge?: boolean; + allow_update_branch?: boolean; + use_squash_pr_title_as_default?: boolean; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** - * AuthorAssociation - * @description How the author is associated with the repository. + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @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; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + allow_merge_commit?: boolean; + subscribers_count?: number; + network_count?: number; + } | null; + temp_clone_token?: string; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + * @example true + */ + allow_squash_merge: boolean; + /** + * @description Whether to allow Auto-merge to be used on pull requests. + * @default false + * @example false + */ + allow_auto_merge: boolean; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + * @example false + */ + delete_branch_on_merge: boolean; + /** + * @description Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. + * @default false + * @example false + */ + allow_update_branch: boolean; + /** + * @deprecated + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + * @example true + */ + allow_merge_commit: boolean; + /** @description Whether to allow forking this repo */ + allow_forking?: boolean; + /** + * @description Whether to require contributors to sign off on web-based commits + * @default false + */ + web_commit_signoff_required: boolean; + subscribers_count?: number; + network_count?: number; + open_issues: number; + watchers: number; + master_branch?: string; + /** @example "2020-07-09T00:17:42Z" */ + starred_at?: string; + /** @description Whether anonymous git access is enabled for this repository */ + anonymous_access_enabled?: boolean; + } | null; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + webhooks_milestone_3: { + /** Format: date-time */ + closed_at: string | null; + closed_issues: number; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { /** Format: uri */ - comments_url: string; - /** Format: date-time */ - created_at: string; - draft?: boolean; + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; /** Format: uri */ - events_url: string; + 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 */ + 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; - }[]; + 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 */ - 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; - } | 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" | "pull_request_review_thread" | "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; - } | 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; - }; - /** 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; - }; + starred_url?: string; /** Format: uri */ - repository_url: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - state?: "open" | "closed"; - state_reason?: string | null; + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; /** 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; - 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; - } | null; + url?: 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; + }; + /** + * Membership + * @description The membership between the user and the organization. Not present when the action is `member_invited`. + */ + webhooks_membership: { + /** Format: uri */ + organization_url: string; + role: string; + state: string; + /** Format: uri */ + 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; + 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; + }; + /** + * Personal Access Token Request + * @description Details of a Personal Access Token Request. + */ + "personal-access-token-request": { + /** @description Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls. */ + id: number; + owner: components["schemas"]["simple-user"]; + /** @description New requested permissions, categorized by type of permission. */ + permissions_added: { + organization?: { + [key: string]: string | undefined; + }; + repository?: { + [key: string]: string | undefined; + }; + other?: { + [key: string]: string | undefined; + }; }; - /** Label */ - label?: { - /** @description 6-character hex code, without the leading #, identifying the color */ - color: string; - default: boolean; - description: string | null; + /** @description Requested permissions that elevate access for a previously approved request for access, categorized by type of permission. */ + permissions_upgraded: { + organization?: { + [key: string]: string | undefined; + }; + repository?: { + [key: string]: string | undefined; + }; + other?: { + [key: string]: string | undefined; + }; + }; + /** @description Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`. */ + permissions_result: { + organization?: { + [key: string]: string | undefined; + }; + repository?: { + [key: string]: string | undefined; + }; + other?: { + [key: string]: string | undefined; + }; + }; + /** + * @description Type of repository selection requested. + * @enum {string} + */ + repository_selection: "none" | "all" | "subset"; + /** @description The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + repository_count: number | null; + /** @description An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`. */ + repositories: { + full_name: string; + /** @description Unique identifier of the repository */ id: number; - /** @description The name of the label. */ + /** @description The name of the repository. */ name: string; node_id: string; - /** - * Format: uri - * @description URL for the label - */ - url: string; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + /** @description Whether the repository is private or public. */ + private: boolean; + }[] | null; + /** @description Date and time when the request for access was created. */ + created_at: string; + /** @description Whether the associated fine-grained personal access token has expired. */ + token_expired: boolean; + /** @description Date and time when the associated fine-grained personal access token expires. */ + token_expires_at: string | null; + /** @description Date and time when the associated fine-grained personal access token was last used for authentication. */ + token_last_used_at: string | null; }; - /** issues locked event */ - "webhook-issues-locked": { - /** @enum {string} */ - action: "locked"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - 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; + /** Project Card */ + webhooks_project_card: { + after_id?: number | null; + /** @description Whether or not the card is archived */ + archived: boolean; + column_id: number; + /** Format: uri */ + column_url: string; + /** Format: uri */ + content_url?: string; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { /** Format: uri */ - comments_url: string; - /** Format: date-time */ - created_at: string; - draft?: boolean; + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; /** Format: uri */ - events_url: string; + 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 */ + 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; - }[]; + 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 */ - 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"; - /** Format: uri */ - url?: 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" | "security_and_analysis")[]; - /** 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; - } | 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"; - /** @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; - }; - /** 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; - }; + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + /** @description The project card's ID */ + id: number; + node_id: string; + note: string | null; + /** Format: uri */ + project_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + }; + /** Project */ + webhooks_project: { + /** @description Body of the project */ + body: string | null; + /** Format: uri */ + columns_url: string; + /** 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 */ - repository_url: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - state?: "open" | "closed"; - state_reason?: string | null; + organizations_url?: string; /** Format: uri */ - timeline_url?: string; - /** @description Title of the issue */ - title: string; + 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; + /** Format: uri */ + html_url: string; + id: number; + /** @description Name of the project */ + name: string; + node_id: string; + number: number; + /** Format: uri */ + owner_url: string; + /** + * @description State of the project; either 'open' or 'closed' + * @enum {string} + */ + state: "open" | "closed"; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + }; + /** Project Column */ + webhooks_project_column: { + after_id?: number | null; + /** Format: uri */ + cards_url: string; + /** Format: date-time */ + created_at: string; + /** @description The unique identifier of the project column */ + id: number; + /** @description Name of the project column */ + name: string; + node_id: string; + /** Format: uri */ + project_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + }; + /** + * Projects v2 Project + * @description A projects v2 project + */ + "projects-v2": { + id: number; + node_id: string; + owner: components["schemas"]["simple-user"]; + creator: components["schemas"]["simple-user"]; + title: string; + description: string | null; + public: boolean; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + closed_at: string | null; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + number: number; + short_description: string | null; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + deleted_at: string | null; + deleted_by: components["schemas"]["nullable-simple-user"]; + }; + webhooks_project_changes: { + archived_at?: { /** 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; + from?: string | null; + /** Format: date-time */ + to?: string | null; + }; + }; + /** + * Projects v2 Item Content Type + * @description The type of content tracked in a project item + * @enum {string} + */ + "projects-v2-item-content-type": "Issue" | "PullRequest" | "DraftIssue"; + /** + * Projects v2 Item + * @description An item belonging to a project + */ + "projects-v2-item": { + id: number; + node_id?: string; + project_node_id?: string; + content_node_id: string; + content_type: components["schemas"]["projects-v2-item-content-type"]; + creator?: components["schemas"]["simple-user"]; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + created_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + updated_at: string; + /** + * Format: date-time + * @example 2022-04-28T12:00:00Z + */ + archived_at: string | null; + }; + /** @description The pull request number. */ + webhooks_number: number; + "pull-request-webhook": components["schemas"]["pull-request"] & { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow updating the pull request's branch. */ + allow_update_branch?: boolean; + /** + * @description Whether to delete head branches when pull requests are merged. + * @default false + */ + delete_branch_on_merge: boolean; + /** + * @description The default value for a merge commit message. + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** + * @description The default value for a squash merge commit message: + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** + * @default false + */ + use_squash_pr_title_as_default: boolean; + }; + /** Pull Request */ + webhooks_pull_request_5: { + _links: { + /** Link */ + comments: { /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; + href: string; + }; + /** Link */ + commits: { /** Format: uri-template */ - following_url?: string; + href: string; + }; + /** Link */ + html: { /** 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; + href: string; + }; + /** Link */ + issue: { /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - } & { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - assignee?: Record; - assignees?: Record[]; - author_association?: string; - body?: string | null; - closed_at?: string | null; - comments?: number; - comments_url?: string; - created_at?: string; + href: string; + }; + /** Link */ + review_comment: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + statuses: { + /** Format: uri-template */ + href: string; + }; + }; + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; + /** 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; - labels?: Record[]; - labels_url?: string; - /** @enum {boolean} */ - locked: true; - milestone?: Record; + id: number; + login: string; + name?: string; 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; - state?: string; - timeline_url?: string; - title?: string; - updated_at?: 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?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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-webhooks"]; - }; - /** issues milestoned event */ - "webhook-issues-milestoned": { - /** @enum {string} */ - action: "milestoned"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + } | 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; + } | 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"; + /** + * PullRequestAutoMerge + * @description The status of auto merging a pull request. + */ + auto_merge: { + /** @description Commit message for the merge commit. */ + commit_message: string | null; + /** @description Title for the merge commit message. */ + commit_title: string | null; /** User */ - assignee?: { + enabled_by: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -43769,174 +35470,189 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees: ({ - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; + /** + * @description The merge method to use. + * @enum {string} + */ + merge_method: "merge" | "squash" | "rebase"; + } | null; + base: { + label: string; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; /** Format: uri-template */ - following_url?: string; + assignees_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; + blobs_url: string; + /** Format: uri-template */ + branches_url: string; /** Format: uri */ - repos_url?: string; - site_admin?: boolean; + clone_url: string; /** Format: uri-template */ - starred_url?: string; + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; /** 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; + deployments_url: string; description: string | null; - id: number; - /** @description The name of the label. */ - name: string; - node_id: string; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; /** - * Format: uri - * @description URL for the label + * @description Whether downloads are enabled. + * @default true */ - url: string; - }[]; - /** 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; - } | null; - description: string | null; - /** Format: date-time */ - due_on: string | null; + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; /** Format: uri */ html_url: string; + /** @description Unique identifier of the repository */ id: number; - /** Format: uri */ + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ labels_url: string; - node_id: string; - /** @description The number of the milestone. */ - number: number; - open_issues: number; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; /** - * @description The state of the milestone. + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. * @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")[]; + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - external_url: string | null; + merges_url: string; + /** Format: uri-template */ + milestones_url: string; /** Format: uri */ - html_url: string; - /** @description Unique identifier of the GitHub app */ - id: number | null; - /** @description The name of the GitHub app */ + mirror_url: string | null; + /** @description The name of the repository. */ name: string; node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ owner: { /** Format: uri */ @@ -43974,129 +35690,77 @@ export interface components { /** Format: uri */ url?: 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"; + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; - /** @description The slug name of the GitHub app */ - slug?: string; - /** Format: date-time */ - updated_at: string | null; - } | null; - pull_request?: { + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: (number | string) | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; /** Format: uri */ - diff_url?: string; + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; /** Format: uri */ - html_url?: string; - /** Format: date-time */ - merged_at?: string | null; + subscribers_url: string; /** Format: uri */ - patch_url?: string; + subscription_url: string; /** Format: uri */ - url?: string; - }; - /** Reactions */ - reactions: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. + * @default false + */ + use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; }; - /** 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; + sha: string; /** User */ user: { /** Format: uri */ @@ -44106,62 +35770,231 @@ export interface components { /** 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; + 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; + }; + body: string | null; + changed_files?: number; + /** Format: date-time */ + closed_at: string | null; + comments?: number; + /** Format: uri */ + comments_url: string; + commits?: number; + /** Format: uri */ + commits_url: string; + /** Format: date-time */ + created_at: string; + deletions?: number; + /** Format: uri */ + diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ + draft: boolean; + head: { + label: string; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; /** Format: uri */ - html_url?: string; + html_url: string; + /** @description Unique identifier of the repository */ id: number; - login: string; - name?: string; - node_id?: string; - /** Format: uri */ - organizations_url?: string; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; /** Format: uri */ - received_events_url?: string; + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ - repos_url?: string; - site_admin?: boolean; + merges_url: string; /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + milestones_url: string; /** Format: uri */ - url?: 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 - * @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; + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - creator: { + owner: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -44193,76 +36026,185 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: 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; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: (number | string) | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; /** - * @description The state of the milestone. + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ - state: "open" | "closed"; - /** @description The title of the milestone. */ - title: string; + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. + * @default false + */ + use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; }; - 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; - state?: string; - timeline_url?: string; - title?: string; - updated_at?: string; - url?: string; - user?: { + sha: 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; - id?: number; - login?: 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; - type?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ url?: string; - }; + } | null; }; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + issue_url: string; + 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; + }[]; + locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ + merged_at: string | null; + /** User */ + merged_by?: { + /** 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; + } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -44333,875 +36275,1231 @@ export interface components { updated_at: string; /** Format: uri */ url: string; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues opened event */ - "webhook-issues-opened": { - /** @enum {string} */ - action: "opened"; - changes?: { - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - old_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; - }[]; - /** 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"; - /** Format: uri */ - url?: 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; + } | null; + node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ + number: number; + /** Format: uri */ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ + /** 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) | { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; 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")[]; - /** 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; - } | 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"; - /** @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; - }; - /** 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; - }; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repository_url: string; + repositories_url: string; + slug: string; /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} + * Format: uri + * @description URL for the team */ - state?: "open" | "closed"; - state_reason?: string | null; + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; + })[]; + requested_teams: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; /** Format: uri */ - timeline_url?: string; - /** @description Title of the issue */ - title: string; - /** Format: date-time */ - updated_at: string; + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; /** * Format: uri - * @description URL for the issue + * @description URL for the team */ 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; - 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; } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url?: string; + slug?: string; /** - * Repository - * @description A git repository + * Format: uri + * @description URL for the team */ - old_repository: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; + url?: string; + }[]; + /** Format: uri-template */ + review_comment_url: string; + review_comments?: number; + /** Format: uri */ + review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + state: "open" | "closed"; + /** Format: uri */ + statuses_url: string; + /** @description The title of the pull request. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + 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; + 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; + } | null; + }; + /** + * Pull Request Review Comment + * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. + */ + webhooks_review_comment: { + _links: { + /** Link */ + html: { /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; + href: string; + }; + /** Link */ + pull_request: { /** Format: uri-template */ - assignees_url: string; + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + }; + /** + * 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 The text of the comment. */ + body: string; + /** @description The SHA of the commit to which the comment applies. */ + commit_id: string; + /** Format: date-time */ + created_at: string; + /** @description The diff of the line that the comment refers to. */ + diff_hunk: string; + /** + * Format: uri + * @description HTML URL for the pull request review comment. + */ + html_url: string; + /** @description The ID of the pull request review comment. */ + id: number; + /** @description The comment ID to reply to. */ + in_reply_to_id?: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + line: number | null; + /** @description The node ID of the pull request review comment. */ + node_id: string; + /** @description The SHA of the original commit to which the comment applies. */ + original_commit_id: string; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + original_line: number; + /** @description The index of the original line in the diff to which the comment applies. */ + original_position: number; + /** @description The first line of the range for a multi-line comment. */ + original_start_line: number | null; + /** @description The relative path of the file to which the comment applies. */ + path: string; + /** @description The line index in the diff to which the comment applies. */ + position: number | null; + /** @description The ID of the pull request review to which the comment belongs. */ + pull_request_review_id: number | null; + /** + * Format: uri + * @description URL for the pull request that the review comment belongs to. + */ + pull_request_url: string; + /** 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; + }; + /** + * @description The side of the first line of the range for a multi-line comment. + * @enum {string} + */ + side: "LEFT" | "RIGHT"; + /** @description The first line of the range for a multi-line comment. */ + start_line: number | null; + /** + * @description The side of the first line of the range for a multi-line comment. + * @default RIGHT + * @enum {string|null} + */ + start_side: "LEFT" | "RIGHT" | null; + /** + * @description The level at which the comment is targeted, can be a diff line or a file. + * @enum {string} + */ + subject_type?: "line" | "file"; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the pull request review 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; + 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; + }; + /** @description The review that was affected. */ + webhooks_review: { + _links: { + /** Link */ + html: { /** Format: uri-template */ - blobs_url: string; + href: string; + }; + /** Link */ + pull_request: { /** Format: uri-template */ - branches_url: string; + href: string; + }; + }; + /** + * 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 The text of the review. */ + body: string | null; + /** @description A commit SHA for the review. */ + commit_id: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the review */ + id: number; + node_id: string; + /** Format: uri */ + pull_request_url: string; + state: string; + /** Format: date-time */ + submitted_at: string | null; + /** 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; + 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; + }; + webhooks_nullable_string: string | null; + /** + * Release + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. + */ + webhooks_release: { + assets: { + /** Format: uri */ + browser_download_url: string; + content_type: string; + /** Format: date-time */ + created_at: string; + download_count: number; + id: number; + label: string | null; + /** @description The file name of the asset. */ + name: string; + node_id: string; + size: number; + /** + * @description State of the release asset. + * @enum {string} + */ + state: "uploaded"; + /** Format: date-time */ + updated_at: string; + /** User */ + uploader?: { /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - commits_url: string; + events_url?: string; + /** Format: uri */ + followers_url?: string; /** Format: uri-template */ - compare_url: string; + following_url?: string; /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - downloads_url: string; + organizations_url?: string; /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; + received_events_url?: string; /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** @description Whether the repository has discussions enabled. */ - has_discussions?: boolean; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; + starred_url?: string; /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; + url?: string; + } | null; + /** Format: uri */ + url: string; + }[]; + /** Format: uri */ + assets_url: string; + /** User */ + author: { + /** 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; + body: string | null; + /** Format: date-time */ + created_at: string | null; + /** Format: uri */ + discussion_url?: string; + /** @description Whether the release is a draft or published */ + draft: boolean; + /** Format: uri */ + html_url: string; + id: number; + name: string | null; + node_id: string; + /** @description Whether the release is identified as a prerelease or a full release. */ + prerelease: boolean; + /** Format: date-time */ + published_at: string | null; + /** 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; + }; + /** @description The name of the tag. */ + tag_name: string; + /** Format: uri */ + tarball_url: string | null; + /** @description Specifies the commitish value that determines where the Git tag is created from. */ + target_commitish: string; + /** Format: uri-template */ + upload_url: string; + /** Format: uri */ + url: string; + /** Format: uri */ + zipball_url: string | null; + }; + /** + * Release + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. + */ + webhooks_release_1: { + assets: ({ + /** Format: uri */ + browser_download_url: string; + content_type: string; + /** Format: date-time */ + created_at: string; + download_count: number; + id: number; + label: string | null; + /** @description The file name of the asset. */ + name: string; + node_id: string; + size: number; + /** + * @description State of the release asset. + * @enum {string} + */ + state: "uploaded"; + /** Format: date-time */ + updated_at: string; + /** User */ + uploader?: { /** Format: uri */ - merges_url: string; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - milestones_url: string; + events_url?: string; /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: (number | string) | null; + followers_url?: string; /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; + following_url?: string; /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - subscription_url: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - svn_url: string; + organizations_url?: string; /** Format: uri */ - tags_url: string; + received_events_url?: string; /** Format: uri */ - teams_url: string; - topics: string[]; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; + starred_url?: string; /** Format: uri */ - url: string; + subscriptions_url?: string; /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require commit signoff. */ - web_commit_signoff_required?: boolean; - }; + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + /** Format: uri */ + url: string; + } | null)[]; + /** Format: uri */ + assets_url: string; + /** User */ + author: { + /** 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; + body: string | null; + /** Format: date-time */ + created_at: string | null; + /** Format: uri */ + discussion_url?: string; + /** @description Whether the release is a draft or published */ + draft: boolean; + /** Format: uri */ + html_url: string; + id: number; + name: string | null; + node_id: string; + /** @description Whether the release is identified as a prerelease or a full release. */ + prerelease: boolean; + /** Format: date-time */ + published_at: string | null; + /** 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; }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; + /** @description The name of the tag. */ + tag_name: string; + /** Format: uri */ + tarball_url: string | null; + /** @description Specifies the commitish value that determines where the Git tag is created from. */ + target_commitish: string; + /** Format: uri-template */ + upload_url: string; + /** Format: uri */ + url: string; + /** Format: uri */ + zipball_url: string | null; + }; + /** + * Repository Vulnerability Alert Alert + * @description The security alert of the vulnerable dependency. + */ + webhooks_alert: { + affected_package_name: string; + affected_range: string; + created_at: string; + dismiss_reason?: string; + dismissed_at?: string; + /** User */ + dismisser?: { + /** 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; + external_identifier: string; + /** Format: uri */ + external_reference: string | null; + fix_reason?: string; + /** Format: date-time */ + fixed_at?: string; + fixed_in?: string; + ghsa_id: string; + id: number; + node_id: string; + number: number; + severity: string; + /** @enum {string} */ + state: "open"; + }; + /** + * @description The reason for resolving the alert. + * @enum {string|null} + */ + "secret-scanning-alert-resolution-webhook": "false_positive" | "wont_fix" | "revoked" | "used_in_tests" | "pattern_deleted" | "pattern_edited"; + "secret-scanning-alert-webhook": { + number?: components["schemas"]["alert-number"]; + created_at?: components["schemas"]["alert-created-at"]; + updated_at?: components["schemas"]["nullable-alert-updated-at"]; + url?: components["schemas"]["alert-url"]; + html_url?: components["schemas"]["alert-html-url"]; /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. + * Format: uri + * @description The REST API URL of the code locations for this alert. */ - 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; + locations_url?: string; + resolution?: components["schemas"]["secret-scanning-alert-resolution-webhook"]; + /** + * Format: date-time + * @description The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + resolved_at?: string | null; + resolved_by?: components["schemas"]["nullable-simple-user"]; + /** @description An optional comment to resolve an alert. */ + resolution_comment?: string | null; + /** @description The type of secret that secret scanning detected. */ + secret_type?: string; + /** + * @description The token status as of the latest validity check. + * @enum {string} + */ + validity?: "active" | "inactive" | "unknown"; + /** @description Whether push protection was bypassed for the detected secret. */ + push_protection_bypassed?: boolean | null; + push_protection_bypassed_by?: components["schemas"]["nullable-simple-user"]; + /** + * Format: date-time + * @description The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + push_protection_bypassed_at?: string | null; + }; + /** @description The details of the security advisory, including summary, description, and severity. */ + webhooks_security_advisory: { + cvss: { + score: number; + vector_string: string | null; + }; + cwes: { + cwe_id: string; + name: string; + }[]; + description: string; + ghsa_id: string; + identifiers: { + type: string; + value: string; + }[]; + published_at: string; + references: { + /** Format: uri */ + url: string; + }[]; + severity: string; + summary: string; + updated_at: string; + vulnerabilities: { + first_patched_version: { + identifier: 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; + package: { + ecosystem: string; + name: string; + }; + severity: string; + vulnerable_version_range: string; + }[]; + withdrawn_at: string | null; + }; + webhooks_sponsorship: { + created_at: string; + maintainer?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + node_id: string; + privacy_level: string; + /** User */ + sponsor: { /** Format: uri */ - comments_url: string; - /** Format: date-time */ - created_at: string; - draft?: boolean; + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; /** Format: uri */ - events_url: string; + 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 */ + 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; - }[]; + 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 */ - labels_url: string; - locked?: boolean; + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + /** User */ + sponsorable: { + /** 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; + /** + * Sponsorship Tier + * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. + */ + tier: { + created_at: string; + description: string; + is_custom_ammount?: boolean; + is_custom_amount?: boolean; + is_one_time: boolean; + monthly_price_in_cents: number; + monthly_price_in_dollars: number; + name: string; + node_id: string; + }; + }; + /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ + webhooks_effective_date: string; + webhooks_changes_8: { + tier: { /** - * Milestone - * @description A collection of related issues and pull requests. + * Sponsorship Tier + * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. */ - milestone: { - /** Format: date-time */ - closed_at: string | null; - closed_issues: number; - /** Format: date-time */ + from: { 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; - } | null; - description: string | null; - /** Format: date-time */ - due_on: string | null; - /** Format: uri */ - html_url: string; - id: number; - /** Format: uri */ - labels_url: string; + description: string; + is_custom_ammount?: boolean; + is_custom_amount?: boolean; + is_one_time: boolean; + monthly_price_in_cents: number; + monthly_price_in_dollars: number; + name: 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; + }; + }; + }; + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + webhooks_team_1: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; node_id: string; - number: number; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** + * @description Whether team members will receive notifications when their team is @mentioned + * @enum {string} + */ + notification_setting: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** + * @description Whether team members will receive notifications when their team is @mentioned + * @enum {string} + */ + notification_setting?: "notifications_enabled" | "notifications_disabled"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; + }; + /** branch protection configuration disabled event */ + "webhook-branch-protection-configuration-disabled": { + /** @enum {string} */ + action: "disabled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection configuration enabled event */ + "webhook-branch-protection-configuration-enabled": { + /** @enum {string} */ + action: "enabled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection rule created event */ + "webhook-branch-protection-rule-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + rule: components["schemas"]["webhooks_rule"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection rule deleted event */ + "webhook-branch-protection-rule-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + rule: components["schemas"]["webhooks_rule"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** branch protection rule edited event */ + "webhook-branch-protection-rule-edited": { + /** @enum {string} */ + action: "edited"; + /** @description If the action was `edited`, the changes to the rule. */ + changes?: { + admin_enforced?: { + from: boolean | null; + }; + authorized_actor_names?: { + from: string[]; + }; + authorized_actors_only?: { + from: boolean | null; + }; + authorized_dismissal_actors_only?: { + from: boolean | null; + }; + linear_history_requirement_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + required_status_checks?: { + from: string[]; + }; + required_status_checks_enforcement_level?: { + /** @enum {string} */ + from: "off" | "non_admins" | "everyone"; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + rule: components["schemas"]["webhooks_rule"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Check Run Completed Event */ + "webhook-check-run-completed": { + /** @enum {string} */ + action?: "completed"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Completed Event + * @description The check_run.completed webhook encoded with URL encoding + */ + "webhook-check-run-completed-form-encoded": { + /** @description A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. */ + payload: string; + }; + /** Check Run Created Event */ + "webhook-check-run-created": { + /** @enum {string} */ + action?: "created"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Created Event + * @description The check_run.created webhook encoded with URL encoding + */ + "webhook-check-run-created-form-encoded": { + /** @description A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. */ + payload: string; + }; + /** Check Run Requested Action Event */ + "webhook-check-run-requested-action": { + /** @enum {string} */ + action: "requested_action"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + /** @description The action requested by the user. */ + requested_action?: { + /** @description The integrator reference of the action requested by the user. */ + identifier?: string; + }; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Requested Action Event + * @description The check_run.requested_action webhook encoded with URL encoding + */ + "webhook-check-run-requested-action-form-encoded": { + /** @description A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. */ + payload: string; + }; + /** Check Run Re-Requested Event */ + "webhook-check-run-rerequested": { + /** @enum {string} */ + action?: "rerequested"; + check_run: components["schemas"]["check-run-with-simple-check-suite"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * Check Run Re-Requested Event + * @description The check_run.rerequested webhook encoded with URL encoding + */ + "webhook-check-run-rerequested-form-encoded": { + /** @description A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. */ + payload: string; + }; + /** check_suite completed event */ + "webhook-check-suite-completed": { + /** @enum {string} */ + action: "completed"; + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ + check_suite: { + after: string | null; /** * 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?: { + 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" | "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" | "merge_group" | "pull_request_review_thread" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "projects_v2_item" | "secret_scanning_alert_location")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -45301,7 +37599,7 @@ export interface components { /** @enum {string} */ repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects?: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ @@ -45325,232 +37623,135 @@ export interface components { 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; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; + before: string | null; + /** Format: uri */ + check_runs_url: string; + /** + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. + * @enum {string|null} + */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped" | "startup_failure"; + /** Format: date-time */ + created_at: string; + /** @description The head branch name the changes are on. */ + head_branch: string | null; + /** SimpleCommit */ + head_commit: { + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + author: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + committer: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + id: string; + message: string; + timestamp: string; + tree_id: string; + }; + /** @description The SHA of the head commit that is being checked. */ + head_sha: string; + id: number; + latest_check_runs_count: number; + node_id: string; + /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; /** Format: uri */ url: string; - }; - /** Format: uri */ - repository_url: string; + }[]; + rerequestable?: boolean; + runs_rerequestable?: boolean; /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} + * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + * @enum {string|null} */ - state?: "open" | "closed"; - state_reason?: string | null; - /** Format: uri */ - timeline_url?: string; - /** @description Title of the issue */ - title: string; + status: "requested" | "in_progress" | "completed" | "queued" | null | "pending"; /** Format: date-time */ updated_at: string; /** * Format: uri - * @description URL for the issue + * @description URL that points to the check suite API resource. */ 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; - 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; }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** issues pinned event */ - "webhook-issues-pinned": { + /** check_suite requested event */ + "webhook-check-suite-requested": { /** @enum {string} */ - action: "pinned"; - 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)[]; + action: "requested"; + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ + check_suite: { + after: string | null; /** - * AuthorAssociation - * @description How the author is associated with the repository. - * @enum {string} + * 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. */ - 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; + app: { + /** Format: date-time */ + created_at: string | null; description: string | null; - id: number; - /** @description The name of the label. */ + /** @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" | "workflow_job" | "merge_queue_entry" | "security_and_analysis" | "secret_scanning_alert_location" | "projects_v2_item" | "merge_group" | "repository_import")[]; + /** 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; - /** - * Format: uri - * @description URL for the label - */ - url: string; - }[]; - /** 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: { + owner: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -45586,42 +37787,201 @@ export interface components { /** Format: uri */ url?: string; } | null; - description: 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 */ - due_on: string | null; - /** Format: uri */ - html_url: string; + updated_at: string | null; + }; + before: string | null; + /** Format: uri */ + check_runs_url: string; + /** + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. + * @enum {string|null} + */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; + /** Format: date-time */ + created_at: string; + /** @description The head branch name the changes are on. */ + head_branch: string | null; + /** SimpleCommit */ + head_commit: { + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + author: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + committer: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + id: string; + message: string; + timestamp: string; + tree_id: string; + }; + /** @description The SHA of the head commit that is being checked. */ + head_sha: string; + id: number; + latest_check_runs_count: number; + node_id: string; + /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: 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; + }[]; + rerequestable?: boolean; + runs_rerequestable?: boolean; + /** + * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + * @enum {string|null} + */ + status: "requested" | "in_progress" | "completed" | "queued" | null; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL that points to the check suite API resource. + */ + url: string; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** check_suite rerequested event */ + "webhook-check-suite-rerequested": { + /** @enum {string} */ + action: "rerequested"; + /** @description The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). */ + check_suite: { + after: string | null; /** * 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?: { + 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")[]; + 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" | "merge_queue_entry" | "workflow_job")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -45705,7 +38065,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} */ @@ -45721,7 +38081,7 @@ export interface components { /** @enum {string} */ repository_hooks?: "read" | "write"; /** @enum {string} */ - repository_projects?: "read" | "write"; + repository_projects?: "read" | "write" | "admin"; /** @enum {string} */ secret_scanning_alerts?: "read" | "write"; /** @enum {string} */ @@ -45745,54 +38105,125 @@ export interface components { 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; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; + before: string | null; + /** Format: uri */ + check_runs_url: string; + /** + * @description The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. + * @enum {string|null} + */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + created_at: string; + /** @description The head branch name the changes are on. */ + head_branch: string | null; + /** SimpleCommit */ + head_commit: { + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + author: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + committer: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + id: string; + message: string; + timestamp: string; + tree_id: string; + }; + /** @description The SHA of the head commit that is being checked. */ + head_sha: string; + id: number; + latest_check_runs_count: number; + node_id: string; + /** @description An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. */ + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; /** Format: uri */ url: string; - }; - /** Format: uri */ - repository_url: string; + }[]; + rerequestable?: boolean; + runs_rerequestable?: boolean; /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} + * @description The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. + * @enum {string|null} */ - state?: "open" | "closed"; - state_reason?: string | null; - /** Format: uri */ - timeline_url?: string; - /** @description Title of the issue */ - title: string; + status: "requested" | "in_progress" | "completed" | "queued" | null; /** Format: date-time */ updated_at: string; /** * Format: uri - * @description URL for the issue + * @description URL that points to the check suite API resource. */ url: string; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert appeared_in_branch event */ + "webhook-code-scanning-alert-appeared-in-branch": { + /** @enum {string} */ + action: "appeared_in_branch"; + /** @description The code scanning alert involved in the event. */ + alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string | null; /** User */ - user: { + dismissed_by: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -45828,22 +38259,97 @@ export interface components { /** Format: uri */ url?: string; } | null; + /** + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + tool: { + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + }; + /** Format: uri */ + url: string; }; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** issues reopened event */ - "webhook-issues-reopened": { + /** code_scanning_alert closed_by_user event */ + "webhook-code-scanning-alert-closed-by-user": { /** @enum {string} */ - action: "reopened"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - issue: { - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + action: "closed_by_user"; + /** @description The code scanning alert involved in the event. */ + alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string; /** User */ - assignee?: { + dismissed_by: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -45879,7 +38385,199 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees: ({ + /** + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + full_description?: string; + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; + }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "dismissed" | "fixed"; + tool: { + guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + }; + /** Format: uri */ + url: string; + }; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert created event */ + "webhook-code-scanning-alert-created": { + /** @enum {string} */ + action: "created"; + /** @description The code scanning alert involved in the event. */ + alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string | null; + /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + dismissed_at: unknown; + dismissed_by: unknown; + dismissed_comment?: components["schemas"]["code-scanning-alert-dismissed-comment"]; + /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + dismissed_reason: unknown; + fixed_at?: unknown; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + instances_url?: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + full_description?: string; + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; + }; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed"; + tool: { + guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + } | null; + updated_at?: string | null; + /** Format: uri */ + url: string; + }; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert fixed event */ + "webhook-code-scanning-alert-fixed": { + /** @enum {string} */ + action: "fixed"; + /** @description The code scanning alert involved in the event. */ + alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** + * Format: date-time + * @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. + */ + dismissed_at: string | null; + /** User */ + dismissed_by: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -45911,271 +38609,303 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null)[]; + } | null; /** - * AuthorAssociation - * @description How the author is associated with the repository. + * @description The reason for dismissing or closing the alert. + * @enum {string|null} + */ + dismissed_reason: "false positive" | "won't fix" | "used in tests" | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + /** Format: uri */ + instances_url?: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; + /** + * @description State of a code scanning alert. + * @enum {string} + */ + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + full_description?: string; + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; + }; + /** + * @description State of a code scanning alert. * @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; + state: "fixed"; + tool: { + guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + }; /** Format: uri */ - comments_url: string; - /** Format: date-time */ + url: string; + }; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert reopened event */ + "webhook-code-scanning-alert-reopened": { + /** @enum {string} */ + action: "reopened"; + /** @description The code scanning alert involved in the event. */ + alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ created_at: string; - draft?: boolean; - /** Format: uri */ - events_url: string; - /** Format: uri */ + /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + dismissed_at: string | null; + dismissed_by: Record; + /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + dismissed_reason: string | null; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ 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; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; /** - * Format: uri - * @description URL for the label + * @description State of a code scanning alert. + * @enum {string} */ - url: string; - }[]; - /** Format: uri-template */ - labels_url: string; - locked?: boolean; + state: "open" | "dismissed" | "fixed"; + } | null; + /** @description The code scanning alert number. */ + number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + full_description?: string; + help?: string | null; + /** @description A link to the documentation for the rule used to detect the alert. */ + help_uri?: string | null; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + name?: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + tags?: string[] | null; + }; /** - * Milestone - * @description A collection of related issues and pull requests. + * @description State of a code scanning alert. + * @enum {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; - } | 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; + state: "open" | "dismissed" | "fixed"; + tool: { + guid?: string | null; + /** @description The name of the tool used to generate the code scanning analysis alert. */ + name: string; + /** @description The version of the tool used to detect the alert. */ + version: string | null; + }; + /** Format: uri */ + url: string; + } | null; + /** @description The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + commit_oid: string | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. */ + ref: string | null; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** code_scanning_alert reopened_by_user event */ + "webhook-code-scanning-alert-reopened-by-user": { + /** @enum {string} */ + action: "reopened_by_user"; + /** @description The code scanning alert involved in the event. */ + alert: { + /** + * Format: date-time + * @description The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` + */ + created_at: string; + /** @description The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. */ + dismissed_at: unknown; + dismissed_by: unknown; + /** @description The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. */ + dismissed_reason: unknown; + /** + * Format: uri + * @description The GitHub URL of the alert resource. + */ + html_url: string; + /** Alert Instance */ + most_recent_instance?: { + /** @description Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. */ + analysis_key: string; + /** @description Identifies the configuration under which the analysis was executed. */ + category?: string; + classifications?: string[]; + commit_sha?: string; + /** @description Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. */ + environment: string; + location?: { + end_column?: number; + end_line?: number; + path?: string; + start_column?: number; + start_line?: number; + }; + message?: { + text?: string; + }; + /** @description The full Git reference, formatted as `refs/heads/`. */ + ref: string; /** - * @description The state of the milestone. + * @description State of a code scanning alert. * @enum {string} */ - state: "open" | "closed"; - /** @description The title of the milestone. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; + state: "open" | "dismissed" | "fixed"; } | null; - node_id: string; + /** @description The code scanning alert number. */ number: number; + rule: { + /** @description A short description of the rule used to detect the alert. */ + description: string; + /** @description A unique identifier for the rule used to detect the alert. */ + id: string; + /** + * @description The severity of the alert. + * @enum {string|null} + */ + severity: "none" | "note" | "warning" | "error" | null; + }; /** - * 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. + * @description State of a code scanning alert. + * @enum {string} */ - 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" | "pull_request_review_thread" | "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 */ + state: "open" | "fixed"; + tool: { + /** @description The name of the tool used to generate the code scanning analysis alert. */ 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; - } | 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; + /** @description The version of the tool used to detect the alert. */ + version: string | null; }; + /** Format: uri */ + url: string; + }; + commit_oid: components["schemas"]["webhooks_code_scanning_commit_oid"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + ref: components["schemas"]["webhooks_code_scanning_ref"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** commit_comment created event */ + "webhook-commit-comment-created": { + /** + * @description The action performed. Can be `created`. + * @enum {string} + */ + action: "created"; + /** @description The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) resource. */ + comment: { + /** + * 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 The text of the comment. */ + body: string; + /** @description The SHA of the commit to which the comment applies. */ + commit_id: string; + created_at: string; + /** Format: uri */ + html_url: string; + /** @description The ID of the commit comment. */ + id: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + line: number | null; + /** @description The node ID of the commit comment. */ + node_id: string; + /** @description The relative path of the file to which the comment applies. */ + path: string | null; + /** @description The line index in the diff to which the comment applies. */ + position: number | null; /** Reactions */ - reactions: { + reactions?: { "+1": number; "-1": number; confused: number; @@ -46188,24 +38918,8 @@ export interface components { /** Format: uri */ url: string; }; - /** 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 - */ + /** Format: uri */ url: string; /** User */ user: { @@ -46240,453 +38954,271 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: 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: "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; - 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; - }; }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** issues transferred event */ - "webhook-issues-transferred": { + /** create event */ + "webhook-create": { + /** @description The repository's current description. */ + description: string | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The name of the repository's default branch (usually `main`). */ + master_branch: string; + organization?: components["schemas"]["organization-simple-webhooks"]; + pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; + ref: components["schemas"]["webhooks_ref_0"]; + /** + * @description The type of Git ref object created in the repository. + * @enum {string} + */ + ref_type: "tag" | "branch"; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** custom property created event */ + "webhook-custom-property-created": { /** @enum {string} */ - action: "transferred"; - changes: { - /** - * Issue - * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. - */ - new_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; - }[]; - /** 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"; - /** Format: uri */ - url?: 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")[]; - /** 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; - } | 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"; - /** @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; - }; - /** 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; - }; + action: "created"; + definition: components["schemas"]["org-custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** custom property deleted event */ + "webhook-custom-property-deleted": { + /** @enum {string} */ + action: "deleted"; + definition: { + /** @description The name of the property that was deleted. */ + property_name: string; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** custom property updated event */ + "webhook-custom-property-updated": { + /** @enum {string} */ + action: "updated"; + definition: components["schemas"]["org-custom-property"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Custom property values updated event */ + "webhook-custom-property-values-updated": { + /** @enum {string} */ + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + repository: components["schemas"]["repository-webhooks"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + /** @description The new custom property values for the repository. */ + new_property_values: components["schemas"]["custom-property-value"][]; + /** @description The old custom property values for the repository. */ + old_property_values: components["schemas"]["custom-property-value"][]; + }; + /** delete event */ + "webhook-delete": { + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pusher_type: components["schemas"]["webhooks_deploy_pusher_type"]; + ref: components["schemas"]["webhooks_ref_0"]; + /** + * @description The type of Git ref object deleted in the repository. + * @enum {string} + */ + ref_type: "tag" | "branch"; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert auto-dismissed event */ + "webhook-dependabot-alert-auto-dismissed": { + /** @enum {string} */ + action: "auto_dismissed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert auto-reopened event */ + "webhook-dependabot-alert-auto-reopened": { + /** @enum {string} */ + action: "auto_reopened"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert created event */ + "webhook-dependabot-alert-created": { + /** @enum {string} */ + action: "created"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert dismissed event */ + "webhook-dependabot-alert-dismissed": { + /** @enum {string} */ + action: "dismissed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert fixed event */ + "webhook-dependabot-alert-fixed": { + /** @enum {string} */ + action: "fixed"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert reintroduced event */ + "webhook-dependabot-alert-reintroduced": { + /** @enum {string} */ + action: "reintroduced"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Dependabot alert reopened event */ + "webhook-dependabot-alert-reopened": { + /** @enum {string} */ + action: "reopened"; + alert: components["schemas"]["dependabot-alert"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** deploy_key created event */ + "webhook-deploy-key-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + key: components["schemas"]["webhooks_deploy_key"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** deploy_key deleted event */ + "webhook-deploy-key-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + key: components["schemas"]["webhooks_deploy_key"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** deployment created event */ + "webhook-deployment-created": { + /** @enum {string} */ + action: "created"; + /** + * Deployment + * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). + */ + deployment: { + created_at: string; + /** User */ + creator: { /** Format: uri */ - repository_url: string; - /** - * @description State of the issue; either 'open' or 'closed' - * @enum {string} - */ - state?: "open" | "closed"; - state_reason?: string | null; + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; /** Format: uri */ - timeline_url?: string; - /** @description Title of the issue */ - title: string; + 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; + description: string | null; + environment: string; + id: number; + node_id: string; + original_environment: string; + payload: Record | string; + /** + * 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 */ - updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - url: string; + 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" | "workflow_job" | "pull_request_review_thread" | "merge_queue_entry" | "secret_scanning_alert_location" | "merge_group")[]; + /** 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 */ - user: { + owner: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -46722,265 +39254,665 @@ export interface components { /** Format: uri */ url?: string; } | null; - }; - /** - * Repository - * @description A git repository - */ - new_repository: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; + /** @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"; + /** @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; + production_environment?: boolean; + ref: string; + /** Format: uri */ + repository_url: string; + sha: string; + /** Format: uri */ + statuses_url: string; + task: string; + transient_environment?: boolean; + updated_at: string; + /** Format: uri */ + url: string; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + workflow: components["schemas"]["webhooks_workflow"]; + /** Deployment Workflow Run */ + workflow_run: { + /** User */ + actor: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; + events_url?: string; + /** Format: uri */ + followers_url?: string; /** Format: uri-template */ - assignees_url: string; + following_url?: string; /** Format: uri-template */ - blobs_url: string; + 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 */ - branches_url: string; + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + created_at: string; + display_title: string; + event: string; + head_branch: string; + head_commit?: unknown; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: unknown; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; + /** Format: uri */ + url: string; + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; + /** Format: date-time */ + run_started_at: string; + /** @enum {string} */ + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; + /** User */ + triggering_actor?: { /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - commits_url: string; + events_url?: string; + /** Format: uri */ + followers_url?: string; /** Format: uri-template */ - compare_url: string; + following_url?: string; /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - downloads_url: string; + organizations_url?: string; /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; + received_events_url?: string; /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - git_tags_url: string; + starred_url?: string; /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - hooks_url: string; + url?: string; + } | null; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + workflow_url?: string; + } | null; + }; + /** deployment protection rule requested event */ + "webhook-deployment-protection-rule-requested": { + /** @enum {string} */ + action?: "requested"; + /** @description The name of the environment that has the deployment protection rule. */ + environment?: string; + /** @description The event that triggered the deployment protection rule. */ + event?: string; + /** + * Format: uri + * @description The URL to review the deployment protection rule. + */ + deployment_callback_url?: string; + deployment?: components["schemas"]["deployment"]; + pull_requests?: components["schemas"]["pull-request"][]; + repository?: components["schemas"]["repository-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + "webhook-deployment-review-approved": { + /** @enum {string} */ + action: "approved"; + approver?: components["schemas"]["webhooks_approver"]; + comment?: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + reviewers?: components["schemas"]["webhooks_reviewers"]; + sender: components["schemas"]["simple-user-webhooks"]; + since: string; + workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; + workflow_job_runs?: { + conclusion?: unknown; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; + }[]; + /** Deployment Workflow Run */ + workflow_run: { + /** User */ + actor: { /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - issues_url: string; + events_url?: string; + /** Format: uri */ + followers_url?: string; /** Format: uri-template */ - keys_url: string; + following_url?: string; /** Format: uri-template */ - labels_url: string; - language: string | null; + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; + organizations_url?: string; /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; - /** User */ - owner: { - /** Format: uri */ + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; + /** Format: date-time */ + created_at: string; + display_title: string; + event: string; + head_branch: string; + head_commit?: Record; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { 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; + id?: number; + login?: 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 */ + type?: string; url?: string; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: (number | string) | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + id: number; + number: number; /** Format: uri */ url: string; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; }; - }; - 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; + rerun_url?: string; + run_attempt: number; + run_number: number; + /** Format: date-time */ + run_started_at: string; + /** @enum {string} */ + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - assignee?: { + triggering_actor: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47016,7 +39948,41 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees: ({ + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + workflow_url?: string; + } | null; + }; + "webhook-deployment-review-rejected": { + /** @enum {string} */ + action: "rejected"; + approver?: components["schemas"]["webhooks_approver"]; + comment?: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + reviewers?: components["schemas"]["webhooks_reviewers"]; + sender: components["schemas"]["simple-user-webhooks"]; + since: string; + workflow_job_run?: components["schemas"]["webhooks_workflow_job_run"]; + workflow_job_runs?: { + conclusion?: string | null; + created_at?: string; + environment?: string; + html_url?: string; + id?: number; + name?: string | null; + status?: string; + updated_at?: string; + }[]; + /** Deployment Workflow Run */ + workflow_run: { + /** User */ + actor: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47051,301 +40017,205 @@ export interface components { 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; + } | null; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** 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; - /** - * 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 */ + event: string; + head_branch: string; + head_commit?: Record; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { 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; + id?: number; + login?: 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 */ + type?: string; url?: string; - } | null; - description: string | null; - /** Format: date-time */ - due_on: string | null; - /** Format: uri */ - html_url: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: 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")[]; - /** 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 */ + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { 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; + id?: number; + login?: 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 */ + type?: string; url?: 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"; - /** @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 */ + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; url?: string; }; - /** 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} - */ - state?: "open" | "closed"; - state_reason?: string | null; - /** Format: uri */ - timeline_url?: string; - /** @description Title of the issue */ - title: string; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - url: string; + run_started_at: string; + /** @enum {string} */ + status: "requested" | "in_progress" | "completed" | "queued" | "waiting"; /** User */ - user: { + triggering_actor: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47353,94 +40223,55 @@ export interface components { /** 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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues unassigned event */ - "webhook-issues-unassigned": { - /** - * @description The action that was performed. - * @enum {string} - */ - action: "unassigned"; - /** 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"; + 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; + /** Format: date-time */ + updated_at: string; /** Format: uri */ - url?: string; + url: string; + workflow_id: number; + workflow_url?: string; + display_title: string; } | null; + }; + "webhook-deployment-review-requested": { + /** @enum {string} */ + action: "requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; + environment: string; 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; + organization: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + requestor: components["schemas"]["webhooks_user"]; + reviewers: { /** User */ - assignee?: { + reviewer?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47457,7 +40288,7 @@ export interface components { /** Format: uri */ html_url?: string; id: number; - login: string; + login?: string; name?: string; node_id?: string; /** Format: uri */ @@ -47472,11 +40303,29 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; - assignees: ({ + /** @enum {string} */ + type?: "User" | "Team"; + }[]; + sender: components["schemas"]["simple-user-webhooks"]; + since: string; + workflow_job_run: { + conclusion: unknown; + created_at: string; + environment: string; + html_url: string; + id: number; + name: string | null; + status: string; + updated_at: string; + }; + /** Deployment Workflow Run */ + workflow_run: { + /** User */ + actor: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47508,359 +40357,208 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + 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; + } | null; + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null; /** 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; - /** - * 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 */ + event: string; + head_branch: string; + head_commit?: Record; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { 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; + id?: number; + login?: 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 */ + type?: string; url?: string; - } | null; - description: string | null; - /** Format: date-time */ - due_on: string | null; - /** Format: uri */ - html_url: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: string | null; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: 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" | "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 */ + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: string | null; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { 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; + id?: number; + login?: 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; - /** @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; - }; - /** 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} - */ - 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; - 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 */ + type?: string; + url?: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; url?: string; - } | null; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues unlabeled event */ - "webhook-issues-unlabeled": { - /** @enum {string} */ - action: "unlabeled"; - 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; + }; + rerun_url?: string; + run_attempt: number; + run_number: number; + /** Format: date-time */ + run_started_at: string; + /** @enum {string} */ + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - assignee?: { + triggering_actor: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47892,11 +40590,61 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; - assignees: ({ + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + workflow_url?: string; + display_title: string; + } | null; + }; + /** deployment_status created event */ + "webhook-deployment-status-created": { + /** @enum {string} */ + action: "created"; + check_run?: { + /** Format: date-time */ + completed_at: string | null; + /** + * @description The result of the completed check run. This value will be `null` until the check run has completed. + * @enum {string|null} + */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; + /** Format: uri */ + details_url: string; + external_id: string; + /** @description The SHA of the commit that is being checked. */ + head_sha: string; + /** Format: uri */ + html_url: string; + /** @description The id of the check. */ + id: number; + /** @description The name of the check run. */ + name: string; + node_id: string; + /** Format: date-time */ + started_at: string; + /** + * @description The current status of the check run. Can be `queued`, `in_progress`, or `completed`. + * @enum {string} + */ + status: "queued" | "in_progress" | "completed" | "waiting" | "pending"; + /** Format: uri */ + url: string; + } | null; + /** + * Deployment + * @description The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). + */ + deployment: { + created_at: string; + /** User */ + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -47928,123 +40676,16 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + 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; - }[]; - /** 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; - } | 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; + description: string | null; + environment: string; + id: number; node_id: string; - number: number; + original_environment: string; + payload: (string | Record) | null; /** * 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. @@ -48054,7 +40695,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" | "merge_queue_entry" | "workflow_job" | "pull_request_review_thread" | "secret_scanning_alert_location" | "merge_group")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -48138,7 +40779,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} */ @@ -48150,333 +40791,99 @@ export interface components { /** @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; - }; - /** 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} - */ - 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; - 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; - } | null; - }; - /** Label */ - label?: { - /** @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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues unlocked event */ - "webhook-issues-unlocked": { - /** @enum {string} */ - action: "unlocked"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - 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; - }[]; - /** 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; + pull_requests?: "read" | "write"; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - description: string | null; + 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 */ - due_on: string | null; + updated_at: string | null; + } | null; + production_environment?: boolean; + ref: string; + /** Format: uri */ + repository_url: string; + sha: string; + /** Format: uri */ + statuses_url: string; + task: string; + transient_environment?: boolean; + updated_at: string; + /** Format: uri */ + url: string; + }; + /** @description The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). */ + deployment_status: { + created_at: string; + /** User */ + creator: { /** Format: uri */ - html_url: string; + 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 */ - 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; + organizations_url?: string; /** Format: uri */ - url: string; + 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; + /** Format: uri */ + deployment_url: string; + /** @description The optional human-readable description added to the status. */ + description: string; + environment: string; + /** Format: uri */ + environment_url?: string; + id: number; + /** Format: uri */ + log_url?: string; 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. @@ -48486,7 +40893,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" | "pull_request_review_thread" | "merge_queue_entry" | "workflow_job" | "merge_group" | "secret_scanning_alert_location")[]; /** Format: uri */ external_url: string | null; /** Format: uri */ @@ -48611,167 +41018,26 @@ export interface components { /** 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; - "-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} - */ - state?: "open" | "closed"; - state_reason?: string | null; - /** Format: uri */ - timeline_url?: string; - /** @description Title of the issue */ - title: string; - /** Format: date-time */ + /** @description The new state. Can be `pending`, `success`, `failure`, or `error`. */ + state: string; + /** @description The optional link added to the status. */ + target_url: string; updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ + /** Format: uri */ 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; - 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; - } & { - active_lock_reason: unknown; - 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; - /** @enum {boolean} */ - locked: false; - milestone?: Record; - node_id?: string; - number?: number; - performed_via_github_app?: unknown; - 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; - state?: string; - 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; - 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; - }; }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; - }; - /** issues unpinned event */ - "webhook-issues-unpinned": { - /** @enum {string} */ - action: "unpinned"; - 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; + workflow?: components["schemas"]["webhooks_workflow"]; + /** Deployment Workflow Run */ + workflow_run?: { /** User */ - assignee?: { + actor: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -48807,336 +41073,205 @@ export interface components { /** Format: uri */ url?: string; } | null; - assignees: ({ - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ + artifacts_url?: string; + cancel_url?: string; + check_suite_id: number; + check_suite_node_id: string; + check_suite_url?: string; + /** @enum {string|null} */ + conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "startup_failure"; + /** Format: date-time */ + created_at: string; + display_title: string; + event: string; + head_branch: string; + head_commit?: unknown; + head_repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; 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 */ + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; html_url?: string; - id: number; - login: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: 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; - }[]; - /** 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 */ + notifications_url?: string; + owner?: { 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; + id?: number; + login?: 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 */ + type?: string; url?: string; - } | null; - description: string | null; - /** Format: date-time */ - due_on: string | null; - /** Format: uri */ - html_url: string; + }; + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; + url?: string; + }; + head_sha: string; + /** Format: uri */ + html_url: string; + id: number; + jobs_url?: string; + logs_url?: string; + name: string; + node_id: string; + path: string; + previous_attempt_url?: unknown; + pull_requests: { + base: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: string; + }; + head: { + ref: string; + /** Repo Ref */ + repo: { + id: number; + name: string; + /** Format: uri */ + url: string; + }; + sha: 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")[]; - /** 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 */ + }[]; + referenced_workflows?: { + path: string; + ref?: string; + sha: string; + }[] | null; + repository?: { + archive_url?: string; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + deployments_url?: string; + description?: unknown; + downloads_url?: string; + events_url?: string; + fork?: boolean; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + hooks_url?: string; + html_url?: string; + id?: number; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + languages_url?: string; + merges_url?: string; + milestones_url?: string; + name?: string; + node_id?: string; + notifications_url?: string; + owner?: { 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; + id?: number; + login?: 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 */ + type?: string; url?: 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"; - /** @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 */ + private?: boolean; + pulls_url?: string; + releases_url?: string; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + tags_url?: string; + teams_url?: string; + trees_url?: string; url?: string; }; - /** 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} - */ - state?: "open" | "closed"; - state_reason?: string | null; - /** Format: uri */ - timeline_url?: string; - /** @description Title of the issue */ - title: string; + rerun_url?: string; + run_attempt: number; + run_number: number; /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the issue - */ - url: string; + run_started_at: string; + /** @enum {string} */ + status: "requested" | "in_progress" | "completed" | "queued" | "waiting" | "pending"; /** User */ - user: { + triggering_actor: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -49172,1055 +41307,930 @@ export interface components { /** Format: uri */ url?: string; } | null; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + workflow_id: number; + workflow_url?: string; + } | null; + }; + /** discussion answered event */ + "webhook-discussion-answered": { + /** @enum {string} */ + action: "answered"; + answer: components["schemas"]["webhooks_answer"]; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion category changed event */ + "webhook-discussion-category-changed": { + /** @enum {string} */ + action: "category_changed"; + changes: { + category: { + from: { + /** Format: date-time */ + created_at: string; + description: string; + emoji: string; + id: number; + is_answerable: boolean; + name: string; + node_id?: string; + repository_id: number; + slug: string; + updated_at: string; + }; + }; }; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** label created event */ - "webhook-label-created": { + /** discussion closed event */ + "webhook-discussion-closed": { + /** @enum {string} */ + action: "closed"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion_comment created event */ + "webhook-discussion-comment-created": { /** @enum {string} */ action: "created"; + comment: components["schemas"]["webhooks_comment"]; + discussion: components["schemas"]["discussion"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** Label */ - label: { - /** @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; - }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** label deleted event */ - "webhook-label-deleted": { + /** discussion_comment deleted event */ + "webhook-discussion-comment-deleted": { /** @enum {string} */ action: "deleted"; + comment: components["schemas"]["webhooks_comment"]; + discussion: components["schemas"]["discussion"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** Label */ - label: { - /** @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; - }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** label edited event */ - "webhook-label-edited": { + /** discussion_comment edited event */ + "webhook-discussion-comment-edited": { /** @enum {string} */ action: "edited"; - /** @description The changes to the label if the action was `edited`. */ - changes?: { - color?: { - /** @description The previous version of the color if the action was `edited`. */ + changes: { + body: { from: string; }; - description?: { - /** @description The previous version of the description if the action was `edited`. */ + }; + comment: components["schemas"]["webhooks_comment"]; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion created event */ + "webhook-discussion-created": { + /** @enum {string} */ + action: "created"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion deleted event */ + "webhook-discussion-deleted": { + /** @enum {string} */ + action: "deleted"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion edited event */ + "webhook-discussion-edited": { + /** @enum {string} */ + action: "edited"; + changes?: { + body?: { from: string; }; - name?: { - /** @description The previous version of the name if the action was `edited`. */ + title?: { from: string; }; }; + discussion: components["schemas"]["discussion"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** Label */ - label: { - /** @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; - }; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase cancelled event */ - "webhook-marketplace-purchase-cancelled": { + /** discussion labeled event */ + "webhook-discussion-labeled": { /** @enum {string} */ - action: "cancelled"; - effective_date: string; + action: "labeled"; + discussion: components["schemas"]["discussion"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - marketplace_purchase: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: string | null; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - } & { - account?: { - id?: number; - login?: string; - node_id?: string; - organization_billing_email?: string | null; - type?: string; - }; - billing_cycle?: string; - free_trial_ends_on?: string | null; - next_billing_date: string | null; - on_free_trial?: boolean; - plan?: { - bullets?: (string | null)[]; - description?: string; - has_free_trial?: boolean; - id?: number; - monthly_price_in_cents?: number; - name?: string; - /** @enum {string} */ - price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name?: string | null; - yearly_price_in_cents?: number; - }; - unit_count?: number; - }; + label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - previous_marketplace_purchase?: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: unknown; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - }; - repository?: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase changed event */ - "webhook-marketplace-purchase-changed": { + /** discussion locked event */ + "webhook-discussion-locked": { /** @enum {string} */ - action: "changed"; - effective_date: string; + action: "locked"; + discussion: components["schemas"]["discussion"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - marketplace_purchase: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: string | null; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - } & { - account?: { - id?: number; - login?: string; - node_id?: string; - organization_billing_email?: string | null; - type?: string; - }; - billing_cycle?: string; - free_trial_ends_on?: string | null; - next_billing_date: string | null; - on_free_trial?: boolean; - plan?: { - bullets?: (string | null)[]; - description?: string; - has_free_trial?: boolean; - id?: number; - monthly_price_in_cents?: number; - name?: string; - /** @enum {string} */ - price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name?: string | null; - yearly_price_in_cents?: number; - }; - unit_count?: number; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion pinned event */ + "webhook-discussion-pinned": { + /** @enum {string} */ + action: "pinned"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion reopened event */ + "webhook-discussion-reopened": { + /** @enum {string} */ + action: "reopened"; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion transferred event */ + "webhook-discussion-transferred": { + /** @enum {string} */ + action: "transferred"; + changes: { + new_discussion: components["schemas"]["discussion"]; + new_repository: components["schemas"]["repository-webhooks"]; }; + discussion: components["schemas"]["discussion"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - previous_marketplace_purchase?: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: string | null; - next_billing_date?: string | null; - on_free_trial: boolean | null; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - }; - repository?: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase pending_change event */ - "webhook-marketplace-purchase-pending-change": { + /** discussion unanswered event */ + "webhook-discussion-unanswered": { /** @enum {string} */ - action: "pending_change"; - effective_date: string; + action: "unanswered"; + discussion: components["schemas"]["discussion"]; + old_answer: components["schemas"]["webhooks_answer"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** discussion unlabeled event */ + "webhook-discussion-unlabeled": { + /** @enum {string} */ + action: "unlabeled"; + discussion: components["schemas"]["discussion"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - marketplace_purchase: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: string | null; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - } & { - account?: { - id?: number; - login?: string; - node_id?: string; - organization_billing_email?: string | null; - type?: string; - }; - billing_cycle?: string; - free_trial_ends_on?: string | null; - next_billing_date: string | null; - on_free_trial?: boolean; - plan?: { - bullets?: (string | null)[]; - description?: string; - has_free_trial?: boolean; - id?: number; - monthly_price_in_cents?: number; - name?: string; - /** @enum {string} */ - price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name?: string | null; - yearly_price_in_cents?: number; - }; - unit_count?: number; - }; + label: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - previous_marketplace_purchase?: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: string | null; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - }; - repository?: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase pending_change_cancelled event */ - "webhook-marketplace-purchase-pending-change-cancelled": { + /** discussion unlocked event */ + "webhook-discussion-unlocked": { /** @enum {string} */ - action: "pending_change_cancelled"; - effective_date: string; + action: "unlocked"; + discussion: components["schemas"]["discussion"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - marketplace_purchase: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: unknown; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - } & { - next_billing_date: string; - }; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - previous_marketplace_purchase?: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: unknown; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - }; - repository?: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** marketplace_purchase purchased event */ - "webhook-marketplace-purchase-purchased": { + /** discussion unpinned event */ + "webhook-discussion-unpinned": { /** @enum {string} */ - action: "purchased"; - effective_date: string; + action: "unpinned"; + discussion: components["schemas"]["discussion"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - marketplace_purchase: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** + * fork event + * @description A user forks a repository. + */ + "webhook-fork": { + enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @description The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. */ + forkee: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; }; - billing_cycle: string; - free_trial_ends_on: string | null; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: 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} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; - unit_count: number; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: (number | string) | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; } & { - account?: { + allow_forking?: boolean; + archive_url?: string; + archived?: boolean; + assignees_url?: string; + blobs_url?: string; + branches_url?: string; + clone_url?: string; + collaborators_url?: string; + comments_url?: string; + commits_url?: string; + compare_url?: string; + contents_url?: string; + contributors_url?: string; + created_at?: string; + default_branch?: string; + deployments_url?: string; + description?: string | null; + disabled?: boolean; + downloads_url?: string; + events_url?: string; + /** @enum {boolean} */ + fork?: true; + forks?: number; + forks_count?: number; + forks_url?: string; + full_name?: string; + git_commits_url?: string; + git_refs_url?: string; + git_tags_url?: string; + git_url?: string; + has_downloads?: boolean; + has_issues?: boolean; + has_pages?: boolean; + has_projects?: boolean; + has_wiki?: boolean; + homepage?: string | null; + hooks_url?: string; + html_url?: string; + id?: number; + is_template?: boolean; + issue_comment_url?: string; + issue_events_url?: string; + issues_url?: string; + keys_url?: string; + labels_url?: string; + language?: unknown; + languages_url?: string; + license?: Record; + merges_url?: string; + milestones_url?: string; + mirror_url?: unknown; + name?: string; + node_id?: string; + notifications_url?: string; + open_issues?: number; + open_issues_count?: number; + owner?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; id?: number; login?: string; node_id?: string; - organization_billing_email?: string | null; + organizations_url?: string; + received_events_url?: string; + repos_url?: string; + site_admin?: boolean; + starred_url?: string; + subscriptions_url?: string; type?: string; + url?: string; }; - billing_cycle?: string; - free_trial_ends_on?: string | null; - next_billing_date: string | null; - on_free_trial?: boolean; - plan?: { - bullets?: (string | null)[]; - description?: string; - has_free_trial?: boolean; - id?: number; - monthly_price_in_cents?: number; - name?: string; - /** @enum {string} */ - price_model?: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name?: string | null; - yearly_price_in_cents?: number; - }; - unit_count?: number; + private?: boolean; + public?: boolean; + pulls_url?: string; + pushed_at?: string; + releases_url?: string; + size?: number; + ssh_url?: string; + stargazers_count?: number; + stargazers_url?: string; + statuses_url?: string; + subscribers_url?: string; + subscription_url?: string; + svn_url?: string; + tags_url?: string; + teams_url?: string; + topics?: unknown[]; + trees_url?: string; + updated_at?: string; + url?: string; + visibility?: string; + watchers?: number; + watchers_count?: number; }; + installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Marketplace Purchase */ - previous_marketplace_purchase?: { - account: { - id: number; - login: string; - node_id: string; - organization_billing_email: string | null; - type: string; - }; - billing_cycle: string; - free_trial_ends_on: unknown; - next_billing_date?: string | null; - on_free_trial: boolean; - plan: { - bullets: string[]; - description: string; - has_free_trial: boolean; - id: number; - monthly_price_in_cents: number; - name: string; - /** @enum {string} */ - price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; - unit_name: string | null; - yearly_price_in_cents: number; - }; - unit_count: number; - }; - repository?: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** member added event */ - "webhook-member-added": { + /** github_app_authorization revoked event */ + "webhook-github-app-authorization-revoked": { /** @enum {string} */ - action: "added"; - changes?: { - permission?: { - /** @enum {string} */ - to: "write" | "admin" | "read"; - }; - }; + action: "revoked"; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** gollum event */ + "webhook-gollum": { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** 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; organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description The pages that were updated. */ + pages: { + /** + * @description The action that was performed on the page. Can be `created` or `edited`. + * @enum {string} + */ + action: "created" | "edited"; + /** + * Format: uri + * @description Points to the HTML wiki page. + */ + html_url: string; + /** @description The name of the page. */ + page_name: string; + /** @description The latest commit SHA of the page. */ + sha: string; + summary: string | null; + /** @description The current page title. */ + title: string; + }[]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** member edited event */ - "webhook-member-edited": { + /** installation created event */ + "webhook-installation-created": { /** @enum {string} */ - action: "edited"; - /** @description The changes to the collaborator permissions */ - changes: { - old_permission?: { - /** @description The previous permissions of the collaborator if the action was edited. */ - from: string; - }; - permission?: { - from?: string | null; - to?: string | null; - }; - }; + action: "created"; enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** 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; + installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: components["schemas"]["webhooks_user"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** member removed event */ - "webhook-member-removed": { + /** installation deleted event */ + "webhook-installation-deleted": { /** @enum {string} */ - action: "removed"; + action: "deleted"; enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** 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; + installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: unknown; sender: components["schemas"]["simple-user-webhooks"]; }; - /** membership added event */ - "webhook-membership-added": { + /** installation new_permissions_accepted event */ + "webhook-installation-new-permissions-accepted": { + /** @enum {string} */ + action: "new_permissions_accepted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: unknown; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** installation_repositories added event */ + "webhook-installation-repositories-added": { /** @enum {string} */ action: "added"; enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** 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; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories_added: components["schemas"]["webhooks_repositories_added"]; + /** @description An array of repository objects, which were removed from the installation. */ + repositories_removed: { + full_name?: string; + /** @description Unique identifier of the repository */ + id?: number; + /** @description The name of the repository. */ 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; - organization: components["schemas"]["organization-simple-webhooks"]; + /** @description Whether the repository is private or public. */ + private?: boolean; + }[]; repository?: components["schemas"]["repository-webhooks"]; - /** - * @description The scope of the membership. Currently, can only be `team`. - * @enum {string} - */ - scope: "team"; - /** User */ - sender: { - /** 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; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** @enum {string} */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; + repository_selection: components["schemas"]["webhooks_repository_selection"]; + requester: components["schemas"]["webhooks_user"]; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** membership removed event */ - "webhook-membership-removed": { + /** installation_repositories removed event */ + "webhook-installation-repositories-removed": { /** @enum {string} */ action: "removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** User */ - member: { - /** 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; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories_added: components["schemas"]["webhooks_repositories_added"]; + /** @description An array of repository objects, which were removed from the installation. */ + repositories_removed: { + full_name: string; + /** @description Unique identifier of the repository */ 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; - organization: components["schemas"]["organization-simple-webhooks"]; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** @description Whether the repository is private or public. */ + private: boolean; + }[]; repository?: components["schemas"]["repository-webhooks"]; - /** - * @description The scope of the membership. Currently, can only be `team`. - * @enum {string} - */ - scope: "team" | "organization"; - /** User */ - sender: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ + repository_selection: components["schemas"]["webhooks_repository_selection"]; + requester: components["schemas"]["webhooks_user"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** installation suspend event */ + "webhook-installation-suspend": { + /** @enum {string} */ + action: "suspend"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; + repository?: components["schemas"]["repository-webhooks"]; + requester?: unknown; + sender: components["schemas"]["simple-user-webhooks"]; + }; + "webhook-installation-target-renamed": { + account: { + archived_at?: string | null; + avatar_url: string; + created_at?: string; + description?: unknown; events_url?: string; - /** Format: uri */ + followers?: number; followers_url?: string; - /** Format: uri-template */ + following?: number; following_url?: string; - /** Format: uri-template */ gists_url?: string; gravatar_id?: string; - /** Format: uri */ - html_url?: string; + has_organization_projects?: boolean; + has_repository_projects?: boolean; + hooks_url?: string; + html_url: string; id: number; - login: string; + is_verified?: boolean; + issues_url?: string; + login?: string; + members_url?: string; name?: string; - node_id?: string; - /** Format: uri */ + node_id: string; organizations_url?: string; - /** Format: uri */ + public_gists?: number; + public_members_url?: string; + public_repos?: number; received_events_url?: string; - /** Format: uri */ repos_url?: string; site_admin?: boolean; - /** Format: uri-template */ + slug?: string; starred_url?: string; - /** Format: uri */ subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** @enum {string} */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ + type?: string; + updated_at?: string; url?: string; + website_url?: unknown; }; - }; - "webhook-merge-group-checks-requested": { /** @enum {string} */ - action: "checks_requested"; - installation?: components["schemas"]["simple-installation"]; - merge_group: components["schemas"]["merge-group"]; + action: "renamed"; + changes: { + login?: { + from: string; + }; + slug?: { + from: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; sender?: components["schemas"]["simple-user-webhooks"]; + target_type: string; }; - "webhook-merge-group-destroyed": { + /** installation unsuspend event */ + "webhook-installation-unsuspend": { /** @enum {string} */ - action: "destroyed"; - /** - * @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated). - * @enum {string} - */ - reason?: "merged" | "invalidated" | "dequeued"; - installation?: components["schemas"]["simple-installation"]; - merge_group: components["schemas"]["merge-group"]; + action: "unsuspend"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; + repositories?: components["schemas"]["webhooks_repositories"]; repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + requester?: unknown; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** meta deleted event */ - "webhook-meta-deleted": { + /** issue_comment created event */ + "webhook-issue-comment-created": { /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ - hook: { - active: boolean; - config: { - /** @enum {string} */ - content_type: "json" | "form"; - insecure_ssl: string; - secret?: string; + action: "created"; + /** + * issue comment + * @description The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. + */ + comment: { + /** + * 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 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; }; - created_at: string; - events: ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[]; - id: number; - name: string; - type: 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; + 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; }; - /** @description The id of the modified webhook. */ - hook_id: number; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone closed event */ - "webhook-milestone-closed": { - /** @enum {string} */ - action: "closed"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** - * 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; + /** @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 */ - creator: { + 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; + } | null; + assignees: ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50228,161 +42238,328 @@ export interface components { /** 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; + 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; + } | 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; + /** + * 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; + } | 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" | "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; + } | 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; - 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: date-time */ + merged_at?: string | null; /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + patch_url?: string; /** Format: uri */ url?: string; - } | null; - description: string | null; - /** Format: date-time */ - due_on: string | null; - /** Format: uri */ - html_url: string; - id: 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 */ - labels_url: string; - node_id: string; - /** @description The number of the milestone. */ - number: number; - open_issues: number; + repository_url: string; /** - * @description The state of the milestone. + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - state: "open" | "closed"; - /** @description The title of the milestone. */ + 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 */ - url: string; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone created event */ - "webhook-milestone-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * 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"; - /** Format: uri */ - url?: 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} + * Format: uri + * @description URL for the issue */ - state: "open" | "closed"; - /** @description The title of the milestone. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ url: string; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone deleted event */ - "webhook-milestone-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * 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: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50418,67 +42595,10 @@ export interface components { /** Format: uri */ url?: 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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone edited event */ - "webhook-milestone-edited": { - /** @enum {string} */ - action: "edited"; - /** @description The changes to the milestone if the action was `edited`. */ - changes: { - description?: { - /** @description The previous version of the description if the action was `edited`. */ - from: string; - }; - due_on?: { - /** @description The previous version of the due date if the action was `edited`. */ - from: string; - }; - title?: { - /** @description The previous version of the title if the action was `edited`. */ - from: string; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * 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; + } & { + active_lock_reason?: string | null; /** User */ - creator: { + assignee: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50514,228 +42634,97 @@ export interface components { /** Format: uri */ url?: 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; + 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 The state of the milestone. + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ state: "open" | "closed"; - /** @description The title of the milestone. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** milestone opened event */ - "webhook-milestone-opened": { - /** @enum {string} */ - action: "opened"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * 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 */ + timeline_url?: string; + title?: string; + updated_at?: string; + url?: string; + user?: { 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; + id?: number; + login?: 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; - 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; - }; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** org_block blocked event */ - "webhook-org-block-blocked": { - /** @enum {string} */ - action: "blocked"; - /** User */ - blocked_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; - 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; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** org_block unblocked event */ - "webhook-org-block-unblocked": { - /** @enum {string} */ - action: "unblocked"; - /** User */ - blocked_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; - 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; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; + type?: string; + url?: string; + }; + }; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** organization deleted event */ - "webhook-organization-deleted": { + /** 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"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - membership?: { - /** Format: uri */ - organization_url: string; - role: string; - state: string; - /** Format: uri */ - url: string; + /** @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 */ - user: { + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50767,34 +42756,11 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - }; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** organization member_added event */ - "webhook-organization-member-added": { - /** @enum {string} */ - action: "member_added"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - membership: { - /** Format: uri */ - organization_url: string; - role: string; - state: string; - /** Format: uri */ - url: string; - /** User */ - user: { + assignees: ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50826,34 +42792,304 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null; - }; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** organization member_invited event */ - "webhook-organization-member-invited": { - /** @enum {string} */ - action: "member_invited"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The invitation for the user or email if the action is `member_invited`. */ - invitation: { + } | 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 */ - created_at: string; - email: string | null; + closed_at: string | null; + comments: number; + /** Format: uri */ + comments_url: string; /** Format: date-time */ - failed_at: string | null; - failed_reason: string | null; + 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; + /** + * 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; + } | 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")[]; + /** 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; + } | 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"; + /** @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; + }; + /** 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 */ - invitation_teams_url: string; + 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 */ - inviter: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50885,76 +43121,14 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - login: string | null; - node_id: string; - role: string; - team_count: number; - invitation_source?: string; - }; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - /** 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; - 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; - }; - /** organization member_removed event */ - "webhook-organization-member-removed": { - /** @enum {string} */ - action: "member_removed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - membership: { - /** Format: uri */ - organization_url: string; - role: string; - state: string; - /** Format: uri */ - url: string; + } & { + active_lock_reason?: string | null; /** User */ - user: { + assignee: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -50986,39 +43160,102 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: 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; + 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"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** organization renamed event */ - "webhook-organization-renamed": { + /** issue_comment edited event */ + "webhook-issue-comment-edited": { /** @enum {string} */ - action: "renamed"; - changes?: { - login?: { - from?: string; - }; - }; + action: "edited"; + changes: components["schemas"]["webhooks_changes"]; + comment: components["schemas"]["webhooks_issue_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** - * Membership - * @description The membership between the user and the organization. Not present when the action is `member_invited`. - */ - membership?: { - /** Format: uri */ - organization_url: string; - role: string; - state: string; - /** Format: uri */ - url: string; + /** @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 */ - user: { + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51050,53 +43287,11 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - }; - organization: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Ruby Gems metadata */ - "webhook-rubygems-metadata": { - name?: string; - description?: string; - readme?: string; - homepage?: string; - version_info?: { - version?: string; - }; - platform?: string; - metadata?: { - [key: string]: string | undefined; - }; - repo?: string; - dependencies?: { - [key: string]: string | undefined; - }[]; - commit_oid?: string; - }; - /** package published event */ - "webhook-package-published": { - /** @enum {string} */ - action: "published"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description Information about the package. */ - package: { - created_at: string | null; - description: string | null; - ecosystem: string; - /** Format: uri */ - html_url: string; - id: number; - name: string; - namespace: string; - /** User */ - owner: { + assignees: ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51128,14 +43323,62 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null; - package_type: string; - package_version: { + } | 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; + /** + * 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 */ - author?: { + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51167,193 +43410,399 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - body?: string | Record; - body_html?: string; - container_metadata?: { - labels?: Record; - manifest?: Record; - tag?: { - digest?: string; - name?: string; - }; - } | null; - created_at?: string; - description: string; - docker_metadata?: { - tags?: string[]; - }[]; - draft?: boolean; + description: string | null; + /** Format: date-time */ + due_on: string | null; /** Format: uri */ html_url: string; id: number; - installation_command: string; - manifest?: string; - metadata: { - [key: string]: unknown; - }[]; + /** 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" | "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; - npm_metadata?: { - name?: string; - version?: string; - npm_user?: string; - author?: Record; - bugs?: Record; - dependencies?: Record; - dev_dependencies?: Record; - peer_dependencies?: Record; - optional_dependencies?: Record; - description?: string; - dist?: Record; - git_head?: string; - homepage?: string; - license?: string; - main?: string; - repository?: Record; - scripts?: Record; - id?: string; - node_version?: string; - npm_version?: string; - has_shrinkwrap?: boolean; - maintainers?: Record[]; - contributors?: Record[]; - engines?: Record; - keywords?: string[]; - files?: string[]; - bin?: Record; - man?: Record; - directories?: Record; - os?: string[]; - cpu?: string[]; - readme?: string; - installation_command?: string; - release_id?: number; - commit_oid?: string; - published_via_actions?: boolean; - deleted_by_id?: number; - } | null; - nuget_metadata?: { - id?: number | string; - name?: string; - value?: boolean | string | number | { - url?: string; - branch?: string; - commit?: string; - type?: string; - }; - }[] | null; - package_files: { - content_type: string; - created_at: string; + node_id: string; + /** User */ + owner: { /** Format: uri */ - download_url: string; - id: number; - md5: string | null; - name: string; - sha1: string | null; - sha256: string | null; - size: number; - state: string | null; - updated_at: string; - }[]; - package_url?: string; - prerelease?: boolean; - release?: { - /** User */ - author: { - /** 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; - created_at: string; - draft: boolean; + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; /** Format: uri */ - html_url: string; + 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; - name: string | null; - prerelease: boolean; - published_at: string; - tag_name: string; - target_commitish: string; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - url: string; + 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; + /** @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"; }; - rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - source_url?: string; - summary: string; - tag_name?: string; - target_commitish?: string; - target_oid?: string; - updated_at?: string; - version: string; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; } | null; - registry: { + 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; + "-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} + */ + 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; + 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; + } | 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 */ - about_url: string; - name: string; - type: string; + organizations_url?: string; /** Format: uri */ - url: string; - vendor: string; + 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; } | null; - updated_at: 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; + 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; + }; }; - repository?: components["schemas"]["repository-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** package updated event */ - "webhook-package-updated": { - /** @enum {string} */ - action: "updated"; + /** 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"]; + issue: components["schemas"]["webhooks_issue"]; organization?: components["schemas"]["organization-simple-webhooks"]; - /** @description Information about the package. */ - package: { - created_at: string; - description: string | null; - ecosystem: string; - /** Format: uri */ - html_url: string; - id: number; - name: string; - namespace: string; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** 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; /** User */ - owner: { + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51385,14 +43834,98 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - package_type: string; - package_version: { + 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; + } | 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; + /** + * 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 */ - author: { + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51424,130 +43957,217 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - body: string; - body_html: string; - created_at: string; - description: string; - docker_metadata?: { - tags?: string[]; - }[]; - draft?: boolean; + description: string | null; + /** Format: date-time */ + due_on: string | null; /** Format: uri */ html_url: string; id: number; - installation_command: string; - manifest?: string; - metadata: { - [key: string]: unknown; - }[]; + /** 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" | "security_and_analysis" | "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; - package_files: { - content_type: string; - created_at: string; + node_id: string; + /** User */ + owner: { /** Format: uri */ - download_url: string; - id: number; - md5: string | null; - name: string; - sha1: string | null; - sha256: string; - size: number; - state: string; - updated_at: string; - }[]; - package_url?: string; - prerelease?: boolean; - release?: { - /** User */ - author: { - /** 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; - created_at: string; - draft: boolean; + avatar_url?: string; + deleted?: boolean; + email?: string | null; + /** Format: uri-template */ + events_url?: string; /** Format: uri */ - html_url: string; + 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; - name: string; - prerelease: boolean; - published_at: string; - tag_name: string; - target_commitish: string; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - url: string; + 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; + /** @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"; }; - rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { /** Format: uri */ - source_url?: string; - summary: string; - tag_name?: string; - target_commitish: string; - target_oid: string; - updated_at: string; - version: string; - }; - registry: { + diff_url?: string; /** Format: uri */ - about_url: string; - name: string; - type: string; + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; + /** Format: uri */ + url?: string; + }; + /** 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; - vendor: string; - } | null; - updated_at: string; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** page_build event */ - "webhook-page-build": { - /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ - build: { - commit: string | null; - created_at: string; - duration: number; - error: { - message: string | null; }; + /** 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 */ - pusher: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51579,137 +44199,89 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - status: string; - updated_at: string; - /** Format: uri */ - url: string; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - id: number; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** personal_access_token_request approved event */ - "webhook-personal-access-token-request-approved": { - /** @enum {string} */ - action: "approved"; - personal_access_token_request: components["schemas"]["personal-access-token-request"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; - }; - /** personal_access_token_request cancelled event */ - "webhook-personal-access-token-request-cancelled": { - /** @enum {string} */ - action: "cancelled"; - personal_access_token_request: components["schemas"]["personal-access-token-request"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; - }; - /** personal_access_token_request created event */ - "webhook-personal-access-token-request-created": { - /** @enum {string} */ - action: "created"; - personal_access_token_request: components["schemas"]["personal-access-token-request"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; - }; - /** personal_access_token_request denied event */ - "webhook-personal-access-token-request-denied": { - /** @enum {string} */ - action: "denied"; - personal_access_token_request: components["schemas"]["personal-access-token-request"]; - organization: components["schemas"]["organization-simple-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - installation: components["schemas"]["simple-installation"]; - }; - "webhook-ping": { - /** - * Webhook - * @description The webhook that is being pinged - */ - hook?: { - /** @description Determines whether the hook is actually triggered for the events it subscribes to. */ - active: boolean; - /** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */ - app_id?: number; - config: { - content_type?: components["schemas"]["webhook-config-content-type"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - secret?: components["schemas"]["webhook-config-secret"]; - url?: components["schemas"]["webhook-config-url"]; + } & { + 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; }; - /** Format: date-time */ - created_at: string; - /** Format: uri */ - deliveries_url?: string; - /** @description Determines what events the hook is triggered for. Default: ['push']. */ - events: string[]; - /** @description Unique identifier of the webhook. */ - id: number; - last_response?: components["schemas"]["hook-response"]; - /** - * @description The type of webhook. The only valid value is 'web'. - * @enum {string} - */ - name: "web"; - /** Format: uri */ - ping_url?: string; - /** Format: uri */ - test_url?: string; - type: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ + 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; + 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; + }; }; - /** @description The ID of the webhook that triggered the ping. */ - hook_id?: number; organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - /** @description Random string of GitHub zen. */ - zen?: string; - }; - /** @description The webhooks ping payload encoded with URL encoding. */ - "webhook-ping-form-encoded": { - /** @description A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. */ - payload: string; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** project_card converted event */ - "webhook-project-card-converted": { + /** issues deleted event */ + "webhook-issues-deleted": { /** @enum {string} */ - action: "converted"; - changes: { - note: { - from: string; - }; - }; + action: "deleted"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - project_card: { - after_id?: number | null; - /** @description Whether or not the card is archived */ - archived: boolean; - column_id: number; - /** Format: uri */ - column_url: string; - /** Format: uri */ - content_url?: string; - /** Format: date-time */ - created_at: string; + /** + * 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 */ - creator: { + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51745,41 +44317,336 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** @description The project card's ID */ + 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; + }[]; + /** 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"; + /** Format: uri */ + url?: 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; - note: string | null; + 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; + } | 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"; + /** @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; + }; + /** 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 */ - project_url: string; + 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 */ + /** + * Format: uri + * @description URL for the issue + */ url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_card created event */ - "webhook-project-card-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - project_card: { - after_id?: number | null; - /** @description Whether or not the card is archived */ - archived: boolean; - column_id: number; - /** Format: uri */ - column_url: string; - /** Format: uri */ - content_url?: string; - /** Format: date-time */ - created_at: string; /** User */ - creator: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51815,41 +44682,26 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** @description The project card's ID */ - id: number; - node_id: string; - note: string | null; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; }; - repository?: components["schemas"]["repository-webhooks"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** project_card deleted event */ - "webhook-project-card-deleted": { + /** issues demilestoned event */ + "webhook-issues-demilestoned": { /** @enum {string} */ - action: "deleted"; + action: "demilestoned"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - project_card: { - after_id?: number | null; - /** @description Whether or not the card is archived */ - archived: boolean; - column_id: number | null; - /** Format: uri */ - column_url: string; - /** Format: uri */ - content_url?: string; - /** Format: date-time */ - created_at: string; + /** + * 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 */ - creator: { + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51885,46 +44737,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** @description The project card's ID */ - id: number; - node_id: string; - note: string | null; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["nullable-repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_card edited event */ - "webhook-project-card-edited": { - /** @enum {string} */ - action: "edited"; - changes: { - note: { - from: string | null; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Card */ - project_card: { - after_id?: number | null; - /** @description Whether or not the card is archived */ - archived: boolean; - column_id: number; - /** Format: uri */ - column_url: string; - /** Format: uri */ - content_url?: string; - /** Format: date-time */ - created_at: string; - /** User */ - creator: { + assignees: ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -51956,147 +44769,304 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null; - /** @description The project card's ID */ - id: number; - node_id: string; - note: string | null; - /** Format: uri */ - project_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 */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_card moved event */ - "webhook-project-card-moved": { - /** @enum {string} */ - action: "moved"; - changes?: { - column_id: { - from: number; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - project_card: { - after_id?: number | null; - /** @description Whether or not the card is archived */ - archived: boolean; - column_id: number; - /** Format: uri */ - column_url: string; + closed_at: string | null; + comments: number; /** Format: uri */ - content_url?: string; + comments_url: string; /** Format: date-time */ created_at: string; - /** User */ - creator: { + 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; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; - /** Format: uri-template */ - events_url?: string; + html_url: string; + id: number; /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; + 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 */ - html_url?: string; - id: number; - login: string; - name?: string; - node_id?: string; + 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")[]; /** Format: uri */ - organizations_url?: string; + external_url: string | null; /** Format: uri */ - received_events_url?: string; + 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; + } | 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 */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; + diff_url?: string; /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; + /** Format: uri */ + patch_url?: string; /** Format: uri */ url?: string; - } | null; - /** @description The project card's ID */ - id: number; - node_id: string; - note: string | null; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; + }; + /** 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 */ - url: string; - } & { - after_id: number | null; - archived?: boolean; - column_id?: number; - column_url?: string; - created_at?: string; - creator?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - } | null; - id?: number; - node_id?: string; - note?: string | null; - project_url?: string; - updated_at?: string; - url?: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project closed event */ - "webhook-project-closed": { - /** @enum {string} */ - action: "closed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - project: { - /** @description Body of the project */ - body: string | null; + repository_url: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - columns_url: string; + timeline_url?: string; + /** @description Title of the issue */ + title: string; /** Format: date-time */ - created_at: string; + updated_at: string; + /** + * Format: uri + * @description URL for the issue + */ + url: string; /** User */ - creator: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -52128,170 +45098,42 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - /** Format: uri */ - html_url: string; - id: number; - /** @description Name of the project */ - name: string; - node_id: string; - number: number; - /** Format: uri */ - owner_url: string; - /** - * @description State of the project; either 'open' or 'closed' - * @enum {string} - */ - state: "open" | "closed"; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project_column created event */ - "webhook-project-column-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - project_column: { - after_id?: number | null; - /** Format: uri */ - cards_url: string; - /** Format: date-time */ - created_at: string; - /** @description The unique identifier of the project column */ - id: number; - /** @description Name of the project column */ - name: string; - node_id: string; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; }; - repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** project_column deleted event */ - "webhook-project-column-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; + milestone?: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - project_column: { - after_id?: number | null; - /** Format: uri */ - cards_url: string; - /** Format: date-time */ - created_at: string; - /** @description The unique identifier of the project column */ - id: number; - /** @description Name of the project column */ - name: string; - node_id: string; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** project_column edited event */ - "webhook-project-column-edited": { + /** issues edited event */ + "webhook-issues-edited": { /** @enum {string} */ action: "edited"; + /** @description The changes to the issue. */ changes: { - name?: { + 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"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - project_column: { - after_id?: number | null; - /** Format: uri */ - cards_url: string; - /** Format: date-time */ - created_at: string; - /** @description The unique identifier of the project column */ - id: number; - /** @description Name of the project column */ - name: string; - node_id: string; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** project_column moved event */ - "webhook-project-column-moved": { - /** @enum {string} */ - action: "moved"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project Column */ - project_column: { - after_id?: number | null; - /** Format: uri */ - cards_url: string; - /** Format: date-time */ - created_at: string; - /** @description The unique identifier of the project column */ - id: number; - /** @description Name of the project column */ - name: string; - node_id: string; - /** Format: uri */ - project_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project created event */ - "webhook-project-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - project: { - /** @description Body of the project */ - body: string | null; - /** Format: uri */ - columns_url: string; - /** Format: date-time */ - created_at: string; + /** + * 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 */ - creator: { + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -52323,49 +45165,340 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** 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" | "Mannequin"; + /** 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; - /** @description Name of the project */ - name: string; + 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; + /** + * 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; + } | 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" | "security_and_analysis" | "pull_request_review_thread" | "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; + } | 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; + }; + /** 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 */ - owner_url: string; + repository_url: string; /** - * @description State of the project; either 'open' or 'closed' + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - state: "open" | "closed"; + 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 */ + /** + * Format: uri + * @description URL for the issue + */ url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** project deleted event */ - "webhook-project-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - project: { - /** @description Body of the project */ - body: string | null; - /** Format: uri */ - columns_url: string; - /** Format: date-time */ - created_at: string; /** User */ - creator: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -52397,60 +45530,31 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - /** Format: uri */ - html_url: string; - id: number; - /** @description Name of the project */ - name: string; - node_id: string; - number: number; - /** Format: uri */ - owner_url: string; - /** - * @description State of the project; either 'open' or 'closed' - * @enum {string} - */ - state: "open" | "closed"; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; }; - repository?: components["schemas"]["nullable-repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + label?: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** project edited event */ - "webhook-project-edited": { + /** issues labeled event */ + "webhook-issues-labeled": { /** @enum {string} */ - action: "edited"; - /** @description The changes to the project if the action was `edited`. */ - changes?: { - body?: { - /** @description The previous version of the body if the action was `edited`. */ - from: string; - }; - name?: { - /** @description The changes to the project if the action was `edited`. */ - from: string; - }; - }; + action: "labeled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - project: { - /** @description Body of the project */ - body: string | null; - /** Format: uri */ - columns_url: string; - /** Format: date-time */ - created_at: string; + /** + * 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 */ - creator: { + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -52482,49 +45586,11 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - /** Format: uri */ - html_url: string; - id: number; - /** @description Name of the project */ - name: string; - node_id: string; - number: number; - /** Format: uri */ - owner_url: string; - /** - * @description State of the project; either 'open' or 'closed' - * @enum {string} - */ - state: "open" | "closed"; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** project reopened event */ - "webhook-project-reopened": { - /** @enum {string} */ - action: "reopened"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Project */ - project: { - /** @description Body of the project */ - body: string | null; - /** Format: uri */ - columns_url: string; - /** Format: date-time */ - created_at: string; - /** User */ - creator: { + assignees: ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -52556,300 +45622,360 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null; + } | 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; - /** @description Name of the project */ - name: string; + 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; + /** + * 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; + } | 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" | "pull_request_review_thread" | "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; + } | 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; + }; + /** 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 */ - owner_url: string; + repository_url: string; /** - * @description State of the project; either 'open' or 'closed' + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ - state: "open" | "closed"; + 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 */ + /** + * 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; + 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; + } | null; }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Closed Event */ - "webhook-projects-v2-project-closed": { - /** @enum {string} */ - action: "closed"; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** @description A project was created */ - "webhook-projects-v2-project-created": { - /** @enum {string} */ - action: "created"; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Deleted Event */ - "webhook-projects-v2-project-deleted": { - /** @enum {string} */ - action: "deleted"; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Edited Event */ - "webhook-projects-v2-project-edited": { - /** @enum {string} */ - action: "edited"; - changes: { - description?: { - from?: string | null; - to?: string | null; - }; - public?: { - from?: boolean; - to?: boolean; - }; - short_description?: { - from?: string | null; - to?: string | null; - }; - title?: { - from?: string; - to?: string; - }; - }; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Archived Event */ - "webhook-projects-v2-item-archived": { - /** @enum {string} */ - action: "archived"; - changes: { - archived_at?: { - /** Format: date-time */ - from?: string | null; - /** Format: date-time */ - to?: string | null; - }; - }; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Converted Event */ - "webhook-projects-v2-item-converted": { - /** @enum {string} */ - action: "converted"; - changes: { - content_type?: { - from?: string | null; - to?: string; - }; - }; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Created Event */ - "webhook-projects-v2-item-created": { - /** @enum {string} */ - action: "created"; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Deleted Event */ - "webhook-projects-v2-item-deleted": { - /** @enum {string} */ - action: "deleted"; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Edited Event */ - "webhook-projects-v2-item-edited": { - /** @enum {string} */ - action: "edited"; - changes?: { - field_value: { - field_node_id?: string; - field_type?: string; - }; - } | { - body: { - from?: string | null; - to?: string | null; - }; - }; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Reordered Event */ - "webhook-projects-v2-item-reordered": { - /** @enum {string} */ - action: "reordered"; - changes: { - previous_projects_v2_item_node_id?: { - from?: string | null; - to?: string | null; - }; - }; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Item Restored Event */ - "webhook-projects-v2-item-restored": { - /** @enum {string} */ - action: "restored"; - changes: { - archived_at?: { - /** Format: date-time */ - from?: string | null; - /** Format: date-time */ - to?: string | null; - }; - }; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2_item: components["schemas"]["projects-v2-item"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Projects v2 Project Reopened Event */ - "webhook-projects-v2-project-reopened": { - /** @enum {string} */ - action: "reopened"; - installation?: components["schemas"]["simple-installation"]; - organization: components["schemas"]["organization-simple-webhooks"]; - projects_v2: components["schemas"]["projects-v2"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** public event */ - "webhook-public": { - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; + label?: components["schemas"]["webhooks_label"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request assigned event */ - "webhook-pull-request-assigned": { + /** issues locked event */ + "webhook-issues-locked": { /** @enum {string} */ - action: "assigned"; - /** 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; + action: "locked"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; - }; - }; + /** + * 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; - additions?: number; /** User */ - assignee: { + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -52881,7 +46007,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -52917,7 +46043,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -52927,345 +46053,53 @@ export interface components { * @enum {string} */ author_association: "COLLABORATOR" | "CONTRIBUTOR" | "FIRST_TIMER" | "FIRST_TIME_CONTRIBUTOR" | "MANNEQUIN" | "MEMBER" | "NONE" | "OWNER"; - /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. - */ - auto_merge: { - /** @description Commit message for the merge commit. */ - commit_message: string | null; - /** @description Title for the merge commit message. */ - commit_title: string | null; - /** User */ - enabled_by: { - /** 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; - /** - * @description The merge method to use. - * @enum {string} - */ - merge_method: "merge" | "squash" | "rebase"; - } | null; - base: { - label: string; - ref: string; + /** @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; /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: (number | string) | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: string; + * Format: uri + * @description URL for the label + */ + url: string; + } | null)[]; + /** Format: uri-template */ + labels_url: string; + /** @enum {boolean} */ + locked: true; + /** + * 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 */ - user: { + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -53301,311 +46135,53 @@ export interface components { /** Format: uri */ url?: string; } | null; - }; - body: string | null; - changed_files?: number; - /** Format: date-time */ - closed_at: string | null; - comments?: number; - /** Format: uri */ - comments_url: string; - commits?: number; - /** Format: uri */ - commits_url: string; - /** Format: date-time */ - created_at: string; - deletions?: number; - /** Format: uri */ - diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - draft: boolean; - head: { - label: string | null; - ref: string; + 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; /** - * Repository - * @description A git repository + * @description The state of the milestone. + * @enum {string} */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: (number | string) | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - } | null; - sha: 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" | "security_and_analysis")[]; + /** 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 */ - user: { + owner: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -53641,38 +46217,186 @@ export interface components { /** Format: uri */ url?: 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"; + /** @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; + }; + /** 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 */ - html_url: string; - id: number; + repository_url: string; + /** + * @description State of the issue; either 'open' or 'closed' + * @enum {string} + */ + state?: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - issue_url: string; - labels: { - /** @description 6-character hex code, without the leading #, identifying the color */ - color: string; - default: boolean; - description: string | null; + 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; id: number; - /** @description The name of the label. */ - name: string; - node_id: string; - /** - * Format: uri - * @description URL for the label - */ - url: string; - }[]; - locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; - merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ - merged_at: string | null; + 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; + }; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** 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 */ - merged_by?: { + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -53708,6 +46432,82 @@ export interface components { /** 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. @@ -53780,300 +46580,188 @@ export interface components { url: string; } | null; node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ - patch_url: string; - rebaseable?: boolean | null; - requested_reviewers: (({ - /** 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; - } | null) | { - deleted?: boolean; - /** @description Description of the team */ + /** + * 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 team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ name: string; node_id: string; - parent?: { - /** @description Description of the team */ - description: string | null; + /** User */ + owner: { /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + events_url?: string; /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - })[]; - requested_teams: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ + 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 */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; + url?: string; } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }[]; - /** Format: uri-template */ - review_comment_url: string; - review_comments?: number; - /** Format: uri */ - review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - state: "open" | "closed"; - /** Format: uri */ - statuses_url: string; - /** @description The title of the pull request. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - 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; - 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; - } | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request auto_merge_disabled event */ - "webhook-pull-request-auto-merge-disabled": { - /** @enum {string} */ - action: "auto_merge_disabled"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; + /** @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"; }; - }; - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; - /** 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; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { /** Format: uri */ - received_events_url?: string; + diff_url?: string; /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + patch_url?: string; /** Format: uri */ url?: string; - } | null; - assignees: ({ + }; + /** 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} + */ + 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; @@ -54108,24 +46796,27 @@ export interface components { 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"; + } | null; + }; + milestone: components["schemas"]["webhooks_milestone"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues opened event */ + "webhook-issues-opened": { + /** @enum {string} */ + action: "opened"; + changes?: { /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - auto_merge: { - /** @description Commit message for the merge commit. */ - commit_message: string | null; - /** @description Title for the merge commit message. */ - commit_title: string | null; + old_issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - enabled_by: { + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -54161,299 +46852,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** - * @description The merge method to use. - * @enum {string} - */ - merge_method: "merge" | "squash" | "rebase"; - } | null; - base: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: (number | string) | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: string; - /** User */ - user: { + assignees: ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -54485,205 +46884,142 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - }; - body: string | null; - changed_files?: number; - /** Format: date-time */ - closed_at: string | null; - comments?: number; - /** Format: uri */ - comments_url: string; - commits?: number; - /** Format: uri */ - commits_url: string; - /** Format: date-time */ - created_at: string; - deletions?: number; - /** Format: uri */ - diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - draft: boolean; - head: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; + 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; /** - * @description Whether discussions are enabled. - * @default false + * Format: uri + * @description URL for the label */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; + url: string; + }[]; + /** 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"; + /** Format: uri */ + url?: string; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @description The state of the milestone. * @enum {string} */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; + 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")[]; /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ + 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; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; /** User */ owner: { /** Format: uri */ @@ -54721,79 +47057,327 @@ export interface components { /** Format: uri */ url?: string; } | null; + /** @description The set of permissions for the GitHub app */ permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; + /** @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"; + /** @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 Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: (number | string) | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { /** Format: uri */ - stargazers_url: string; + 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; + "-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} + */ + 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 */ - statuses_url: string; + events_url?: string; /** Format: uri */ - subscribers_url: string; + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - subscription_url: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - svn_url: string; + organizations_url?: string; /** Format: uri */ - tags_url: string; + received_events_url?: string; /** Format: uri */ - teams_url: string; - topics: string[]; + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + } | null; + /** + * Repository + * @description A git repository + */ + old_repository: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** @description Whether the repository has discussions enabled. */ + has_discussions?: boolean; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: string; + url: string | null; + } | null; + master_branch?: string; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - user: { + owner: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -54829,13 +47413,160 @@ export interface components { /** Format: uri */ url?: string; } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: (number | string) | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require commit signoff. */ + web_commit_signoff_required?: boolean; }; + }; + 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; - /** Format: uri */ - issue_url: string; - labels: { + labels?: { /** @description 6-character hex code, without the leading #, identifying the color */ color: string; default: boolean; @@ -54850,17 +47581,329 @@ export interface components { */ url: string; }[]; - locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; - merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | 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; + } | 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" | "security_and_analysis" | "pull_request_review_thread" | "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; + } | 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; + }; + /** 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} + */ + state?: "open" | "closed"; + state_reason?: string | null; + /** Format: uri */ + timeline_url?: string; + /** @description Title of the issue */ + title: string; /** Format: date-time */ - merged_at: string | null; + 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; + 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; + }; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues pinned event */ + "webhook-issues-pinned": { + /** @enum {string} */ + action: "pinned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue_2"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues reopened event */ + "webhook-issues-reopened": { + /** @enum {string} */ + action: "reopened"; + 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 */ - merged_by?: { + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -54896,6 +47939,82 @@ export interface components { /** 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" | "Mannequin"; + /** 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. @@ -54939,7 +48058,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; @@ -54968,165 +48087,185 @@ export interface components { url: string; } | null; node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ number: number; - /** Format: uri */ - patch_url: string; - rebaseable?: boolean | null; - requested_reviewers: (({ - /** 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; - } | null) | { - deleted?: boolean; - /** @description Description of the team */ + /** + * 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" | "pull_request_review_thread" | "reminder")[]; + /** Format: uri */ + external_url: string | null; /** Format: uri */ html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ + /** @description Unique identifier of the GitHub app */ + id: number | null; + /** @description The name of the GitHub app */ name: string; node_id: string; - parent?: { - /** @description Description of the team */ - description: string | null; + /** User */ + owner: { /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + events_url?: string; /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - })[]; - requested_teams: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ + 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 */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; + url?: string; } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; + /** @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: uri - * @description URL for the team - */ + /** 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; - }[]; - /** Format: uri-template */ - review_comment_url: string; - review_comments?: 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 */ - review_comments_url: string; + repository_url: string; /** - * @description State of this Pull Request. Either `open` or `closed`. + * @description State of the issue; either 'open' or 'closed' * @enum {string} */ state: "open" | "closed"; + state_reason?: string | null; /** Format: uri */ - statuses_url: string; - /** @description The title of the pull request. */ + timeline_url?: string; + /** @description Title of the issue */ title: string; /** Format: date-time */ updated_at: string; - /** Format: uri */ + /** + * Format: uri + * @description URL for the issue + */ url: string; /** User */ user: { @@ -55160,161 +48299,30 @@ export interface components { starred_url?: string; /** Format: uri */ subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; - /** Format: uri */ - url?: string; - } | null; - }; - reason: string; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request auto_merge_enabled event */ - "webhook-pull-request-auto-merge-enabled": { - /** @enum {string} */ - action: "auto_merge_enabled"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; - }; - }; - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; - /** 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"; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization" | "Mannequin"; + /** Format: uri */ + url?: string; + } | null; + }; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues transferred event */ + "webhook-issues-transferred": { + /** @enum {string} */ + action: "transferred"; + changes: { /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. + * Issue + * @description The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. */ - auto_merge: { - /** @description Commit message for the merge commit. */ - commit_message: string | null; - /** @description Title for the merge commit message. */ - commit_title: string | null; + new_issue: { + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; /** User */ - enabled_by: { + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -55350,299 +48358,7 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** - * @description The merge method to use. - * @enum {string} - */ - merge_method: "merge" | "squash" | "rebase"; - } | null; - base: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: (number | string) | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: string; - /** User */ - user: { + assignees: ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -55677,202 +48393,139 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null; - }; - body: string | null; - changed_files?: number; - /** Format: date-time */ - closed_at: string | null; - comments?: number; - /** Format: uri */ - comments_url: string; - commits?: number; - /** Format: uri */ - commits_url: string; - /** Format: date-time */ - created_at: string; - deletions?: number; - /** Format: uri */ - diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - draft: boolean; - head: { - label: string; - ref: string; + } | null)[]; /** - * Repository - * @description A git repository + * AuthorAssociation + * @description How the author is associated with the repository. + * @enum {string} */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: 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; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; + id: number; + /** @description The name of the label. */ + name: string; + node_id: string; /** - * @description Whether discussions are enabled. - * @default false + * Format: uri + * @description URL for the label */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; + url: string; + }[]; + /** 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"; + /** Format: uri */ + url?: string; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + labels_url: string; + node_id: string; + /** @description The number of the milestone. */ + number: number; + open_issues: number; /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @description The state of the milestone. * @enum {string} */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + state: "open" | "closed"; + /** @description The title of the milestone. */ + title: string; + /** Format: date-time */ + updated_at: string; /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; + 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")[]; /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ + 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; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; /** User */ owner: { /** Format: uri */ @@ -55910,77 +48563,129 @@ export interface components { /** Format: uri */ url?: string; } | null; + /** @description The set of permissions for the GitHub app */ permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; + /** @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"; + /** @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 Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: (number | string) | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; + /** @description The slug name of the GitHub app */ + slug?: string; + /** Format: date-time */ + updated_at: string | null; + } | null; + pull_request?: { /** Format: uri */ - subscription_url: string; + diff_url?: string; /** Format: uri */ - svn_url: string; + html_url?: string; + /** Format: date-time */ + merged_at?: string | null; /** Format: uri */ - tags_url: string; + patch_url?: string; /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; + url?: string; + }; + /** 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; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; }; - sha: string; + /** 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 */ @@ -56019,37 +48724,302 @@ export interface components { url?: string; } | null; }; - /** Format: uri */ - html_url: string; - id: number; - /** Format: uri */ - issue_url: string; - labels: { - /** @description 6-character hex code, without the leading #, identifying the color */ - color: string; - default: boolean; + /** + * Repository + * @description A git repository + */ + new_repository: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; + }; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ id: number; - /** @description The name of the label. */ + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ name: string; node_id: string; - /** - * Format: uri - * @description URL for the label - */ + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: 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; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: (number | string) | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ url: string; - }[]; - locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; - merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ - merged_at: string | null; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue_2"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues unassigned event */ + "webhook-issues-unassigned": { + /** + * @description The action that was performed. + * @enum {string} + */ + action: "unassigned"; + assignee?: components["schemas"]["webhooks_user_mannequin"]; + 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-webhooks"]; + }; + /** issues unlabeled event */ + "webhook-issues-unlabeled": { + /** @enum {string} */ + action: "unlabeled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue"]; + label?: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues unlocked event */ + "webhook-issues-unlocked": { + /** @enum {string} */ + action: "unlocked"; + 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 */ - merged_by?: { + assignee?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -56085,6 +49055,83 @@ export interface components { /** 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; + /** @enum {boolean} */ + locked: false; /** * Milestone * @description A collection of related issues and pull requests. @@ -56128,7 +49175,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -56157,12 +49204,188 @@ export interface components { url: string; } | null; node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ 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")[]; + /** 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; + } | 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"; + /** @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; + }; + /** 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 */ - patch_url: string; - rebaseable?: boolean | null; - requested_reviewers: (({ + 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; @@ -56194,387 +49417,567 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null) | { - deleted?: boolean; - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ + } | null; + }; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** issues unpinned event */ + "webhook-issues-unpinned": { + /** @enum {string} */ + action: "unpinned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + issue: components["schemas"]["webhooks_issue_2"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** label created event */ + "webhook-label-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** label deleted event */ + "webhook-label-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** label edited event */ + "webhook-label-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the label if the action was `edited`. */ + changes?: { + color?: { + /** @description The previous version of the color if the action was `edited`. */ + from: string; + }; + description?: { + /** @description The previous version of the description if the action was `edited`. */ + from: string; + }; + name?: { + /** @description The previous version of the name if the action was `edited`. */ + from: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + label: components["schemas"]["webhooks_label"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase cancelled event */ + "webhook-marketplace-purchase-cancelled": { + /** @enum {string} */ + action: "cancelled"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase changed event */ + "webhook-marketplace-purchase-changed": { + /** @enum {string} */ + action: "changed"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** Marketplace Purchase */ + previous_marketplace_purchase?: { + account: { id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: string | null; + next_billing_date?: string | null; + on_free_trial: boolean | null; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; name: string; + /** @enum {string} */ + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; + }; + unit_count: number; + }; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase pending_change event */ + "webhook-marketplace-purchase-pending-change": { + /** @enum {string} */ + action: "pending_change"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** Marketplace Purchase */ + previous_marketplace_purchase?: { + account: { + id: number; + login: string; node_id: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: string | null; + next_billing_date?: string | null; + on_free_trial: boolean; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; + name: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - })[]; - requested_teams: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; + }; + unit_count: number; + }; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase pending_change_cancelled event */ + "webhook-marketplace-purchase-pending-change-cancelled": { + /** @enum {string} */ + action: "pending_change_cancelled"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** Marketplace Purchase */ + marketplace_purchase: { + account: { id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ + login: string; + node_id: string; + organization_billing_email: string | null; + type: string; + }; + billing_cycle: string; + free_trial_ends_on: unknown; + next_billing_date: string | null; + on_free_trial: boolean; + plan: { + bullets: string[]; + description: string; + has_free_trial: boolean; + id: number; + monthly_price_in_cents: number; name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }[]; + price_model: "FREE" | "FLAT_RATE" | "PER_UNIT"; + unit_name: string | null; + yearly_price_in_cents: number; + }; + unit_count: number; + }; + organization?: components["schemas"]["organization-simple-webhooks"]; + previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** marketplace_purchase purchased event */ + "webhook-marketplace-purchase-purchased": { + /** @enum {string} */ + action: "purchased"; + effective_date: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + marketplace_purchase: components["schemas"]["webhooks_marketplace_purchase"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + previous_marketplace_purchase?: components["schemas"]["webhooks_previous_marketplace_purchase"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member added event */ + "webhook-member-added": { + /** @enum {string} */ + action: "added"; + changes?: { + /** @description This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + * role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + * assigned to the collaborator, use the `role_name` field instead, which will provide the full + * role name, including custom roles. */ + permission?: { + /** @enum {string} */ + to: "write" | "admin" | "read"; + }; + /** @description The role assigned to the collaborator. */ + role_name?: { + to: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member edited event */ + "webhook-member-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the collaborator permissions */ + changes: { + old_permission?: { + /** @description The previous permissions of the collaborator if the action was edited. */ + from: string; + }; + permission?: { + from?: string | null; + to?: string | null; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** member removed event */ + "webhook-member-removed": { + /** @enum {string} */ + action: "removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** membership added event */ + "webhook-membership-added": { + /** @enum {string} */ + action: "added"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + /** + * @description The scope of the membership. Currently, can only be `team`. + * @enum {string} + */ + scope: "team"; + /** User */ + sender: { + /** Format: uri */ + avatar_url?: string; + deleted?: boolean; + email?: string | null; /** Format: uri-template */ - review_comment_url: string; - review_comments?: number; + events_url?: string; /** Format: uri */ - review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - state: "open" | "closed"; + followers_url?: string; + /** Format: uri-template */ + following_url?: string; + /** Format: uri-template */ + gists_url?: string; + gravatar_id?: string; /** Format: uri */ - statuses_url: string; - /** @description The title of the pull request. */ - title: string; - /** Format: date-time */ - updated_at: string; + html_url?: string; + id: number; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - 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; - 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; + 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; + team: components["schemas"]["webhooks_team"]; + }; + /** membership removed event */ + "webhook-membership-removed": { + /** @enum {string} */ + action: "removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + member: components["schemas"]["webhooks_user"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + /** + * @description The scope of the membership. Currently, can only be `team`. + * @enum {string} + */ + scope: "team" | "organization"; + /** User */ + sender: { + /** 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; + team: components["schemas"]["webhooks_team"]; + }; + "webhook-merge-group-checks-requested": { + /** @enum {string} */ + action: "checks_requested"; + installation?: components["schemas"]["simple-installation"]; + merge_group: components["schemas"]["merge-group"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + "webhook-merge-group-destroyed": { + /** @enum {string} */ + action: "destroyed"; + /** + * @description Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated). + * @enum {string} + */ + reason?: "merged" | "invalidated" | "dequeued"; + installation?: components["schemas"]["simple-installation"]; + merge_group: components["schemas"]["merge-group"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** meta deleted event */ + "webhook-meta-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @description The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. */ + hook: { + active: boolean; + config: { /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + content_type: "json" | "form"; + insecure_ssl: string; + secret?: string; /** Format: uri */ - url?: string; - } | null; + url: string; + }; + created_at: string; + events: ("*" | "branch_protection_rule" | "check_run" | "check_suite" | "code_scanning_alert" | "commit_comment" | "create" | "delete" | "deployment" | "deployment_status" | "deploy_key" | "discussion" | "discussion_comment" | "fork" | "gollum" | "issues" | "issue_comment" | "label" | "member" | "membership" | "meta" | "milestone" | "organization" | "org_block" | "package" | "page_build" | "project" | "project_card" | "project_column" | "public" | "pull_request" | "pull_request_review" | "pull_request_review_comment" | "pull_request_review_thread" | "push" | "registry_package" | "release" | "repository" | "repository_import" | "repository_vulnerability_alert" | "secret_scanning_alert" | "secret_scanning_alert_location" | "security_and_analysis" | "star" | "status" | "team" | "team_add" | "watch" | "workflow_job" | "workflow_run" | "repository_dispatch" | "projects_v2_item")[]; + id: number; + name: string; + type: string; + updated_at: string; }; - reason?: string; + /** @description The id of the modified webhook. */ + hook_id: number; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["nullable-repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** milestone closed event */ + "webhook-milestone-closed": { + /** @enum {string} */ + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone"]; + organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request closed event */ - "webhook-pull-request-closed": { + /** milestone created event */ + "webhook-milestone-created": { /** @enum {string} */ - action: "closed"; + action: "created"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; + milestone: components["schemas"]["webhooks_milestone_3"]; organization?: components["schemas"]["organization-simple-webhooks"]; - pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - use_squash_pr_title_as_default: boolean; - }; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request converted_to_draft event */ - "webhook-pull-request-converted-to-draft": { + /** milestone deleted event */ + "webhook-milestone-deleted": { /** @enum {string} */ - action: "converted_to_draft"; + action: "deleted"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; + milestone: components["schemas"]["webhooks_milestone"]; organization?: components["schemas"]["organization-simple-webhooks"]; - pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - use_squash_pr_title_as_default: boolean; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** milestone edited event */ + "webhook-milestone-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the milestone if the action was `edited`. */ + changes: { + description?: { + /** @description The previous version of the description if the action was `edited`. */ + from: string; + }; + due_on?: { + /** @description The previous version of the due date if the action was `edited`. */ + from: string; + }; + title?: { + /** @description The previous version of the title if the action was `edited`. */ + from: string; + }; }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** milestone opened event */ + "webhook-milestone-opened": { + /** @enum {string} */ + action: "opened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + milestone: components["schemas"]["webhooks_milestone_3"]; + organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request demilestoned event */ - "webhook-pull-request-demilestoned": { + /** org_block blocked event */ + "webhook-org-block-blocked": { + /** @enum {string} */ + action: "blocked"; + blocked_user: components["schemas"]["webhooks_user"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** org_block unblocked event */ + "webhook-org-block-unblocked": { /** @enum {string} */ - action: "demilestoned"; + action: "unblocked"; + blocked_user: components["schemas"]["webhooks_user"]; enterprise?: components["schemas"]["enterprise-webhooks"]; - milestone?: components["schemas"]["milestone"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; - }; - }; - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization deleted event */ + "webhook-organization-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership?: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization member_added event */ + "webhook-organization-member-added": { + /** @enum {string} */ + action: "member_added"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization member_invited event */ + "webhook-organization-member-invited": { + /** @enum {string} */ + action: "member_invited"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + /** @description The invitation for the user or email if the action is `member_invited`. */ + invitation: { + /** Format: date-time */ + created_at: string; + email: string | null; + /** Format: date-time */ + failed_at: string | null; + failed_reason: string | null; + id: number; + /** Format: uri */ + invitation_teams_url: string; /** 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; - } | null; - assignees: ({ + inviter: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -56606,355 +50009,125 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + 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"; - /** - * PullRequestAutoMerge - * @description The status of auto merging a pull request. - */ - auto_merge: { - /** @description Commit message for the merge commit. */ - commit_message: string | null; - /** @description Title for the merge commit message. */ - commit_title: string | null; - /** User */ - enabled_by: { - /** 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; - /** - * @description The merge method to use. - * @enum {string} - */ - merge_method: "merge" | "squash" | "rebase"; } | null; - base: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ - id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: 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; - } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: (number | string) | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sha: string; + login: string | null; + node_id: string; + role: string; + team_count: number; + invitation_source?: string; + }; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + user?: components["schemas"]["webhooks_user"]; + }; + /** organization member_removed event */ + "webhook-organization-member-removed": { + /** @enum {string} */ + action: "member_removed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** organization renamed event */ + "webhook-organization-renamed": { + /** @enum {string} */ + action: "renamed"; + changes?: { + login?: { + from?: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + membership?: components["schemas"]["webhooks_membership"]; + organization: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Ruby Gems metadata */ + "webhook-rubygems-metadata": { + name?: string; + description?: string; + readme?: string; + homepage?: string; + version_info?: { + version?: string; + }; + platform?: string; + metadata?: { + [key: string]: string | undefined; + }; + repo?: string; + dependencies?: { + [key: string]: string | undefined; + }[]; + commit_oid?: string; + }; + /** package published event */ + "webhook-package-published": { + /** @enum {string} */ + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description Information about the package. */ + package: { + created_at: string | null; + description: string | null; + ecosystem: string; + /** Format: uri */ + html_url: string; + id: number; + name: string; + namespace: 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; + } | null; + package_type: string; + package_version: { /** User */ - user: { + author?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -56990,203 +50163,99 @@ export interface components { /** Format: uri */ url?: string; } | null; - }; - body: string | null; - changed_files?: number; - /** Format: date-time */ - closed_at: string | null; - comments?: number; - /** Format: uri */ - comments_url: string; - commits?: number; - /** Format: uri */ - commits_url: string; - /** Format: date-time */ - created_at: string; - deletions?: number; - /** Format: uri */ - diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ - draft: boolean; - head: { - label: string; - ref: string; - /** - * Repository - * @description A git repository - */ - repo: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; + body?: string | Record; + body_html?: string; + container_metadata?: { + labels?: Record; + manifest?: Record; + tag?: { + digest?: string; + name?: string; + }; + } | null; + created_at?: string; + description: string; + docker_metadata?: { + tags?: string[]; + }[]; + draft?: boolean; + /** Format: uri */ + html_url: string; + id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; + }[]; + name: string; + npm_metadata?: { + name?: string; + version?: string; + npm_user?: string; + author?: Record; + bugs?: Record; + dependencies?: Record; + dev_dependencies?: Record; + peer_dependencies?: Record; + optional_dependencies?: Record; + description?: string; + dist?: Record; + git_head?: string; + homepage?: string; + license?: string; + main?: string; + repository?: Record; + scripts?: Record; + id?: string; + node_version?: string; + npm_version?: string; + has_shrinkwrap?: boolean; + maintainers?: Record[]; + contributors?: Record[]; + engines?: Record; + keywords?: string[]; + files?: string[]; + bin?: Record; + man?: Record; + directories?: Record; + os?: string[]; + cpu?: string[]; + readme?: string; + installation_command?: string; + release_id?: number; + commit_oid?: string; + published_via_actions?: boolean; + deleted_by_id?: number; + } | null; + nuget_metadata?: { + id?: number | string; + name?: string; + value?: boolean | string | number | { + url?: string; + branch?: string; + commit?: string; + type?: string; + }; + }[] | null; + package_files: { + content_type: string; + created_at: string; /** Format: uri */ - html_url: string; - /** @description Unique identifier of the repository */ + download_url: string; id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; - /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; - name: string; - node_id: string; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ + md5: string | null; name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; + sha1: string | null; + sha256: string | null; + size: number; + state: string | null; + updated_at: string; + }[]; + package_url?: string; + prerelease?: boolean; + release?: { /** User */ - owner: { + author: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -57222,146 +50291,61 @@ export interface components { /** Format: uri */ url?: string; } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: (number | string) | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; + created_at: string; + draft: boolean; /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; + html_url: string; + id: number; + name: string | null; + prerelease: boolean; + published_at: string; + tag_name: string; + target_commitish: string; /** Format: uri */ url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; }; - sha: 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; - 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; - }; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + source_url?: string; + summary: string; + tag_name?: string; + target_commitish?: string; + target_oid?: string; + updated_at?: string; + version: string; + } | null; + registry: { + /** Format: uri */ + about_url: string; + name: string; + type: string; + /** Format: uri */ + url: string; + vendor: string; + } | null; + updated_at: string | null; + }; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** package updated event */ + "webhook-package-updated": { + /** @enum {string} */ + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** @description Information about the package. */ + package: { + created_at: string; + description: string | null; + ecosystem: string; /** Format: uri */ html_url: string; id: number; - /** Format: uri */ - issue_url: string; - 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; - }[]; - locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; - merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ - merged_at: string | null; + name: string; + namespace: string; /** User */ - merged_by?: { + owner: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -57393,22 +50377,14 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; - /** - * 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; + package_type: string; + package_version: { /** User */ - creator: { + author: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -57440,41 +50416,130 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; - description: string | null; - /** Format: date-time */ - due_on: string | null; + body: string; + body_html: string; + created_at: string; + description: string; + docker_metadata?: { + tags?: string[]; + }[]; + draft?: boolean; /** Format: uri */ html_url: string; id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; + }[]; + name: string; + package_files: { + content_type: string; + created_at: string; + /** Format: uri */ + download_url: string; + id: number; + md5: string | null; + name: string; + sha1: string | null; + sha256: string; + size: number; + state: string; + updated_at: string; + }[]; + package_url?: string; + prerelease?: boolean; + release?: { + /** User */ + author: { + /** 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; + created_at: string; + draft: boolean; + /** Format: uri */ + html_url: string; + id: number; + name: string; + prerelease: boolean; + published_at: string; + tag_name: string; + target_commitish: string; + /** Format: uri */ + url: string; + }; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; /** 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 */ + source_url?: string; + summary: string; + tag_name?: string; + target_commitish: string; + target_oid: string; updated_at: string; + version: string; + }; + registry: { + /** Format: uri */ + about_url: string; + name: string; + type: string; /** Format: uri */ url: string; + vendor: string; } | null; - node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ - number: number; - /** Format: uri */ - patch_url: string; - rebaseable?: boolean | null; - requested_reviewers: (({ + updated_at: string; + }; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** page_build event */ + "webhook-page-build": { + /** @description The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) itself. */ + build: { + commit: string | null; + created_at: string; + duration: number; + error: { + message: string | null; + }; + /** User */ + pusher: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -57509,128 +50574,246 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null) | { + } | null; + status: string; + updated_at: string; + /** Format: uri */ + url: string; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + id: number; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** personal_access_token_request approved event */ + "webhook-personal-access-token-request-approved": { + /** @enum {string} */ + action: "approved"; + personal_access_token_request: components["schemas"]["personal-access-token-request"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + installation: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request cancelled event */ + "webhook-personal-access-token-request-cancelled": { + /** @enum {string} */ + action: "cancelled"; + personal_access_token_request: components["schemas"]["personal-access-token-request"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + installation: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request created event */ + "webhook-personal-access-token-request-created": { + /** @enum {string} */ + action: "created"; + personal_access_token_request: components["schemas"]["personal-access-token-request"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + installation: components["schemas"]["simple-installation"]; + }; + /** personal_access_token_request denied event */ + "webhook-personal-access-token-request-denied": { + /** @enum {string} */ + action: "denied"; + personal_access_token_request: components["schemas"]["personal-access-token-request"]; + organization: components["schemas"]["organization-simple-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + installation: components["schemas"]["simple-installation"]; + }; + "webhook-ping": { + /** + * Webhook + * @description The webhook that is being pinged + */ + hook?: { + /** @description Determines whether the hook is actually triggered for the events it subscribes to. */ + active: boolean; + /** @description Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. */ + app_id?: number; + config: { + content_type?: components["schemas"]["webhook-config-content-type"]; + insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; + secret?: components["schemas"]["webhook-config-secret"]; + url?: components["schemas"]["webhook-config-url"]; + }; + /** Format: date-time */ + created_at: string; + /** Format: uri */ + deliveries_url?: string; + /** @description Determines what events the hook is triggered for. Default: ['push']. */ + events: string[]; + /** @description Unique identifier of the webhook. */ + id: number; + last_response?: components["schemas"]["hook-response"]; + /** + * @description The type of webhook. The only valid value is 'web'. + * @enum {string} + */ + name: "web"; + /** Format: uri */ + ping_url?: string; + /** Format: uri */ + test_url?: string; + type: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url?: string; + }; + /** @description The ID of the webhook that triggered the ping. */ + hook_id?: number; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + /** @description Random string of GitHub zen. */ + zen?: string; + }; + /** @description The webhooks ping payload encoded with URL encoding. */ + "webhook-ping-form-encoded": { + /** @description A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. */ + payload: string; + }; + /** project_card converted event */ + "webhook-project-card-converted": { + /** @enum {string} */ + action: "converted"; + changes: { + note: { + from: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: components["schemas"]["webhooks_project_card"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card created event */ + "webhook-project-card-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: components["schemas"]["webhooks_project_card"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card deleted event */ + "webhook-project-card-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** Project Card */ + project_card: { + after_id?: number | null; + /** @description Whether or not the card is archived */ + archived: boolean; + column_id: number | null; + /** Format: uri */ + column_url: string; + /** Format: uri */ + content_url?: string; + /** Format: date-time */ + created_at: string; + /** User */ + creator: { + /** Format: uri */ + avatar_url?: string; deleted?: boolean; - /** @description Description of the team */ - description?: string | null; + 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; - /** @description Unique identifier of the team */ id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; + login: string; + name?: string; node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - })[]; - requested_teams: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; + organizations_url?: string; /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; + received_events_url?: string; + /** Format: uri */ + repos_url?: string; + site_admin?: boolean; /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; + starred_url?: string; + /** Format: uri */ + subscriptions_url?: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ url?: string; - }[]; - /** Format: uri-template */ - review_comment_url: string; - review_comments?: number; - /** Format: uri */ - review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - state: "open" | "closed"; + } | null; + /** @description The project card's ID */ + id: number; + node_id: string; + note: string | null; /** Format: uri */ - statuses_url: string; - /** @description The title of the pull request. */ - title: string; + project_url: string; /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; + }; + repository?: components["schemas"]["nullable-repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card edited event */ + "webhook-project-card-edited": { + /** @enum {string} */ + action: "edited"; + changes: { + note: { + from: string | null; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: components["schemas"]["webhooks_project_card"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_card moved event */ + "webhook-project-card-moved": { + /** @enum {string} */ + action: "moved"; + changes?: { + column_id: { + from: number; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_card: { + after_id?: number | null; + /** @description Whether or not the card is archived */ + archived: boolean; + column_id: number; + /** Format: uri */ + column_url: string; + /** Format: uri */ + content_url?: string; + /** Format: date-time */ + created_at: string; /** User */ - user: { + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -57666,17 +50849,334 @@ export interface components { /** Format: uri */ url?: string; } | null; + /** @description The project card's ID */ + id: number; + node_id: string; + note: string | null; + /** Format: uri */ + project_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + } & { + after_id: number | null; + archived?: boolean; + column_id?: number; + column_url?: string; + created_at?: string; + creator?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + } | null; + id?: number; + node_id?: string; + note?: string | null; + project_url?: string; + updated_at?: string; + url?: string; }; - repository: components["schemas"]["repository-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project closed event */ + "webhook-project-closed": { + /** @enum {string} */ + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project_column created event */ + "webhook-project-column-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["repository-webhooks"]; sender?: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request dequeued event */ - "webhook-pull-request-dequeued": { + /** project_column deleted event */ + "webhook-project-column-deleted": { /** @enum {string} */ - action: "dequeued"; + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["nullable-repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project_column edited event */ + "webhook-project-column-edited": { + /** @enum {string} */ + action: "edited"; + changes: { + name?: { + from: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project_column moved event */ + "webhook-project-column-moved": { + /** @enum {string} */ + action: "moved"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project_column: components["schemas"]["webhooks_project_column"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project created event */ + "webhook-project-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** project deleted event */ + "webhook-project-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["nullable-repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project edited event */ + "webhook-project-edited": { + /** @enum {string} */ + action: "edited"; + /** @description The changes to the project if the action was `edited`. */ + changes?: { + body?: { + /** @description The previous version of the body if the action was `edited`. */ + from: string; + }; + name?: { + /** @description The changes to the project if the action was `edited`. */ + from: string; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** project reopened event */ + "webhook-project-reopened": { + /** @enum {string} */ + action: "reopened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + project: components["schemas"]["webhooks_project"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Closed Event */ + "webhook-projects-v2-project-closed": { + /** @enum {string} */ + action: "closed"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** @description A project was created */ + "webhook-projects-v2-project-created": { + /** @enum {string} */ + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Deleted Event */ + "webhook-projects-v2-project-deleted": { + /** @enum {string} */ + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Edited Event */ + "webhook-projects-v2-project-edited": { + /** @enum {string} */ + action: "edited"; + changes: { + description?: { + from?: string | null; + to?: string | null; + }; + public?: { + from?: boolean; + to?: boolean; + }; + short_description?: { + from?: string | null; + to?: string | null; + }; + title?: { + from?: string; + to?: string; + }; + }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Archived Event */ + "webhook-projects-v2-item-archived": { + /** @enum {string} */ + action: "archived"; + changes: components["schemas"]["webhooks_project_changes"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Converted Event */ + "webhook-projects-v2-item-converted": { + /** @enum {string} */ + action: "converted"; + changes: { + content_type?: { + from?: string | null; + to?: string; + }; + }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Created Event */ + "webhook-projects-v2-item-created": { + /** @enum {string} */ + action: "created"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Deleted Event */ + "webhook-projects-v2-item-deleted": { + /** @enum {string} */ + action: "deleted"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Edited Event */ + "webhook-projects-v2-item-edited": { + /** @enum {string} */ + action: "edited"; + changes?: { + field_value: { + field_node_id?: string; + field_type?: string; + }; + } | { + body: { + from?: string | null; + to?: string | null; + }; + }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Reordered Event */ + "webhook-projects-v2-item-reordered": { + /** @enum {string} */ + action: "reordered"; + changes: { + previous_projects_v2_item_node_id?: { + from?: string | null; + to?: string | null; + }; + }; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Item Restored Event */ + "webhook-projects-v2-item-restored": { + /** @enum {string} */ + action: "restored"; + changes: components["schemas"]["webhooks_project_changes"]; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2_item: components["schemas"]["projects-v2-item"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Projects v2 Project Reopened Event */ + "webhook-projects-v2-project-reopened": { + /** @enum {string} */ + action: "reopened"; + installation?: components["schemas"]["simple-installation"]; + organization: components["schemas"]["organization-simple-webhooks"]; + projects_v2: components["schemas"]["projects-v2"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** public event */ + "webhook-public": { enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - number: number; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request assigned event */ + "webhook-pull-request-assigned": { + /** @enum {string} */ + action: "assigned"; + assignee: components["schemas"]["webhooks_user"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ pull_request: { @@ -57758,7 +51258,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; @@ -57794,7 +51294,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)[]; @@ -58197,7 +51697,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string; + label: string | null; ref: string; /** * Repository @@ -58479,7 +51979,7 @@ export interface components { watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - }; + } | null; sha: string; /** User */ user: { @@ -58694,22 +52194,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -58736,17 +52236,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; })[]; requested_teams: { deleted?: boolean; @@ -58855,94 +52355,13 @@ export interface components { url?: string; } | null; }; - reason: string; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request edited event */ - "webhook-pull-request-edited": { - /** @enum {string} */ - action: "edited"; - /** @description The changes to the comment if the action was `edited`. */ - changes: { - base?: { - ref: { - from: string; - }; - sha: { - from: string; - }; - }; - body?: { - /** @description The previous version of the body if the action was `edited`. */ - from: string; - }; - title?: { - /** @description The previous version of the title if the action was `edited`. */ - from: string; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request enqueued event */ - "webhook-pull-request-enqueued": { + /** pull_request auto_merge_disabled event */ + "webhook-pull-request-auto-merge-disabled": { /** @enum {string} */ - action: "enqueued"; + action: "auto_merge_disabled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; number: number; @@ -59224,6 +52643,11 @@ export interface components { * @default true */ has_issues: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; has_pages: boolean; /** * @description Whether projects are enabled. @@ -59235,11 +52659,6 @@ export interface components { * @default true */ has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -59897,7 +53316,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -59963,22 +53382,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -60005,17 +53424,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; })[]; requested_teams: { deleted?: boolean; @@ -60124,32 +53543,16 @@ export interface components { url?: string; } | null; }; + reason: string; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request labeled event */ - "webhook-pull-request-labeled": { + /** pull_request auto_merge_enabled event */ + "webhook-pull-request-auto-merge-enabled": { /** @enum {string} */ - action: "labeled"; + action: "auto_merge_enabled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** Label */ - label?: { - /** @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; - }; - /** @description The pull request number. */ number: number; organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ @@ -60232,7 +53635,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -60268,7 +53671,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -60671,7 +54074,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string | null; + label: string; ref: string; /** * Repository @@ -60953,7 +54356,7 @@ export interface components { watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - } | null; + }; sha: string; /** User */ user: { @@ -61055,7 +54458,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -61329,16 +54732,52 @@ export interface components { url?: string; } | null; }; + reason?: string; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request locked event */ - "webhook-pull-request-locked": { + /** pull_request closed event */ + "webhook-pull-request-closed": { /** @enum {string} */ - action: "locked"; + action: "closed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request converted_to_draft event */ + "webhook-pull-request-converted-to-draft": { + /** @enum {string} */ + action: "converted_to_draft"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request demilestoned event */ + "webhook-pull-request-demilestoned": { + /** @enum {string} */ + action: "demilestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + milestone?: components["schemas"]["milestone"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["webhooks_pull_request_5"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request dequeued event */ + "webhook-pull-request-dequeued": { + /** @enum {string} */ + action: "dequeued"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ number: number; organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ @@ -61457,7 +54896,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -61860,7 +55299,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string | null; + label: string; ref: string; /** * Repository @@ -62142,7 +55581,7 @@ export interface components { watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - } | null; + }; sha: string; /** User */ user: { @@ -62244,7 +55683,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -62291,7 +55730,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; @@ -62357,22 +55796,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description: string | null; + description?: string | null; /** Format: uri */ - html_url: string; + html_url?: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url: string; + members_url?: string; /** @description Name of the team */ name: string; - node_id: string; + node_id?: string; parent?: { /** @description Description of the team */ description: string | null; @@ -62399,17 +55838,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission: string; + permission?: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url: string; - slug: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - url: string; + url?: string; })[]; requested_teams: { deleted?: boolean; @@ -62518,16 +55957,47 @@ export interface components { url?: string; } | null; }; + reason: string; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request milestoned event */ - "webhook-pull-request-milestoned": { + /** pull_request edited event */ + "webhook-pull-request-edited": { /** @enum {string} */ - action: "milestoned"; + action: "edited"; + /** @description The changes to the comment if the action was `edited`. */ + changes: { + base?: { + ref: { + from: string; + }; + sha: { + from: string; + }; + }; + body?: { + /** @description The previous version of the body if the action was `edited`. */ + from: string; + }; + title?: { + /** @description The previous version of the title if the action was `edited`. */ + from: string; + }; + }; enterprise?: components["schemas"]["enterprise-webhooks"]; - milestone?: components["schemas"]["milestone"]; - /** @description The pull request number. */ + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request enqueued event */ + "webhook-pull-request-enqueued": { + /** @enum {string} */ + action: "enqueued"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; number: number; organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ @@ -62610,7 +56080,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -62646,7 +56116,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -62981,7 +56451,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -63321,7 +56791,7 @@ export interface components { /** Format: uri */ url: string; /** - * @description Whether a squash merge commit can use the pull request title as default. + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. * @default false */ use_squash_pr_title_as_default: boolean; @@ -63433,7 +56903,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -63549,502 +57019,177 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null) | { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - })[]; - requested_teams: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }[]; - /** Format: uri-template */ - review_comment_url: string; - review_comments?: number; - /** Format: uri */ - review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - state: "open" | "closed"; - /** Format: uri */ - statuses_url: string; - /** @description The title of the pull request. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - 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; - 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; - } | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request opened event */ - "webhook-pull-request-opened": { - /** @enum {string} */ - action: "opened"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - use_squash_pr_title_as_default: boolean; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request ready_for_review event */ - "webhook-pull-request-ready-for-review": { - /** @enum {string} */ - action: "ready_for_review"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - use_squash_pr_title_as_default: boolean; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request reopened event */ - "webhook-pull-request-reopened": { - /** @enum {string} */ - action: "reopened"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - pull_request: components["schemas"]["pull-request"] & { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow updating the pull request's branch. */ - allow_update_branch?: boolean; - /** - * @description Whether to delete head branches when pull requests are merged. - * @default false - */ - delete_branch_on_merge: boolean; - /** - * @description The default value for a merge commit message. - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; - /** - * @description The default value for a squash merge commit message: - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.** - * @default false - */ - use_squash_pr_title_as_default: boolean; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request_review_comment created event */ - "webhook-pull-request-review-comment-created": { - /** @enum {string} */ - action: "created"; - /** - * Pull Request Review Comment - * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. - */ - comment: { - _links: { - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - pull_request: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - }; - /** - * 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 The text of the comment. */ - body: string; - /** @description The SHA of the commit to which the comment applies. */ - commit_id: string; - /** Format: date-time */ - created_at: string; - /** @description The diff of the line that the comment refers to. */ - diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ - html_url: string; - /** @description The ID of the pull request review comment. */ - id: number; - /** @description The comment ID to reply to. */ - in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - line: number | null; - /** @description The node ID of the pull request review comment. */ - node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - original_line: number | null; - /** @description The index of the original line in the diff to which the comment applies. */ - original_position: number; - /** @description The first line of the range for a multi-line comment. */ - original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - path: string; - /** @description The line index in the diff to which the comment applies. */ - position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - subject_type?: "line" | "file"; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the pull request review 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; - 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) | { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; + })[]; + requested_teams: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; + }[]; + /** Format: uri-template */ + review_comment_url: string; + review_comments?: number; + /** Format: uri */ + review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + state: "open" | "closed"; + /** Format: uri */ + statuses_url: string; + /** @description The title of the pull request. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + 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; + 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; } | null; }; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request labeled event */ + "webhook-pull-request-labeled": { + /** @enum {string} */ + action: "labeled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; + label?: components["schemas"]["webhooks_label"]; + number: components["schemas"]["webhooks_number"]; organization?: components["schemas"]["organization-simple-webhooks"]; + /** Pull Request */ pull_request: { _links: { /** Link */ @@ -64090,6 +57235,7 @@ export interface components { }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ assignee: { /** Format: uri */ @@ -64173,7 +57319,7 @@ export interface components { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - auto_merge?: { + auto_merge: { /** @description Commit message for the merge commit. */ commit_message: string | null; /** @description Title for the merge commit message. */ @@ -64545,17 +57691,24 @@ export interface components { } | null; }; body: string | null; + changed_files?: number; + /** Format: date-time */ closed_at: string | null; + comments?: number; /** Format: uri */ comments_url: string; + commits?: number; /** Format: uri */ commits_url: string; + /** Format: date-time */ created_at: string; + deletions?: number; /** Format: uri */ diff_url: string; - draft?: boolean; + /** @description Indicates whether or not the pull request is a draft. */ + draft: boolean; head: { - label: string; + label: string | null; ref: string; /** * Repository @@ -64898,8 +58051,51 @@ export interface components { url: string; }[]; locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ merged_at: string | null; + /** User */ + merged_by?: { + /** 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; + } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -64972,9 +58168,11 @@ export interface components { url: string; } | null; node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; + rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -65114,13 +58312,19 @@ export interface components { }[]; /** Format: uri-template */ review_comment_url: string; + review_comments?: number; /** Format: uri */ review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; + /** @description The title of the pull request. */ title: string; + /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -65165,158 +58369,15 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review_comment deleted event */ - "webhook-pull-request-review-comment-deleted": { + /** pull_request locked event */ + "webhook-pull-request-locked": { /** @enum {string} */ - action: "deleted"; - /** - * Pull Request Review Comment - * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. - */ - comment: { - _links: { - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - pull_request: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - }; - /** - * 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 The text of the comment. */ - body: string; - /** @description The SHA of the commit to which the comment applies. */ - commit_id: string; - /** Format: date-time */ - created_at: string; - /** @description The diff of the line that the comment refers to. */ - diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ - html_url: string; - /** @description The ID of the pull request review comment. */ - id: number; - /** @description The comment ID to reply to. */ - in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - line: number | null; - /** @description The node ID of the pull request review comment. */ - node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - original_line: number; - /** @description The index of the original line in the diff to which the comment applies. */ - original_position: number; - /** @description The first line of the range for a multi-line comment. */ - original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - path: string; - /** @description The line index in the diff to which the comment applies. */ - position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - subject_type?: "line" | "file"; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the pull request review 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; - 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; - }; + action: "locked"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; organization?: components["schemas"]["organization-simple-webhooks"]; + /** Pull Request */ pull_request: { _links: { /** Link */ @@ -65362,6 +58423,7 @@ export interface components { }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ assignee: { /** Format: uri */ @@ -65431,7 +58493,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)[]; @@ -65445,7 +58507,7 @@ export interface components { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - auto_merge?: { + auto_merge: { /** @description Commit message for the merge commit. */ commit_message: string | null; /** @description Title for the merge commit message. */ @@ -65817,17 +58879,24 @@ export interface components { } | null; }; body: string | null; + changed_files?: number; + /** Format: date-time */ closed_at: string | null; + comments?: number; /** Format: uri */ comments_url: string; + commits?: number; /** Format: uri */ commits_url: string; + /** Format: date-time */ created_at: string; + deletions?: number; /** Format: uri */ diff_url: string; - draft?: boolean; + /** @description Indicates whether or not the pull request is a draft. */ + draft: boolean; head: { - label: string; + label: string | null; ref: string; /** * Repository @@ -66170,8 +59239,51 @@ export interface components { url: string; }[]; locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ merged_at: string | null; + /** User */ + merged_by?: { + /** 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; + } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -66244,9 +59356,11 @@ export interface components { url: string; } | null; node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; + rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -66279,22 +59393,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -66321,17 +59435,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; })[]; requested_teams: { deleted?: boolean; @@ -66386,13 +59500,19 @@ export interface components { }[]; /** Format: uri-template */ review_comment_url: string; + review_comments?: number; /** Format: uri */ review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; + /** @description The title of the pull request. */ title: string; + /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -66437,17 +59557,58 @@ export interface components { repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review_comment edited event */ - "webhook-pull-request-review-comment-edited": { + /** pull_request milestoned event */ + "webhook-pull-request-milestoned": { /** @enum {string} */ - action: "edited"; - /** @description The changes to the comment. */ - changes: { - body?: { - /** @description The previous version of the body. */ - from: string; - }; - }; + action: "milestoned"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + milestone?: components["schemas"]["milestone"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["webhooks_pull_request_5"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request opened event */ + "webhook-pull-request-opened": { + /** @enum {string} */ + action: "opened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request ready_for_review event */ + "webhook-pull-request-ready-for-review": { + /** @enum {string} */ + action: "ready_for_review"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request reopened event */ + "webhook-pull-request-reopened": { + /** @enum {string} */ + action: "reopened"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: components["schemas"]["pull-request-webhook"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request_review_comment created event */ + "webhook-pull-request-review-comment-created": { + /** @enum {string} */ + action: "created"; /** * Pull Request Review Comment * @description The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -66500,7 +59661,7 @@ export interface components { /** @description The SHA of the original commit to which the comment applies. */ original_commit_id: string; /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - original_line: number; + original_line: number | null; /** @description The index of the original line in the diff to which the comment applies. */ original_position: number; /** @description The first line of the range for a multi-line comment. */ @@ -66674,7 +59835,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; @@ -66710,7 +59871,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)[]; @@ -67558,22 +60719,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -67600,17 +60761,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; })[]; requested_teams: { deleted?: boolean; @@ -67712,100 +60873,100 @@ export interface components { /** Format: uri */ url?: string; } | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request_review dismissed event */ - "webhook-pull-request-review-dismissed": { - /** @enum {string} */ - action: "dismissed"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; - }; - }; - /** @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; - } | null; + }; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request_review_comment deleted event */ + "webhook-pull-request-review-comment-deleted": { + /** @enum {string} */ + action: "deleted"; + comment: components["schemas"]["webhooks_review_comment"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + pull_request: { + _links: { + /** Link */ + comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + commits: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + issue: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comment: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + statuses: { + /** Format: uri-template */ + href: string; + }; + }; + /** @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; @@ -67838,7 +60999,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -67852,7 +61013,7 @@ export interface components { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - auto_merge: { + auto_merge?: { /** @description Commit message for the merge commit. */ commit_message: string | null; /** @description Title for the merge commit message. */ @@ -68232,7 +61393,7 @@ export interface components { created_at: string; /** Format: uri */ diff_url: string; - draft: boolean; + draft?: boolean; head: { label: string; ref: string; @@ -68686,22 +61847,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description: string | null; + description?: string | null; /** Format: uri */ - html_url: string; + html_url?: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url: string; + members_url?: string; /** @description Name of the team */ name: string; - node_id: string; + node_id?: string; parent?: { /** @description Description of the team */ description: string | null; @@ -68728,17 +61889,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission: string; + permission?: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url: string; - slug: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - url: string; + url?: string; })[]; requested_teams: { deleted?: boolean; @@ -68842,95 +62003,17 @@ export interface components { } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** @description The review that was affected. */ - review: { - _links: { - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - pull_request: { - /** Format: uri-template */ - href: string; - }; - }; - /** - * 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 The text of the review. */ - body: string | null; - /** @description A commit SHA for the review. */ - commit_id: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the review */ - id: number; - node_id: string; - /** Format: uri */ - pull_request_url: string; - /** @enum {string} */ - state: "dismissed" | "approved" | "changes_requested"; - /** Format: date-time */ - submitted_at: 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; - 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; - } | null; - }; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review edited event */ - "webhook-pull-request-review-edited": { + /** pull_request_review_comment edited event */ + "webhook-pull-request-review-comment-edited": { /** @enum {string} */ action: "edited"; - changes: { - body?: { - /** @description The previous version of the body if the action was `edited`. */ - from: string; - }; - }; + changes: components["schemas"]["webhooks_changes"]; + comment: components["schemas"]["webhooks_review_comment"]; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ pull_request: { _links: { /** Link */ @@ -69009,7 +62092,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -69045,7 +62128,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -69059,7 +62142,7 @@ export interface components { * PullRequestAutoMerge * @description The status of auto merging a pull request. */ - auto_merge: { + auto_merge?: { /** @description Commit message for the merge commit. */ commit_message: string | null; /** @description Title for the merge commit message. */ @@ -69217,6 +62300,11 @@ export interface components { * @default true */ has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -69248,6 +62336,23 @@ export interface components { url: string | null; } | null; master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -69316,6 +62421,23 @@ export interface components { releases_url: string; role_name?: string | null; size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -69340,10 +62462,17 @@ export interface components { updated_at: string; /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; }; sha: string; /** User */ @@ -69393,7 +62522,7 @@ export interface components { created_at: string; /** Format: uri */ diff_url: string; - draft: boolean; + draft?: boolean; head: { label: string; ref: string; @@ -69504,6 +62633,11 @@ export interface components { * @default true */ has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -69535,6 +62669,23 @@ export interface components { url: string | null; } | null; master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -69603,6 +62754,23 @@ export interface components { releases_url: string; role_name?: string | null; size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -69627,10 +62795,17 @@ export interface components { updated_at: string; /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; } | null; sha: string; /** User */ @@ -69801,22 +62976,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description: string | null; + description?: string | null; /** Format: uri */ - html_url: string; + html_url?: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url: string; + members_url?: string; /** @description Name of the team */ name: string; - node_id: string; + node_id?: string; parent?: { /** @description Description of the team */ description: string | null; @@ -69843,17 +63018,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission: string; + permission?: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url: string; - slug: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - url: string; + url?: string; })[]; requested_teams: { deleted?: boolean; @@ -69957,90 +63132,16 @@ export interface components { } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** @description The review that was affected. */ - review: { - _links: { - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - pull_request: { - /** Format: uri-template */ - href: string; - }; - }; - /** - * 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 The text of the review. */ - body: string | null; - /** @description A commit SHA for the review. */ - commit_id: string; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the review */ - id: number; - node_id: string; - /** Format: uri */ - pull_request_url: string; - state: string; - /** Format: date-time */ - submitted_at: string | null; - /** 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; - 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; - }; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request review_request_removed event */ - "webhook-pull-request-review-request-removed": { + /** pull_request_review dismissed event */ + "webhook-pull-request-review-dismissed": { /** @enum {string} */ - action: "review_request_removed"; + action: "dismissed"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ + /** Simple Pull Request */ pull_request: { _links: { /** Link */ @@ -70086,7 +63187,6 @@ export interface components { }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; /** User */ assignee: { /** Format: uri */ @@ -70120,7 +63220,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; @@ -70156,7 +63256,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)[]; @@ -70450,12 +63550,19 @@ export interface components { role_name?: string | null; size: number; /** - * @description The default value for a squash merge commit message. + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a squash merge commit title. + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -70535,21 +63642,14 @@ export interface components { } | null; }; body: string | null; - changed_files?: number; - /** Format: date-time */ closed_at: string | null; - comments?: number; /** Format: uri */ comments_url: string; - commits?: number; /** Format: uri */ commits_url: string; - /** Format: date-time */ created_at: string; - deletions?: number; /** Format: uri */ diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { label: string; @@ -70834,7 +63934,7 @@ export interface components { watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - }; + } | null; sha: string; /** User */ user: { @@ -70895,51 +63995,8 @@ export interface components { url: string; }[]; locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ merged_at: string | null; - /** User */ - merged_by?: { - /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -71012,11 +64069,9 @@ export interface components { url: string; } | null; node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; - rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -71049,7 +64104,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) | { @@ -71102,73 +64157,67 @@ export interface components { * @description URL for the team */ url: string; - })[]; - requested_teams: { - deleted?: boolean; - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; + })[]; + requested_teams: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; }[]; /** Format: uri-template */ review_comment_url: string; - review_comments?: number; /** Format: uri */ review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; - /** @description The title of the pull request. */ title: string; - /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -71205,59 +64254,101 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** User */ - requested_reviewer: { - /** 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; + /** @description The review that was affected. */ + review: { + _links: { + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + pull_request: { + /** Format: uri-template */ + href: string; + }; + }; + /** + * 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 The text of the review. */ + body: string | null; + /** @description A commit SHA for the review. */ + commit_id: string; /** Format: uri */ - html_url?: string; + html_url: string; + /** @description Unique identifier of the review */ 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; + node_id: string; /** Format: uri */ - subscriptions_url?: string; + pull_request_url: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; + state: "dismissed" | "approved" | "changes_requested"; + /** Format: date-time */ + submitted_at: 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; + 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; + } | null; + }; sender: components["schemas"]["simple-user-webhooks"]; - } | { + }; + /** pull_request_review edited event */ + "webhook-pull-request-review-edited": { /** @enum {string} */ - action: "review_request_removed"; + action: "edited"; + changes: { + body?: { + /** @description The previous version of the body if the action was `edited`. */ + from: string; + }; + }; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ + /** Simple Pull Request */ pull_request: { _links: { /** Link */ @@ -71303,7 +64394,6 @@ export interface components { }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; /** User */ assignee: { /** Format: uri */ @@ -71337,7 +64427,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; @@ -71373,7 +64463,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)[]; @@ -71545,11 +64635,6 @@ export interface components { * @default true */ has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -71581,23 +64666,6 @@ export interface components { url: string | null; } | null; master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -71666,23 +64734,6 @@ export interface components { releases_url: string; role_name?: string | null; size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -71707,17 +64758,10 @@ export interface components { updated_at: string; /** Format: uri */ url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; }; sha: string; /** User */ @@ -71759,21 +64803,14 @@ export interface components { } | null; }; body: string | null; - changed_files?: number; - /** Format: date-time */ closed_at: string | null; - comments?: number; /** Format: uri */ comments_url: string; - commits?: number; /** Format: uri */ commits_url: string; - /** Format: date-time */ created_at: string; - deletions?: number; /** Format: uri */ diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { label: string; @@ -71885,11 +64922,6 @@ export interface components { * @default true */ has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; homepage: string | null; /** Format: uri */ hooks_url: string; @@ -71921,23 +64953,6 @@ export interface components { url: string | null; } | null; master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -72006,23 +65021,6 @@ export interface components { releases_url: string; role_name?: string | null; size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -72047,18 +65045,11 @@ export interface components { updated_at: string; /** Format: uri */ url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; + } | null; sha: string; /** User */ user: { @@ -72119,51 +65110,8 @@ export interface components { url: string; }[]; locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ merged_at: string | null; - /** User */ - merged_by?: { - /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -72207,7 +65155,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; @@ -72236,11 +65184,9 @@ export interface components { url: string; } | null; node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; - rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -72273,7 +65219,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) | { @@ -72330,16 +65276,16 @@ export interface components { requested_teams: { deleted?: boolean; /** @description Description of the team */ - description: string | null; + description?: string | null; /** Format: uri */ - html_url: string; + html_url?: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url: string; + members_url?: string; /** @description Name of the team */ name: string; - node_id: string; + node_id?: string; parent?: { /** @description Description of the team */ description: string | null; @@ -72366,33 +65312,27 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission: string; + permission?: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url: string; - slug: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - url: string; + url?: string; }[]; /** Format: uri-template */ review_comment_url: string; - review_comments?: number; /** Format: uri */ review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; - /** @description The title of the pull request. */ title: string; - /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -72429,73 +65369,19 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - requested_team: { - deleted?: boolean; - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - }; + review: components["schemas"]["webhooks_review"]; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request review_requested event */ - "webhook-pull-request-review-requested": { + /** pull_request review_request_removed event */ + "webhook-pull-request-review-request-removed": { /** @enum {string} */ - action: "review_requested"; + action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ @@ -72581,7 +65467,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -72617,7 +65503,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -72911,19 +65797,12 @@ export interface components { role_name?: string | null; size: number; /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. + * @description The default value for a squash merge commit message. * @enum {string} */ squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @description The default value for a squash merge commit title. * @enum {string} */ squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; @@ -73451,7 +66330,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -73574,16 +66453,16 @@ export interface components { requested_teams: { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -73610,17 +66489,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; }[]; /** Format: uri-template */ review_comment_url: string; @@ -73673,7 +66552,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -73712,14 +66591,14 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; sender: components["schemas"]["simple-user-webhooks"]; } | { /** @enum {string} */ - action: "review_requested"; + action: "review_request_removed"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; /** @description The pull request number. */ @@ -73805,7 +66684,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -73841,7 +66720,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -74675,7 +67554,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -74747,16 +67626,16 @@ export interface components { } | null) | { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -74783,31 +67662,31 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; })[]; requested_teams: { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -74834,17 +67713,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; }[]; /** Format: uri-template */ review_comment_url: string; @@ -74897,7 +67776,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -74910,16 +67789,16 @@ export interface components { requested_team: { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -74946,28 +67825,30 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; }; sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review submitted event */ - "webhook-pull-request-review-submitted": { + /** pull_request review_requested event */ + "webhook-pull-request-review-requested": { /** @enum {string} */ - action: "submitted"; + action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; + /** @description The pull request number. */ + number: number; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ + /** Pull Request */ pull_request: { _links: { /** Link */ @@ -75013,6 +67894,7 @@ export interface components { }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ assignee: { /** Format: uri */ @@ -75468,17 +68350,24 @@ export interface components { } | null; }; body: string | null; + changed_files?: number; + /** Format: date-time */ closed_at: string | null; + comments?: number; /** Format: uri */ comments_url: string; + commits?: number; /** Format: uri */ commits_url: string; + /** Format: date-time */ created_at: string; + deletions?: number; /** Format: uri */ diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string | null; + label: string; ref: string; /** * Repository @@ -75760,7 +68649,7 @@ export interface components { watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - } | null; + }; sha: string; /** User */ user: { @@ -75821,8 +68710,51 @@ export interface components { url: string; }[]; locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ merged_at: string | null; + /** User */ + merged_by?: { + /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -75895,9 +68827,11 @@ export interface components { url: string; } | null; node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; + rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -75930,7 +68864,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null) | { @@ -76037,13 +68971,19 @@ export interface components { }[]; /** Format: uri-template */ review_comment_url: string; + review_comments?: number; /** Format: uri */ review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; + /** @description The title of the pull request. */ title: string; + /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -76086,88 +69026,53 @@ export interface components { } | null; }; repository: components["schemas"]["repository-webhooks"]; - /** @description The review that was affected. */ - review: { - _links: { - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - pull_request: { - /** Format: uri-template */ - href: string; - }; - }; - /** - * 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 The text of the review. */ - body: string | null; - /** @description A commit SHA for the review. */ - commit_id: string; + /** User */ + requested_reviewer: { /** Format: uri */ - html_url: string; - /** @description Unique identifier of the review */ + 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; - node_id: string; + login: string; + name?: string; + node_id?: string; /** Format: uri */ - pull_request_url: string; - state: string; - /** Format: date-time */ - submitted_at: string | null; - /** 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; - 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; - }; + 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; + } | null; sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request_review_thread resolved event */ - "webhook-pull-request-review-thread-resolved": { + } | { /** @enum {string} */ - action: "resolved"; + action: "review_requested"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; + /** @description The pull request number. */ + number: number; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Simple Pull Request */ + /** Pull Request */ pull_request: { _links: { /** Link */ @@ -76213,6 +69118,7 @@ export interface components { }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ assignee: { /** Format: uri */ @@ -76246,7 +69152,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; @@ -76282,7 +69188,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)[]; @@ -76490,6 +69396,23 @@ export interface components { url: string | null; } | null; master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -76558,6 +69481,23 @@ export interface components { releases_url: string; role_name?: string | null; size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -76582,6 +69522,11 @@ export interface components { updated_at: string; /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -76629,17 +69574,24 @@ export interface components { } | null; }; body: string | null; + changed_files?: number; + /** Format: date-time */ closed_at: string | null; + comments?: number; /** Format: uri */ comments_url: string; + commits?: number; /** Format: uri */ commits_url: string; + /** Format: date-time */ created_at: string; + deletions?: number; /** Format: uri */ diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string | null; + label: string; ref: string; /** * Repository @@ -76784,6 +69736,23 @@ export interface components { url: string | null; } | null; master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -76852,6 +69821,23 @@ export interface components { releases_url: string; role_name?: string | null; size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -76876,13 +69862,18 @@ export interface components { updated_at: string; /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - } | null; + }; sha: string; /** User */ user: { @@ -76943,8 +69934,51 @@ export interface components { url: string; }[]; locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ merged_at: string | null; + /** User */ + merged_by?: { + /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -76988,7 +70022,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; @@ -77017,9 +70051,11 @@ export interface components { url: string; } | null; node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; + rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -77052,22 +70088,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description: string | null; + description?: string | null; /** Format: uri */ - html_url: string; + html_url?: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url: string; + members_url?: string; /** @description Name of the team */ name: string; - node_id: string; + node_id?: string; parent?: { /** @description Description of the team */ description: string | null; @@ -77094,17 +70130,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission: string; + permission?: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url: string; - slug: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - url: string; + url?: string; })[]; requested_teams: { deleted?: boolean; @@ -77159,13 +70195,19 @@ export interface components { }[]; /** Format: uri-template */ review_comment_url: string; + review_comments?: number; /** Format: uri */ review_comments_url: string; - /** @enum {string} */ + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; + /** @description The title of the pull request. */ title: string; + /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -77208,156 +70250,67 @@ export interface components { } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - thread: { - comments: { - _links: { - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - pull_request: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - }; - /** - * 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 The text of the comment. */ - body: string; - /** @description The SHA of the commit to which the comment applies. */ - commit_id: string; - /** Format: date-time */ - created_at: string; - /** @description The diff of the line that the comment refers to. */ - diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ + /** + * Team + * @description Groups of organization members that gives permissions on specified repositories. + */ + requested_team: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ html_url: string; - /** @description The ID of the pull request review comment. */ + /** @description Unique identifier of the team */ id: number; - /** @description The comment ID to reply to. */ - in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - line: number | null; - /** @description The node ID of the pull request review comment. */ + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - original_line: number | null; - /** @description The index of the original line in the diff to which the comment applies. */ - original_position: number; - /** @description The first line of the range for a multi-line comment. */ - original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - path: string; - /** @description The line index in the diff to which the comment applies. */ - position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - subject_type?: "line" | "file"; - /** Format: date-time */ - updated_at: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; /** * Format: uri - * @description URL for the pull request review comment + * @description URL for the team */ 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; - 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; - } | null; - }[]; - node_id: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; }; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** pull_request_review_thread unresolved event */ - "webhook-pull-request-review-thread-unresolved": { + /** pull_request_review submitted event */ + "webhook-pull-request-review-submitted": { /** @enum {string} */ - action: "unresolved"; + action: "submitted"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; @@ -77440,7 +70393,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; @@ -77476,7 +70429,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)[]; @@ -77494,7 +70447,7 @@ export interface components { /** @description Commit message for the merge commit. */ commit_message: string | null; /** @description Title for the merge commit message. */ - commit_title: string; + commit_title: string | null; /** User */ enabled_by: { /** Format: uri */ @@ -77684,6 +70637,23 @@ export interface components { url: string | null; } | null; master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -77752,6 +70722,23 @@ export interface components { releases_url: string; role_name?: string | null; size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -77776,6 +70763,11 @@ export interface components { updated_at: string; /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -77833,7 +70825,7 @@ export interface components { diff_url: string; draft: boolean; head: { - label: string; + label: string | null; ref: string; /** * Repository @@ -77978,6 +70970,23 @@ export interface components { url: string | null; } | null; master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -78046,6 +71055,23 @@ export interface components { releases_url: string; role_name?: string | null; size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -78070,13 +71096,18 @@ export interface components { updated_at: string; /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - }; + } | null; sha: string; /** User */ user: { @@ -78182,7 +71213,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; @@ -78246,22 +71277,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description?: string | null; + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url?: string; + members_url: string; /** @description Name of the team */ name: string; - node_id?: string; + node_id: string; parent?: { /** @description Description of the team */ description: string | null; @@ -78288,17 +71319,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission?: string; + permission: string; /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url?: string; - slug?: string; + repositories_url: string; + slug: string; /** * Format: uri * @description URL for the team */ - url?: string; + url: string; })[]; requested_teams: { deleted?: boolean; @@ -78365,285 +71396,6 @@ export interface components { 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; - 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; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - thread: { - comments: { - _links: { - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - pull_request: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - }; - /** - * 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 The text of the comment. */ - body: string; - /** @description The SHA of the commit to which the comment applies. */ - commit_id: string; - /** Format: date-time */ - created_at: string; - /** @description The diff of the line that the comment refers to. */ - diff_hunk: string; - /** - * Format: uri - * @description HTML URL for the pull request review comment. - */ - html_url: string; - /** @description The ID of the pull request review comment. */ - id: number; - /** @description The comment ID to reply to. */ - in_reply_to_id?: number; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - line: number | null; - /** @description The node ID of the pull request review comment. */ - node_id: string; - /** @description The SHA of the original commit to which the comment applies. */ - original_commit_id: string; - /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ - original_line: number; - /** @description The index of the original line in the diff to which the comment applies. */ - original_position: number; - /** @description The first line of the range for a multi-line comment. */ - original_start_line: number | null; - /** @description The relative path of the file to which the comment applies. */ - path: string; - /** @description The line index in the diff to which the comment applies. */ - position: number | null; - /** @description The ID of the pull request review to which the comment belongs. */ - pull_request_review_id: number | null; - /** - * Format: uri - * @description URL for the pull request that the review comment belongs to. - */ - pull_request_url: string; - /** 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; - }; - /** - * @description The side of the first line of the range for a multi-line comment. - * @enum {string} - */ - side: "LEFT" | "RIGHT"; - /** @description The first line of the range for a multi-line comment. */ - start_line: number | null; - /** - * @description The side of the first line of the range for a multi-line comment. - * @default RIGHT - * @enum {string|null} - */ - start_side: "LEFT" | "RIGHT" | null; - /** - * @description The level at which the comment is targeted, can be a diff line or a file. - * @enum {string} - */ - subject_type?: "line" | "file"; - /** Format: date-time */ - updated_at: string; - /** - * Format: uri - * @description URL for the pull request review 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; - 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; - }[]; - node_id: string; - }; - }; - /** pull_request synchronize event */ - "webhook-pull-request-synchronize": { - /** @enum {string} */ - action: "synchronize"; - after: string; - before: string; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; - }; - }; - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; - /** 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; - } | null; - assignees: ({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -78678,6 +71430,137 @@ export interface components { type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; + } | null; + }; + repository: components["schemas"]["repository-webhooks"]; + review: components["schemas"]["webhooks_review"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request_review_thread resolved event */ + "webhook-pull-request-review-thread-resolved": { + /** @enum {string} */ + action: "resolved"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** Simple Pull Request */ + pull_request: { + _links: { + /** Link */ + comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + commits: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + issue: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comment: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + statuses: { + /** Format: uri-template */ + href: string; + }; + }; + /** @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 @@ -78883,23 +71766,6 @@ export interface components { url: string | null; } | null; master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -78968,23 +71834,6 @@ export interface components { releases_url: string; role_name?: string | null; size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -79009,11 +71858,6 @@ export interface components { updated_at: string; /** Format: uri */ url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -79061,24 +71905,17 @@ export interface components { } | null; }; body: string | null; - changed_files?: number; - /** Format: date-time */ closed_at: string | null; - comments?: number; /** Format: uri */ comments_url: string; - commits?: number; /** Format: uri */ commits_url: string; - /** Format: date-time */ created_at: string; - deletions?: number; /** Format: uri */ diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string; + label: string | null; ref: string; /** * Repository @@ -79223,16 +72060,6 @@ export interface components { url: string | null; } | null; master_branch?: string; - /** - * @description The default value for a merge commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit message title. - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -79301,23 +72128,6 @@ export interface components { releases_url: string; role_name?: string | null; size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -79342,18 +72152,13 @@ export interface components { updated_at: string; /** Format: uri */ url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - }; + } | null; sha: string; /** User */ user: { @@ -79414,51 +72219,8 @@ export interface components { url: string; }[]; locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ merged_at: string | null; - /** User */ - merged_by?: { - /** 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; /** * Milestone * @description A collection of related issues and pull requests. @@ -79502,7 +72264,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -79531,11 +72293,9 @@ export interface components { url: string; } | null; node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; - rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -79675,19 +72435,13 @@ export interface components { }[]; /** Format: uri-template */ review_comment_url: string; - review_comments?: number; /** Format: uri */ review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; - /** @description The title of the pull request. */ title: string; - /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -79730,55 +72484,160 @@ export interface components { } | null; }; repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + thread: { + comments: { + _links: { + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + pull_request: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + }; + /** + * 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 The text of the comment. */ + body: string; + /** @description The SHA of the commit to which the comment applies. */ + commit_id: string; + /** Format: date-time */ + created_at: string; + /** @description The diff of the line that the comment refers to. */ + diff_hunk: string; + /** + * Format: uri + * @description HTML URL for the pull request review comment. + */ + html_url: string; + /** @description The ID of the pull request review comment. */ + id: number; + /** @description The comment ID to reply to. */ + in_reply_to_id?: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + line: number | null; + /** @description The node ID of the pull request review comment. */ + node_id: string; + /** @description The SHA of the original commit to which the comment applies. */ + original_commit_id: string; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + original_line: number | null; + /** @description The index of the original line in the diff to which the comment applies. */ + original_position: number; + /** @description The first line of the range for a multi-line comment. */ + original_start_line: number | null; + /** @description The relative path of the file to which the comment applies. */ + path: string; + /** @description The line index in the diff to which the comment applies. */ + position: number | null; + /** @description The ID of the pull request review to which the comment belongs. */ + pull_request_review_id: number | null; + /** + * Format: uri + * @description URL for the pull request that the review comment belongs to. + */ + pull_request_url: string; + /** 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; + }; + /** + * @description The side of the first line of the range for a multi-line comment. + * @enum {string} + */ + side: "LEFT" | "RIGHT"; + /** @description The first line of the range for a multi-line comment. */ + start_line: number | null; + /** + * @description The side of the first line of the range for a multi-line comment. + * @default RIGHT + * @enum {string|null} + */ + start_side: "LEFT" | "RIGHT" | null; + /** + * @description The level at which the comment is targeted, can be a diff line or a file. + * @enum {string} + */ + subject_type?: "line" | "file"; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the pull request review 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; + 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; + } | null; + }[]; + node_id: string; + }; }; - /** pull_request unassigned event */ - "webhook-pull-request-unassigned": { + /** pull_request_review_thread unresolved event */ + "webhook-pull-request-review-thread-unresolved": { /** @enum {string} */ - action: "unassigned"; - /** 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; - } | null; + action: "unresolved"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ + /** Simple Pull Request */ pull_request: { _links: { /** Link */ @@ -79824,7 +72683,6 @@ export interface components { }; /** @enum {string|null} */ active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; /** User */ assignee: { /** Format: uri */ @@ -79858,7 +72716,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -79894,7 +72752,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null)[]; @@ -79912,7 +72770,7 @@ export interface components { /** @description Commit message for the merge commit. */ commit_message: string | null; /** @description Title for the merge commit message. */ - commit_title: string | null; + commit_title: string; /** User */ enabled_by: { /** Format: uri */ @@ -79957,7 +72815,7 @@ export interface components { merge_method: "merge" | "squash" | "rebase"; } | null; base: { - label: string | null; + label: string; ref: string; /** * Repository @@ -80102,23 +72960,6 @@ export interface components { url: string | null; } | null; master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -80187,23 +73028,6 @@ export interface components { releases_url: string; role_name?: string | null; size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -80228,11 +73052,6 @@ export interface components { updated_at: string; /** Format: uri */ url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; @@ -80280,24 +73099,17 @@ export interface components { } | null; }; body: string | null; - changed_files?: number; - /** Format: date-time */ closed_at: string | null; - comments?: number; /** Format: uri */ comments_url: string; - commits?: number; /** Format: uri */ commits_url: string; - /** Format: date-time */ created_at: string; - deletions?: number; /** Format: uri */ diff_url: string; - /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string | null; + label: string; ref: string; /** * Repository @@ -80442,23 +73254,6 @@ export interface components { url: string | null; } | null; master_branch?: string; - /** - * @description The default value for a merge commit message. - * - * - `PR_TITLE` - default to the pull request's title. - * - `PR_BODY` - default to the pull request's body. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; - /** - * @description The default value for a merge commit title. - * - * - `PR_TITLE` - default to the pull request's title. - * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - * @enum {string} - */ - merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; /** Format: uri */ merges_url: string; /** Format: uri-template */ @@ -80527,23 +73322,6 @@ export interface components { releases_url: string; role_name?: string | null; size: number; - /** - * @description The default value for a squash merge commit message: - * - * - `PR_BODY` - default to the pull request's body. - * - `COMMIT_MESSAGES` - default to the branch's commit messages. - * - `BLANK` - default to a blank commit message. - * @enum {string} - */ - squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; - /** - * @description The default value for a squash merge commit title: - * - * - `PR_TITLE` - default to the pull request's title. - * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - * @enum {string} - */ - squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; ssh_url: string; stargazers?: number; stargazers_count: number; @@ -80568,18 +73346,13 @@ export interface components { updated_at: string; /** Format: uri */ url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; /** @enum {string} */ visibility: "public" | "private" | "internal"; watchers: number; watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - } | null; + }; sha: string; /** User */ user: { @@ -80640,51 +73413,8 @@ export interface components { url: string; }[]; locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ merged_at: string | null; - /** User */ - merged_by?: { - /** 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; - } | null; /** * Milestone * @description A collection of related issues and pull requests. @@ -80728,7 +73458,7 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; @@ -80757,11 +73487,9 @@ export interface components { url: string; } | null; node_id: string; - /** @description Number uniquely identifying the pull request within its repository. */ number: number; /** Format: uri */ patch_url: string; - rebaseable?: boolean | null; requested_reviewers: (({ /** Format: uri */ avatar_url?: string; @@ -80794,22 +73522,22 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null) | { deleted?: boolean; /** @description Description of the team */ - description: string | null; + description?: string | null; /** Format: uri */ - html_url: string; + html_url?: string; /** @description Unique identifier of the team */ id: number; /** Format: uri-template */ - members_url: string; + members_url?: string; /** @description Name of the team */ name: string; - node_id: string; + node_id?: string; parent?: { /** @description Description of the team */ description: string | null; @@ -80836,17 +73564,17 @@ export interface components { url: string; } | null; /** @description Permission that the team will have for its repositories */ - permission: string; + permission?: string; /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - repositories_url: string; - slug: string; + repositories_url?: string; + slug?: string; /** * Format: uri * @description URL for the team */ - url: string; + url?: string; })[]; requested_teams: { deleted?: boolean; @@ -80901,19 +73629,13 @@ export interface components { }[]; /** Format: uri-template */ review_comment_url: string; - review_comments?: number; /** Format: uri */ review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ + /** @enum {string} */ state: "open" | "closed"; /** Format: uri */ statuses_url: string; - /** @description The title of the pull request. */ title: string; - /** Format: date-time */ updated_at: string; /** Format: uri */ url: string; @@ -80950,38 +73672,167 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization" | "Mannequin"; + type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; } | null; }; repository: components["schemas"]["repository-webhooks"]; sender?: components["schemas"]["simple-user-webhooks"]; + thread: { + comments: { + _links: { + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + pull_request: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + }; + /** + * 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 The text of the comment. */ + body: string; + /** @description The SHA of the commit to which the comment applies. */ + commit_id: string; + /** Format: date-time */ + created_at: string; + /** @description The diff of the line that the comment refers to. */ + diff_hunk: string; + /** + * Format: uri + * @description HTML URL for the pull request review comment. + */ + html_url: string; + /** @description The ID of the pull request review comment. */ + id: number; + /** @description The comment ID to reply to. */ + in_reply_to_id?: number; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + line: number | null; + /** @description The node ID of the pull request review comment. */ + node_id: string; + /** @description The SHA of the original commit to which the comment applies. */ + original_commit_id: string; + /** @description The line of the blob to which the comment applies. The last line of the range for a multi-line comment */ + original_line: number; + /** @description The index of the original line in the diff to which the comment applies. */ + original_position: number; + /** @description The first line of the range for a multi-line comment. */ + original_start_line: number | null; + /** @description The relative path of the file to which the comment applies. */ + path: string; + /** @description The line index in the diff to which the comment applies. */ + position: number | null; + /** @description The ID of the pull request review to which the comment belongs. */ + pull_request_review_id: number | null; + /** + * Format: uri + * @description URL for the pull request that the review comment belongs to. + */ + pull_request_url: string; + /** 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; + }; + /** + * @description The side of the first line of the range for a multi-line comment. + * @enum {string} + */ + side: "LEFT" | "RIGHT"; + /** @description The first line of the range for a multi-line comment. */ + start_line: number | null; + /** + * @description The side of the first line of the range for a multi-line comment. + * @default RIGHT + * @enum {string|null} + */ + start_side: "LEFT" | "RIGHT" | null; + /** + * @description The level at which the comment is targeted, can be a diff line or a file. + * @enum {string} + */ + subject_type?: "line" | "file"; + /** Format: date-time */ + updated_at: string; + /** + * Format: uri + * @description URL for the pull request review 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; + 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; + }[]; + node_id: string; + }; }; - /** pull_request unlabeled event */ - "webhook-pull-request-unlabeled": { + /** pull_request synchronize event */ + "webhook-pull-request-synchronize": { /** @enum {string} */ - action: "unlabeled"; + action: "synchronize"; + after: string; + before: string; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; - /** Label */ - label?: { - /** @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; - }; - /** @description The pull request number. */ - number: number; + number: components["schemas"]["webhooks_number"]; organization?: components["schemas"]["organization-simple-webhooks"]; /** Pull Request */ pull_request: { @@ -81502,7 +74353,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string | null; + label: string; ref: string; /** * Repository @@ -81777,7 +74628,7 @@ export interface components { watchers_count: number; /** @description Whether to require contributors to sign off on web-based commits */ web_commit_signoff_required?: boolean; - } | null; + }; sha: string; /** User */ user: { @@ -82152,103 +75003,103 @@ export interface components { /** Format: uri */ url?: string; } | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** pull_request unlocked event */ - "webhook-pull-request-unlocked": { - /** @enum {string} */ - action: "unlocked"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - /** @description The pull request number. */ - number: number; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** Pull Request */ - pull_request: { - _links: { - /** Link */ - comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - commits: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - html: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - issue: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comment: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - review_comments: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - self: { - /** Format: uri-template */ - href: string; - }; - /** Link */ - statuses: { - /** Format: uri-template */ - href: string; - }; - }; - /** @enum {string|null} */ - active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; - additions?: number; - /** 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; + }; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** pull_request unassigned event */ + "webhook-pull-request-unassigned": { + /** @enum {string} */ + action: "unassigned"; + assignee?: components["schemas"]["webhooks_user_mannequin"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** Pull Request */ + pull_request: { + _links: { + /** Link */ + comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + commits: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + issue: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comment: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + statuses: { + /** Format: uri-template */ + href: string; + }; + }; + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; + /** 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; + } | null; assignees: ({ /** Format: uri */ avatar_url?: string; @@ -82281,7 +75132,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)[]; @@ -82299,7 +75150,7 @@ export interface components { /** @description Commit message for the merge commit. */ commit_message: string | null; /** @description Title for the merge commit message. */ - commit_title: string; + commit_title: string | null; /** User */ enabled_by: { /** Format: uri */ @@ -82344,7 +75195,7 @@ export interface components { merge_method: "merge" | "squash" | "rebase"; } | null; base: { - label: string; + label: string | null; ref: string; /** * Repository @@ -82684,7 +75535,7 @@ export interface components { /** @description Indicates whether or not the pull request is a draft. */ draft: boolean; head: { - label: string; + label: string | null; ref: string; /** * Repository @@ -82935,714 +75786,108 @@ export interface components { stargazers?: number; stargazers_count: number; /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** - * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. - * @default false - */ - use_squash_pr_title_as_default: boolean; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - } | null; - sha: 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; - 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; - }; - /** Format: uri */ - html_url: string; - id: number; - /** Format: uri */ - issue_url: string; - 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; - }[]; - locked: boolean; - /** @description Indicates whether maintainers can modify the pull request. */ - maintainer_can_modify?: boolean; - merge_commit_sha: string | null; - mergeable?: boolean | null; - mergeable_state?: string; - merged?: boolean | null; - /** Format: date-time */ - merged_at: string | null; - /** User */ - merged_by?: { - /** 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; - /** - * 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; + stargazers_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; + statuses_url: string; /** Format: uri */ - received_events_url?: string; + subscribers_url: string; /** Format: uri */ - repos_url?: string; - site_admin?: boolean; - /** Format: uri-template */ - starred_url?: string; + subscription_url: string; /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + svn_url: string; /** Format: uri */ - url?: 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; - /** @description Number uniquely identifying the pull request within its repository. */ - number: number; - /** Format: uri */ - patch_url: string; - rebaseable?: boolean | null; - requested_reviewers: (({ - /** 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) | { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; + tags_url: string; /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; + teams_url: string; + topics: string[]; /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; + trees_url: string; + /** Format: date-time */ + updated_at: string; /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - })[]; - requested_teams: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url: string; - slug: string; /** - * Format: uri - * @description URL for the team + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }[]; - /** Format: uri-template */ - review_comment_url: string; - review_comments?: number; - /** Format: uri */ - review_comments_url: string; - /** - * @description State of this Pull Request. Either `open` or `closed`. - * @enum {string} - */ - state: "open" | "closed"; - /** Format: uri */ - statuses_url: string; - /** @description The title of the pull request. */ - title: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - 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; - 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; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** push event */ - "webhook-push": { - /** @description The SHA of the most recent commit on `ref` after the push. */ - after: string; - base_ref: string | null; - /** @description The SHA of the most recent commit on `ref` before the push. */ - before: string; - /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries. */ - commits: { - /** @description An array of files added in the commit. */ - added?: string[]; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - author: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - committer: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** @description Whether this commit is distinct from any that have been pushed before. */ - distinct: boolean; - id: string; - /** @description The commit message. */ - message: string; - /** @description An array of files modified by the commit. */ - modified?: string[]; - /** @description An array of files removed in the commit. */ - removed?: string[]; - /** - * Format: date-time - * @description The ISO 8601 timestamp of the commit. - */ - timestamp: string; - tree_id: string; - /** - * Format: uri - * @description URL that points to the commit API resource. - */ - url: string; - }[]; - /** @description URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. */ - compare: string; - /** @description Whether this push created the `ref`. */ - created: boolean; - /** @description Whether this push deleted the `ref`. */ - deleted: boolean; - enterprise?: components["schemas"]["enterprise-webhooks"]; - /** @description Whether this push was a force push of the `ref`. */ - forced: boolean; - /** Commit */ - head_commit: { - /** @description An array of files added in the commit. */ - added?: string[]; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - author: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - committer: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** @description Whether this commit is distinct from any that have been pushed before. */ - distinct: boolean; - id: string; - /** @description The commit message. */ - message: string; - /** @description An array of files modified by the commit. */ - modified?: string[]; - /** @description An array of files removed in the commit. */ - removed?: string[]; - /** - * Format: date-time - * @description The ISO 8601 timestamp of the commit. - */ - timestamp: string; - tree_id: string; - /** - * Format: uri - * @description URL that points to the commit API resource. - */ - url: string; - } | null; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Committer - * @description Metaproperties for Git author/committer information. - */ - pusher: { - /** Format: date-time */ - date?: string; - /** Format: email */ - email?: string | null; - /** @description The git author's name. */ - name: string; - username?: string; - }; - /** @description The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. */ - ref: string; - /** - * Repository - * @description A git repository - */ - repository: { - /** - * @description Whether to allow auto-merge for pull requests. - * @default false - */ - allow_auto_merge: boolean; - /** @description Whether to allow private forks */ - allow_forking?: boolean; - /** - * @description Whether to allow merge commits for pull requests. - * @default true - */ - allow_merge_commit: boolean; - /** - * @description Whether to allow rebase merges for pull requests. - * @default true - */ - allow_rebase_merge: boolean; - /** - * @description Whether to allow squash merges for pull requests. - * @default true - */ - allow_squash_merge: boolean; - allow_update_branch?: boolean; - /** Format: uri-template */ - archive_url: string; - /** - * @description Whether the repository is archived. - * @default false - */ - archived: boolean; - /** Format: uri-template */ - assignees_url: string; - /** Format: uri-template */ - blobs_url: string; - /** Format: uri-template */ - branches_url: string; - /** Format: uri */ - clone_url: string; - /** Format: uri-template */ - collaborators_url: string; - /** Format: uri-template */ - comments_url: string; - /** Format: uri-template */ - commits_url: string; - /** Format: uri-template */ - compare_url: string; - /** Format: uri-template */ - contents_url: string; - /** Format: uri */ - contributors_url: string; - created_at: number | string; - /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ - custom_properties?: { - [key: string]: unknown; - }; - /** @description The default branch of the repository. */ - default_branch: string; - /** - * @description Whether to delete head branches when pull requests are merged - * @default false - */ - delete_branch_on_merge: boolean; - /** Format: uri */ - deployments_url: string; - description: string | null; - /** @description Returns whether or not this repository is disabled. */ - disabled?: boolean; - /** Format: uri */ - downloads_url: string; - /** Format: uri */ - events_url: string; - fork: boolean; - forks: number; - forks_count: number; - /** Format: uri */ - forks_url: string; - full_name: string; - /** Format: uri-template */ - git_commits_url: string; - /** Format: uri-template */ - git_refs_url: string; - /** Format: uri-template */ - git_tags_url: string; - /** Format: uri */ - git_url: string; - /** - * @description Whether downloads are enabled. - * @default true - */ - has_downloads: boolean; - /** - * @description Whether issues are enabled. - * @default true - */ - has_issues: boolean; - has_pages: boolean; - /** - * @description Whether projects are enabled. - * @default true - */ - has_projects: boolean; - /** - * @description Whether the wiki is enabled. - * @default true - */ - has_wiki: boolean; - /** - * @description Whether discussions are enabled. - * @default false - */ - has_discussions: boolean; - homepage: string | null; - /** Format: uri */ - hooks_url: string; + use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + } | null; + sha: 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; + 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; + }; /** Format: uri */ html_url: string; - /** @description Unique identifier of the repository */ id: number; - is_template?: boolean; - /** Format: uri-template */ - issue_comment_url: string; - /** Format: uri-template */ - issue_events_url: string; - /** Format: uri-template */ - issues_url: string; - /** Format: uri-template */ - keys_url: string; - /** Format: uri-template */ - labels_url: string; - language: string | null; /** Format: uri */ - languages_url: string; - /** License */ - license: { - key: string; + issue_url: string; + 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; - spdx_id: string; - /** Format: uri */ - url: string | null; - } | null; - master_branch?: string; - /** Format: uri */ - merges_url: string; - /** Format: uri-template */ - milestones_url: string; - /** Format: uri */ - mirror_url: string | null; - /** @description The name of the repository. */ - name: string; - node_id: string; - /** Format: uri-template */ - notifications_url: string; - open_issues: number; - open_issues_count: number; - organization?: string; + /** + * Format: uri + * @description URL for the label + */ + url: string; + }[]; + locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ + merged_at: string | null; /** User */ - owner: { + merged_by?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -83674,423 +75919,757 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - permissions?: { - admin: boolean; - maintain?: boolean; - pull: boolean; - push: boolean; - triage?: boolean; - }; - /** @description Whether the repository is private or public. */ - private: boolean; - public?: boolean; - /** Format: uri-template */ - pulls_url: string; - pushed_at: (number | string) | null; - /** Format: uri-template */ - releases_url: string; - role_name?: string | null; - size: number; - ssh_url: string; - stargazers?: number; - stargazers_count: number; - /** Format: uri */ - stargazers_url: string; - /** Format: uri-template */ - statuses_url: string; - /** Format: uri */ - subscribers_url: string; - /** Format: uri */ - subscription_url: string; - /** Format: uri */ - svn_url: string; - /** Format: uri */ - tags_url: string; - /** Format: uri */ - teams_url: string; - topics: string[]; - /** Format: uri-template */ - trees_url: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - /** @enum {string} */ - visibility: "public" | "private" | "internal"; - watchers: number; - watchers_count: number; - /** @description Whether to require contributors to sign off on web-based commits */ - web_commit_signoff_required?: boolean; - }; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - "webhook-registry-package-published": { - /** @enum {string} */ - action: "published"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - registry_package: { - created_at: string | null; - description: string | null; - ecosystem: string; - html_url: string; - id: number; - name: string; - namespace: string; - owner: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; + /** + * 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; + } | null; + description: string | null; + /** Format: date-time */ + due_on: string | null; + /** Format: uri */ html_url: string; id: number; - login: string; + /** Format: uri */ + labels_url: 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; + /** @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; - }; - package_type: string; - package_version: { - author?: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; + } | null; + node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ + number: number; + /** Format: uri */ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ + /** 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; + } | null) | { + deleted?: boolean; + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ html_url: string; + /** @description Unique identifier of the team */ id: number; - login: string; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: 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; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ url: string; - }; - body?: string | Record; - body_html?: string; - container_metadata?: { - labels?: Record; - manifest?: Record; - tag?: { - digest?: string; - name?: string; - }; - }; - created_at?: string; - description: string; - docker_metadata?: { - tags?: string[]; - }[]; - draft?: boolean; - html_url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + })[]; + requested_teams: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ id: number; - installation_command: string; - manifest?: string; - metadata: { - [key: string]: unknown; - }[]; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ name: string; - npm_metadata?: { - name?: string; - version?: string; - npm_user?: string; - author?: (string | Record) | null; - bugs?: (string | Record) | null; - dependencies?: Record; - dev_dependencies?: Record; - peer_dependencies?: Record; - optional_dependencies?: Record; - description?: string; - dist?: (string | Record) | null; - git_head?: string; - homepage?: string; - license?: string; - main?: string; - repository?: (string | Record) | null; - scripts?: Record; - id?: string; - node_version?: string; - npm_version?: string; - has_shrinkwrap?: boolean; - maintainers?: string[]; - contributors?: string[]; - engines?: Record; - keywords?: string[]; - files?: string[]; - bin?: Record; - man?: Record; - directories?: (string | Record) | null; - os?: string[]; - cpu?: string[]; - readme?: string; - installation_command?: string; - release_id?: number; - commit_oid?: string; - published_via_actions?: boolean; - deleted_by_id?: number; - } | null; - nuget_metadata?: { - id?: (string | Record | number) | null; - name?: string; - value?: boolean | string | number | { - url?: string; - branch?: string; - commit?: string; - type?: string; - }; - }[] | null; - package_files: { - content_type: string; - created_at: string; - download_url: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ id: number; - md5: string | null; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ name: string; - sha1: string | null; - sha256: string | null; - size: number; - state: string | null; - updated_at: string; - }[]; - package_url: string; - prerelease?: boolean; - release?: { - author?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - created_at?: string; - draft?: boolean; - html_url?: string; - id?: number; - name?: string | null; - prerelease?: boolean; - published_at?: string; - tag_name?: string; - target_commitish?: string; - url?: string; - }; - rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - summary: string; - tag_name?: string; - target_commitish?: string; - target_oid?: string; - updated_at?: string; - version: string; - } | null; - registry: { - about_url?: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; + }[]; + /** Format: uri-template */ + review_comment_url: string; + review_comments?: number; + /** Format: uri */ + review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + state: "open" | "closed"; + /** Format: uri */ + statuses_url: string; + /** @description The title of the pull request. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + 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; + id: number; + login: string; name?: string; - type?: 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; - vendor?: string; } | null; - updated_at: string | null; }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; }; - "webhook-registry-package-updated": { + /** pull_request unlabeled event */ + "webhook-pull-request-unlabeled": { /** @enum {string} */ - action: "updated"; + action: "unlabeled"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; + label?: components["schemas"]["webhooks_label"]; + number: components["schemas"]["webhooks_number"]; organization?: components["schemas"]["organization-simple-webhooks"]; - registry_package: { - created_at: string; - description: unknown; - ecosystem: string; - html_url: string; - id: number; - name: string; - namespace: string; - owner: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; + /** Pull Request */ + pull_request: { + _links: { + /** Link */ + comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + commits: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + html: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + issue: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comment: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + statuses: { + /** Format: uri-template */ + href: string; + }; + }; + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; + /** 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; - 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; - }; - package_type: string; - package_version: { - author: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: 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; + } | 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; + } | 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"; + /** + * PullRequestAutoMerge + * @description The status of auto merging a pull request. + */ + auto_merge: { + /** @description Commit message for the merge commit. */ + commit_message: string | null; + /** @description Title for the merge commit message. */ + commit_title: string | null; + /** User */ + enabled_by: { + /** 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; - 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; - }; - body: string; - body_html: string; - created_at: string; - description: string; - docker_metadata?: ({ - tags?: string[]; - } | null)[]; - draft?: boolean; - html_url: string; - id: number; - installation_command: string; - manifest?: string; - metadata: { - [key: string]: unknown; - }[]; - name: string; - package_files: { - content_type?: string; - created_at?: string; - download_url?: string; - id?: number; - md5?: string | null; name?: string; - sha1?: string | null; - sha256?: string; - size?: number; - state?: string; - updated_at?: string; - }[]; - package_url: string; - prerelease?: boolean; - release?: { - author: { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: 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; + /** + * @description The merge method to use. + * @enum {string} + */ + merge_method: "merge" | "squash" | "rebase"; + } | null; + base: { + label: string; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: 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; - 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; + 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; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; }; - created_at: string; - draft: boolean; - html_url: string; - id: number; - name: string; - prerelease: boolean; - published_at: string; - tag_name: string; - target_commitish: string; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: (number | string) | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; }; - rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; - summary: string; - tag_name?: string; - target_commitish: string; - target_oid: string; - updated_at: string; - version: string; - }; - registry: Record; - updated_at: string; - }; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** release created event */ - "webhook-release-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - release: { - assets: { - /** Format: uri */ - browser_download_url: string; - content_type: string; - /** Format: date-time */ - created_at: string; - download_count: number; - id: number; - label: string | null; - /** @description The file name of the asset. */ - name: string; - node_id: string; - size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - state: "uploaded"; - /** Format: date-time */ - updated_at: string; + sha: string; /** User */ - uploader?: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -84126,128 +76705,304 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** Format: uri */ - url: string; - }[]; - /** Format: uri */ - assets_url: string; - /** User */ - author: { - /** 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; + }; body: string | null; + changed_files?: number; /** Format: date-time */ - created_at: string | null; + closed_at: string | null; + comments?: number; /** Format: uri */ - discussion_url?: string; - /** @description Whether the release is a draft or published */ - draft: boolean; + comments_url: string; + commits?: number; /** Format: uri */ - html_url: string; - id: number; - name: string | null; - node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - prerelease: boolean; + commits_url: string; /** Format: date-time */ - published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - tag_name: string; - /** Format: uri */ - tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - target_commitish: string; - /** Format: uri-template */ - upload_url: string; - /** Format: uri */ - url: string; + created_at: string; + deletions?: number; /** Format: uri */ - zipball_url: string | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** release deleted event */ - "webhook-release-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - release: { - assets: { - /** Format: uri */ - browser_download_url: string; - content_type: string; - /** Format: date-time */ - created_at: string; - download_count: number; - id: number; + diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ + draft: boolean; + head: { label: string | null; - /** @description The file name of the asset. */ - name: string; - node_id: string; - size: number; + ref: string; /** - * @description State of the release asset. - * @enum {string} + * Repository + * @description A git repository */ - state: "uploaded"; - /** Format: date-time */ - updated_at: string; + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** + * @description The default value for a merge commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit message title. + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: 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; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: (number | string) | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + } | null; + sha: string; /** User */ - uploader?: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -84283,13 +77038,38 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** Format: uri */ + }; + /** Format: uri */ + html_url: string; + id: number; + /** Format: uri */ + issue_url: string; + 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 */ - assets_url: string; + locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ + merged_at: string | null; /** User */ - author: { + merged_by?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -84325,100 +77105,18 @@ export interface components { /** Format: uri */ url?: string; } | null; - body: string | null; - /** Format: date-time */ - created_at: string | null; - /** Format: uri */ - discussion_url?: string; - /** @description Whether the release is a draft or published */ - draft: boolean; - /** Format: uri */ - html_url: string; - id: number; - name: string | null; - node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - prerelease: boolean; - /** Format: date-time */ - published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - tag_name: string; - /** Format: uri */ - tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - target_commitish: string; - /** Format: uri-template */ - upload_url: string; - /** Format: uri */ - url: string; - /** Format: uri */ - zipball_url: string | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** release edited event */ - "webhook-release-edited": { - /** @enum {string} */ - action: "edited"; - changes: { - body?: { - /** @description The previous version of the body if the action was `edited`. */ - from: string; - }; - name?: { - /** @description The previous version of the name if the action was `edited`. */ - from: string; - }; - make_latest?: { - /** @description Whether this release was explicitly `edited` to be the latest. */ - to: boolean; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - release: { - assets: { - /** Format: uri */ - browser_download_url: string; - content_type: string; + /** + * Milestone + * @description A collection of related issues and pull requests. + */ + milestone: { /** Format: date-time */ - created_at: string; - download_count: number; - id: number; - label: string | null; - /** @description The file name of the asset. */ - name: string; - node_id: string; - size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - state: "uploaded"; + closed_at: string | null; + closed_issues: number; /** Format: date-time */ - updated_at: string; + created_at: string; /** User */ - uploader?: { + creator: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -84450,17 +77148,41 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: 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; + /** @description Number uniquely identifying the pull request within its repository. */ + number: number; /** Format: uri */ - assets_url: string; - /** User */ - author: { + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -84492,128 +77214,131 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; - } | null; - body: string | null; - /** Format: date-time */ - created_at: string | null; - /** Format: uri */ - discussion_url?: string; - /** @description Whether the release is a draft or published */ - draft: boolean; - /** Format: uri */ - html_url: string; - id: number; - name: string | null; - node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - prerelease: boolean; - /** Format: date-time */ - published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - tag_name: string; - /** Format: uri */ - tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - target_commitish: string; - /** Format: uri-template */ - upload_url: string; - /** Format: uri */ - url: string; - /** Format: uri */ - zipball_url: string | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** release prereleased event */ - "webhook-release-prereleased": { - /** @enum {string} */ - action: "prereleased"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - release: { - assets: { + } | null) | { + deleted?: boolean; + /** @description Description of the team */ + description: string | null; /** Format: uri */ - browser_download_url: string; - content_type: string; - /** Format: date-time */ - created_at: string; - download_count: number; + html_url: string; + /** @description Unique identifier of the team */ id: number; - label: string | null; - /** @description The file name of the asset. */ + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ name: string; node_id: string; - size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - state: "uploaded"; - /** Format: date-time */ - updated_at: string; - /** User */ - uploader?: { + parent?: { + /** @description Description of the team */ + description: string | null; /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; + html_url: string; + /** @description Unique identifier of the team */ + id: number; /** Format: uri-template */ - events_url?: string; + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; /** Format: uri */ - followers_url?: string; - /** Format: uri-template */ - following_url?: string; - /** Format: uri-template */ - gists_url?: string; - gravatar_id?: string; + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + })[]; + requested_teams: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; + /** Format: uri */ + html_url?: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; /** Format: uri */ - html_url?: string; + html_url: string; + /** @description Unique identifier of the team */ 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; + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + privacy: "open" | "closed" | "secret"; /** Format: uri */ - url?: string; + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - url: string; + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; }[]; + /** Format: uri-template */ + review_comment_url: string; + review_comments?: number; /** Format: uri */ - assets_url: string; + review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + state: "open" | "closed"; + /** Format: uri */ + statuses_url: string; + /** @description The title of the pull request. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; /** User */ - author: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -84645,170 +77370,71 @@ export interface components { /** Format: uri */ subscriptions_url?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + type?: "Bot" | "User" | "Organization" | "Mannequin"; /** Format: uri */ url?: string; } | null; - body: string | null; - /** Format: date-time */ - created_at: string | null; - /** Format: uri */ - discussion_url?: string; - /** @description Whether the release is a draft or published */ - draft: boolean; - /** Format: uri */ - html_url: string; - id: number; - name: string | null; - node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - prerelease: boolean; - /** Format: date-time */ - published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - tag_name: string; - /** Format: uri */ - tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - target_commitish: string; - /** Format: uri-template */ - upload_url: string; - /** Format: uri */ - url: string; - /** Format: uri */ - zipball_url: string | null; - } & { - assets?: Record[]; - assets_url?: string; - author?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - body?: string | null; - created_at?: string; - draft?: boolean; - html_url?: string; - id?: number; - name?: string | null; - node_id?: string; - /** - * @description Whether the release is identified as a prerelease or a full release. - * @enum {boolean} - */ - prerelease: true; - published_at?: string | null; - tag_name?: string; - tarball_url?: string | null; - target_commitish?: string; - upload_url?: string; - url?: string; - zipball_url?: string | null; }; repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** release published event */ - "webhook-release-published": { + /** pull_request unlocked event */ + "webhook-pull-request-unlocked": { /** @enum {string} */ - action: "published"; + action: "unlocked"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; + number: components["schemas"]["webhooks_number"]; organization?: components["schemas"]["organization-simple-webhooks"]; - release: { - assets: { - /** Format: uri */ - browser_download_url: string; - content_type: string; - /** Format: date-time */ - created_at: string; - download_count: number; - id: number; - label: string | null; - /** @description The file name of the asset. */ - name: string; - node_id: string; - size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - state: "uploaded"; - /** Format: date-time */ - updated_at: string; - /** User */ - uploader?: { - /** Format: uri */ - avatar_url?: string; - deleted?: boolean; - email?: string | null; + /** Pull Request */ + pull_request: { + _links: { + /** Link */ + comments: { /** Format: uri-template */ - events_url?: string; - /** Format: uri */ - followers_url?: string; + href: string; + }; + /** Link */ + commits: { /** Format: uri-template */ - following_url?: string; + href: string; + }; + /** Link */ + html: { /** 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; + href: string; + }; + /** Link */ + issue: { /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - /** Format: uri */ - url: string; - }[]; - /** Format: uri */ - assets_url: string; + href: string; + }; + /** Link */ + review_comment: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + review_comments: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + self: { + /** Format: uri-template */ + href: string; + }; + /** Link */ + statuses: { + /** Format: uri-template */ + href: string; + }; + }; + /** @enum {string|null} */ + active_lock_reason: "resolved" | "off-topic" | "too heated" | "spam" | null; + additions?: number; /** User */ - author: { + assignee: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -84844,125 +77470,59 @@ export interface components { /** Format: uri */ url?: string; } | null; - body: string | null; - /** Format: date-time */ - created_at: string | null; - /** Format: uri */ - discussion_url?: string; - /** @description Whether the release is a draft or published */ - draft: boolean; - /** Format: uri */ - html_url: string; - id: number; - name: string | null; - node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - prerelease: boolean; - /** Format: date-time */ - published_at: string | null; - /** Reactions */ - reactions?: { - "+1": number; - "-1": number; - confused: number; - eyes: number; - heart: number; - hooray: number; - laugh: number; - rocket: number; - total_count: number; + assignees: ({ /** Format: uri */ - url: string; - }; - /** @description The name of the tag. */ - tag_name: string; - /** Format: uri */ - tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - target_commitish: string; - /** Format: uri-template */ - upload_url: string; - /** Format: uri */ - url: string; - /** Format: uri */ - zipball_url: string | null; - } & { - assets?: Record[]; - assets_url?: string; - author?: { 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; + 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; - type?: string; - url?: string; - }; - body?: string | null; - created_at?: string; - draft?: boolean; - html_url?: string; - id?: number; - name?: string | null; - node_id?: string; - prerelease?: boolean; - /** Format: date-time */ - published_at: string | null; - tag_name?: string; - tarball_url?: string | null; - target_commitish?: string; - upload_url?: string; - url?: string; - zipball_url?: string | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** release released event */ - "webhook-release-released": { - /** @enum {string} */ - action: "released"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - /** - * Release - * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. - */ - release: { - assets: { + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; /** Format: uri */ - browser_download_url: string; - content_type: string; - /** Format: date-time */ - created_at: string; - download_count: number; - id: number; - label: string | null; - /** @description The file name of the asset. */ - name: string; - node_id: string; - size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - state: "uploaded"; - /** Format: date-time */ - updated_at: string; + 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"; + /** + * PullRequestAutoMerge + * @description The status of auto merging a pull request. + */ + auto_merge: { + /** @description Commit message for the merge commit. */ + commit_message: string | null; + /** @description Title for the merge commit message. */ + commit_title: string; /** User */ - uploader?: { + enabled_by: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -84992,130 +77552,305 @@ export interface components { /** Format: uri-template */ starred_url?: string; /** Format: uri */ - subscriptions_url?: string; + subscriptions_url?: string; + /** @enum {string} */ + type?: "Bot" | "User" | "Organization"; + /** Format: uri */ + url?: string; + } | null; + /** + * @description The merge method to use. + * @enum {string} + */ + merge_method: "merge" | "squash" | "rebase"; + } | null; + base: { + label: string; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: 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; + } | null; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: (number | string) | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; - /** Format: uri */ - url?: string; - } | null; - /** Format: uri */ - url: string; - }[]; - /** Format: uri */ - assets_url: string; - /** User */ - author: { - /** 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; - body: string | null; - /** Format: date-time */ - created_at: string | null; - /** Format: uri */ - discussion_url?: string; - /** @description Whether the release is a draft or published */ - draft: boolean; - /** Format: uri */ - html_url: string; - id: number; - name: string | null; - node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - prerelease: boolean; - /** Format: date-time */ - published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - tag_name: string; - /** Format: uri */ - tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - target_commitish: string; - /** Format: uri-template */ - upload_url: string; - /** Format: uri */ - url: string; - /** Format: uri */ - zipball_url: string | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** release unpublished event */ - "webhook-release-unpublished": { - /** @enum {string} */ - action: "unpublished"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - release: { - assets: { - /** Format: uri */ - browser_download_url: string; - content_type: string; - /** Format: date-time */ - created_at: string; - download_count: number; - id: number; - label: string | null; - /** @description The file name of the asset. */ - name: string; - node_id: string; - size: number; - /** - * @description State of the release asset. - * @enum {string} - */ - state: "uploaded"; - /** Format: date-time */ - updated_at: string; + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + }; + sha: string; /** User */ - uploader?: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -85131,403 +77866,223 @@ export interface components { 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; - /** Format: uri */ - url: string; - }[]; - /** Format: uri */ - assets_url: string; - /** User */ - author: { - /** 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; - body: string | null; - /** Format: date-time */ - created_at: string | null; - /** Format: uri */ - discussion_url?: string; - /** @description Whether the release is a draft or published */ - draft: boolean; - /** Format: uri */ - html_url: string; - id: number; - name: string | null; - node_id: string; - /** @description Whether the release is identified as a prerelease or a full release. */ - prerelease: boolean; - /** Format: date-time */ - published_at: string | null; - /** 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; - }; - /** @description The name of the tag. */ - tag_name: string; - /** Format: uri */ - tarball_url: string | null; - /** @description Specifies the commitish value that determines where the Git tag is created from. */ - target_commitish: string; - /** Format: uri-template */ - upload_url: string; - /** Format: uri */ - url: string; - /** Format: uri */ - zipball_url: string | null; - } & { - assets?: Record[]; - assets_url?: string; - author?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - body?: string | null; - created_at?: string; - draft?: boolean; - html_url?: string; - id?: number; - name?: string | null; - node_id?: string; - prerelease?: boolean; - published_at: string | null; - tag_name?: string; - tarball_url?: string | null; - target_commitish?: string; - upload_url?: string; - url?: string; - zipball_url?: string | null; - }; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** Repository advisory published event */ - "webhook-repository-advisory-published": { - /** @enum {string} */ - action: "published"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** Repository advisory reported event */ - "webhook-repository-advisory-reported": { - /** @enum {string} */ - action: "reported"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - repository_advisory: components["schemas"]["repository-advisory"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** repository archived event */ - "webhook-repository-archived": { - /** @enum {string} */ - action: "archived"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository created event */ - "webhook-repository-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository deleted event */ - "webhook-repository-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_dispatch event */ - "webhook-repository-dispatch-sample": { - /** @enum {string} */ - action: "sample.collected"; - branch: string; - client_payload: { - [key: string]: unknown; - } | null; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository edited event */ - "webhook-repository-edited": { - /** @enum {string} */ - action: "edited"; - changes: { - default_branch?: { - from: string; - }; - description?: { - from: string | null; - }; - homepage?: { - from: string | null; - }; - topics?: { - from?: string[] | null; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_import event */ - "webhook-repository-import": { - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - /** @enum {string} */ - status: "success" | "cancelled" | "failure"; - }; - /** repository privatized event */ - "webhook-repository-privatized": { - /** @enum {string} */ - action: "privatized"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository publicized event */ - "webhook-repository-publicized": { - /** @enum {string} */ - action: "publicized"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository renamed event */ - "webhook-repository-renamed": { - /** @enum {string} */ - action: "renamed"; - changes: { - repository: { - name: { - from: string; - }; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository ruleset created event */ - "webhook-repository-ruleset-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository ruleset deleted event */ - "webhook-repository-ruleset-deleted": { - /** @enum {string} */ - action: "deleted"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - repository_ruleset: components["schemas"]["repository-ruleset"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository ruleset edited event */ - "webhook-repository-ruleset-edited": { - /** @enum {string} */ - action: "edited"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - repository_ruleset: components["schemas"]["repository-ruleset"]; - changes?: { - name?: { - from?: string; - }; - enforcement?: { - from?: string; - }; - conditions?: { - added?: components["schemas"]["repository-ruleset-conditions"][]; - deleted?: components["schemas"]["repository-ruleset-conditions"][]; - updated?: { - condition?: components["schemas"]["repository-ruleset-conditions"]; - changes?: { - condition_type?: { - from?: string; - }; - target?: { - from?: string; - }; - include?: { - from?: string[]; - }; - exclude?: { - from?: string[]; - }; - }; - }[]; - }; - rules?: { - added?: components["schemas"]["repository-rule"][]; - deleted?: components["schemas"]["repository-rule"][]; - updated?: { - rule?: components["schemas"]["repository-rule"]; - changes?: { - configuration?: { - from?: string; - }; - rule_type?: { - from?: string; - }; - pattern?: { - from?: string; - }; - }; - }[]; - }; - }; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository transferred event */ - "webhook-repository-transferred": { - /** @enum {string} */ - action: "transferred"; - changes: { - owner: { - from: { - /** Organization */ - organization?: { - /** Format: uri */ - avatar_url: string; - description: string | null; - /** Format: uri */ - events_url: string; - /** Format: uri */ - hooks_url: string; - /** Format: uri */ - html_url?: string; - id: number; - /** Format: uri */ - issues_url: string; - login: string; - /** Format: uri-template */ - members_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; + }; + body: string | null; + changed_files?: number; + /** Format: date-time */ + closed_at: string | null; + comments?: number; + /** Format: uri */ + comments_url: string; + commits?: number; + /** Format: uri */ + commits_url: string; + /** Format: date-time */ + created_at: string; + deletions?: number; + /** Format: uri */ + diff_url: string; + /** @description Indicates whether or not the pull request is a draft. */ + draft: boolean; + head: { + label: string; + ref: string; + /** + * Repository + * @description A git repository + */ + repo: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; node_id: string; - /** Format: uri-template */ - public_members_url: string; - /** Format: uri */ - repos_url: string; + spdx_id: string; /** Format: uri */ - url: string; - }; + url: string | null; + } | null; + master_branch?: string; + /** + * @description The default value for a merge commit message. + * + * - `PR_TITLE` - default to the pull request's title. + * - `PR_BODY` - default to the pull request's body. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + merge_commit_message?: "PR_BODY" | "PR_TITLE" | "BLANK"; + /** + * @description The default value for a merge commit title. + * + * - `PR_TITLE` - default to the pull request's title. + * - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + * @enum {string} + */ + merge_commit_title?: "PR_TITLE" | "MERGE_MESSAGE"; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; + node_id: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - user?: { + owner: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -85563,324 +78118,146 @@ export interface components { /** Format: uri */ url?: string; } | null; - }; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository unarchived event */ - "webhook-repository-unarchived": { - /** @enum {string} */ - action: "unarchived"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert create event */ - "webhook-repository-vulnerability-alert-create": { - /** @enum {string} */ - action: "create"; - alert: { - affected_package_name: string; - affected_range: string; - created_at: string; - dismiss_reason?: string; - dismissed_at?: string; - /** User */ - dismisser?: { - /** 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; - external_identifier: string; - /** Format: uri */ - external_reference: string | null; - fix_reason?: string; - /** Format: date-time */ - fixed_at?: string; - fixed_in?: string; - ghsa_id: string; - id: number; - node_id: string; - number: number; - severity: string; - /** @enum {string} */ - state: "open" | "dismissed" | "fixed"; - } & { - affected_package_name?: string; - affected_range?: string; - created_at?: string; - external_identifier?: string; - external_reference?: string | null; - fixed_in?: string; - ghsa_id?: string; - id?: number; - node_id?: string; - number?: number; - severity?: string; - /** @enum {string} */ - state: "open"; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert dismiss event */ - "webhook-repository-vulnerability-alert-dismiss": { - /** @enum {string} */ - action: "dismiss"; - alert: { - affected_package_name: string; - affected_range: string; - created_at: string; - dismiss_comment?: string | null; - dismiss_reason?: string; - dismissed_at?: string; - /** User */ - dismisser?: { - /** 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; - external_identifier: string; - /** Format: uri */ - external_reference: string | null; - fix_reason?: string; - /** Format: date-time */ - fixed_at?: string; - fixed_in?: string; - ghsa_id: string; - id: number; - node_id: string; - number: number; - severity: string; - /** @enum {string} */ - state: "open" | "dismissed" | "fixed"; - } & { - affected_package_name?: string; - affected_range?: string; - created_at?: string; - dismiss_comment?: string | null; - dismiss_reason: string; - dismissed_at: string; - /** User */ - dismisser: { - /** 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; - external_identifier?: string; - external_reference?: string | null; - fixed_in?: string; - ghsa_id?: string; - id?: number; - node_id?: string; - number?: number; - severity?: string; - /** @enum {string} */ - state: "dismissed"; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert reopen event */ - "webhook-repository-vulnerability-alert-reopen": { - /** @enum {string} */ - action: "reopen"; - alert: { - affected_package_name: string; - affected_range: string; - created_at: string; - dismiss_reason?: string; - dismissed_at?: string; - /** User */ - dismisser?: { - /** 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; - external_identifier: string; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: (number | string) | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + /** + * @description The default value for a squash merge commit message: + * + * - `PR_BODY` - default to the pull request's body. + * - `COMMIT_MESSAGES` - default to the branch's commit messages. + * - `BLANK` - default to a blank commit message. + * @enum {string} + */ + squash_merge_commit_message?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK"; + /** + * @description The default value for a squash merge commit title: + * + * - `PR_TITLE` - default to the pull request's title. + * - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + * @enum {string} + */ + squash_merge_commit_title?: "PR_TITLE" | "COMMIT_OR_PR_TITLE"; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** + * @description Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. + * @default false + */ + use_squash_pr_title_as_default: boolean; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + } | null; + sha: 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; + 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; + }; /** Format: uri */ - external_reference: string | null; - fix_reason?: string; - /** Format: date-time */ - fixed_at?: string; - fixed_in?: string; - ghsa_id: string; + html_url: string; id: number; - node_id: string; - number: number; - severity: string; - /** @enum {string} */ - state: "open" | "dismissed" | "fixed"; - } & { - affected_package_name?: string; - affected_range?: string; - created_at?: string; - external_identifier?: string; - external_reference?: string | null; - fixed_in?: string; - ghsa_id?: string; - id?: number; - node_id?: string; - number?: number; - severity?: string; - /** @enum {string} */ - state: "open"; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** repository_vulnerability_alert resolve event */ - "webhook-repository-vulnerability-alert-resolve": { - /** @enum {string} */ - action: "resolve"; - alert: { - affected_package_name: string; - affected_range: string; - created_at: string; - dismiss_reason?: string; - dismissed_at?: string; + /** Format: uri */ + issue_url: string; + 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; + }[]; + locked: boolean; + /** @description Indicates whether maintainers can modify the pull request. */ + maintainer_can_modify?: boolean; + merge_commit_sha: string | null; + mergeable?: boolean | null; + mergeable_state?: string; + merged?: boolean | null; + /** Format: date-time */ + merged_at: string | null; /** User */ - dismisser?: { + merged_by?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -85916,330 +78293,84 @@ export interface components { /** Format: uri */ url?: string; } | null; - external_identifier: string; - /** Format: uri */ - external_reference: string | null; - fix_reason?: string; - /** Format: date-time */ - fixed_at?: string; - fixed_in?: string; - ghsa_id: string; - id: number; - node_id: string; - number: number; - severity: string; - /** @enum {string} */ - state: "open" | "dismissed" | "fixed"; - } & { - affected_package_name?: string; - affected_range?: string; - created_at?: string; - external_identifier?: string; - external_reference?: string | null; - fix_reason?: string; - /** Format: date-time */ - fixed_at?: string; - fixed_in?: string; - ghsa_id?: string; - id?: number; - node_id?: string; - number?: number; - severity?: string; - /** @enum {string} */ - state: "fixed" | "open"; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** secret_scanning_alert created event */ - "webhook-secret-scanning-alert-created": { - /** @enum {string} */ - action: "created"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** Secret Scanning Alert Location Created Event */ - "webhook-secret-scanning-alert-location-created": { - /** @enum {string} */ - action?: "created"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; - installation?: components["schemas"]["simple-installation"]; - location: components["schemas"]["secret-scanning-location"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - }; - /** Secret Scanning Alert Location Created Event */ - "webhook-secret-scanning-alert-location-created-form-encoded": { - /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ - payload: string; - }; - /** secret_scanning_alert reopened event */ - "webhook-secret-scanning-alert-reopened": { - /** @enum {string} */ - action: "reopened"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** secret_scanning_alert resolved event */ - "webhook-secret-scanning-alert-resolved": { - /** @enum {string} */ - action: "resolved"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** secret_scanning_alert revoked event */ - "webhook-secret-scanning-alert-revoked": { - /** @enum {string} */ - action: "revoked"; - alert: components["schemas"]["secret-scanning-alert-webhook"]; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_advisory published event */ - "webhook-security-advisory-published": { - /** @enum {string} */ - action: "published"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - /** @description The details of the security advisory, including summary, description, and severity. */ - security_advisory: { - cvss: { - score: number; - vector_string: string | null; - }; - cwes: { - cwe_id: string; - name: string; - }[]; - description: string; - ghsa_id: string; - identifiers: { - type: string; - value: string; - }[]; - published_at: string; - references: { - /** Format: uri */ - url: string; - }[]; - severity: string; - summary: string; - updated_at: string; - vulnerabilities: { - first_patched_version: { - identifier: string; - } | null; - package: { - ecosystem: string; - name: string; - }; - severity: string; - vulnerable_version_range: string; - }[]; - withdrawn_at: string | null; - }; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_advisory updated event */ - "webhook-security-advisory-updated": { - /** @enum {string} */ - action: "updated"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - /** @description The details of the security advisory, including summary, description, and severity. */ - security_advisory: { - cvss: { - score: number; - vector_string: string | null; - }; - cwes: { - cwe_id: string; - name: string; - }[]; - description: string; - ghsa_id: string; - identifiers: { - type: string; - value: string; - }[]; - published_at: string; - references: { - /** Format: uri */ - url: string; - }[]; - severity: string; - summary: string; - updated_at: string; - vulnerabilities: { - first_patched_version: { - identifier: string; - } | null; - package: { - ecosystem: string; - name: string; - }; - severity: string; - vulnerable_version_range: string; - }[]; - withdrawn_at: string | null; - }; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_advisory withdrawn event */ - "webhook-security-advisory-withdrawn": { - /** @enum {string} */ - action: "withdrawn"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - /** @description The details of the security advisory, including summary, description, and severity. */ - security_advisory: { - cvss: { - score: number; - vector_string: string | null; - }; - cwes: { - cwe_id: string; - name: string; - }[]; - description: string; - ghsa_id: string; - identifiers: { - type: string; - value: string; - }[]; - published_at: string; - references: { - /** Format: uri */ - url: string; - }[]; - severity: string; - summary: string; - updated_at: string; - vulnerabilities: { - first_patched_version: { - identifier: string; + /** + * 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"; + /** Format: uri */ + url?: string; } | null; - package: { - ecosystem: string; - name: string; - }; - severity: string; - vulnerable_version_range: string; - }[]; - withdrawn_at: string; - }; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** security_and_analysis event */ - "webhook-security-and-analysis": { - changes: { - from?: { - security_and_analysis?: components["schemas"]["security-and-analysis"]; - }; - }; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["full-repository"]; - sender?: components["schemas"]["simple-user-webhooks"]; - }; - /** sponsorship cancelled event */ - "webhook-sponsorship-cancelled": { - /** @enum {string} */ - action: "cancelled"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - sponsorship: { - created_at: string; - maintainer?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - node_id: string; - privacy_level: string; - /** User */ - sponsor: { - /** 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; + description: string | null; + /** Format: date-time */ + due_on: string | null; /** Format: uri */ - html_url?: string; + 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"; + 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; + url: string; } | null; - /** User */ - sponsorable: { + node_id: string; + /** @description Number uniquely identifying the pull request within its repository. */ + number: number; + /** Format: uri */ + patch_url: string; + rebaseable?: boolean | null; + requested_reviewers: (({ /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -86274,96 +78405,128 @@ export interface components { type?: "Bot" | "User" | "Organization"; /** Format: uri */ url?: string; - } | null; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - tier: { - created_at: string; - description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; - name: string; - node_id: string; - }; - }; - }; - /** sponsorship created event */ - "webhook-sponsorship-created": { - /** @enum {string} */ - action: "created"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - sponsorship: { - created_at: string; - maintainer?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - node_id: string; - privacy_level: string; - /** User */ - sponsor: { - /** Format: uri */ - avatar_url?: string; + } | null) | { 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; + /** @description Description of the team */ + description?: string | null; /** Format: uri */ html_url?: string; + /** @description Unique identifier of the team */ id: number; - login: string; - name?: string; + /** Format: uri-template */ + members_url?: string; + /** @description Name of the team */ + name: string; node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; + /** @enum {string} */ + privacy?: "open" | "closed" | "secret"; /** Format: uri */ - organizations_url?: string; - /** Format: uri */ - received_events_url?: string; + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ + url?: string; + })[]; + requested_teams: { + deleted?: boolean; + /** @description Description of the team */ + description?: string | null; /** Format: uri */ - repos_url?: string; - site_admin?: boolean; + html_url?: string; + /** @description Unique identifier of the team */ + id: number; /** Format: uri-template */ - starred_url?: string; - /** Format: uri */ - subscriptions_url?: string; + members_url?: string; + /** @description Name of the team */ + name: string; + node_id?: string; + parent?: { + /** @description Description of the team */ + description: string | null; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the team */ + id: number; + /** Format: uri-template */ + members_url: string; + /** @description Name of the team */ + name: string; + node_id: string; + /** @description Permission that the team will have for its repositories */ + permission: string; + /** @enum {string} */ + privacy: "open" | "closed" | "secret"; + /** Format: uri */ + repositories_url: string; + slug: string; + /** + * Format: uri + * @description URL for the team + */ + url: string; + } | null; + /** @description Permission that the team will have for its repositories */ + permission?: string; /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + privacy?: "open" | "closed" | "secret"; /** Format: uri */ + repositories_url?: string; + slug?: string; + /** + * Format: uri + * @description URL for the team + */ url?: string; - } | null; + }[]; + /** Format: uri-template */ + review_comment_url: string; + review_comments?: number; + /** Format: uri */ + review_comments_url: string; + /** + * @description State of this Pull Request. Either `open` or `closed`. + * @enum {string} + */ + state: "open" | "closed"; + /** Format: uri */ + statuses_url: string; + /** @description The title of the pull request. */ + title: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; /** User */ - sponsorable: { + user: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -86399,64 +78562,308 @@ export interface components { /** Format: uri */ url?: string; } | null; + }; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** push event */ + "webhook-push": { + /** @description The SHA of the most recent commit on `ref` after the push. */ + after: string; + base_ref: components["schemas"]["webhooks_nullable_string"]; + /** @description The SHA of the most recent commit on `ref` before the push. */ + before: string; + /** @description An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. */ + commits: { + /** @description An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. */ + added?: string[]; /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. + * Committer + * @description Metaproperties for Git author/committer information. */ - tier: { - created_at: string; - description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; + author: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ name: string; - node_id: string; + username?: string; }; - }; - }; - /** sponsorship edited event */ - "webhook-sponsorship-edited": { - /** @enum {string} */ - action: "edited"; - changes: { - privacy_level?: { - /** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */ - from: string; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + committer: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; }; - }; + /** @description Whether this commit is distinct from any that have been pushed before. */ + distinct: boolean; + id: string; + /** @description The commit message. */ + message: string; + /** @description An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit. */ + modified?: string[]; + /** @description An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. */ + removed?: string[]; + /** + * Format: date-time + * @description The ISO 8601 timestamp of the commit. + */ + timestamp: string; + tree_id: string; + /** + * Format: uri + * @description URL that points to the commit API resource. + */ + url: string; + }[]; + /** @description URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. */ + compare: string; + /** @description Whether this push created the `ref`. */ + created: boolean; + /** @description Whether this push deleted the `ref`. */ + deleted: boolean; enterprise?: components["schemas"]["enterprise-webhooks"]; + /** @description Whether this push was a force push of the `ref`. */ + forced: boolean; + /** Commit */ + head_commit: { + /** @description An array of files added in the commit. */ + added?: string[]; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + author: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + committer: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + /** @description Whether this commit is distinct from any that have been pushed before. */ + distinct: boolean; + id: string; + /** @description The commit message. */ + message: string; + /** @description An array of files modified by the commit. */ + modified?: string[]; + /** @description An array of files removed in the commit. */ + removed?: string[]; + /** + * Format: date-time + * @description The ISO 8601 timestamp of the commit. + */ + timestamp: string; + tree_id: string; + /** + * Format: uri + * @description URL that points to the commit API resource. + */ + url: string; + } | null; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - sponsorship: { - created_at: string; - maintainer?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; + /** + * Committer + * @description Metaproperties for Git author/committer information. + */ + pusher: { + /** Format: date-time */ + date?: string; + /** Format: email */ + email?: string | null; + /** @description The git author's name. */ + name: string; + username?: string; + }; + /** @description The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. */ + ref: string; + /** + * Repository + * @description A git repository + */ + repository: { + /** + * @description Whether to allow auto-merge for pull requests. + * @default false + */ + allow_auto_merge: boolean; + /** @description Whether to allow private forks */ + allow_forking?: boolean; + /** + * @description Whether to allow merge commits for pull requests. + * @default true + */ + allow_merge_commit: boolean; + /** + * @description Whether to allow rebase merges for pull requests. + * @default true + */ + allow_rebase_merge: boolean; + /** + * @description Whether to allow squash merges for pull requests. + * @default true + */ + allow_squash_merge: boolean; + allow_update_branch?: boolean; + /** Format: uri-template */ + archive_url: string; + /** + * @description Whether the repository is archived. + * @default false + */ + archived: boolean; + /** Format: uri-template */ + assignees_url: string; + /** Format: uri-template */ + blobs_url: string; + /** Format: uri-template */ + branches_url: string; + /** Format: uri */ + clone_url: string; + /** Format: uri-template */ + collaborators_url: string; + /** Format: uri-template */ + comments_url: string; + /** Format: uri-template */ + commits_url: string; + /** Format: uri-template */ + compare_url: string; + /** Format: uri-template */ + contents_url: string; + /** Format: uri */ + contributors_url: string; + created_at: number | string; + /** @description The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. */ + custom_properties?: { + [key: string]: unknown; }; + /** @description The default branch of the repository. */ + default_branch: string; + /** + * @description Whether to delete head branches when pull requests are merged + * @default false + */ + delete_branch_on_merge: boolean; + /** Format: uri */ + deployments_url: string; + description: string | null; + /** @description Returns whether or not this repository is disabled. */ + disabled?: boolean; + /** Format: uri */ + downloads_url: string; + /** Format: uri */ + events_url: string; + fork: boolean; + forks: number; + forks_count: number; + /** Format: uri */ + forks_url: string; + full_name: string; + /** Format: uri-template */ + git_commits_url: string; + /** Format: uri-template */ + git_refs_url: string; + /** Format: uri-template */ + git_tags_url: string; + /** Format: uri */ + git_url: string; + /** + * @description Whether downloads are enabled. + * @default true + */ + has_downloads: boolean; + /** + * @description Whether issues are enabled. + * @default true + */ + has_issues: boolean; + has_pages: boolean; + /** + * @description Whether projects are enabled. + * @default true + */ + has_projects: boolean; + /** + * @description Whether the wiki is enabled. + * @default true + */ + has_wiki: boolean; + /** + * @description Whether discussions are enabled. + * @default false + */ + has_discussions: boolean; + homepage: string | null; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url: string; + /** @description Unique identifier of the repository */ + id: number; + is_template?: boolean; + /** Format: uri-template */ + issue_comment_url: string; + /** Format: uri-template */ + issue_events_url: string; + /** Format: uri-template */ + issues_url: string; + /** Format: uri-template */ + keys_url: string; + /** Format: uri-template */ + labels_url: string; + language: string | null; + /** Format: uri */ + languages_url: string; + /** License */ + license: { + key: string; + name: string; + node_id: string; + spdx_id: string; + /** Format: uri */ + url: string | null; + } | null; + master_branch?: string; + /** Format: uri */ + merges_url: string; + /** Format: uri-template */ + milestones_url: string; + /** Format: uri */ + mirror_url: string | null; + /** @description The name of the repository. */ + name: string; node_id: string; - privacy_level: string; + /** Format: uri-template */ + notifications_url: string; + open_issues: number; + open_issues_count: number; + organization?: string; /** User */ - sponsor: { + owner: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -86492,134 +78899,508 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** User */ - sponsorable: { - /** 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; + permissions?: { + admin: boolean; + maintain?: boolean; + pull: boolean; + push: boolean; + triage?: boolean; + }; + /** @description Whether the repository is private or public. */ + private: boolean; + public?: boolean; + /** Format: uri-template */ + pulls_url: string; + pushed_at: (number | string) | null; + /** Format: uri-template */ + releases_url: string; + role_name?: string | null; + size: number; + ssh_url: string; + stargazers?: number; + stargazers_count: number; + /** Format: uri */ + stargazers_url: string; + /** Format: uri-template */ + statuses_url: string; + /** Format: uri */ + subscribers_url: string; + /** Format: uri */ + subscription_url: string; + /** Format: uri */ + svn_url: string; + /** Format: uri */ + tags_url: string; + /** Format: uri */ + teams_url: string; + topics: string[]; + /** Format: uri-template */ + trees_url: string; + /** Format: date-time */ + updated_at: string; + /** Format: uri */ + url: string; + /** @enum {string} */ + visibility: "public" | "private" | "internal"; + watchers: number; + watchers_count: number; + /** @description Whether to require contributors to sign off on web-based commits */ + web_commit_signoff_required?: boolean; + }; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + "webhook-registry-package-published": { + /** @enum {string} */ + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + registry_package: { + created_at: string | null; + description: string | null; + ecosystem: string; + html_url: string; + id: number; + name: string; + namespace: string; + owner: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; 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; + }; + package_type: string; + package_version: { + author?: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + 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; + }; + body?: string | Record; + body_html?: string; + container_metadata?: { + labels?: Record; + manifest?: Record; + tag?: { + digest?: string; + name?: string; + }; + }; + created_at?: string; + description: string; + docker_metadata?: { + tags?: string[]; + }[]; + draft?: boolean; + html_url: string; + id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; + }[]; + name: string; + npm_metadata?: { + name?: string; + version?: string; + npm_user?: string; + author?: (string | Record) | null; + bugs?: (string | Record) | null; + dependencies?: Record; + dev_dependencies?: Record; + peer_dependencies?: Record; + optional_dependencies?: Record; + description?: string; + dist?: (string | Record) | null; + git_head?: string; + homepage?: string; + license?: string; + main?: string; + repository?: (string | Record) | null; + scripts?: Record; + id?: string; + node_version?: string; + npm_version?: string; + has_shrinkwrap?: boolean; + maintainers?: string[]; + contributors?: string[]; + engines?: Record; + keywords?: string[]; + files?: string[]; + bin?: Record; + man?: Record; + directories?: (string | Record) | null; + os?: string[]; + cpu?: string[]; + readme?: string; + installation_command?: string; + release_id?: number; + commit_oid?: string; + published_via_actions?: boolean; + deleted_by_id?: number; + } | null; + nuget_metadata?: { + id?: (string | Record | number) | null; + name?: string; + value?: boolean | string | number | { + url?: string; + branch?: string; + commit?: string; + type?: string; + }; + }[] | null; + package_files: { + content_type: string; + created_at: string; + download_url: string; + id: number; + md5: string | null; + name: string; + sha1: string | null; + sha256: string | null; + size: number; + state: string | null; + updated_at: string; + }[]; + package_url: string; + prerelease?: boolean; + release?: { + author?: { + avatar_url?: string; + events_url?: string; + followers_url?: string; + following_url?: string; + gists_url?: string; + gravatar_id?: string; + html_url?: string; + 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; + }; + created_at?: string; + draft?: boolean; + html_url?: string; + id?: number; + name?: string | null; + prerelease?: boolean; + published_at?: string; + tag_name?: string; + target_commitish?: string; + url?: string; + }; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + summary: string; + tag_name?: string; + target_commitish?: string; + target_oid?: string; + updated_at?: string; + version: string; + } | null; + registry: { + about_url?: 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 */ + type?: string; url?: string; + vendor?: string; } | null; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - tier: { + updated_at: string | null; + }; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + "webhook-registry-package-updated": { + /** @enum {string} */ + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + registry_package: { + created_at: string; + description: unknown; + ecosystem: string; + html_url: string; + id: number; + name: string; + namespace: string; + owner: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + 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; + }; + package_type: string; + package_version: { + author: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + 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; + }; + body: string; + body_html: string; created_at: string; description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; + docker_metadata?: ({ + tags?: string[]; + } | null)[]; + draft?: boolean; + html_url: string; + id: number; + installation_command: string; + manifest?: string; + metadata: { + [key: string]: unknown; + }[]; name: string; - node_id: string; + package_files: { + content_type?: string; + created_at?: string; + download_url?: string; + id?: number; + md5?: string | null; + name?: string; + sha1?: string | null; + sha256?: string; + size?: number; + state?: string; + updated_at?: string; + }[]; + package_url: string; + prerelease?: boolean; + release?: { + author: { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + 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; + }; + created_at: string; + draft: boolean; + html_url: string; + id: number; + name: string; + prerelease: boolean; + published_at: string; + tag_name: string; + target_commitish: string; + url: string; + }; + rubygems_metadata?: components["schemas"]["webhook-rubygems-metadata"][]; + summary: string; + tag_name?: string; + target_commitish: string; + target_oid: string; + updated_at: string; + version: string; }; + registry: Record; + updated_at: string; }; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** sponsorship pending_cancellation event */ - "webhook-sponsorship-pending-cancellation": { + /** release created event */ + "webhook-release-created": { /** @enum {string} */ - action: "pending_cancellation"; - /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ - effective_date?: string; + action: "created"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; - sponsorship: { - created_at: string; - maintainer?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; + }; + /** release deleted event */ + "webhook-release-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** release edited event */ + "webhook-release-edited": { + /** @enum {string} */ + action: "edited"; + changes: { + body?: { + /** @description The previous version of the body if the action was `edited`. */ + from: string; }; - node_id: string; - privacy_level: string; - /** User */ - sponsor: { - /** 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; + name?: { + /** @description The previous version of the name if the action was `edited`. */ + from: string; + }; + make_latest?: { + /** @description Whether this release was explicitly `edited` to be the latest. */ + to: boolean; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** release prereleased event */ + "webhook-release-prereleased": { + /** @enum {string} */ + action: "prereleased"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + /** + * Release + * @description The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. + */ + release: { + assets: ({ /** Format: uri */ - subscriptions_url?: string; - /** @enum {string} */ - type?: "Bot" | "User" | "Organization"; + browser_download_url: string; + content_type: string; + /** Format: date-time */ + created_at: string; + download_count: number; + id: number; + label: string | null; + /** @description The file name of the asset. */ + name: string; + node_id: string; + size: number; + /** + * @description State of the release asset. + * @enum {string} + */ + state: "uploaded"; + /** Format: date-time */ + updated_at: string; + /** User */ + uploader?: { + /** 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; /** Format: uri */ - url?: string; - } | null; + url: string; + } | null)[]; + /** Format: uri */ + assets_url: string; /** User */ - sponsorable: { + author: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -86655,222 +79436,422 @@ export interface components { /** Format: uri */ url?: string; } | null; + body: string | null; + /** Format: date-time */ + created_at: string | null; + /** Format: uri */ + discussion_url?: string; + /** @description Whether the release is a draft or published */ + draft: boolean; + /** Format: uri */ + html_url: string; + id: number; + name: string | null; + node_id: string; /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. + * @description Whether the release is identified as a prerelease or a full release. + * @enum {boolean} */ - tier: { - created_at: string; - description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; - name: string; - node_id: string; + prerelease: true; + /** Format: date-time */ + published_at: string | null; + /** 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; }; + /** @description The name of the tag. */ + tag_name: string; + /** Format: uri */ + tarball_url: string | null; + /** @description Specifies the commitish value that determines where the Git tag is created from. */ + target_commitish: string; + /** Format: uri-template */ + upload_url: string; + /** Format: uri */ + url: string; + /** Format: uri */ + zipball_url: string | null; }; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; }; - /** sponsorship pending_tier_change event */ - "webhook-sponsorship-pending-tier-change": { + /** release published event */ + "webhook-release-published": { /** @enum {string} */ - action: "pending_tier_change"; + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release_1"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** release released event */ + "webhook-release-released": { + /** @enum {string} */ + action: "released"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** release unpublished event */ + "webhook-release-unpublished": { + /** @enum {string} */ + action: "unpublished"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + release: components["schemas"]["webhooks_release_1"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Repository advisory published event */ + "webhook-repository-advisory-published": { + /** @enum {string} */ + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + repository_advisory: components["schemas"]["repository-advisory"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Repository advisory reported event */ + "webhook-repository-advisory-reported": { + /** @enum {string} */ + action: "reported"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + repository_advisory: components["schemas"]["repository-advisory"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** repository archived event */ + "webhook-repository-archived": { + /** @enum {string} */ + action: "archived"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository created event */ + "webhook-repository-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository deleted event */ + "webhook-repository-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_dispatch event */ + "webhook-repository-dispatch-sample": { + /** @description The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + action: string; + branch: string; + /** @description The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. */ + client_payload: { + [key: string]: unknown; + } | null; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository edited event */ + "webhook-repository-edited": { + /** @enum {string} */ + action: "edited"; changes: { - tier: { - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - from: { - created_at: string; - description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; - name: string; - node_id: string; + default_branch?: { + from: string; + }; + description?: { + from: string | null; + }; + homepage?: { + from: string | null; + }; + topics?: { + from?: string[] | null; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_import event */ + "webhook-repository-import": { + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + /** @enum {string} */ + status: "success" | "cancelled" | "failure"; + }; + /** repository privatized event */ + "webhook-repository-privatized": { + /** @enum {string} */ + action: "privatized"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository publicized event */ + "webhook-repository-publicized": { + /** @enum {string} */ + action: "publicized"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository renamed event */ + "webhook-repository-renamed": { + /** @enum {string} */ + action: "renamed"; + changes: { + repository: { + name: { + from: string; }; }; }; - /** @description The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. */ - effective_date?: string; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository ruleset created event */ + "webhook-repository-ruleset-created": { + /** @enum {string} */ + action: "created"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository?: components["schemas"]["repository-webhooks"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; sender: components["schemas"]["simple-user-webhooks"]; - sponsorship: { - created_at: string; - maintainer?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; + }; + /** repository ruleset deleted event */ + "webhook-repository-ruleset-deleted": { + /** @enum {string} */ + action: "deleted"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository ruleset edited event */ + "webhook-repository-ruleset-edited": { + /** @enum {string} */ + action: "edited"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + repository_ruleset: components["schemas"]["repository-ruleset"]; + changes?: { + name?: { + from?: string; }; - node_id: string; - privacy_level: string; - /** User */ - sponsor: { - /** 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; - /** User */ - sponsorable: { - /** 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; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - tier: { - created_at: string; - description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; - name: string; - node_id: string; + enforcement?: { + from?: string; + }; + conditions?: { + added?: components["schemas"]["repository-ruleset-conditions"][]; + deleted?: components["schemas"]["repository-ruleset-conditions"][]; + updated?: { + condition?: components["schemas"]["repository-ruleset-conditions"]; + changes?: { + condition_type?: { + from?: string; + }; + target?: { + from?: string; + }; + include?: { + from?: string[]; + }; + exclude?: { + from?: string[]; + }; + }; + }[]; + }; + rules?: { + added?: components["schemas"]["repository-rule"][]; + deleted?: components["schemas"]["repository-rule"][]; + updated?: { + rule?: components["schemas"]["repository-rule"]; + changes?: { + configuration?: { + from?: string; + }; + rule_type?: { + from?: string; + }; + pattern?: { + from?: string; + }; + }; + }[]; + }; + }; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository transferred event */ + "webhook-repository-transferred": { + /** @enum {string} */ + action: "transferred"; + changes: { + owner: { + from: { + /** Organization */ + organization?: { + /** Format: uri */ + avatar_url: string; + description: string | null; + /** Format: uri */ + events_url: string; + /** Format: uri */ + hooks_url: string; + /** Format: uri */ + html_url?: string; + id: number; + /** Format: uri */ + issues_url: string; + login: string; + /** Format: uri-template */ + members_url: string; + node_id: string; + /** Format: uri-template */ + public_members_url: string; + /** Format: uri */ + repos_url: string; + /** Format: uri */ + 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; + 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; + }; }; }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; }; - /** sponsorship tier_changed event */ - "webhook-sponsorship-tier-changed": { + /** repository unarchived event */ + "webhook-repository-unarchived": { /** @enum {string} */ - action: "tier_changed"; - changes: { - tier: { - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - from: { - created_at: string; - description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; - name: string; - node_id: string; - }; - }; - }; + action: "unarchived"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; - repository?: components["schemas"]["repository-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_vulnerability_alert create event */ + "webhook-repository-vulnerability-alert-create": { + /** @enum {string} */ + action: "create"; + alert: components["schemas"]["webhooks_alert"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; - sponsorship: { + }; + /** repository_vulnerability_alert dismiss event */ + "webhook-repository-vulnerability-alert-dismiss": { + /** @enum {string} */ + action: "dismiss"; + /** + * Repository Vulnerability Alert Alert + * @description The security alert of the vulnerable dependency. + */ + alert: { + affected_package_name: string; + affected_range: string; created_at: string; - maintainer?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - node_id: string; - privacy_level: string; + dismiss_comment?: string | null; + dismiss_reason: string; + dismissed_at: string; /** User */ - sponsor: { + dismisser: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -86906,8 +79887,54 @@ export interface components { /** Format: uri */ url?: string; } | null; + external_identifier: string; + /** Format: uri */ + external_reference: string | null; + fix_reason?: string; + /** Format: date-time */ + fixed_at?: string; + fixed_in?: string; + ghsa_id: string; + id: number; + node_id: string; + number: number; + severity: string; + /** @enum {string} */ + state: "dismissed"; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_vulnerability_alert reopen event */ + "webhook-repository-vulnerability-alert-reopen": { + /** @enum {string} */ + action: "reopen"; + alert: components["schemas"]["webhooks_alert"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** repository_vulnerability_alert resolve event */ + "webhook-repository-vulnerability-alert-resolve": { + /** @enum {string} */ + action: "resolve"; + /** + * Repository Vulnerability Alert Alert + * @description The security alert of the vulnerable dependency. + */ + alert: { + affected_package_name: string; + affected_range: string; + created_at: string; + dismiss_reason?: string; + dismissed_at?: string; /** User */ - sponsorable: { + dismisser?: { /** Format: uri */ avatar_url?: string; deleted?: boolean; @@ -86943,22 +79970,255 @@ export interface components { /** Format: uri */ url?: string; } | null; - /** - * Sponsorship Tier - * @description The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. - */ - tier: { - created_at: string; - description: string; - is_custom_ammount?: boolean; - is_custom_amount?: boolean; - is_one_time: boolean; - monthly_price_in_cents: number; - monthly_price_in_dollars: number; + external_identifier: string; + /** Format: uri */ + external_reference: string | null; + fix_reason?: string; + /** Format: date-time */ + fixed_at?: string; + fixed_in?: string; + ghsa_id: string; + id: number; + node_id: string; + number: number; + severity: string; + /** @enum {string} */ + state: "fixed" | "open"; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert created event */ + "webhook-secret-scanning-alert-created": { + /** @enum {string} */ + action: "created"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** Secret Scanning Alert Location Created Event */ + "webhook-secret-scanning-alert-location-created": { + /** @enum {string} */ + action?: "created"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + installation?: components["schemas"]["simple-installation"]; + location: components["schemas"]["secret-scanning-location"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + }; + /** Secret Scanning Alert Location Created Event */ + "webhook-secret-scanning-alert-location-created-form-encoded": { + /** @description A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. */ + payload: string; + }; + /** secret_scanning_alert reopened event */ + "webhook-secret-scanning-alert-reopened": { + /** @enum {string} */ + action: "reopened"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert resolved event */ + "webhook-secret-scanning-alert-resolved": { + /** @enum {string} */ + action: "resolved"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert revoked event */ + "webhook-secret-scanning-alert-revoked": { + /** @enum {string} */ + action: "revoked"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** secret_scanning_alert validated event */ + "webhook-secret-scanning-alert-validated": { + /** @enum {string} */ + action: "validated"; + alert: components["schemas"]["secret-scanning-alert-webhook"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_advisory published event */ + "webhook-security-advisory-published": { + /** @enum {string} */ + action: "published"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + security_advisory: components["schemas"]["webhooks_security_advisory"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_advisory updated event */ + "webhook-security-advisory-updated": { + /** @enum {string} */ + action: "updated"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + security_advisory: components["schemas"]["webhooks_security_advisory"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_advisory withdrawn event */ + "webhook-security-advisory-withdrawn": { + /** @enum {string} */ + action: "withdrawn"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + /** @description The details of the security advisory, including summary, description, and severity. */ + security_advisory: { + cvss: { + score: number; + vector_string: string | null; + }; + cwes: { + cwe_id: string; name: string; - node_id: string; + }[]; + description: string; + ghsa_id: string; + identifiers: { + type: string; + value: string; + }[]; + published_at: string; + references: { + /** Format: uri */ + url: string; + }[]; + severity: string; + summary: string; + updated_at: string; + vulnerabilities: { + first_patched_version: { + identifier: string; + } | null; + package: { + ecosystem: string; + name: string; + }; + severity: string; + vulnerable_version_range: string; + }[]; + withdrawn_at: string; + }; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** security_and_analysis event */ + "webhook-security-and-analysis": { + changes: { + from?: { + security_and_analysis?: components["schemas"]["security-and-analysis"]; + }; + }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["full-repository"]; + sender?: components["schemas"]["simple-user-webhooks"]; + }; + /** sponsorship cancelled event */ + "webhook-sponsorship-cancelled": { + /** @enum {string} */ + action: "cancelled"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship created event */ + "webhook-sponsorship-created": { + /** @enum {string} */ + action: "created"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship edited event */ + "webhook-sponsorship-edited": { + /** @enum {string} */ + action: "edited"; + changes: { + privacy_level?: { + /** @description The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. */ + from: string; }; }; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship pending_cancellation event */ + "webhook-sponsorship-pending-cancellation": { + /** @enum {string} */ + action: "pending_cancellation"; + effective_date?: components["schemas"]["webhooks_effective_date"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship pending_tier_change event */ + "webhook-sponsorship-pending-tier-change": { + /** @enum {string} */ + action: "pending_tier_change"; + changes: components["schemas"]["webhooks_changes_8"]; + effective_date?: components["schemas"]["webhooks_effective_date"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; + }; + /** sponsorship tier_changed event */ + "webhook-sponsorship-tier-changed": { + /** @enum {string} */ + action: "tier_changed"; + changes: components["schemas"]["webhooks_changes_8"]; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository?: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + sponsorship: components["schemas"]["webhooks_sponsorship"]; }; /** star created event */ "webhook-star-created": { @@ -87163,71 +80423,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; + team: components["schemas"]["webhooks_team_1"]; }; /** team added_to_repository event */ "webhook-team-added-to-repository": { @@ -87476,71 +80672,7 @@ export interface components { watchers_count: number; }; sender?: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; + team: components["schemas"]["webhooks_team_1"]; }; /** team created event */ "webhook-team-created": { @@ -87789,71 +80921,7 @@ export interface components { watchers_count: number; }; sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; + team: components["schemas"]["webhooks_team_1"]; }; /** team deleted event */ "webhook-team-deleted": { @@ -88102,71 +81170,7 @@ export interface components { watchers_count: number; }; sender?: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; + team: components["schemas"]["webhooks_team_1"]; }; /** team edited event */ "webhook-team-edited": { @@ -88446,71 +81450,7 @@ export interface components { watchers_count: number; }; sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; + team: components["schemas"]["webhooks_team_1"]; }; /** team removed_from_repository event */ "webhook-team-removed-from-repository": { @@ -88759,71 +81699,7 @@ export interface components { watchers_count: number; }; sender: components["schemas"]["simple-user-webhooks"]; - /** - * Team - * @description Groups of organization members that gives permissions on specified repositories. - */ - team: { - deleted?: boolean; - /** @description Description of the team */ - description?: string | null; - /** Format: uri */ - html_url?: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url?: string; - /** @description Name of the team */ - name: string; - node_id?: string; - parent?: { - /** @description Description of the team */ - description: string | null; - /** Format: uri */ - html_url: string; - /** @description Unique identifier of the team */ - id: number; - /** Format: uri-template */ - members_url: string; - /** @description Name of the team */ - name: string; - node_id: string; - /** @description Permission that the team will have for its repositories */ - permission: string; - /** @enum {string} */ - privacy: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url: string; - slug: string; - /** - * Format: uri - * @description URL for the team - */ - url: string; - } | null; - /** @description Permission that the team will have for its repositories */ - permission?: string; - /** @enum {string} */ - privacy?: "open" | "closed" | "secret"; - /** - * @description Whether team members will receive notifications when their team is @mentioned - * @enum {string} - */ - notification_setting?: "notifications_enabled" | "notifications_disabled"; - /** Format: uri */ - repositories_url?: string; - slug?: string; - /** - * Format: uri - * @description URL for the team - */ - url?: string; - }; + team: components["schemas"]["webhooks_team_1"]; }; /** watch started event */ "webhook-watch-started": { @@ -89069,66 +81945,12 @@ export interface components { runner_name: string | null; /** Format: date-time */ started_at: string; - /** @enum {string} */ - status: "queued" | "in_progress" | "completed" | "waiting"; - /** @description The name of the current branch. */ - head_branch: string | null; - /** @description The name of the workflow. */ - workflow_name: string | null; - steps: { - completed_at: string | null; - /** @enum {string|null} */ - conclusion: "failure" | "skipped" | "success" | "cancelled" | null; - name: string; - number: number; - started_at: string | null; - /** @enum {string} */ - status: "completed" | "in_progress" | "queued" | "pending"; - }[]; - /** Format: uri */ - url: string; - }; - deployment?: components["schemas"]["deployment"]; - }; - /** workflow_job waiting event */ - "webhook-workflow-job-waiting": { - /** @enum {string} */ - action: "waiting"; - enterprise?: components["schemas"]["enterprise-webhooks"]; - installation?: components["schemas"]["simple-installation"]; - organization?: components["schemas"]["organization-simple-webhooks"]; - repository: components["schemas"]["repository-webhooks"]; - sender: components["schemas"]["simple-user-webhooks"]; - workflow_job: { - /** Format: uri */ - check_run_url: string; - completed_at: string | null; - conclusion: string | null; - /** @description The time that the job created. */ - created_at: string; - head_sha: string; - /** Format: uri */ - html_url: string; - id: number; - labels: string[]; - name: string; - node_id: string; - run_attempt: number; - run_id: number; - /** Format: uri */ - run_url: string; - runner_group_id: number | null; - runner_group_name: string | null; - runner_id: number | null; - runner_name: string | null; - /** Format: date-time */ - started_at: string; + /** @enum {string} */ + status: "queued" | "in_progress" | "completed" | "waiting"; /** @description The name of the current branch. */ head_branch: string | null; /** @description The name of the workflow. */ workflow_name: string | null; - /** @enum {string} */ - status: "queued" | "in_progress" | "completed" | "waiting"; steps: { completed_at: string | null; /** @enum {string|null} */ @@ -89137,40 +81959,78 @@ export interface components { number: number; started_at: string | null; /** @enum {string} */ - status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; + status: "completed" | "in_progress" | "queued" | "pending"; }[]; /** Format: uri */ url: string; }; deployment?: components["schemas"]["deployment"]; }; - /** workflow_run completed event */ - "webhook-workflow-run-completed": { + /** workflow_job waiting event */ + "webhook-workflow-job-waiting": { /** @enum {string} */ - action: "completed"; + action: "waiting"; enterprise?: components["schemas"]["enterprise-webhooks"]; installation?: components["schemas"]["simple-installation"]; organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - workflow: { + workflow_job: { /** Format: uri */ - badge_url: string; - /** Format: date-time */ + check_run_url: string; + completed_at: string | null; + conclusion: string | null; + /** @description The time that the job created. */ created_at: string; + head_sha: string; /** Format: uri */ html_url: string; id: number; + labels: string[]; name: string; node_id: string; - path: string; - state: string; + run_attempt: number; + run_id: number; + /** Format: uri */ + run_url: string; + runner_group_id: number | null; + runner_group_name: string | null; + runner_id: number | null; + runner_name: string | null; /** Format: date-time */ - updated_at: string; + started_at: string; + /** @description The name of the current branch. */ + head_branch: string | null; + /** @description The name of the workflow. */ + workflow_name: string | null; + /** @enum {string} */ + status: "queued" | "in_progress" | "completed" | "waiting"; + steps: { + completed_at: string | null; + /** @enum {string|null} */ + conclusion: "failure" | "skipped" | "success" | "cancelled" | null; + name: string; + number: number; + started_at: string | null; + /** @enum {string} */ + status: "completed" | "in_progress" | "queued" | "pending" | "waiting"; + }[]; /** Format: uri */ url: string; - } | null; + }; + deployment?: components["schemas"]["deployment"]; + }; + /** workflow_run completed event */ + "webhook-workflow-run-completed": { + /** @enum {string} */ + action: "completed"; + enterprise?: components["schemas"]["enterprise-webhooks"]; + installation?: components["schemas"]["simple-installation"]; + organization?: components["schemas"]["organization-simple-webhooks"]; + repository: components["schemas"]["repository-webhooks"]; + sender: components["schemas"]["simple-user-webhooks"]; + workflow: components["schemas"]["webhooks_workflow"]; + /** Workflow Run */ workflow_run: { /** User */ actor: { @@ -89218,7 +82078,7 @@ export interface components { /** Format: uri */ check_suite_url: string; /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | null | "skipped"; + conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out"; /** Format: date-time */ created_at: string; event: string; @@ -89395,7 +82255,7 @@ export interface components { path: string; /** Format: uri */ previous_attempt_url: string | null; - pull_requests: { + pull_requests: ({ base: { ref: string; /** Repo Ref */ @@ -89422,7 +82282,7 @@ export interface components { number: number; /** Format: uri */ url: string; - }[]; + } | null)[]; referenced_workflows?: { path: string; ref?: string; @@ -89606,229 +82466,11 @@ export interface components { workflow_id: number; /** Format: uri */ workflow_url: string; - } & { - actor?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - artifacts_url?: string; - cancel_url?: string; - check_suite_id?: number; - check_suite_node_id?: string; - check_suite_url?: string; - /** @enum {string} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped"; - created_at?: string; - event?: string; - head_branch?: string | null; - head_commit?: { - author?: { - email?: string; - name?: string; - }; - committer?: { - email?: string; - name?: string; - }; - id?: string; - message?: string; - timestamp?: string; - tree_id?: string; - }; - head_repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - head_sha?: string; - html_url?: string; - id?: number; - jobs_url?: string; - logs_url?: string; - name?: string | null; - node_id?: string; - path?: string; - previous_attempt_url?: string | null; - pull_requests?: Record[]; - referenced_workflows?: { - path: string; - ref?: string; - sha: string; - }[] | null; - repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - rerun_url?: string; - run_attempt?: number; - run_number?: number; - run_started_at?: string; - status?: string; - triggering_actor?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - } | null; - updated_at?: string; - url?: string; - workflow_id?: number; - workflow_url?: string; + /** + * @description The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow. + * @example Simple Workflow + */ + display_title?: string; }; }; /** workflow_run in_progress event */ @@ -89840,24 +82482,8 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - workflow: { - /** Format: uri */ - badge_url: string; - /** Format: date-time */ - created_at: string; - /** Format: uri */ - html_url: string; - id: number; - name: string; - node_id: string; - path: string; - state: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - } | null; + workflow: components["schemas"]["webhooks_workflow"]; + /** Workflow Run */ workflow_run: { /** User */ actor: { @@ -89905,7 +82531,7 @@ export interface components { /** Format: uri */ check_suite_url: string; /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "stale" | "skipped" | null; + conclusion: "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out"; /** Format: date-time */ created_at: string; event: string; @@ -90005,7 +82631,7 @@ export interface components { /** Format: uri-template */ milestones_url: string; /** @description The name of the repository. */ - name: string; + name: string | null; node_id: string; /** Format: uri-template */ notifications_url: string; @@ -90082,7 +82708,7 @@ export interface components { path: string; /** Format: uri */ previous_attempt_url: string | null; - pull_requests: { + pull_requests: ({ base: { ref: string; /** Repo Ref */ @@ -90109,7 +82735,7 @@ export interface components { number: number; /** Format: uri */ url: string; - }[]; + } | null)[]; referenced_workflows?: { path: string; ref?: string; @@ -90293,229 +82919,6 @@ export interface components { workflow_id: number; /** Format: uri */ workflow_url: string; - } & { - actor?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - artifacts_url?: string; - cancel_url?: string; - check_suite_id?: number; - check_suite_node_id?: string; - check_suite_url?: string; - /** @enum {string|null} */ - conclusion: "success" | "failure" | "neutral" | "cancelled" | "timed_out" | "action_required" | "skipped" | "stale"; - created_at?: string; - event?: string; - head_branch?: string | null; - head_commit?: { - author?: { - email?: string; - name?: string; - }; - committer?: { - email?: string; - name?: string; - }; - id?: string; - message?: string; - timestamp?: string; - tree_id?: string; - }; - head_repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string | null; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - head_sha?: string; - html_url?: string; - id?: number; - jobs_url?: string; - logs_url?: string; - name?: string | null; - node_id?: string; - path?: string; - previous_attempt_url?: string | null; - pull_requests?: Record[]; - referenced_workflows?: { - path: string; - ref?: string; - sha: string; - }[] | null; - repository?: { - archive_url?: string; - assignees_url?: string; - blobs_url?: string; - branches_url?: string; - collaborators_url?: string; - comments_url?: string; - commits_url?: string; - compare_url?: string; - contents_url?: string; - contributors_url?: string; - deployments_url?: string; - description?: string | null; - downloads_url?: string; - events_url?: string; - fork?: boolean; - forks_url?: string; - full_name?: string; - git_commits_url?: string; - git_refs_url?: string; - git_tags_url?: string; - hooks_url?: string; - html_url?: string; - id?: number; - issue_comment_url?: string; - issue_events_url?: string; - issues_url?: string; - keys_url?: string; - labels_url?: string; - languages_url?: string; - merges_url?: string; - milestones_url?: string; - name?: string; - node_id?: string; - notifications_url?: string; - owner?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - private?: boolean; - pulls_url?: string; - releases_url?: string; - stargazers_url?: string; - statuses_url?: string; - subscribers_url?: string; - subscription_url?: string; - tags_url?: string; - teams_url?: string; - trees_url?: string; - url?: string; - }; - rerun_url?: string; - run_attempt?: number; - run_number?: number; - run_started_at?: string; - status?: string; - triggering_actor?: { - avatar_url?: string; - events_url?: string; - followers_url?: string; - following_url?: string; - gists_url?: string; - gravatar_id?: string; - html_url?: string; - 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; - }; - updated_at?: string; - url?: string; - workflow_id?: number; - workflow_url?: string; }; }; /** workflow_run requested event */ @@ -90527,24 +82930,7 @@ export interface components { organization?: components["schemas"]["organization-simple-webhooks"]; repository: components["schemas"]["repository-webhooks"]; sender: components["schemas"]["simple-user-webhooks"]; - /** Workflow */ - workflow: { - /** Format: uri */ - badge_url: string; - /** Format: date-time */ - created_at: string; - /** Format: uri */ - html_url: string; - id: number; - name: string; - node_id: string; - path: string; - state: string; - /** Format: date-time */ - updated_at: string; - /** Format: uri */ - url: string; - } | null; + workflow: components["schemas"]["webhooks_workflow"]; /** Workflow Run */ workflow_run: { /** User */ @@ -91057,6 +83443,15 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Internal Error */ + internal_error: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; /** @description Service unavailable */ service_unavailable: { headers: { @@ -91142,15 +83537,6 @@ export interface components { }; }; }; - /** @description Internal Error */ - internal_error: { - headers: { - [name: string]: unknown; - }; - 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: { headers: { @@ -91235,22 +83621,31 @@ export interface components { "application/json": components["schemas"]["basic-error"]; }; }; + /** @description Unacceptable */ + unacceptable: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["basic-error"]; + }; + }; }; parameters: { - /** @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. */ + /** @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)." */ "pagination-before": string; - /** @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. */ + /** @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)." */ "pagination-after": string; /** @description The direction to sort the results by. */ direction: "asc" | "desc"; /** @description The GHSA (GitHub Security Advisory) identifier of the advisory. */ ghsa_id: string; - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor: string; "delivery-id": number; - /** @description Page number of the results to fetch. */ + /** @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: number; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since: string; @@ -91341,7 +83736,7 @@ export interface components { "runner-label-name": string; /** @description The name of the secret. */ "secret-name": string; - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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)." */ "variables-per-page": number; /** @description The name of the variable. */ "variable-name": string; @@ -91452,7 +83847,7 @@ export interface components { "workflow-run-branch": string; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event: string; - /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ + /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ "workflow-run-status": "completed" | "action_required" | "cancelled" | "failure" | "neutral" | "skipped" | "stale" | "success" | "timed_out" | "in_progress" | "queued" | "requested" | "waiting" | "pending"; /** @description Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created: string; @@ -91499,12 +83894,17 @@ export interface components { "manifest-path": string; /** @description deployment_id parameter */ "deployment-id": number; - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ "environment-name": string; /** @description The unique identifier of the branch policy. */ "branch-policy-id": number; /** @description The unique identifier of the protection rule. */ "protection-rule-id": number; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + "git-ref-only": string; /** @description A user ID. Only return users with an ID greater than this ID. */ "since-user": number; /** @description The number that identifies the issue. */ @@ -91513,6 +83913,8 @@ export interface components { "key-id": number; /** @description The number that identifies the milestone. */ "milestone-number": number; + /** @description The ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + "pages-deployment-id": number | string; /** @description The number that identifies the pull request. */ "pull-number": number; /** @description The unique identifier of the review. */ @@ -91599,7 +84001,7 @@ export interface operations { /** @description If specified, only advisories with this CVE (Common Vulnerabilities and Exposures) identifier will be returned. */ cve_id?: string; /** @description If specified, only advisories for these ecosystems will be returned. */ - ecosystem?: "actions" | "composer" | "erlang" | "go" | "maven" | "npm" | "nuget" | "other" | "pip" | "pub" | "rubygems" | "rust"; + ecosystem?: components["schemas"]["security-advisory-ecosystems"]; /** @description If specified, only advisories with these severities will be returned. */ severity?: "unknown" | "low" | "medium" | "high" | "critical"; /** @description If specified, only advisories with these Common Weakness Enumerations (CWEs) will be returned. @@ -91625,13 +84027,13 @@ export interface operations { * * For more information on the syntax of the date range, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ modified?: string; - /** @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. */ + /** @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. */ + /** @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 The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 The property to sort the results by. */ sort?: "updated" | "published"; @@ -91789,7 +84191,7 @@ export interface operations { "apps/list-webhook-deliveries": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; @@ -91857,9 +84259,9 @@ export interface operations { "apps/list-installation-requests-for-authenticated-app": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -91884,9 +84286,9 @@ export interface operations { "apps/list-installations": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; @@ -92271,9 +84673,9 @@ export interface operations { "classroom/list-accepted-assigments-for-an-assignment": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -92323,9 +84725,9 @@ export interface operations { "classroom/list-classrooms": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -92372,9 +84774,9 @@ export interface operations { "classroom/list-assignments-for-a-classroom": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -92465,6 +84867,42 @@ export interface operations { 304: components["responses"]["not_modified"]; }; }; + "copilot/usage-metrics-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; + }; + 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"]["copilot-usage-metrics"][]; + }; + }; + 401: components["responses"]["requires_authentication"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 500: components["responses"]["internal_error"]; + }; + }; "dependabot/list-alerts-for-enterprise": { parameters: { query?: { @@ -92490,9 +84928,9 @@ export interface operations { sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @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. */ + /** @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. */ + /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. @@ -92502,7 +84940,7 @@ export interface operations { * This parameter must not be used in combination with `first`. * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; header?: never; @@ -92544,11 +84982,11 @@ export interface operations { sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 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. */ + /** @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. */ + /** @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 validities that, when present, will return alerts that match the validities in this list. Valid options are `active`, `inactive`, and `unknown`. */ validity?: components["parameters"]["secret-scanning-alert-validity"]; @@ -92579,9 +85017,9 @@ export interface operations { "activity/list-public-events": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92629,9 +85067,9 @@ export interface operations { query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92710,9 +85148,9 @@ export interface operations { query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92741,9 +85179,9 @@ export interface operations { query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -92876,9 +85314,9 @@ export interface operations { "gists/list-comments": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93036,9 +85474,9 @@ export interface operations { "gists/list-commits": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93069,9 +85507,9 @@ export interface operations { "gists/list-forks": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93281,9 +85719,9 @@ export interface operations { "apps/list-repos-accessible-to-installation": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93349,9 +85787,9 @@ export interface operations { orgs?: boolean; owned?: boolean; pulls?: boolean; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93379,9 +85817,9 @@ export interface operations { parameters: { query?: { featured?: boolean; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93531,9 +85969,9 @@ export interface operations { "apps/list-plans": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93563,9 +86001,9 @@ export interface operations { sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93626,9 +86064,9 @@ export interface operations { "apps/list-plans-stubbed": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93657,9 +86095,9 @@ export interface operations { sort?: components["parameters"]["sort"]; /** @description To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. */ direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93708,9 +86146,9 @@ export interface operations { "activity/list-public-events-for-repo-network": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -93750,9 +86188,9 @@ export interface operations { since?: components["parameters"]["since"]; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; - /** @description Page number of the results to fetch. */ + /** @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 50). */ + /** @description The number of results per page (max 50). 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; @@ -93847,6 +86285,27 @@ export interface operations { 403: components["responses"]["forbidden"]; }; }; + "activity/mark-thread-as-done": { + parameters: { + query?: never; + header?: never; + path: { + /** @description The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user)). */ + thread_id: components["parameters"]["thread-id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description No content */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "activity/mark-thread-as-read": { parameters: { query?: never; @@ -93984,7 +86443,7 @@ export interface operations { query?: { /** @description An organization ID. Only return organizations with an ID greater than this ID. */ since?: components["parameters"]["since-org"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; header?: never; @@ -94073,7 +86532,7 @@ export interface operations { location?: string; /** @description The shorthand name of the company. */ name?: string; - /** @description The description of the company. */ + /** @description The description of the company. The maximum size is 160 characters. */ description?: string; /** @description Whether an organization can use organization projects. */ has_organization_projects?: boolean; @@ -94221,9 +86680,9 @@ export interface operations { "actions/get-actions-cache-usage-by-repo-for-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -94356,9 +86815,9 @@ export interface operations { "actions/list-selected-repositories-enabled-github-actions-organization": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -94559,9 +87018,9 @@ export interface operations { query?: { /** @description The name of a self-hosted runner. */ name?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -94850,9 +87309,9 @@ export interface operations { "actions/list-org-secrets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95001,9 +87460,9 @@ export interface operations { "actions/list-selected-repos-for-org-secret": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -95126,9 +87585,9 @@ export interface operations { "actions/list-org-variables": { parameters: { query?: { - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ + /** @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; @@ -95284,9 +87743,9 @@ export interface operations { "actions/list-selected-repos-for-org-variable": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -95423,9 +87882,9 @@ export interface operations { "orgs/list-blocked-users": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95534,13 +87993,13 @@ export interface operations { tool_name?: components["parameters"]["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["parameters"]["tool-guid"]; - /** @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. */ + /** @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. */ + /** @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 Page number of the results to fetch. */ + /** @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). */ + /** @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 direction to sort the results by. */ direction?: components["parameters"]["direction"]; @@ -95577,9 +88036,9 @@ export interface operations { "codespaces/list-in-organization": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95735,9 +88194,9 @@ export interface operations { "codespaces/list-org-secrets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -95890,9 +88349,9 @@ export interface operations { "codespaces/list-selected-repos-for-org-secret": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -96049,15 +88508,22 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + /** @description There is a problem with your account's associated payment method. */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; 500: components["responses"]["internal_error"]; }; }; "copilot/list-copilot-seats": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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; }; header?: never; @@ -96077,7 +88543,7 @@ export interface operations { }; content: { "application/json": { - /** @description Total number of Copilot For Business seats for the organization currently being billed. */ + /** @description Total number of Copilot seats for the organization currently being billed. */ total_seats?: number; seats?: components["schemas"]["copilot-seat-details"][]; }; @@ -96089,7 +88555,7 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - "copilot/add-copilot-for-business-seats-for-teams": { + "copilot/add-copilot-seats-for-teams": { parameters: { query?: never; header?: never; @@ -96122,7 +88588,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ 422: { headers: { [name: string]: unknown; @@ -96165,7 +88631,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ 422: { headers: { [name: string]: unknown; @@ -96175,7 +88641,7 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; - "copilot/add-copilot-for-business-seats-for-users": { + "copilot/add-copilot-seats-for-users": { parameters: { query?: never; header?: never; @@ -96208,7 +88674,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. */ 422: { headers: { [name: string]: unknown; @@ -96251,7 +88717,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ + /** @description Copilot Business or Enterprise is not enabled for this organization, billing has not been set up for this organization, a public code suggestions policy has not been set for this organization, the seat management setting is set to enable Copilot for all users or is unconfigured, or a user's seat cannot be cancelled because it was assigned to them via a team. */ 422: { headers: { [name: string]: unknown; @@ -96261,6 +88727,42 @@ export interface operations { 500: components["responses"]["internal_error"]; }; }; + "copilot/usage-metrics-for-org": { + 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 organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + }; + 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"]; + }; + }; "dependabot/list-alerts-for-org": { parameters: { query?: { @@ -96286,9 +88788,9 @@ export interface operations { sort?: components["parameters"]["dependabot-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @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. */ + /** @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. */ + /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. @@ -96298,7 +88800,7 @@ export interface operations { * This parameter must not be used in combination with `first`. * Instead, use `per_page` in combination with `before` to fetch the last page of results. */ last?: components["parameters"]["pagination-last"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; header?: never; @@ -96329,9 +88831,9 @@ export interface operations { "dependabot/list-org-secrets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96480,9 +88982,9 @@ export interface operations { "dependabot/list-selected-repos-for-org-secret": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -96630,9 +89132,9 @@ export interface operations { "activity/list-public-org-events": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96658,9 +89160,9 @@ export interface operations { "orgs/list-failed-invitations": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96688,9 +89190,9 @@ export interface operations { "orgs/list-webhooks": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -96937,7 +89439,7 @@ export interface operations { "orgs/list-webhook-deliveries": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; @@ -97065,9 +89567,9 @@ export interface operations { "orgs/list-app-installations": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97169,9 +89671,9 @@ export interface operations { "orgs/list-pending-invitations": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Filter invitations by their member role. */ role?: "all" | "admin" | "direct_member" | "billing_manager" | "hiring_manager"; @@ -97222,10 +89724,11 @@ export interface operations { * * `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. * * `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. * * `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization. + * * `reinstate` - The previous role assigned to the invitee before they were removed from your organization. Can be one of the roles listed above. Only works if the invitee was previously part of your organization. * @default direct_member * @enum {string} */ - role: "admin" | "direct_member" | "billing_manager"; + role: "admin" | "direct_member" | "billing_manager" | "reinstate"; /** @description Specify IDs for the teams you want to invite new members to. */ team_ids?: number[]; }; @@ -97273,9 +89776,9 @@ export interface operations { "orgs/list-invitation-teams": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97317,9 +89820,9 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97351,9 +89854,9 @@ export interface operations { filter?: "2fa_disabled" | "all"; /** @description Filter members returned by their role. */ role?: "all" | "admin" | "member"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97444,9 +89947,9 @@ export interface operations { "codespaces/get-codespaces-for-user-in-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -97561,7 +90064,7 @@ export interface operations { 401: components["responses"]["requires_authentication"]; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; - /** @description Copilot Business is not enabled for this organization or the user has a pending organization invitation. */ + /** @description Copilot Business or Enterprise is not enabled for this organization or the user has a pending organization invitation. */ 422: { headers: { [name: string]: unknown; @@ -97666,9 +90169,9 @@ export interface operations { "migrations/list-for-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Exclude attributes from the API response to improve performance */ exclude?: "repositories"[]; @@ -97877,9 +90380,9 @@ export interface operations { "migrations/list-repos-for-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98264,9 +90767,9 @@ export interface operations { "orgs/list-org-role-teams": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98309,9 +90812,9 @@ export interface operations { "orgs/list-org-role-users": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98356,9 +90859,9 @@ export interface operations { query?: { /** @description Filter the list of outside collaborators. `2fa_disabled` means that only outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled will be returned. */ filter?: "2fa_disabled" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98477,9 +90980,9 @@ export interface operations { * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; - /** @description Page number of the results to fetch. */ + /** @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?: number; - /** @description The number of results per page (max 100). */ + /** @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; }; header?: never; @@ -98594,9 +91097,9 @@ export interface operations { "packages/get-all-package-versions-for-package-owned-by-org": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 state of the package, either active or deleted. */ state?: "active" | "deleted"; @@ -98720,9 +91223,9 @@ export interface operations { "orgs/list-pat-grant-requests": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 property by which to sort the results. */ sort?: components["parameters"]["personal-access-token-sort"]; @@ -98833,9 +91336,9 @@ export interface operations { "orgs/list-pat-grant-request-repositories": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -98867,9 +91370,9 @@ export interface operations { "orgs/list-pat-grants": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 property by which to sort the results. */ sort?: components["parameters"]["personal-access-token-sort"]; @@ -98976,9 +91479,9 @@ export interface operations { "orgs/list-pat-grant-repositories": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99012,9 +91515,9 @@ export interface operations { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99184,10 +91687,11 @@ export interface operations { /** @description Whether the property is required. */ required?: boolean; /** @description Default value of the property */ - default_value?: string | null; + default_value?: (string | string[]) | null; /** @description Short description of the property */ description?: string | null; - /** @description Ordered list of allowed values of the property */ + /** @description An ordered list of the allowed values of the property. + * The property can have up to 200 allowed values. */ allowed_values?: string[] | null; }; }; @@ -99228,9 +91732,9 @@ export interface operations { "orgs/list-custom-properties-values-for-repos": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Finds repositories in the organization with a query containing one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). See "[Searching for repositories](https://docs.github.com/articles/searching-for-repositories/)" for a detailed list of qualifiers. */ repository_query?: string; @@ -99288,14 +91792,15 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; }; }; "orgs/list-public-members": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99405,9 +91910,9 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99578,7 +92083,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; 403: components["responses"]["forbidden"]; @@ -99588,9 +92093,9 @@ export interface operations { "repos/get-org-rulesets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99632,10 +92137,12 @@ export interface operations { /** @description The name of the ruleset. */ name: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag"; + target?: "branch" | "tag" | "push"; 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"][]; @@ -99672,9 +92179,9 @@ export interface operations { actor_name?: components["parameters"]["actor-name-in-query"]; /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ rule_suite_result?: components["parameters"]["rule-suite-result"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -99775,10 +92282,12 @@ export interface operations { /** @description The name of the ruleset. */ name?: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag"; + target?: "branch" | "tag" | "push"; 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"][]; @@ -99842,9 +92351,9 @@ export interface operations { sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; @@ -99883,11 +92392,11 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: "created" | "updated" | "published"; - /** @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. */ + /** @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. */ + /** @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 The number of advisories to return per page. */ + /** @description The number of advisories to return per page. 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 Filter by the state of the repository advisories. Only advisories of this state will be returned. */ state?: "triage" | "draft" | "published" | "closed"; @@ -100059,12 +92568,50 @@ export interface operations { }; }; }; + "copilot/usage-metrics-for-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 organization name. The name is not case sensitive. */ + org: components["parameters"]["org"]; + /** @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"]; + }; + }; "teams/list": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100280,9 +92827,9 @@ export interface operations { query?: { /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Pinned discussions only filter */ pinned?: string; @@ -100442,9 +92989,9 @@ export interface operations { query?: { /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100603,9 +93150,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100717,9 +93264,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100823,9 +93370,9 @@ export interface operations { "teams/list-pending-invitations-in-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -100856,9 +93403,9 @@ export interface operations { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101005,9 +93552,9 @@ export interface operations { "teams/list-projects-in-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101085,7 +93632,7 @@ export interface operations { content: { "application/json": { /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * @enum {string} */ permission?: "read" | "write" | "admin"; @@ -101142,9 +93689,9 @@ export interface operations { "teams/list-repos-in-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101280,9 +93827,9 @@ export interface operations { "teams/list-child-in-org": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101629,9 +94176,9 @@ export interface operations { query?: { /** @description Filters the project cards that are returned by the card's state. */ archived_state?: "all" | "archived" | "not_archived"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -101911,9 +94458,9 @@ export interface operations { query?: { /** @description Filters the collaborators by their affiliation. `outside` means outside collaborators of a project that are not a member of the project's organization. `direct` means collaborators with permissions to a project, regardless of organization membership status. `all` means all collaborators the authenticated user can see. */ affiliation?: "outside" | "direct" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -102043,9 +94590,9 @@ export interface operations { "projects/list-columns": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -102385,9 +94932,9 @@ export interface operations { "actions/list-artifacts-for-repo": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; @@ -102526,9 +95073,9 @@ export interface operations { "actions/get-actions-cache-list": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 full Git reference for narrowing down the cache. The `ref` for a branch should be formatted as `refs/heads/`. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["actions-cache-git-ref-full"]; @@ -102776,9 +95323,9 @@ export interface operations { "actions/list-repo-organization-secrets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -102810,9 +95357,9 @@ export interface operations { "actions/list-repo-organization-variables": { parameters: { query?: { - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ + /** @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; @@ -103064,9 +95611,9 @@ export interface operations { query?: { /** @description The name of a self-hosted runner. */ name?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -103385,11 +95932,11 @@ export interface operations { branch?: components["parameters"]["workflow-run-branch"]; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: components["parameters"]["event"]; - /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ + /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ status?: components["parameters"]["workflow-run-status"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: components["parameters"]["created"]; @@ -103540,9 +96087,9 @@ export interface operations { "actions/list-workflow-run-artifacts": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 name field of an artifact. When specified, only artifacts with this name will be returned. */ name?: components["parameters"]["artifact-name"]; @@ -103610,9 +96157,9 @@ export interface operations { "actions/list-jobs-for-workflow-run-attempt": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -103765,9 +96312,9 @@ export interface operations { query?: { /** @description Filters jobs by their `completed_at` timestamp. `latest` returns jobs from the most recent execution of the workflow run. `all` returns all jobs for a workflow run, including from old executions of the workflow run. */ filter?: "latest" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104034,9 +96581,9 @@ export interface operations { "actions/list-repo-secrets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104188,9 +96735,9 @@ export interface operations { "actions/list-repo-variables": { parameters: { query?: { - /** @description The number of results per page (max 30). */ + /** @description The number of results per page (max 30). 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"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ + /** @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; @@ -104342,9 +96889,9 @@ export interface operations { "actions/list-repo-workflows": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104495,11 +97042,11 @@ export interface operations { branch?: components["parameters"]["workflow-run-branch"]; /** @description Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events that trigger workflows](https://docs.github.com/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)." */ event?: components["parameters"]["event"]; - /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. */ + /** @description Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. */ status?: components["parameters"]["workflow-run-status"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Returns workflow runs created within the given date-time range. For more information on the syntax, see "[Understanding the search syntax](https://docs.github.com/search-github/getting-started-with-searching-on-github/understanding-the-search-syntax#query-for-dates)." */ created?: components["parameters"]["created"]; @@ -104570,11 +97117,11 @@ export interface operations { query?: { /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 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. */ + /** @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. */ + /** @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 The Git reference for the activities you want to list. * @@ -104618,9 +97165,9 @@ export interface operations { "issues/list-assignees": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -104682,10 +97229,7 @@ export interface operations { }; "repos/list-autolinks": { parameters: { - query?: { - /** @description Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; + query?: never; header?: never; path: { /** @description The account owner of the repository. The name is not case sensitive. */ @@ -104887,9 +97431,9 @@ export interface operations { query?: { /** @description Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches. */ protected?: boolean; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -106144,11 +98688,11 @@ export interface operations { /** @description A reference for the run on the integrator's system. */ external_id?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @default queued * @enum {string} */ - status: "queued" | "in_progress" | "completed"; + status: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * Format: date-time * @description The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. @@ -106295,10 +98839,10 @@ export interface operations { */ started_at?: string; /** - * @description The current status. + * @description The current status of the check run. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`. * @enum {string} */ - status?: "queued" | "in_progress" | "completed"; + status?: "queued" | "in_progress" | "completed" | "waiting" | "requested" | "pending"; /** * @description **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this. @@ -106387,9 +98931,9 @@ export interface operations { "checks/list-annotations": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -106580,9 +99124,9 @@ export interface operations { status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -106647,9 +99191,9 @@ export interface operations { tool_name?: components["parameters"]["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["parameters"]["tool-guid"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["git-ref"]; @@ -106760,9 +99304,9 @@ export interface operations { "code-scanning/list-alert-instances": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["parameters"]["git-ref"]; @@ -106801,9 +99345,9 @@ export interface operations { tool_name?: components["parameters"]["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["parameters"]["tool-guid"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ ref?: components["schemas"]["code-scanning-ref"]; @@ -107176,9 +99720,9 @@ export interface operations { "codespaces/list-in-repository-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107282,9 +99826,9 @@ export interface operations { "codespaces/list-devcontainers-in-repository-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107438,9 +99982,9 @@ export interface operations { "codespaces/list-repo-secrets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107596,9 +100140,9 @@ export interface operations { affiliation?: "outside" | "direct" | "all"; /** @description Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned. */ permission?: "pull" | "triage" | "push" | "maintain" | "admin"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107764,9 +100308,9 @@ export interface operations { "repos/list-commit-comments-for-repo": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -107886,9 +100430,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a commit comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108006,9 +100550,9 @@ export interface operations { since?: components["parameters"]["since"]; /** @description Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ until?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108063,15 +100607,16 @@ export interface operations { "application/json": components["schemas"]["branch-short"][]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; "repos/list-comments-for-commit": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108146,9 +100691,9 @@ export interface operations { "repos/list-pull-requests-associated-with-commit": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108174,14 +100719,15 @@ export interface operations { "application/json": components["schemas"]["pull-request-simple"][]; }; }; + 409: components["responses"]["conflict"]; }; }; "repos/get-commit": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -108207,6 +100753,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; 500: components["responses"]["internal_error"]; 503: components["responses"]["service_unavailable"]; @@ -108221,9 +100768,9 @@ export interface operations { status?: components["parameters"]["status"]; /** @description Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. */ filter?: "latest" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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"]; app_id?: number; }; @@ -108265,9 +100812,9 @@ export interface operations { app_id?: number; /** @description Returns check runs with the specified `name`. */ check_name?: components["parameters"]["check-name"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108301,9 +100848,9 @@ export interface operations { "repos/get-combined-status-for-ref": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108334,9 +100881,9 @@ export interface operations { "repos/list-commit-statuses-for-ref": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108393,9 +100940,9 @@ export interface operations { "repos/compare-commits": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -108590,9 +101137,9 @@ export interface operations { query?: { /** @description Set to `1` or `true` to include anonymous contributors in results. */ anon?: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -108661,12 +101208,12 @@ export interface operations { page?: number; /** * @deprecated - * @description The number of results per page (max 100). + * @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. */ + /** @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. */ + /** @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 **Deprecated**. The number of results per page (max 100), starting from the first matching result. * This parameter must not be used in combination with `last`. @@ -108793,9 +101340,9 @@ export interface operations { "dependabot/list-repo-secrets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109054,9 +101601,9 @@ export interface operations { task?: string; /** @description The name of the environment that was deployed to (e.g., `staging` or `production`). */ environment?: string | null; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109223,9 +101770,9 @@ export interface operations { "repos/list-deployment-statuses": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109379,15 +101926,16 @@ export interface operations { }; content?: never; }; + 404: components["responses"]["not_found"]; 422: components["responses"]["validation_failed"]; }; }; "repos/get-all-environments": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109428,7 +101976,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; cookie?: never; @@ -109455,7 +102003,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; cookie?: never; @@ -109508,7 +102056,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; cookie?: never; @@ -109527,9 +102075,9 @@ export interface operations { "repos/list-deployment-branch-policies": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109538,7 +102086,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; cookie?: never; @@ -109572,7 +102120,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; }; cookie?: never; @@ -109617,7 +102165,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; @@ -109646,7 +102194,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; @@ -109679,7 +102227,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the branch policy. */ branch_policy_id: components["parameters"]["branch-policy-id"]; @@ -109702,7 +102250,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; @@ -109736,7 +102284,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; @@ -109768,14 +102316,14 @@ export interface operations { "repos/list-custom-deployment-rule-integrations": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; @@ -109813,7 +102361,7 @@ export interface operations { 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 name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The unique identifier of the protection rule. */ protection_rule_id: components["parameters"]["protection-rule-id"]; @@ -109838,7 +102386,7 @@ export interface operations { query?: never; header?: never; path: { - /** @description The name of the environment. */ + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ environment_name: components["parameters"]["environment-name"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; @@ -109860,12 +102408,340 @@ export interface operations { }; }; }; + "actions/list-environment-secrets": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + secrets: components["schemas"]["actions-secret"][]; + }; + }; + }; + }; + }; + "actions/get-environment-public-key": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-public-key"]; + }; + }; + }; + }; + "actions/get-environment-secret": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-secret"]; + }; + }; + }; + }; + "actions/create-or-update-environment-secret": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ + encrypted_value: string; + /** @description ID of the key you used to encrypt the secret. */ + key_id: string; + }; + }; + }; + responses: { + /** @description Response when creating a secret */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + /** @description Response when updating a secret */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/delete-environment-secret": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + /** @description The name of the secret. */ + secret_name: components["parameters"]["secret-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Default response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/list-environment-variables": { + parameters: { + query?: { + /** @description The number of results per page (max 30). 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"]["variables-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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": { + total_count: number; + variables: components["schemas"]["actions-variable"][]; + }; + }; + }; + }; + }; + "actions/create-environment-variable": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name: string; + /** @description The value of the variable. */ + value: string; + }; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["empty-object"]; + }; + }; + }; + }; + "actions/get-environment-variable": { + 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 name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + /** @description The name of the variable. */ + name: components["parameters"]["variable-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["actions-variable"]; + }; + }; + }; + }; + "actions/delete-environment-variable": { + 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 name of the variable. */ + name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "actions/update-environment-variable": { + 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 name of the variable. */ + name: components["parameters"]["variable-name"]; + /** @description The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`. */ + environment_name: components["parameters"]["environment-name"]; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/json": { + /** @description The name of the variable. */ + name?: string; + /** @description The value of the variable. */ + value?: string; + }; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; "activity/list-repo-events": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -109895,9 +102771,9 @@ export interface operations { query?: { /** @description The sort order. `stargazers` will sort by star count. */ sort?: "newest" | "oldest" | "stargazers" | "watchers"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -110033,6 +102909,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -110099,6 +102976,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -110128,6 +103006,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; "git/list-matching-refs": { @@ -110139,8 +103018,11 @@ export interface operations { 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 commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - ref: components["parameters"]["commit-ref"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + ref: components["parameters"]["git-ref-only"]; }; cookie?: never; }; @@ -110156,6 +103038,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"][]; }; }; + 409: components["responses"]["conflict"]; }; }; "git/get-ref": { @@ -110167,8 +103050,11 @@ export interface operations { 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 commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - ref: components["parameters"]["commit-ref"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + ref: components["parameters"]["git-ref-only"]; }; cookie?: never; }; @@ -110184,6 +103070,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; "git/create-ref": { @@ -110220,6 +103107,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -110232,8 +103120,11 @@ export interface operations { 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 commit reference. Can be a commit SHA, branch name (`heads/BRANCH_NAME`), or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. */ - ref: components["parameters"]["commit-ref"]; + /** + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a + */ + ref: components["parameters"]["git-ref-only"]; }; cookie?: never; }; @@ -110246,6 +103137,7 @@ export interface operations { }; content?: never; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -110259,10 +103151,10 @@ export interface operations { /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; /** - * @description The name of the reference to update (for example, `heads/featureA`). Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. - * @example heads/featureA + * @description The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation. + * @example heads/feature-a */ - ref: string; + ref: components["parameters"]["git-ref-only"]; }; cookie?: never; }; @@ -110289,6 +103181,7 @@ export interface operations { "application/json": components["schemas"]["git-ref"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -110345,6 +103238,7 @@ export interface operations { "application/json": components["schemas"]["git-tag"]; }; }; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -110373,6 +103267,7 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; }; }; "git/create-tree": { @@ -110434,6 +103329,7 @@ export interface operations { }; 403: components["responses"]["forbidden"]; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; @@ -110466,15 +103362,16 @@ export interface operations { }; }; 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; "repos/list-webhooks": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -110524,10 +103421,6 @@ export interface operations { content_type?: components["schemas"]["webhook-config-content-type"]; secret?: components["schemas"]["webhook-config-secret"]; insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - /** @example "abc" */ - token?: string; - /** @example "sha256" */ - digest?: string; }; /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. @@ -110632,17 +103525,7 @@ export interface operations { requestBody: { content: { "application/json": { - /** @description Key/value pairs to provide settings for this webhook. */ - config?: { - url: components["schemas"]["webhook-config-url"]; - content_type?: components["schemas"]["webhook-config-content-type"]; - secret?: components["schemas"]["webhook-config-secret"]; - insecure_ssl?: components["schemas"]["webhook-config-insecure-ssl"]; - /** @example "bar@example.com" */ - address?: string; - /** @example "The Serious Room" */ - room?: string; - }; + config?: components["schemas"]["webhook-config"]; /** * @description Determines what [events](https://docs.github.com/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events. * @default [ @@ -110742,7 +103625,7 @@ export interface operations { "repos/list-webhook-deliveries": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the `link` header for the next and previous page cursors. */ cursor?: components["parameters"]["cursor"]; @@ -111275,9 +104158,9 @@ export interface operations { "repos/list-invitations": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111386,9 +104269,9 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111480,9 +104363,9 @@ export interface operations { direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111603,9 +104486,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111711,9 +104594,9 @@ export interface operations { "issues/list-events-for-repo": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -111973,9 +104856,9 @@ export interface operations { query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112048,9 +104931,9 @@ export interface operations { "issues/list-events": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112082,9 +104965,9 @@ export interface operations { "issues/list-labels-on-issue": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112337,9 +105220,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to an issue. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112446,9 +105329,9 @@ export interface operations { "issues/list-events-for-timeline": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112481,9 +105364,9 @@ export interface operations { "repos/list-deploy-keys": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112606,9 +105489,9 @@ export interface operations { "issues/list-labels-for-repo": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -112790,7 +105673,10 @@ export interface operations { }; "licenses/get-for-repo": { parameters: { - query?: never; + query?: { + /** @description The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`. */ + ref?: components["parameters"]["git-ref"]; + }; header?: never; path: { /** @description The account owner of the repository. The name is not case sensitive. */ @@ -112928,9 +105814,9 @@ export interface operations { sort?: "due_on" | "completeness"; /** @description The direction of the sort. Either `asc` or `desc`. */ direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113110,9 +105996,9 @@ export interface operations { "issues/list-labels-for-milestone": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113151,9 +106037,234 @@ export interface operations { since?: components["parameters"]["since"]; /** @description Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ before?: components["parameters"]["before"]; - /** @description The number of results per page (max 100). */ + /** @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"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 200: { + headers: { + Link: components["headers"]["link"]; + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["thread"][]; + }; + }; + }; + }; + "activity/mark-repo-notifications-as-read": { + 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?: { + content: { + "application/json": { + /** + * Format: date-time + * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. + */ + last_read_at?: string; + }; + }; + }; + responses: { + /** @description Response */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + message?: string; + url?: string; + }; + }; + }; + /** @description Reset Content */ + 205: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + }; + }; + "repos/get-pages": { + 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"]["page"]; + }; + }; + 404: components["responses"]["not_found"]; + }; + }; + "repos/update-information-about-pages-site": { + 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: { + content: { + "application/json": { + /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ + cname?: string | null; + /** @description Specify whether HTTPS should be enforced for the repository. */ + https_enforced?: boolean; + /** + * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + source?: ("gh-pages" | "master" | "master /docs") | { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. + * @enum {string} + */ + path: "/" | "/docs"; + }; + } | unknown | unknown | unknown | unknown | unknown; + }; + }; + responses: { + /** @description Response */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 400: components["responses"]["bad_request"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/create-pages-site": { + 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: { + content: { + "application/json": ({ + /** + * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. + * @enum {string} + */ + build_type?: "legacy" | "workflow"; + /** @description The source branch and directory used to publish your Pages site. */ + source?: { + /** @description The repository branch used to publish your site's source files. */ + branch: string; + /** + * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` + * @default / + * @enum {string} + */ + path: "/" | "/docs"; + }; + } | unknown | unknown) | null; + }; + }; + responses: { + /** @description Response */ + 201: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["page"]; + }; + }; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/delete-pages-site": { + 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 */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 404: components["responses"]["not_found"]; + 409: components["responses"]["conflict"]; + 422: components["responses"]["validation_failed"]; + }; + }; + "repos/list-pages-builds": { + 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 Page number of the results to fetch. */ + /** @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; @@ -113174,12 +106285,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["thread"][]; + "application/json": components["schemas"]["page-build"][]; }; }; }; }; - "activity/mark-repo-notifications-as-read": { + "repos/request-pages-build": { parameters: { query?: never; header?: never; @@ -113191,40 +106302,20 @@ export interface operations { }; cookie?: never; }; - requestBody?: { - content: { - "application/json": { - /** - * Format: date-time - * @description Describes the last point that notifications were checked. Anything updated since this time will not be marked as read. If you omit this parameter, all notifications are marked as read. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp. - */ - last_read_at?: string; - }; - }; - }; + requestBody?: never; responses: { /** @description Response */ - 202: { + 201: { headers: { [name: string]: unknown; }; content: { - "application/json": { - message?: string; - url?: string; - }; - }; - }; - /** @description Reset Content */ - 205: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["page-build-status"]; }; - content?: never; }; }; }; - "repos/get-pages": { + "repos/get-latest-pages-build": { parameters: { query?: never; header?: never; @@ -113244,13 +106335,12 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["page"]; + "application/json": components["schemas"]["page-build"]; }; }; - 404: components["responses"]["not_found"]; }; }; - "repos/update-information-about-pages-site": { + "repos/get-pages-build": { parameters: { query?: never; header?: never; @@ -113259,47 +106349,24 @@ export interface operations { owner: components["parameters"]["owner"]; /** @description The name of the repository without the `.git` extension. The name is not case sensitive. */ repo: components["parameters"]["repo"]; + build_id: number; }; cookie?: never; }; - requestBody: { - content: { - "application/json": { - /** @description Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/articles/using-a-custom-domain-with-github-pages/)." */ - cname?: string | null; - /** @description Specify whether HTTPS should be enforced for the repository. */ - https_enforced?: boolean; - /** - * @description The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch. - * @enum {string} - */ - build_type?: "legacy" | "workflow"; - source?: ("gh-pages" | "master" | "master /docs") | { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. - * @enum {string} - */ - path: "/" | "/docs"; - }; - } | unknown | unknown | unknown | unknown | unknown; - }; - }; + requestBody?: never; responses: { /** @description Response */ - 204: { + 200: { headers: { [name: string]: unknown; }; - content?: never; + content: { + "application/json": components["schemas"]["page-build"]; + }; }; - 400: components["responses"]["bad_request"]; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; }; }; - "repos/create-pages-site": { + "repos/create-pages-deployment": { parameters: { query?: never; header?: never; @@ -113313,80 +106380,52 @@ export interface operations { }; requestBody: { content: { - "application/json": ({ + "application/json": { + /** @description The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */ + artifact_id?: number; + /** @description The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required. */ + artifact_url?: string; /** - * @description The process in which the Page will be built. Possible values are `"legacy"` and `"workflow"`. - * @enum {string} + * @description The target environment for this GitHub Pages deployment. + * @default github-pages */ - build_type?: "legacy" | "workflow"; - /** @description The source branch and directory used to publish your Pages site. */ - source?: { - /** @description The repository branch used to publish your site's source files. */ - branch: string; - /** - * @description The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`. Default: `/` - * @default / - * @enum {string} - */ - path: "/" | "/docs"; - }; - } | unknown | unknown) | null; + environment: string; + /** + * @description A unique string that represents the version of the build for this deployment. + * @default GITHUB_SHA + */ + pages_build_version: string; + /** @description The OIDC token issued by GitHub Actions certifying the origin of the deployment. */ + oidc_token: string; + }; }; }; responses: { /** @description Response */ - 201: { + 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["page"]; - }; - }; - 409: components["responses"]["conflict"]; - 422: components["responses"]["validation_failed"]; - }; - }; - "repos/delete-pages-site": { - 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 */ - 204: { - headers: { - [name: string]: unknown; + "application/json": components["schemas"]["page-deployment"]; }; - content?: never; }; + 400: components["responses"]["bad_request"]; 404: components["responses"]["not_found"]; - 409: components["responses"]["conflict"]; 422: components["responses"]["validation_failed"]; }; }; - "repos/list-pages-builds": { + "repos/get-pages-deployment": { parameters: { - query?: { - /** @description The number of results per page (max 100). */ - per_page?: components["parameters"]["per-page"]; - /** @description Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; + 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 ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; cookie?: never; }; @@ -113395,16 +106434,16 @@ export interface operations { /** @description Response */ 200: { headers: { - Link: components["headers"]["link"]; [name: string]: unknown; }; content: { - "application/json": components["schemas"]["page-build"][]; + "application/json": components["schemas"]["pages-deployment-status"]; }; }; + 404: components["responses"]["not_found"]; }; }; - "repos/request-pages-build": { + "repos/cancel-pages-deployment": { parameters: { query?: never; header?: never; @@ -113413,23 +106452,18 @@ export interface operations { 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 ID of the Pages deployment. You can also give the commit SHA of the deployment. */ + pages_deployment_id: components["parameters"]["pages-deployment-id"]; }; cookie?: never; }; requestBody?: never; responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["page-build-status"]; - }; - }; + 204: components["responses"]["no_content"]; + 404: components["responses"]["not_found"]; }; }; - "repos/get-latest-pages-build": { + "repos/get-pages-health-check": { parameters: { query?: never; header?: never; @@ -113449,85 +106483,36 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["page-build"]; + "application/json": components["schemas"]["pages-health-check"]; }; }; - }; - }; - "repos/get-pages-build": { - 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"]; - build_id: number; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { + /** @description Empty response */ + 202: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["page-build"]; + "application/json": components["schemas"]["empty-object"]; }; }; - }; - }; - "repos/create-pages-deployment": { - 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: { - content: { - "application/json": { - /** @description The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. */ - artifact_url: string; - /** - * @description The target environment for this GitHub Pages deployment. - * @default github-pages - */ - environment: string; - /** - * @description A unique string that represents the version of the build for this deployment. - * @default GITHUB_SHA - */ - pages_build_version: string; - /** @description The OIDC token issued by GitHub Actions certifying the origin of the deployment. */ - oidc_token: string; + /** @description Custom domains are not available for GitHub Pages */ + 400: { + headers: { + [name: string]: unknown; }; + content?: never; }; - }; - responses: { - /** @description Response */ - 200: { + 404: components["responses"]["not_found"]; + /** @description There isn't a CNAME for this page */ + 422: { headers: { [name: string]: unknown; }; - content: { - "application/json": components["schemas"]["page-deployment"]; - }; + content?: never; }; - 400: components["responses"]["bad_request"]; - 404: components["responses"]["not_found"]; - 422: components["responses"]["validation_failed"]; }; }; - "repos/get-pages-health-check": { + "repos/check-private-vulnerability-reporting": { parameters: { query?: never; header?: never; @@ -113541,39 +106526,19 @@ export interface operations { }; requestBody?: never; responses: { - /** @description Response */ + /** @description Private vulnerability reporting status */ 200: { headers: { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["pages-health-check"]; - }; - }; - /** @description Empty response */ - 202: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Custom domains are not available for GitHub Pages */ - 400: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - 404: components["responses"]["not_found"]; - /** @description There isn't a CNAME for this page */ - 422: { - headers: { - [name: string]: unknown; + "application/json": { + /** @description Whether or not private vulnerability reporting is enabled for the repository. */ + enabled: boolean; + }; }; - content?: never; }; + 422: components["responses"]["bad_request"]; }; }; "repos/enable-private-vulnerability-reporting": { @@ -113617,9 +106582,9 @@ export interface operations { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113716,6 +106681,39 @@ export interface operations { 404: components["responses"]["not_found"]; }; }; + "repos/create-or-update-custom-properties-values": { + 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: { + content: { + "application/json": { + /** @description A list of custom property names and associated values to apply to the repositories. */ + properties: components["schemas"]["custom-property-value"][]; + }; + }; + }; + responses: { + /** @description No Content when custom property values are successfully created or updated */ + 204: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "pulls/list": { parameters: { query?: { @@ -113729,9 +106727,9 @@ export interface operations { sort?: "created" | "updated" | "popularity" | "long-running"; /** @description The direction of the sort. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`. */ direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113825,9 +106823,9 @@ export interface operations { direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -113946,9 +106944,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a pull request review comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114078,6 +107076,7 @@ export interface operations { }; 304: components["responses"]["not_modified"]; 404: components["responses"]["not_found"]; + 406: components["responses"]["unacceptable"]; 500: components["responses"]["internal_error"]; 503: components["responses"]["service_unavailable"]; }; @@ -114206,9 +107205,9 @@ export interface operations { direction?: "asc" | "desc"; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114261,7 +107260,7 @@ export interface operations { path: string; /** * @deprecated - * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. + * @description **This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ position?: number; /** @@ -114349,9 +107348,9 @@ export interface operations { "pulls/list-commits": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114382,9 +107381,9 @@ export interface operations { "pulls/list-files": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114629,9 +107628,9 @@ export interface operations { "pulls/list-reviews": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -114689,7 +107688,7 @@ export interface operations { comments?: { /** @description The relative path to the file that necessitates a review comment. */ path: string; - /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below. */ + /** @description The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ position?: number; /** @description Text of the review comment. */ body: string; @@ -114820,9 +107819,9 @@ export interface operations { "pulls/list-comments-for-review": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115044,9 +108043,9 @@ export interface operations { "repos/list-releases": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115346,7 +108345,7 @@ export interface operations { }; requestBody?: never; responses: { - /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia). */ + /** @description **Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a hypermedia resource. For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." */ 200: { headers: { [name: string]: unknown; @@ -115453,9 +108452,9 @@ export interface operations { "repos/list-release-assets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115529,9 +108528,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a release. */ content?: "+1" | "laugh" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115637,9 +108636,9 @@ export interface operations { "repos/get-branch-rules": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115669,9 +108668,9 @@ export interface operations { "repos/get-repo-rulesets": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Include rulesets configured at higher levels that apply to this repository */ includes_parents?: boolean; @@ -115719,10 +108718,12 @@ export interface operations { /** @description The name of the ruleset. */ name: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag"; + target?: "branch" | "tag" | "push"; 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"][]; @@ -115759,9 +108760,9 @@ export interface operations { actor_name?: components["parameters"]["actor-name-in-query"]; /** @description The rule results to filter on. When specified, only suites with this result will be returned. */ rule_suite_result?: components["parameters"]["rule-suite-result"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -115873,10 +108874,12 @@ export interface operations { /** @description The name of the ruleset. */ name?: string; /** - * @description The target of the ruleset. + * @description The target of the ruleset + * + * **Note**: The `push` target is in beta and is subject to change. * @enum {string} */ - target?: "branch" | "tag"; + target?: "branch" | "tag" | "push"; 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"][]; @@ -115942,9 +108945,9 @@ export interface operations { sort?: components["parameters"]["secret-scanning-alert-sort"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 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 events before this cursor. To receive an initial cursor on your first request, include an empty "before" query string. */ before?: components["parameters"]["secret-scanning-pagination-before-org-repo"]; @@ -116079,9 +109082,9 @@ export interface operations { "secret-scanning/list-locations-for-alert": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -116124,11 +109127,11 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description The property to sort the results by. */ sort?: "created" | "updated" | "published"; - /** @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. */ + /** @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. */ + /** @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 Number of advisories to return per page. */ + /** @description The number of advisories to return per page. 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 Filter by state of the repository advisories. Only advisories of this state will be returned. */ state?: "triage" | "draft" | "published" | "closed"; @@ -116315,12 +109318,43 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; + "security-advisories/create-fork": { + 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 GHSA (GitHub Security Advisory) identifier of the advisory. */ + ghsa_id: components["parameters"]["ghsa_id"]; + }; + cookie?: never; + }; + requestBody?: never; + responses: { + /** @description Response */ + 202: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["full-repository"]; + }; + }; + 400: components["responses"]["bad_request"]; + 403: components["responses"]["forbidden"]; + 404: components["responses"]["not_found"]; + 422: components["responses"]["validation_failed"]; + }; + }; "activity/list-stargazers-for-repo": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116372,6 +109406,13 @@ export interface operations { }; 202: components["responses"]["accepted"]; 204: components["responses"]["no_content"]; + /** @description Repository contains more than 10,000 commits */ + 422: { + headers: { + [name: string]: unknown; + }; + content?: never; + }; }; }; "repos/get-commit-activity-stats": { @@ -116532,9 +109573,9 @@ export interface operations { "activity/list-watchers-for-repo": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116653,9 +109694,9 @@ export interface operations { "repos/list-tags": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116798,9 +109839,9 @@ export interface operations { "repos/list-teams": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -116830,9 +109871,9 @@ export interface operations { "repos/get-all-topics": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -117183,7 +110224,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; }; @@ -117215,314 +110256,6 @@ export interface operations { 422: components["responses"]["validation_failed"]; }; }; - "actions/list-environment-secrets": { - parameters: { - query?: { - /** @description The number of results per page (max 100). */ - per_page?: components["parameters"]["per-page"]; - /** @description Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": { - total_count: number; - secrets: components["schemas"]["actions-secret"][]; - }; - }; - }; - }; - }; - "actions/get-environment-public-key": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["actions-public-key"]; - }; - }; - }; - }; - "actions/get-environment-secret": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["actions-secret"]; - }; - }; - }; - }; - "actions/create-or-update-environment-secret": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) endpoint. */ - encrypted_value: string; - /** @description ID of the key you used to encrypt the secret. */ - key_id: string; - }; - }; - }; - responses: { - /** @description Response when creating a secret */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - /** @description Response when updating a secret */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "actions/delete-environment-secret": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - /** @description The name of the secret. */ - secret_name: components["parameters"]["secret-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Default response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "actions/list-environment-variables": { - parameters: { - query?: { - /** @description The number of results per page (max 30). */ - per_page?: components["parameters"]["variables-per-page"]; - /** @description Page number of the results to fetch. */ - page?: components["parameters"]["page"]; - }; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - Link: components["headers"]["link"]; - [name: string]: unknown; - }; - content: { - "application/json": { - total_count: number; - variables: components["schemas"]["actions-variable"][]; - }; - }; - }; - }; - }; - "actions/create-environment-variable": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name: string; - /** @description The value of the variable. */ - value: string; - }; - }; - }; - responses: { - /** @description Response */ - 201: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["empty-object"]; - }; - }; - }; - }; - "actions/get-environment-variable": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - /** @description The name of the variable. */ - name: components["parameters"]["variable-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["actions-variable"]; - }; - }; - }; - }; - "actions/delete-environment-variable": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the variable. */ - name: components["parameters"]["variable-name"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - }; - cookie?: never; - }; - requestBody?: never; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; - "actions/update-environment-variable": { - parameters: { - query?: never; - header?: never; - path: { - /** @description The unique identifier of the repository. */ - repository_id: components["parameters"]["repository-id"]; - /** @description The name of the variable. */ - name: components["parameters"]["variable-name"]; - /** @description The name of the environment. */ - environment_name: components["parameters"]["environment-name"]; - }; - cookie?: never; - }; - requestBody: { - content: { - "application/json": { - /** @description The name of the variable. */ - name?: string; - /** @description The value of the variable. */ - value?: string; - }; - }; - }; - responses: { - /** @description Response */ - 204: { - headers: { - [name: string]: unknown; - }; - content?: never; - }; - }; - }; "search/code": { parameters: { query: { @@ -117538,9 +110271,9 @@ export interface operations { * @description **This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: "desc" | "asc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117577,9 +110310,9 @@ export interface operations { sort?: "author-date" | "committer-date"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117613,9 +110346,9 @@ export interface operations { sort?: "comments" | "reactions" | "reactions-+1" | "reactions--1" | "reactions-smile" | "reactions-thinking_face" | "reactions-heart" | "reactions-tada" | "interactions" | "created" | "updated"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117654,9 +110387,9 @@ export interface operations { sort?: "created" | "updated"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117693,9 +110426,9 @@ export interface operations { sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117727,9 +110460,9 @@ export interface operations { query: { /** @description The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as the web interface for GitHub. To learn more about the format of the query, see [Constructing a search query](https://docs.github.com/rest/search/search#constructing-a-search-query). */ q: string; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117763,9 +110496,9 @@ export interface operations { sort?: "followers" | "repositories" | "joined"; /** @description Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. */ order?: components["parameters"]["order"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -117913,9 +110646,9 @@ export interface operations { query?: { /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118063,9 +110796,9 @@ export interface operations { query?: { /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118214,9 +110947,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion comment. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118286,9 +111019,9 @@ export interface operations { query?: { /** @description Returns a single [reaction type](https://docs.github.com/rest/reactions/reactions#about-reactions). Omit this parameter to list all reactions to a team discussion. */ content?: "+1" | "-1" | "laugh" | "confused" | "heart" | "hooray" | "rocket" | "eyes"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118352,9 +111085,9 @@ export interface operations { "teams/list-pending-invitations-legacy": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118383,9 +111116,9 @@ export interface operations { query?: { /** @description Filters members returned by their role in the team. */ role?: "member" | "maintainer" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118618,9 +111351,9 @@ export interface operations { "teams/list-projects-legacy": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118693,7 +111426,7 @@ export interface operations { content: { "application/json": { /** - * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + * @description The permission to grant to the team for this project. Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." * @enum {string} */ permission?: "read" | "write" | "admin"; @@ -118752,9 +111485,9 @@ export interface operations { "teams/list-repos-legacy": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -118885,9 +111618,9 @@ export interface operations { "teams/list-child-legacy": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119004,9 +111737,9 @@ export interface operations { "users/list-blocked-by-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119117,9 +111850,9 @@ export interface operations { "codespaces/list-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 ID of the Repository to filter on */ repository_id?: components["parameters"]["repository-id-in-query"]; @@ -119240,9 +111973,9 @@ export interface operations { "codespaces/list-secrets-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119820,9 +112553,9 @@ export interface operations { "users/list-emails-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119915,9 +112648,9 @@ export interface operations { "users/list-followers-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -119944,9 +112677,9 @@ export interface operations { "users/list-followed-by-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120056,9 +112789,9 @@ export interface operations { "users/list-gpg-keys-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120173,9 +112906,9 @@ export interface operations { "apps/list-installations-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120205,9 +112938,9 @@ export interface operations { "apps/list-installation-repos-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120382,9 +113115,9 @@ export interface operations { direction?: components["parameters"]["direction"]; /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120410,9 +113143,9 @@ export interface operations { "users/list-public-ssh-keys-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120529,9 +113262,9 @@ export interface operations { "apps/list-subscriptions-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120558,9 +113291,9 @@ export interface operations { "apps/list-subscriptions-for-authenticated-user-stubbed": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120588,9 +113321,9 @@ export interface operations { query?: { /** @description Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. */ state?: "active" | "pending"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120679,9 +113412,9 @@ export interface operations { "migrations/list-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120886,9 +113619,9 @@ export interface operations { "migrations/list-repos-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120916,9 +113649,9 @@ export interface operations { "orgs/list-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -120952,9 +113685,9 @@ export interface operations { * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -121058,9 +113791,9 @@ export interface operations { "packages/get-all-package-versions-for-package-owned-by-authenticated-user": { parameters: { query?: { - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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 state of the package, either active or deleted. */ state?: "active" | "deleted"; @@ -121215,9 +113948,9 @@ export interface operations { "users/list-public-emails-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121258,9 +113991,9 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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 Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since-repo-date"]; @@ -121441,7 +114174,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["repository"]; + "application/json": components["schemas"]["full-repository"]; }; }; 304: components["responses"]["not_modified"]; @@ -121455,9 +114188,9 @@ export interface operations { "repos/list-invitations-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121535,9 +114268,9 @@ export interface operations { "users/list-social-accounts-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121633,9 +114366,9 @@ export interface operations { "users/list-ssh-signing-keys-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121756,9 +114489,9 @@ export interface operations { sort?: components["parameters"]["sort-starred"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121875,9 +114608,9 @@ export interface operations { "activity/list-watched-repos-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121904,9 +114637,9 @@ export interface operations { "teams/list-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -121935,7 +114668,7 @@ export interface operations { query?: { /** @description A user ID. Only return users with an ID greater than this ID. */ since?: components["parameters"]["since-user"]; - /** @description The number of results per page (max 100). */ + /** @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"]; }; header?: never; @@ -122010,9 +114743,9 @@ export interface operations { "activity/list-events-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122038,9 +114771,9 @@ export interface operations { "activity/list-org-events-for-authenticated-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122068,9 +114801,9 @@ export interface operations { "activity/list-public-events-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122096,9 +114829,9 @@ export interface operations { "users/list-followers-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122125,9 +114858,9 @@ export interface operations { "users/list-following-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122185,9 +114918,9 @@ export interface operations { query?: { /** @description Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. */ since?: components["parameters"]["since"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122215,9 +114948,9 @@ export interface operations { "users/list-gpg-keys-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122297,9 +115030,9 @@ export interface operations { "users/list-public-keys-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122326,9 +115059,9 @@ export interface operations { "orgs/list-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122362,9 +115095,9 @@ export interface operations { * The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. * For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." */ visibility?: components["parameters"]["package-visibility"]; - /** @description Page number of the results to fetch. */ + /** @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). */ + /** @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"]; }; header?: never; @@ -122600,9 +115333,9 @@ export interface operations { query?: { /** @description Indicates the state of the projects to return. */ state?: "open" | "closed" | "all"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122630,9 +115363,9 @@ export interface operations { "activity/list-received-events-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122658,9 +115391,9 @@ export interface operations { "activity/list-received-public-events-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122692,9 +115425,9 @@ export interface operations { sort?: "created" | "updated" | "pushed" | "full_name"; /** @description The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`. */ direction?: "asc" | "desc"; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122790,9 +115523,9 @@ export interface operations { "users/list-social-accounts-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122819,9 +115552,9 @@ export interface operations { "users/list-ssh-signing-keys-for-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122852,9 +115585,9 @@ export interface operations { sort?: components["parameters"]["sort-starred"]; /** @description The direction to sort the results by. */ direction?: components["parameters"]["direction"]; - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; @@ -122881,9 +115614,9 @@ export interface operations { "activity/list-repos-watched-by-user": { parameters: { query?: { - /** @description The number of results per page (max 100). */ + /** @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 Page number of the results to fetch. */ + /** @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; diff --git a/packages/openapi-typescript/examples/github-api.yaml b/packages/openapi-typescript/examples/github-api.yaml index 9bc4eecaa..3ad1b9e53 100644 --- a/packages/openapi-typescript/examples/github-api.yaml +++ b/packages/openapi-typescript/examples/github-api.yaml @@ -160,20 +160,7 @@ paths: in: query description: If specified, only advisories for these ecosystems will be returned. schema: - type: string - enum: - - actions - - composer - - erlang - - go - - maven - - npm - - nuget - - other - - pip - - pub - - rubygems - - rust + "$ref": "#/components/schemas/security-advisory-ecosystems" - name: severity in: query description: If specified, only advisories with these severities will be returned. @@ -244,7 +231,8 @@ paths: - "$ref": "#/components/parameters/pagination-after" - "$ref": "#/components/parameters/direction" - name: per_page - description: The number of results per page (max 100). + 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 schema: type: integer @@ -620,9 +608,9 @@ paths: get: summary: List installations for the authenticated app description: |- - 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. - The permissions the installation has are included under the `permissions` key. + + 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 operationId: apps/list-installations @@ -719,7 +707,13 @@ paths: post: summary: Create an installation access token for an app description: |- - Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key. + Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. + + Optionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner. + + 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: @@ -757,7 +751,8 @@ paths: examples: default: value: - repository: Hello-World + repositories: + - Hello-World permissions: issues: write contents: read @@ -1020,13 +1015,16 @@ paths: "/applications/{client_id}/token/scoped": post: summary: Create a scoped access token - description: Use a non-scoped user access token to create a repository scoped - and/or permission scoped user access token. You can specify which repositories - the token can access and which permissions are granted to the token. You must - use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) - when accessing this endpoint, using the `client_id` and `client_secret` of - the GitHub App as the username and password. Invalid tokens will return `404 - NOT FOUND`. + description: |- + Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify + which repositories the token can access and which permissions are granted to the + token. + + Invalid tokens will return `404 NOT FOUND`. + + You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) + when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + as the username and password. tags: - apps operationId: apps/scope-token @@ -1113,10 +1111,9 @@ paths: "/apps/{app_slug}": get: summary: Get an app - description: |- - **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). - - If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + description: "**Note**: The `:app_slug` is just the URL-friendly name of your + GitHub App. You can find this on the settings page for your GitHub App (e.g., + `https://github.com/settings/apps/:app_slug`)." tags: - apps operationId: apps/get-by-slug @@ -1426,14 +1423,92 @@ paths: enabledForGitHubApps: true category: emojis subcategory: emojis + "/enterprises/{enterprise}/copilot/usage": + get: + summary: Get a summary of Copilot usage for enterprise members + description: |- + **Note**: This endpoint is in beta 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 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 response contains metrics for the prior 28 days. 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. + + Only the owners and billing managers of enterprises with a Copilot Business or Enterprise subscription can view Copilot usage + metrics for the enterprise. + + OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + tags: + - copilot + operationId: copilot/usage-metrics-for-enterprise + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members + 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 + 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-enterprise" + '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 "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise description: |- Lists Dependabot alerts for repositories that are owned by the specified enterprise. - To use this endpoint, you must be a member of the enterprise, and you must use an - access token with the `repo` scope or `security_events` scope. + + The authenticated user must be a member of the enterprise to use this endpoint. + 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 the `repo` or `security_events` scope to use this endpoint. tags: - dependabot operationId: dependabot/list-alerts-for-enterprise @@ -1485,7 +1560,12 @@ paths: summary: List secret scanning alerts for an enterprise description: |- Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are 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). + + 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). + + 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 the `repo` scope or `security_events` scope to use this endpoint. tags: - secret-scanning operationId: secret-scanning/list-alerts-for-enterprise @@ -1569,16 +1649,18 @@ paths: get: summary: Get feeds description: |- - GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user: + Lists the feeds available to the authenticated user. The response provides a URL for each feed. You can then get a specific feed by sending a request to one of the feed URLs. * **Timeline**: The GitHub global public timeline - * **User**: The public timeline for any user, using [URI template](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) + * **User**: The public timeline for any user, using `uri_template`. For more information, see "[Hypermedia](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." * **Current user public**: The public timeline for the authenticated user * **Current user**: The private timeline for the authenticated user * **Current user actor**: The private timeline for activity created by the authenticated user * **Current user organizations**: The private timeline for the organizations the authenticated user is a member of. * **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub. + By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." + **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens. tags: - activity @@ -1817,7 +1899,13 @@ paths: "/gists/{gist_id}": get: summary: Get a gist - description: '' + description: |- + Gets a specified gist. + + 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. This is the default if you do not pass any specific media type. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/get @@ -1850,8 +1938,16 @@ paths: patch: summary: Update a gist description: |- - Allows you to update a gist's description and to update, delete, or rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged. + Allows you to update a gist's description and to update, delete, or rename gist files. Files + from the previous version of the gist that aren't explicitly changed during an edit + are unchanged. + At least one of `description` or `files` is required. + + 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. This is the default if you do not pass any specific media type. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/update @@ -1965,7 +2061,13 @@ paths: "/gists/{gist_id}/comments": get: summary: List gist comments - description: '' + description: |- + Lists the comments on a gist. + + 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. This is the default if you do not pass any specific media type. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/list-comments @@ -2004,7 +2106,13 @@ paths: subcategory: comments post: summary: Create a gist comment - description: '' + description: |- + Creates a comment on a gist. + + 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. This is the default if you do not pass any specific media type. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/create-comment @@ -2061,7 +2169,13 @@ paths: "/gists/{gist_id}/comments/{comment_id}": get: summary: Get a gist comment - description: '' + description: |- + Gets a comment on a gist. + + 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. This is the default if you do not pass any specific media type. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/get-comment @@ -2094,7 +2208,13 @@ paths: subcategory: comments patch: summary: Update a gist comment - description: '' + description: |- + Updates a comment on a gist. + + 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. This is the default if you do not pass any specific media type. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/update-comment @@ -2322,7 +2442,7 @@ paths: put: summary: Star a gist description: Note that you'll need to set `Content-Length` to zero when calling - out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - gists operationId: gists/star @@ -2373,7 +2493,13 @@ paths: "/gists/{gist_id}/{sha}": get: summary: Get a gist revision - description: '' + description: |- + Gets a specified gist revision. + + 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. This is the default if you do not pass any specific media type. + - **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences. tags: - gists operationId: gists/get-revision @@ -2450,8 +2576,11 @@ paths: get: summary: Get a gitignore template description: |- - The API also allows fetching the source of a single template. - Use the raw [media type](https://docs.github.com/rest/overview/media-types/) to get the raw contents. + Get the content of a gitignore template. + + 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 .gitignore contents. operationId: gitignore/get-template tags: - gitignore @@ -2484,10 +2613,7 @@ paths: "/installation/repositories": get: summary: List repositories accessible to the app installation - description: |- - List repositories that an app installation can access. - - You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. + description: List repositories that an app installation can access. tags: - apps operationId: apps/list-repos-accessible-to-installation @@ -2541,8 +2667,6 @@ paths: Revokes the installation token you're using to authenticate as an installation and access this endpoint. Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. - - You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. tags: - apps operationId: apps/revoke-installation-access-token @@ -2566,11 +2690,17 @@ paths: repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not necessarily assigned to you. - **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + 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 @@ -3215,7 +3345,8 @@ paths: - "$ref": "#/components/parameters/before" - "$ref": "#/components/parameters/page" - name: per_page - description: The number of results per page (max 50). + description: The number of results per page (max 50). 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 @@ -3369,6 +3500,26 @@ paths: enabledForGitHubApps: false category: activity subcategory: notifications + delete: + summary: Mark a thread as done + description: 'Marks a thread as "done." Marking a thread as "done" is equivalent + to marking a notification in your notification inbox on GitHub as done: https://github.com/notifications.' + tags: + - activity + operationId: activity/mark-thread-as-done + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done + parameters: + - "$ref": "#/components/parameters/thread-id" + responses: + '204': + description: No content + x-github: + githubCloudOnly: false + enabledForGitHubApps: false + category: activity + subcategory: notifications "/notifications/threads/{thread_id}/subscription": get: summary: Get a thread subscription for the authenticated user @@ -3522,7 +3673,7 @@ paths: get: summary: List organizations description: |- - Lists all organizations, in the order that they were created on GitHub. + Lists all organizations, in the order that they were created. **Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers) to get the URL for the next page of organizations. tags: @@ -3562,9 +3713,26 @@ paths: get: summary: Get an organization description: |- - To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + Gets information about an organization. + + When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + + To see the full details about an organization, the authenticated user must be an organization owner. + + The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration: - GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + - advanced_security_enabled_for_new_repositories + - dependabot_alerts_enabled_for_new_repositories + - dependabot_security_updates_enabled_for_new_repositories + - dependency_graph_enabled_for_new_repositories + - secret_scanning_enabled_for_new_repositories + - secret_scanning_push_protection_enabled_for_new_repositories + + For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + + To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. tags: - orgs operationId: orgs/get @@ -3595,7 +3763,22 @@ paths: description: |- **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). - Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. + Updates the organization's profile and member privileges. + + With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration: + + - advanced_security_enabled_for_new_repositories + - dependabot_alerts_enabled_for_new_repositories + - dependabot_security_updates_enabled_for_new_repositories + - dependency_graph_enabled_for_new_repositories + - secret_scanning_enabled_for_new_repositories + - secret_scanning_push_protection_enabled_for_new_repositories + + For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)." + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. tags: - orgs operationId: orgs/update @@ -3631,7 +3814,8 @@ paths: description: The shorthand name of the company. description: type: string - description: The description of the company. + description: The description of the company. The maximum size is + 160 characters. has_organization_projects: type: boolean description: Whether an organization can use organization projects. @@ -3852,7 +4036,8 @@ paths: description: |- Gets the total GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - actions operationId: actions/get-actions-cache-usage-for-org @@ -3885,7 +4070,8 @@ paths: description: |- Lists repositories and their GitHub Actions cache usage for an organization. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - actions operationId: actions/get-actions-cache-usage-by-repo-for-org @@ -3929,8 +4115,8 @@ paths: summary: Get the customization template for an OIDC subject claim for an organization description: |- Gets the customization template for an OpenID Connect (OIDC) subject claim. - You must authenticate using an access token with the `read:org` scope to use this endpoint. - GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - oidc operationId: oidc/get-oidc-custom-sub-template-for-org @@ -3957,8 +4143,8 @@ paths: summary: Set the customization template for an OIDC subject claim for an organization description: |- Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - You must authenticate using an access token with the `write:org` scope to use this endpoint. - GitHub Apps must have the `admin:org` permission to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - oidc operationId: oidc/update-oidc-custom-sub-template-for-org @@ -4001,7 +4187,7 @@ paths: description: |- Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/get-github-actions-permissions-organization tags: - actions @@ -4030,7 +4216,7 @@ paths: description: |- Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/set-github-actions-permissions-organization tags: - actions @@ -4071,7 +4257,7 @@ paths: description: |- Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/list-selected-repositories-enabled-github-actions-organization tags: - actions @@ -4112,7 +4298,8 @@ paths: description: |- Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/set-selected-repositories-enabled-github-actions-organization tags: - actions @@ -4156,7 +4343,7 @@ paths: description: |- Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/enable-selected-repository-github-actions-organization tags: - actions @@ -4179,7 +4366,7 @@ paths: description: |- Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/disable-selected-repository-github-actions-organization tags: - actions @@ -4201,9 +4388,9 @@ paths: get: summary: Get allowed actions and reusable workflows for an organization description: |- - Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/get-allowed-actions-organization tags: - actions @@ -4232,7 +4419,7 @@ paths: description: |- Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. operationId: actions/set-allowed-actions-organization tags: - actions @@ -4266,7 +4453,7 @@ paths: as well as whether GitHub Actions can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - actions operationId: actions/get-github-actions-default-workflow-permissions-organization @@ -4297,7 +4484,7 @@ paths: can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - actions operationId: actions/set-github-actions-default-workflow-permissions-organization @@ -4329,10 +4516,9 @@ paths: description: |- Lists all self-hosted runners configured in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-self-hosted-runners-for-org @@ -4382,10 +4568,9 @@ paths: description: |- Lists binaries for the runner application that you can download and run. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-runner-applications-for-org @@ -4417,10 +4602,9 @@ paths: description: |- Generates a configuration that can be passed to the runner application at startup. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + The authenticated user must have admin access to the organization. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/generate-runner-jitconfig-for-org @@ -4485,17 +4669,18 @@ paths: "/orgs/{org}/actions/runners/registration-token": post: summary: Create a registration token for an organization - description: "Returns a token that you can pass to the `config` script. The - token expires after one hour.\n\nYou must authenticate using an access token - with the `admin:org` scope to use this endpoint.\nIf the repository is private, - you must use an access token with the `repo` scope.\nGitHub Apps must have - the `administration` permission for repositories and the `organization_self_hosted_runners` - permission for organizations.\nAuthenticated users must have admin access - to repositories or organizations, or the `manage_runners:enterprise` scope - for enterprises, to use these endpoints.\n\nExample using registration token: - \n\nConfigure your self-hosted runner, replacing `TOKEN` with the registration - token provided by this endpoint.\n\n```\n./config.sh --url https://github.com/octo-org - --token TOKEN\n```" + description: |- + Returns a token that you can pass to the `config` script. The token expires after one hour. + + For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: + + ``` + ./config.sh --url https://github.com/octo-org --token TOKEN + ``` + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-registration-token-for-org @@ -4525,19 +4710,15 @@ paths: description: |- Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - - Example using remove token: - - To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this - endpoint. + For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: ``` ./config.sh remove --token TOKEN ``` + + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-remove-token-for-org @@ -4567,10 +4748,9 @@ paths: description: |- Gets a specific self-hosted runner configured in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/get-self-hosted-runner-for-org @@ -4600,10 +4780,9 @@ paths: description: |- Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-self-hosted-runner-from-org @@ -4627,10 +4806,9 @@ paths: description: |- Lists all labels for a self-hosted runner configured in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-labels-for-self-hosted-runner-for-org @@ -4653,12 +4831,11 @@ paths: post: summary: Add custom labels to a self-hosted runner for an organization description: |- - Add custom labels to a self-hosted runner configured in an organization. + Adds custom labels to a self-hosted runner configured in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - actions operationId: actions/add-custom-labels-to-self-hosted-runner-for-org @@ -4708,10 +4885,9 @@ paths: Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/set-custom-labels-for-self-hosted-runner-for-org @@ -4762,10 +4938,9 @@ paths: Remove all custom labels from a self-hosted runner configured in an organization. Returns the remaining read-only labels from the runner. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-org @@ -4795,10 +4970,9 @@ paths: This endpoint returns a `404 Not Found` status if the custom label is not present on the runner. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/remove-custom-label-from-self-hosted-runner-for-org @@ -4828,10 +5002,9 @@ paths: Lists all secrets available in an organization without revealing their encrypted values. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-org-secrets @@ -4877,10 +5050,9 @@ paths: Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. + The authenticated user must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-org-public-key @@ -4910,10 +5082,9 @@ paths: description: |- Gets a single organization secret without revealing its encrypted value. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. + The authenticated user must have collaborator access to a repository to create, update, or read secrets + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-org-secret @@ -4944,10 +5115,9 @@ paths: Creates or updates an organization secret with an encrypted value. 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)." - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-or-update-org-secret @@ -5028,10 +5198,9 @@ paths: description: |- Deletes a secret in an organization using the secret name. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-org-secret @@ -5056,10 +5225,9 @@ paths: Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-selected-repos-for-org-secret @@ -5103,10 +5271,9 @@ paths: for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/set-selected-repos-for-org-secret @@ -5154,13 +5321,12 @@ paths: summary: Add selected repository to an organization secret description: |- Adds a repository to an organization secret when the `visibility` for - repository access is set to `selected`. The visibility is set when you [Create or + repository access is set to `selected`. For more information about setting the visibility, see [Create or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/add-selected-repo-to-org-secret @@ -5192,10 +5358,9 @@ paths: for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/remove-selected-repo-from-org-secret @@ -5225,7 +5390,10 @@ paths: summary: List organization variables description: |- Lists all organization variables. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-org-variables @@ -5269,10 +5437,9 @@ paths: description: |- Creates an organization variable that you can reference in a GitHub Actions workflow. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-org-variable @@ -5344,10 +5511,9 @@ paths: description: |- Gets a specific variable in an organization. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. + The authenticated user must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-org-variable @@ -5377,10 +5543,9 @@ paths: description: |- Updates an organization variable that you can reference in a GitHub Actions workflow. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/update-org-variable @@ -5441,10 +5606,9 @@ paths: description: |- Deletes an organization variable using the variable name. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-org-variable @@ -5469,10 +5633,9 @@ paths: Lists all repositories that can access an organization variable that is available to selected repositories. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/list-selected-repos-for-org-variable @@ -5519,11 +5682,9 @@ paths: to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:write` organization permission to use this - endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/set-selected-repos-for-org-variable @@ -5571,10 +5732,9 @@ paths: Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/add-selected-repo-to-org-variable @@ -5607,10 +5767,9 @@ paths: available to selected repositories. Organization variables that are available to selected repositories have their `visibility` field set to `selected`. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. tags: - actions operationId: actions/remove-selected-repo-from-org-variable @@ -5745,9 +5904,9 @@ paths: description: |- Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. 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)." - To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. + The authenticated user must be an owner or security manager for the organization to use this endpoint. - For public repositories, you may instead use the `public_repo` scope. + OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope 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/list-alerts-for-org @@ -5817,7 +5976,7 @@ paths: description: |- Lists the codespaces associated to a specified organization. - You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-in-organization @@ -5868,7 +6027,7 @@ paths: summary: Manage access control for organization codespaces description: |- Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/set-codespaces-access @@ -5939,7 +6098,7 @@ paths: To use this endpoint, the access settings for the organization must be set to `selected_members`. For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." - You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/set-codespaces-access-users @@ -5997,7 +6156,7 @@ paths: To use this endpoint, the access settings for the organization must be set to `selected_members`. For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." - You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-codespaces-access-users @@ -6051,8 +6210,10 @@ paths: get: summary: List organization secrets description: |- - Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + Lists all Codespaces development environment secrets 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: - codespaces operationId: codespaces/list-org-secrets @@ -6094,10 +6255,9 @@ paths: "/orgs/{org}/codespaces/secrets/public-key": get: summary: Get an organization public key - description: Gets a public key for an organization, which is required in order - to encrypt secrets. You need to encrypt the value of a secret before you can - create or update secrets. You must authenticate using an access token with - the `admin:org` scope to use this endpoint. + description: |- + Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-org-public-key @@ -6126,7 +6286,8 @@ paths: summary: Get an organization secret description: |- Gets an organization development environment secret without revealing its encrypted value. - You must authenticate using an access token with the `admin:org` scope to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-org-secret @@ -6160,8 +6321,7 @@ paths: Creates or updates an organization development environment secret with an encrypted value. 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)." - You must authenticate using an access - token with the `admin:org` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-or-update-org-secret @@ -6243,9 +6403,10 @@ paths: subcategory: organization-secrets delete: summary: Delete an organization secret - description: Deletes an organization development environment secret using the - secret name. You must authenticate using an access token with the `admin:org` - scope to use this endpoint. + description: |- + Deletes an organization development environment secret using the secret name. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-org-secret @@ -6268,9 +6429,11 @@ paths: "/orgs/{org}/codespaces/secrets/{secret_name}/repositories": get: summary: List selected repositories for an organization secret - description: Lists all repositories that have been selected when the `visibility` - for repository access to a secret is set to `selected`. You must authenticate - using an access token with the `admin:org` scope to use this endpoint. + description: |- + Lists all repositories that have been selected when the `visibility` + for repository access to a secret is set to `selected`. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-selected-repos-for-org-secret @@ -6311,11 +6474,12 @@ paths: subcategory: organization-secrets put: summary: Set selected repositories for an organization secret - description: Replaces all repositories for an organization development environment - secret when the `visibility` for repository access is set to `selected`. The - visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to - use this endpoint. + description: |- + Replaces all repositories for an organization development environment secret when the `visibility` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/set-selected-repos-for-org-secret @@ -6365,11 +6529,9 @@ paths: "/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}": put: summary: Add selected repository to an organization secret - description: Adds a repository to an organization development environment secret - when the `visibility` for repository access is set to `selected`. The visibility - is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to - use this endpoint. + description: |- + Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/add-selected-repo-to-org-secret @@ -6400,11 +6562,12 @@ paths: subcategory: organization-secrets delete: summary: Remove selected repository from an organization secret - description: Removes a repository from an organization development environment - secret when the `visibility` for repository access is set to `selected`. The - visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to - use this endpoint. + description: |- + Removes a repository from an organization development environment secret when the `visibility` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/remove-selected-repo-from-org-secret @@ -6435,22 +6598,23 @@ paths: subcategory: organization-secrets "/orgs/{org}/copilot/billing": get: - summary: Get Copilot Business seat information and settings for an organization + summary: Get Copilot seat information and settings for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Gets information about an organization's Copilot Business subscription, including seat breakdown + Gets information about an organization's Copilot subscription, including seat breakdown and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. - For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". + For more information, see "[Managing policies for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-copilot-business-in-your-organization)". - Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must - authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + Only organization owners can configure and view details about the organization's Copilot Business subscription. + + OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. tags: - copilot operationId: copilot/get-copilot-organization-details externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-business#get-copilot-business-seat-information-and-settings-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-information-and-settings-for-an-organization parameters: - "$ref": "#/components/parameters/org" responses: @@ -6471,32 +6635,36 @@ paths: "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" + '422': + description: There is a problem with your account's associated payment method. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-business + subcategory: copilot-user-management "/orgs/{org}/copilot/billing/seats": get: - summary: List all Copilot Business seat assignments for an organization + summary: List all Copilot seat assignments for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). + Lists all Copilot seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). - Only organization owners and members with admin permissions can configure and view details about the organization's Copilot Business subscription. You must - authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + Only organization owners can configure and view details about the organization's Copilot Business or Enterprise subscription. + + OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. tags: - copilot operationId: copilot/list-copilot-seats externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-business#list-all-copilot-business-seat-assignments-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-organization parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/page" - name: per_page - description: The number of results per page (max 100). + 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 schema: type: integer @@ -6511,8 +6679,8 @@ paths: properties: total_seats: type: integer - description: Total number of Copilot For Business seats for the - organization currently being billed. + description: Total number of Copilot seats for the organization + currently being billed. seats: type: array items: @@ -6535,28 +6703,29 @@ paths: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-business + subcategory: copilot-user-management "/orgs/{org}/copilot/billing/selected_teams": post: - summary: Add teams to the Copilot Business subscription for an organization + summary: Add teams to the Copilot subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Purchases a GitHub Copilot Business seat for all users within each specified team. - The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + Purchases a GitHub Copilot seat for all users within each specified team. + The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + + Only organization owners can configure GitHub Copilot in their organization. - Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + 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. + For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. - For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. tags: - copilot - operationId: copilot/add-copilot-for-business-seats-for-teams + operationId: copilot/add-copilot-seats-for-teams externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-business#add-teams-to-the-copilot-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-user-management#add-teams-to-the-copilot-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6608,35 +6777,36 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot Business is not enabled for this organization, billing - has not been set up for this organization, a public code suggestions policy - has not been set for this organization, or the organization's Copilot + description: Copilot Business or Enterprise is not enabled for this organization, + billing has not been set up for this organization, a public code suggestions + policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-business + subcategory: copilot-user-management delete: - summary: Remove teams from the Copilot Business subscription for an organization + summary: Remove teams from the Copilot subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Cancels the Copilot Business seat assignment for all members of each team specified. + Cancels the Copilot seat assignment for all members of each team specified. This will cause the members of the specified team(s) to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. - For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + Only organization owners can configure GitHub Copilot in their organization. + + OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-teams externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-business#remove-teams-from-the-copilot-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-user-management#remove-teams-from-the-copilot-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6688,36 +6858,37 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot Business is not enabled for this organization, billing - has not been set up for this organization, a public code suggestions policy - has not been set for this organization, or the organization's Copilot + description: Copilot Business or Enterprise is not enabled for this organization, + billing has not been set up for this organization, a public code suggestions + policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-business + subcategory: copilot-user-management "/orgs/{org}/copilot/billing/selected_users": post: - summary: Add users to the Copilot Business subscription for an organization + summary: Add users to the Copilot subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Purchases a GitHub Copilot Business seat for each user specified. - The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". + Purchases a GitHub Copilot seat for each user specified. + The organization will be billed accordingly. For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". + + Only organization owners can configure GitHub Copilot in their organization. - Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + 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. + For more information about setting up a Copilot subscription, see "[Setting up a Copilot subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise)". + For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-policies-for-github-copilot-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". - In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. - For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". - For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". + OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. tags: - copilot - operationId: copilot/add-copilot-for-business-seats-for-users + operationId: copilot/add-copilot-seats-for-users externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-business#add-users-to-the-copilot-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-user-management#add-users-to-the-copilot-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6769,35 +6940,36 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot Business is not enabled for this organization, billing - has not been set up for this organization, a public code suggestions policy - has not been set for this organization, or the organization's Copilot + description: Copilot Business or Enterprise is not enabled for this organization, + billing has not been set up for this organization, a public code suggestions + policy has not been set for this organization, or the organization's Copilot access setting is set to enable Copilot for all users or is unconfigured. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-business + subcategory: copilot-user-management delete: - summary: Remove users from the Copilot Business subscription for an organization + summary: Remove users from the Copilot subscription for an organization description: |- **Note**: This endpoint is in beta and is subject to change. - Cancels the Copilot Business seat assignment for each user specified. + Cancels the Copilot seat assignment for each user specified. This will cause the specified users to lose access to GitHub Copilot at the end of the current billing cycle, and the organization will not be billed further for those users. - For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)" + For more information about Copilot pricing, see "[Pricing for GitHub Copilot](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#about-billing-for-github-copilot)". - For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". + For more information about disabling access to Copilot Business or Enterprise, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot/managing-access-for-copilot-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". - Only organization owners and members with admin permissions can configure GitHub Copilot in their organization. You must - authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + Only organization owners can configure GitHub Copilot in their organization. + + OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. tags: - copilot operationId: copilot/cancel-copilot-seat-assignment-for-users externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-business#remove-users-from-the-copilot-business-subscription-for-an-organization + url: https://docs.github.com/rest/copilot/copilot-user-management#remove-users-from-the-copilot-subscription-for-an-organization parameters: - "$ref": "#/components/parameters/org" requestBody: @@ -6849,27 +7021,100 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot Business is not enabled for this organization, billing - has not been set up for this organization, a public code suggestions policy - has not been set for this organization, the seat management setting is - set to enable Copilot for all users or is unconfigured, or a user's seat - cannot be cancelled because it was assigned to them via a team. + description: Copilot Business or Enterprise is not enabled for this organization, + billing has not been set up for this organization, a public code suggestions + policy has not been set for this organization, the seat management setting + is set to enable Copilot for all users or is unconfigured, or a user's + seat cannot be cancelled because it was assigned to them via a team. + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: copilot + subcategory: copilot-user-management + "/orgs/{org}/copilot/usage": + get: + summary: Get a summary of Copilot usage for organization members + description: |- + **Note**: This endpoint is in beta 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 + across an organization, 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 the prior 28 days. 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. + + Copilot Business or Copilot Enterprise organization owners, and owners and billing managers of their parent enterprises, can view + Copilot usage metrics. + + OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + tags: + - copilot + operationId: copilot/usage-metrics-for-org + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-organization-members + parameters: + - "$ref": "#/components/parameters/org" + - 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-business + subcategory: copilot-usage "/orgs/{org}/dependabot/alerts": get: summary: List Dependabot alerts for an organization description: |- Lists Dependabot alerts for an organization. - To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - - For public repositories, you may instead use the `public_repo` scope. + The authenticated user must be an owner or security manager for the organization to use this endpoint. - GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `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: - dependabot operationId: dependabot/list-alerts-for-org @@ -6920,10 +7165,11 @@ paths: "/orgs/{org}/dependabot/secrets": get: summary: List organization secrets - description: Lists all secrets available in an organization without revealing - their encrypted values. You must authenticate using an access token with the - `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` - organization permission to use this endpoint. + description: |- + Lists all secrets available in an organization without revealing their + encrypted values. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/list-org-secrets @@ -6965,11 +7211,11 @@ paths: "/orgs/{org}/dependabot/secrets/public-key": get: summary: Get an organization public key - description: Gets your public key, which you need to encrypt secrets. You need - to encrypt a secret before you can create or update secrets. You must authenticate - using an access token with the `admin:org` scope to use this endpoint. GitHub - Apps must have the `dependabot_secrets` organization permission to use this - endpoint. + description: |- + Gets your public key, which you need to encrypt secrets. You need to + encrypt a secret before you can create or update secrets. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/get-org-public-key @@ -6996,10 +7242,10 @@ paths: "/orgs/{org}/dependabot/secrets/{secret_name}": get: summary: Get an organization secret - description: Gets a single organization secret without revealing its encrypted - value. You must authenticate using an access token with the `admin:org` scope - to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - permission to use this endpoint. + description: |- + Gets a single organization secret without revealing its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/get-org-secret @@ -7030,9 +7276,7 @@ paths: Creates or updates an organization secret with an encrypted value. 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)." - You must authenticate using an access - token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/create-or-update-org-secret @@ -7110,10 +7354,10 @@ paths: subcategory: secrets delete: summary: Delete an organization secret - description: Deletes a secret in an organization using the secret name. You - must authenticate using an access token with the `admin:org` scope to use - this endpoint. GitHub Apps must have the `dependabot_secrets` organization - permission to use this endpoint. + description: |- + Deletes a secret in an organization using the secret name. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/delete-org-secret @@ -7134,11 +7378,11 @@ paths: "/orgs/{org}/dependabot/secrets/{secret_name}/repositories": get: summary: List selected repositories for an organization secret - description: Lists all repositories that have been selected when the `visibility` - for repository access to a secret is set to `selected`. You must authenticate - using an access token with the `admin:org` scope to use this endpoint. GitHub - Apps must have the `dependabot_secrets` organization permission to use this - endpoint. + description: |- + Lists all repositories that have been selected when the `visibility` + for repository access to a secret is set to `selected`. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/list-selected-repos-for-org-secret @@ -7177,12 +7421,12 @@ paths: subcategory: secrets put: summary: Set selected repositories for an organization secret - description: Replaces all repositories for an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you - [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to - use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - permission to use this endpoint. + description: |- + Replaces all repositories for an organization secret when the `visibility` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/set-selected-repos-for-org-secret @@ -7228,12 +7472,12 @@ paths: "/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}": put: summary: Add selected repository to an organization secret - description: Adds a repository to an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you - [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to - use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - permission to use this endpoint. + description: |- + Adds a repository to an organization secret when the `visibility` for + repository access is set to `selected`. The visibility is set when you [Create or + update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/add-selected-repo-to-org-secret @@ -7260,12 +7504,12 @@ paths: subcategory: secrets delete: summary: Remove selected repository from an organization secret - description: Removes a repository from an organization secret when the `visibility` - for repository access is set to `selected`. The visibility is set when you - [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). - You must authenticate using an access token with the `admin:org` scope to - use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - permission to use this endpoint. + description: |- + Removes a repository from an organization secret when the `visibility` + for repository access is set to `selected`. The visibility is set when you [Create + or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - dependabot operationId: dependabot/remove-selected-repo-from-org-secret @@ -7295,7 +7539,8 @@ paths: summary: Get list of conflicting packages during Docker migration for organization description: |- Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. tags: - packages operationId: packages/list-docker-migration-conflicting-packages-for-organization @@ -7397,7 +7642,11 @@ paths: "/orgs/{org}/hooks": get: summary: List organization webhooks - description: '' + description: |- + You 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. tags: - orgs operationId: orgs/list-webhooks @@ -7432,8 +7681,13 @@ paths: subcategory: webhooks post: summary: Create an organization webhook - description: 'Here''s how you can create a hook that posts payloads in JSON - format:' + description: |- + Create a hook that posts payloads in JSON format. + + You 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. tags: - orgs operationId: orgs/create-webhook @@ -7527,8 +7781,14 @@ paths: "/orgs/{org}/hooks/{hook_id}": get: summary: Get an organization webhook - description: Returns a webhook configured in an organization. To get only the - webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)." + description: |- + Returns a webhook configured in an organization. To get only the webhook + `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + + You 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. tags: - orgs operationId: orgs/get-webhook @@ -7557,11 +7817,17 @@ paths: subcategory: webhooks patch: summary: Update an organization webhook - description: Updates a webhook configured in an organization. When you update - a webhook, the `secret` will be overwritten. If you previously had a `secret` - set, you must provide the same `secret` or set a new `secret` or the secret - will be removed. If you are only updating individual webhook `config` properties, - use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)." + description: |- + Updates a webhook configured in an organization. When you update a webhook, + the `secret` will be overwritten. If you previously had a `secret` set, you must + provide the same `secret` or set a new `secret` or the secret will be removed. If + you are only updating individual webhook `config` properties, use "[Update a webhook + configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)". + + You 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. tags: - orgs operationId: orgs/update-webhook @@ -7635,7 +7901,11 @@ paths: subcategory: webhooks delete: summary: Delete an organization webhook - description: '' + description: |- + You 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. tags: - orgs operationId: orgs/delete-webhook @@ -7661,7 +7931,10 @@ paths: description: |- Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." - Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + You 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. tags: - orgs operationId: orgs/get-webhook-config-for-org @@ -7691,7 +7964,10 @@ paths: description: |- Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." - Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + You 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. tags: - orgs operationId: orgs/update-webhook-config-for-org @@ -7742,8 +8018,13 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries": get: summary: List deliveries for an organization webhook - description: Returns a list of webhook deliveries for a webhook configured in - an organization. + description: |- + Returns a list of webhook deliveries for a webhook configured in an organization. + + You 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. tags: - orgs operationId: orgs/list-webhook-deliveries @@ -7784,7 +8065,13 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a webhook delivery for an organization webhook - description: Returns a delivery for a webhook configured in an organization. + description: |- + Returns a delivery for a webhook configured in an organization. + + You 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. tags: - orgs operationId: orgs/get-webhook-delivery @@ -7817,7 +8104,13 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for an organization webhook - description: Redeliver a delivery for a webhook configured in an organization. + description: |- + Redeliver a delivery for a webhook configured in an organization. + + You 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. tags: - orgs operationId: orgs/redeliver-webhook-delivery @@ -7843,8 +8136,14 @@ paths: "/orgs/{org}/hooks/{hook_id}/pings": post: summary: Ping an organization webhook - description: This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) + description: |- + This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + + You 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. tags: - orgs operationId: orgs/ping-webhook @@ -7897,9 +8196,13 @@ paths: "/orgs/{org}/installations": get: summary: List app installations for an organization - description: Lists all GitHub Apps in an organization. The installation count - includes all GitHub Apps installed on repositories in the organization. You - must be an organization owner with `admin:read` scope to use this endpoint. + description: |- + Lists all GitHub Apps in an organization. The installation count includes + all GitHub Apps installed on repositories in the organization. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. tags: - orgs operationId: orgs/list-app-installations @@ -8136,11 +8439,15 @@ paths: - Non-owner organization members with ability to see other members and join teams by invitation. \n * `billing_manager` - Non-owner organization members with ability to manage the billing settings - of your organization." + of your organization. \n * `reinstate` - The previous role assigned + to the invitee before they were removed from your organization. + Can be one of the roles listed above. Only works if the invitee + was previously part of your organization." enum: - admin - direct_member - billing_manager + - reinstate default: direct_member team_ids: type: array @@ -8253,6 +8560,13 @@ paths: reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + 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-for-org @@ -8451,7 +8765,7 @@ paths: description: |- Lists the codespaces that a member of an organization has for repositories in that organization. - You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-codespaces-for-user-in-org @@ -8504,10 +8818,7 @@ paths: description: |- Deletes a user's codespace. - To use this endpoint you must authenticate using one of the following methods: - - - An access token with the `admin:org` scope - - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-from-organization @@ -8542,10 +8853,7 @@ paths: description: |- Stops a user's codespace. - To use this endpoint you must authenticate using one of the following methods: - - - An access token with the `admin:org` scope - - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - codespaces operationId: codespaces/stop-in-organization @@ -8583,19 +8891,21 @@ paths: subcategory: organizations "/orgs/{org}/members/{username}/copilot": get: - summary: Get Copilot Business seat assignment details for a user + summary: Get Copilot seat assignment details for a user description: |- **Note**: This endpoint is in beta and is subject to change. - Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. + Gets the GitHub Copilot seat assignment details for a member of an organization who currently has access to GitHub Copilot. + + Organization owners can view GitHub Copilot seat assignment details for members in their organization. - Organization owners and members with admin permissions can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. tags: - copilot operationId: copilot/get-copilot-seat-details-for-user externalDocs: description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-business#get-copilot-business-seat-assignment-details-for-a-user + url: https://docs.github.com/rest/copilot/copilot-user-management#get-copilot-seat-assignment-details-for-a-user parameters: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/username" @@ -8618,13 +8928,13 @@ paths: '404': "$ref": "#/components/responses/not_found" '422': - description: Copilot Business is not enabled for this organization or the - user has a pending organization invitation. + description: Copilot Business or Enterprise is not enabled for this organization + or the user has a pending organization invitation. x-github: githubCloudOnly: false enabledForGitHubApps: true category: copilot - subcategory: copilot-business + subcategory: copilot-user-management "/orgs/{org}/memberships/{username}": get: summary: Get organization membership for a user @@ -9065,8 +9375,6 @@ paths: get: summary: List organization fine-grained permissions for an organization description: |- - **Note**: This operation is in beta and subject to change. - Lists the fine-grained permissions that can be used in custom organization roles for an organization. For more information, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To list the fine-grained permissions that can be used in custom repository roles for an organization, see "[List repository fine-grained permissions for an organization](https://docs.github.com/rest/orgs/organization-roles#list-repository-fine-grained-permissions-for-an-organization)." @@ -9076,8 +9384,7 @@ paths: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-organization-fine-grained-permissions @@ -9111,17 +9418,14 @@ paths: get: summary: Get all organization roles for an organization description: |- - Lists the organization roles available in this organization. + Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-org-roles @@ -9162,17 +9466,14 @@ paths: post: summary: Create a custom organization role description: |- - Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - - For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/create-custom-organization-role @@ -9261,12 +9562,11 @@ paths: delete: summary: Remove all organization roles for a team description: |- - Removes all assigned organization roles from a team. + Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members:write` organization permission to use this endpoint. + The authenticated user must be an administrator for the organization to use this endpoint. - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/revoke-all-org-roles-team @@ -9288,11 +9588,11 @@ paths: put: summary: Assign an organization role to a team description: |- - Assigns an organization role to a team in an organization. - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members` organization read-write permission to use this endpoint. + Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + + The authenticated user must be an administrator for the organization to use this endpoint. - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/assign-team-to-org-role @@ -9319,12 +9619,11 @@ paths: delete: summary: Remove an organization role from a team description: |- - Removes an organization role from a team. + Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members:write` organization permission to use this endpoint. + The authenticated user must be an administrator for the organization to use this endpoint. - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/revoke-org-role-team @@ -9347,12 +9646,11 @@ paths: delete: summary: Remove all organization roles for a user description: |- - Revokes all assigned organization roles from a user. + Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members:write` organization permission to use this endpoint. + The authenticated user must be an administrator for the organization to use this endpoint. - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/revoke-all-org-roles-user @@ -9374,11 +9672,11 @@ paths: put: summary: Assign an organization role to a user description: |- - Assigns an organization role to a member of an organization. - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members` organization read-write permission to use this endpoint. + Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + 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. tags: - orgs operationId: orgs/assign-user-to-org-role @@ -9406,12 +9704,11 @@ paths: delete: summary: Remove an organization role from a user description: |- - Remove an organization role from a user. + Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members:write` organization permission to use this endpoint. + The authenticated user must be an administrator for the organization to use this endpoint. - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/revoke-org-role-user @@ -9434,17 +9731,14 @@ paths: get: summary: Get an organization role description: |- - Gets an organization role that is available to this organization. + Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. - The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/get-org-role @@ -9476,17 +9770,15 @@ paths: patch: summary: Update a custom organization role description: |- - Updates an existing custom organization role. Permission changes will apply to all assignees. + Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - - For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/patch-custom-organization-role @@ -9566,17 +9858,14 @@ paths: delete: summary: Delete a custom organization role. description: |- - Deletes a custom organization role. + Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." To use this endpoint, the authenticated user must be one of: - An administrator for the organization. - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. - The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - - For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/delete-custom-organization-role @@ -9598,12 +9887,11 @@ paths: get: summary: List teams that are assigned to an organization role description: |- - Lists the teams that are assigned to an organization role. + Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members` organization read permission to use this endpoint. + To use this endpoint, you must be an administrator for the organization. - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-org-role-teams @@ -9645,12 +9933,11 @@ paths: get: summary: List users that are assigned to an organization role description: |- - Lists organization members that are assigned to an organization role. + Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - GitHub Apps must have the `members` organization read permission to use this endpoint. + To use this endpoint, you must be an administrator for the organization. - For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-org-role-users @@ -9843,7 +10130,7 @@ paths: description: |- Lists packages in an organization readable by the user. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-organization @@ -9871,13 +10158,15 @@ paths: - "$ref": "#/components/parameters/org" - "$ref": "#/components/parameters/package-visibility" - name: page - description: Page number of the results to fetch. + 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)." in: query schema: type: integer default: 1 - name: per_page - description: The number of results per page (max 100). + 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 schema: type: integer @@ -9911,7 +10200,7 @@ paths: description: |- Gets a specific package in an organization. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-organization @@ -9942,9 +10231,9 @@ paths: description: |- Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-org @@ -9979,9 +10268,9 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-org @@ -10018,7 +10307,7 @@ paths: description: |- Lists package versions for a package owned by an organization. - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-org @@ -10070,7 +10359,7 @@ paths: description: |- Gets a specific package version in an organization. - You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-organization @@ -10102,9 +10391,9 @@ paths: description: |- Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. - To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-org @@ -10140,9 +10429,9 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-org @@ -10173,10 +10462,9 @@ paths: summary: List requests to access organization resources with fine-grained personal access tokens description: |- - Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API, - using the `organization_personal_access_token_requests: read` permission. + Lists requests from organization members to access organization resources with a fine-grained personal access token. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/list-pat-grant-requests @@ -10226,10 +10514,9 @@ paths: summary: Review requests to access organization resources with fine-grained personal access tokens description: |- - Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - using the `organization_personal_access_token_requests: write` permission. + Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/review-pat-grant-requests-in-bulk @@ -10298,10 +10585,9 @@ paths: summary: Review a request to access organization resources with a fine-grained personal access token description: |- - Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - using the `organization_personal_access_token_requests: write` permission. + Approves or denies a pending request to access organization resources via a fine-grained personal access token. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/review-pat-grant-request @@ -10365,10 +10651,9 @@ paths: summary: List repositories requested to be accessed by a fine-grained personal access token description: |- - Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API, - using the `organization_personal_access_token_requests: read` permission. + Lists the repositories a fine-grained personal access token request is requesting access to. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/list-pat-grant-request-repositories @@ -10417,10 +10702,9 @@ paths: summary: List fine-grained personal access tokens with access to organization resources description: |- - Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API, - using the `organization_personal_access_tokens: read` permission. + Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/list-pat-grants @@ -10470,10 +10754,9 @@ paths: summary: Update the access to organization resources via fine-grained personal access tokens description: |- - Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - using the `organization_personal_access_tokens: write` permission. + Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/update-pat-accesses @@ -10536,10 +10819,9 @@ paths: summary: Update the access a fine-grained personal access token has to organization resources description: |- - Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - using the `organization_personal_access_tokens: write` permission. + Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/update-pat-access @@ -10589,10 +10871,9 @@ paths: get: summary: List repositories a fine-grained personal access token has access to description: |- - Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API, - using the `organization_personal_access_tokens: read` permission. + Lists the repositories a fine-grained personal access token has access to. - **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + Only GitHub Apps can use this endpoint. tags: - orgs operationId: orgs/list-pat-grant-repositories @@ -10749,7 +11030,7 @@ paths: summary: Get all custom properties for an organization description: |- Gets all custom properties defined for an organization. - You must be an organization owner to use this endpoint. + Organization members can read these properties. tags: - orgs operationId: orgs/get-all-custom-properties @@ -10783,7 +11064,10 @@ paths: summary: Create or update custom properties for an organization description: |- Creates new or updates existing custom properties defined for an organization in a batch. - Only organization owners (or users with the proper permissions granted by them) can update these properties + + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs operationId: orgs/create-or-update-custom-properties @@ -10820,6 +11104,7 @@ paths: allowed_values: - production - development + values_editable_by: org_actors - property_name: service value_type: string - property_name: team @@ -10851,7 +11136,7 @@ paths: summary: Get a custom property for an organization description: |- Gets a custom property that is defined for an organization. - You must be an organization owner to use this endpoint. + Organization members can read these properties. tags: - orgs operationId: orgs/get-custom-property @@ -10884,7 +11169,10 @@ paths: summary: Create or update a custom property for an organization description: |- Creates a new or updates an existing custom property that is defined for an organization. - You must be an organization owner to use this endpoint. + + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs operationId: orgs/create-or-update-custom-property @@ -10912,7 +11200,11 @@ paths: type: boolean description: Whether the property is required. default_value: - type: string + oneOf: + - type: string + - type: array + items: + type: string nullable: true description: Default value of the property description: @@ -10923,8 +11215,12 @@ paths: type: array items: type: string + maxLength: 75 + maxItems: 200 nullable: true - description: Ordered list of allowed values of the property + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. required: - value_type examples: @@ -10960,7 +11256,10 @@ paths: summary: Remove a custom property for an organization description: |- Removes a custom property that is defined for an organization. - You must be an organization owner to use this endpoint. + + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. tags: - orgs operationId: orgs/remove-custom-property @@ -11044,7 +11343,9 @@ paths: Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. - Only organization owners (or users with the proper permissions granted by them) can update these properties + To use this endpoint, the authenticated user must be one of: + - An administrator for the organization. + - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. tags: - orgs operationId: orgs/create-or-update-custom-properties-values-for-repos @@ -11088,6 +11389,8 @@ paths: "$ref": "#/components/responses/forbidden" '404': "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -11156,7 +11459,7 @@ paths: description: |- The user can publicize their own membership. (A user cannot publicize the membership for another user.) - Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - orgs operationId: orgs/set-public-membership-for-authenticated-user @@ -11275,12 +11578,7 @@ paths: description: |- Creates a new repository in the specified organization. The authenticated user must be a member of the organization. - **OAuth scope requirements** - - When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - - * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * `repo` scope to create a private repository + OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. tags: - repos operationId: repos/create-in-org @@ -11466,10 +11764,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/repository" + "$ref": "#/components/schemas/full-repository" examples: default: - "$ref": "#/components/examples/repository" + "$ref": "#/components/examples/full-repository" headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -11548,10 +11846,14 @@ paths: description: The name of the ruleset. target: type: string - description: The target of the ruleset. + description: |- + The target of the ruleset + + **Note**: The `push` target is in beta and is subject to change. enum: - branch - tag + - push enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -11757,10 +12059,14 @@ paths: description: The name of the ruleset. target: type: string - description: The target of the ruleset. + description: |- + The target of the ruleset + + **Note**: The `push` target is in beta and is subject to change. enum: - branch - tag + - push enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -11852,10 +12158,10 @@ paths: summary: List secret scanning alerts for an organization description: |- Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - For public repositories, you may instead use the `public_repo` scope. - GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + 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 `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/list-alerts-for-org @@ -11904,7 +12210,9 @@ paths: description: |- Lists repository security advisories for an organization. - To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `repository_advisories:write` permission. + The authenticated user must be an owner or security manager for the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. tags: - security-advisories operationId: security-advisories/list-org-repository-advisories @@ -11928,7 +12236,8 @@ paths: - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - name: per_page - description: The number of advisories to return per page. + description: The number of advisories to return per page. 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: @@ -11975,9 +12284,9 @@ paths: 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)." - To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `read:org` scope. + The authenticated user must be an administrator or security manager for the organization to use this endpoint. - GitHub Apps must have the `administration` organization read permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. tags: - orgs operationId: orgs/list-security-manager-teams @@ -12010,9 +12319,9 @@ paths: 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." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope. + The authenticated user must be an administrator for the organization to use this endpoint. - GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - orgs operationId: orgs/add-security-manager-team @@ -12039,9 +12348,9 @@ paths: 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." - To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + The authenticated user must be an administrator for the organization to use this endpoint. - GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. tags: - orgs operationId: orgs/remove-security-manager-team @@ -12068,7 +12377,7 @@ paths: Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - Access tokens must have the `repo` or `admin:org` scope. + OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. operationId: billing/get-github-actions-billing-org tags: - billing @@ -12100,7 +12409,7 @@ paths: Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - Access tokens must have the `repo` or `admin:org` scope. + OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. operationId: billing/get-github-packages-billing-org tags: - billing @@ -12132,7 +12441,7 @@ paths: Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - Access tokens must have the `repo` or `admin:org` scope. + OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. operationId: billing/get-shared-storage-billing-org tags: - billing @@ -12156,6 +12465,84 @@ paths: enabledForGitHubApps: false category: billing subcategory: billing + "/orgs/{org}/team/{team_slug}/copilot/usage": + get: + summary: Get a summary of Copilot usage for a team + description: |- + **Note**: This endpoint is in beta 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 a 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 the prior 28 days. 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 team had five or more members on that day. + + Copilot Business or Copilot Enterprise organization owners for the organization that contains this team, + and owners and billing managers of their parent enterprises, can view Copilot usage metrics for a team. + + OAuth app tokens and personal access tokens (classic) need the `copilot`, `manage_billing:copilot`, `admin:org`, `admin:enterprise`, or `manage_billing:enterprise` scope to use this endpoint. + tags: + - copilot + operationId: copilot/usage-metrics-for-team + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team + parameters: + - "$ref": "#/components/parameters/org" + - "$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 "/orgs/{org}/teams": get: summary: List teams @@ -12455,9 +12842,11 @@ paths: get: summary: List discussions description: |- - List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List all discussions on a team's page. **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/list-discussions-in-org @@ -12499,11 +12888,13 @@ paths: post: summary: Create a discussion description: |- - Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Creates a new discussion post on a team's page. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/create-discussion-in-org @@ -12561,9 +12952,11 @@ paths: get: summary: Get a discussion description: |- - Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Get a specific discussion on a team's page. **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/get-discussion-in-org @@ -12592,9 +12985,11 @@ paths: patch: summary: Update a discussion description: |- - Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Edits the title and body text of a discussion post. Only the parameters you provide are updated. **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/update-discussion-in-org @@ -12640,9 +13035,11 @@ paths: delete: summary: Delete a discussion description: |- - Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Delete a discussion from a team's page. **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/delete-discussion-in-org @@ -12665,9 +13062,11 @@ paths: get: summary: List discussion comments description: |- - List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List all comments on a team discussion. **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/list-discussion-comments-in-org @@ -12704,11 +13103,13 @@ paths: post: summary: Create a discussion comment description: |- - Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Creates a new comment on a team discussion. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/create-discussion-comment-in-org @@ -12755,9 +13156,11 @@ paths: get: summary: Get a discussion comment description: |- - Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Get a specific comment on a team discussion. **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/get-discussion-comment-in-org @@ -12787,9 +13190,11 @@ paths: patch: summary: Update a discussion comment description: |- - Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Edits the body text of a discussion comment. **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/update-discussion-comment-in-org @@ -12835,9 +13240,11 @@ paths: delete: summary: Delete a discussion comment description: |- - Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Deletes a comment on a team discussion. **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/delete-discussion-comment-in-org @@ -12861,9 +13268,11 @@ paths: get: summary: List reactions for a team discussion comment description: |- - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/list-for-team-discussion-comment-in-org @@ -12916,9 +13325,13 @@ paths: post: summary: Create reaction for a team discussion comment description: |- - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + + A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/create-for-team-discussion-comment-in-org @@ -12987,7 +13400,9 @@ paths: description: |- **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. - Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/delete-for-team-discussion-comment @@ -13012,9 +13427,11 @@ paths: get: summary: List reactions for a team discussion description: |- - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/list-for-team-discussion-in-org @@ -13066,9 +13483,13 @@ paths: post: summary: Create reaction for a team discussion description: |- - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + + A response with an HTTP `200` status means that you already added the reaction type to this team discussion. **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/create-for-team-discussion-in-org @@ -13135,7 +13556,9 @@ paths: description: |- **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. - Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/delete-for-team-discussion @@ -13478,7 +13901,7 @@ paths: what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you''ll need to set `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."' + information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' enum: - read - write @@ -13585,7 +14008,7 @@ paths: If a team doesn't have permission for the repository, you will receive a `404 Not Found` response status. - If the repository is private, you must have at least `read` permission for that repository and your token must have the `repo` scope. Otherwise, you will receive a `404 Not Found` response status. + If the repository is private, you must have at least `read` permission for that repository, and your token must have the `repo` or `admin:org` scope. Otherwise, you will receive a `404 Not Found` response status. **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. tags: @@ -13623,7 +14046,7 @@ paths: put: summary: Add or update team repository permissions description: |- - To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`. @@ -13737,14 +14160,11 @@ paths: post: summary: Enable or disable a security feature for an organization description: |- - Enables or disables the specified security feature for all eligible repositories in an organization. + Enables or disables the specified security feature for all eligible repositories in 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)." - To use this endpoint, you must be an organization owner or be member of a team with the security manager role. - A token with the 'write:org' scope is also required. + The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. - GitHub Apps must have the `organization_administration:write` permission to use this endpoint. - - 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)." + OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. tags: - orgs operationId: orgs/enable-or-disable-security-product-on-all-org-repos @@ -14808,7 +15228,7 @@ paths: Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." @@ -15135,10 +15555,12 @@ paths: delete: summary: Delete a repository description: |- - Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + Deleting a repository requires admin access. If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, you will get a `403 Forbidden` response. + + OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. tags: - repos operationId: repos/delete @@ -15181,10 +15603,12 @@ paths: "/repos/{owner}/{repo}/actions/artifacts": get: summary: List artifacts for a repository - description: Lists all artifacts for a repository. Anyone with read access to - the repository can use this endpoint. If the repository is private you must - use an access token with the `repo` scope. GitHub Apps must have the `actions:read` - permission to use this endpoint. + description: |- + Lists all artifacts for a repository. + + 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. tags: - actions operationId: actions/list-artifacts-for-repo @@ -15228,10 +15652,12 @@ paths: "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": get: summary: Get an artifact - description: Gets a specific artifact for a workflow run. Anyone with read access - to the repository can use this endpoint. If the repository is private you - must use an access token with the `repo` scope. GitHub Apps must have the - `actions:read` permission to use this endpoint. + description: |- + Gets a specific artifact for a workflow run. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-artifact @@ -15259,9 +15685,9 @@ paths: subcategory: artifacts delete: summary: Delete an artifact - description: Deletes an artifact for a workflow run. You must authenticate using - an access token with the `repo` scope to use this endpoint. GitHub Apps must - have the `actions:write` permission to use this endpoint. + description: |- + Deletes an artifact for a workflow run. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-artifact @@ -15287,8 +15713,7 @@ paths: Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. The `:archive_format` must be `zip`. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions:read` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/download-artifact @@ -15323,7 +15748,10 @@ paths: description: |- Gets GitHub Actions cache usage for a repository. The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-actions-cache-usage @@ -15353,8 +15781,8 @@ paths: summary: List GitHub Actions caches for a repository description: |- Lists the GitHub Actions caches for a repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions:read` permission to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-actions-cache-list @@ -15394,9 +15822,7 @@ paths: description: |- Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. - You must authenticate using an access token with the `repo` scope to use this endpoint. - - GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-actions-cache-by-key @@ -15429,9 +15855,7 @@ paths: description: |- Deletes a GitHub Actions cache for a repository, using a cache ID. - You must authenticate using an access token with the `repo` scope to use this endpoint. - - GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-actions-cache-by-id @@ -15453,10 +15877,12 @@ paths: "/repos/{owner}/{repo}/actions/jobs/{job_id}": get: summary: Get a job for a workflow run - description: Gets a specific job in a workflow run. Anyone with read access - to the repository can use this endpoint. If the repository is private you - must use an access token with the `repo` scope. GitHub Apps must have the - `actions:read` permission to use this endpoint. + description: |- + Gets a specific job in a workflow run. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-job-for-workflow-run @@ -15487,9 +15913,11 @@ paths: summary: Download job logs for a workflow run description: |- Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look - for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can - use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must - have the `actions:read` permission to use this endpoint. + for `Location:` in the response header to find the URL for the download. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/download-job-logs-for-workflow-run @@ -15519,8 +15947,7 @@ paths: description: |- Re-run a job and its dependent jobs in a workflow run. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/re-run-job-for-workflow-run @@ -15568,8 +15995,8 @@ paths: summary: Get the customization template for an OIDC subject claim for a repository description: |- Gets the customization template for an OpenID Connect (OIDC) subject claim. - You must authenticate using an access token with the `repo` scope to use this - endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-custom-oidc-sub-claim-for-repo @@ -15602,8 +16029,8 @@ paths: summary: Set the customization template for an OIDC subject claim for a repository description: |- Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - You must authenticate using an access token with the `repo` scope to use this - endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/set-custom-oidc-sub-claim-for-repo @@ -15669,9 +16096,9 @@ paths: Lists all organization secrets shared with a repository without revealing their encrypted values. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-repo-organization-secrets @@ -15715,11 +16142,11 @@ paths: get: summary: List repository organization variables description: |- - Lists all organiation variables shared with a repository. + Lists all organization variables shared with a repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-repo-organization-variables @@ -15765,7 +16192,7 @@ paths: description: |- Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/get-github-actions-permissions-repository tags: - actions @@ -15795,7 +16222,7 @@ paths: description: |- Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/set-github-actions-permissions-repository tags: - actions @@ -15839,8 +16266,7 @@ paths: This endpoint only applies to private repositories. For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - repository `administration` permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-workflow-access-to-repository @@ -15873,8 +16299,7 @@ paths: This endpoint only applies to private repositories. For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - repository `administration` permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/set-workflow-access-to-repository @@ -15908,7 +16333,7 @@ paths: description: |- Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/get-allowed-actions-repository tags: - actions @@ -15938,7 +16363,7 @@ paths: description: |- Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/set-allowed-actions-repository tags: - actions @@ -15973,7 +16398,7 @@ paths: as well as if GitHub Actions can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-github-actions-default-workflow-permissions-repository @@ -16005,7 +16430,7 @@ paths: can submit approving pull request reviews. For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/set-github-actions-default-workflow-permissions-repository @@ -16041,9 +16466,9 @@ paths: description: |- Lists all self-hosted runners configured in a repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-self-hosted-runners-for-repo @@ -16094,9 +16519,9 @@ paths: description: |- Lists binaries for the runner application that you can download and run. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-runner-applications-for-repo @@ -16129,9 +16554,9 @@ paths: description: |- Generates a configuration that can be passed to the runner application at startup. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + The authenticated user must have admin access to the repository. + + OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. tags: - actions operationId: actions/generate-runner-jitconfig-for-repo @@ -16198,19 +16623,17 @@ paths: post: summary: Create a registration token for a repository description: |- - Returns a token that you can pass to the `config` script. The token - expires after one hour. + Returns a token that you can pass to the `config` script. The token expires after one hour. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: - Example using registration token: + ``` + ./config.sh --url https://github.com/octo-org --token TOKEN + ``` - Configure your self-hosted runner, replacing `TOKEN` with the registration token provided - by this endpoint. + Authenticated users must have admin access to the repository to use this endpoint. - ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-registration-token-for-repo @@ -16239,19 +16662,17 @@ paths: post: summary: Create a remove token for a repository description: |- - Returns a token that you can pass to remove a self-hosted runner from - a repository. The token expires after one hour. + Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: - Example using remove token: + ``` + ./config.sh remove --token TOKEN + ``` - To remove your self-hosted runner from a repository, replace TOKEN with - the remove token provided by this endpoint. + Authenticated users must have admin access to the repository to use this endpoint. - ```config.sh remove --token TOKEN``` + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-remove-token-for-repo @@ -16282,9 +16703,9 @@ paths: description: |- Gets a specific self-hosted runner configured in a repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-self-hosted-runner-for-repo @@ -16315,9 +16736,9 @@ paths: description: |- Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-self-hosted-runner-from-repo @@ -16342,9 +16763,9 @@ paths: description: |- Lists all labels for a self-hosted runner configured in a repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-labels-for-self-hosted-runner-for-repo @@ -16368,11 +16789,11 @@ paths: post: summary: Add custom labels to a self-hosted runner for a repository description: |- - Add custom labels to a self-hosted runner configured in a repository. + Adds custom labels to a self-hosted runner configured in a repository. + + Authenticated users must have admin access to the organization to use this endpoint. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/add-custom-labels-to-self-hosted-runner-for-repo @@ -16423,9 +16844,9 @@ paths: Remove all previous custom labels and set the new custom labels for a specific self-hosted runner configured in a repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/set-custom-labels-for-self-hosted-runner-for-repo @@ -16477,9 +16898,9 @@ paths: Remove all custom labels from a self-hosted runner configured in a repository. Returns the remaining read-only labels from the runner. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/remove-all-custom-labels-from-self-hosted-runner-for-repo @@ -16510,9 +16931,9 @@ paths: This endpoint returns a `404 Not Found` status if the custom label is not present on the runner. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + Authenticated users must have admin access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/remove-custom-label-from-self-hosted-runner-for-repo @@ -16540,9 +16961,13 @@ paths: get: summary: List workflow runs for a repository description: |- - Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + 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. - Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + 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`. tags: - actions operationId: actions/list-workflow-runs-for-repo @@ -16593,10 +17018,12 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}": get: summary: Get a workflow run - description: Gets a specific workflow run. Anyone with read access to the repository - can use this endpoint. If the repository is private you must use an access - token with the `repo` scope. GitHub Apps must have the `actions:read` permission - to use this endpoint. + description: |- + Gets a specific workflow run. + + 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. tags: - actions operationId: actions/get-workflow-run @@ -16626,9 +17053,11 @@ paths: delete: summary: Delete a workflow run description: |- - Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is - private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use - this endpoint. + Deletes a specific workflow run. + + Anyone with write access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/delete-workflow-run tags: - actions @@ -16650,9 +17079,10 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": get: summary: Get the review history for a workflow run - description: Anyone with read access to the repository can use this endpoint. - If the repository is private, you must use an access token with the `repo` - scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + description: |- + 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. tags: - actions operationId: actions/get-reviews-for-run @@ -16686,7 +17116,7 @@ paths: description: |- Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/approve-workflow-run @@ -16719,10 +17149,12 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": get: summary: List workflow run artifacts - description: Lists artifacts for a workflow run. Anyone with read access to - the repository can use this endpoint. If the repository is private you must - use an access token with the `repo` scope. GitHub Apps must have the `actions:read` - permission to use this endpoint. + description: |- + Lists artifacts for a workflow run. + + 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. tags: - actions operationId: actions/list-workflow-run-artifacts @@ -16768,10 +17200,11 @@ paths: get: summary: Get a workflow run attempt description: |- - Gets a specific workflow run attempt. Anyone with read access to the repository - can use this endpoint. If the repository is private you must use an access token - with the `repo` scope. GitHub Apps must have the `actions:read` permission to - use this endpoint. + Gets a specific workflow run attempt. + + 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. tags: - actions operationId: actions/get-workflow-run-attempt @@ -16802,12 +17235,13 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs": get: summary: List jobs for a workflow run attempt - description: Lists jobs for a specific workflow run attempt. Anyone with read - access to the repository can use this endpoint. If the repository is private - you must use an access token with the `repo` scope. GitHub Apps must have - the `actions:read` permission to use this endpoint. You can use parameters - to narrow the list of results. For more information about using parameters, - see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + description: |- + Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information + about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + 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. tags: - actions operationId: actions/list-jobs-for-workflow-run-attempt @@ -16856,9 +17290,11 @@ paths: summary: Download workflow run attempt logs description: |- Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to - the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. - GitHub Apps must have the `actions:read` permission to use this endpoint. + 1 minute. Look for `Location:` in the response header to find the URL for the download. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/download-workflow-run-attempt-logs @@ -16889,8 +17325,7 @@ paths: description: |- Cancels a workflow run using its `id`. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/cancel-workflow-run @@ -16927,8 +17362,7 @@ paths: **Note:** GitHub Apps can only review their own custom deployment protection rules. To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). - If the repository is private, you must use an access token with the `repo` scope. - GitHub Apps must have read and write permission for **Deployments** to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - actions operationId: actions/review-custom-gates-for-run @@ -16969,8 +17403,7 @@ paths: Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/force-cancel-workflow-run @@ -17001,11 +17434,13 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": get: summary: List jobs for a workflow run - description: Lists jobs for a workflow run. Anyone with read access to the repository - can use this endpoint. If the repository is private you must use an access - token with the `repo` scope. GitHub Apps must have the `actions:read` permission - to use this endpoint. You can use parameters to narrow the list of results. - For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + description: |- + Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information + about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + 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. tags: - actions operationId: actions/list-jobs-for-workflow-run @@ -17063,9 +17498,11 @@ paths: summary: Download workflow run logs description: |- Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use - this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have - the `actions:read` permission to use this endpoint. + `Location:` in the response header to find the URL for the download. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/download-workflow-run-logs @@ -17091,9 +17528,10 @@ paths: subcategory: workflow-runs delete: summary: Delete workflow run logs - description: Deletes all logs for a workflow run. You must authenticate using - an access token with the `repo` scope to use this endpoint. GitHub Apps must - have the `actions:write` permission to use this endpoint. + description: |- + Deletes all logs for a workflow run. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-workflow-run-logs @@ -17122,7 +17560,9 @@ paths: description: |- Get all deployment environments for a workflow run that are waiting for protection rules to pass. - Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-pending-deployments-for-run @@ -17155,7 +17595,9 @@ paths: description: |- Approve or reject pending deployments that are waiting on approval by a required reviewer. - Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint. + Required reviewers with read access to the repository contents and deployments can use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/review-pending-deployments-for-run @@ -17225,9 +17667,10 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": post: summary: Re-run a workflow - description: Re-runs your workflow run using its `id`. You must authenticate - using an access token with the `repo` scope to use this endpoint. GitHub Apps - must have the `actions:write` permission to use this endpoint. + description: |- + Re-runs your workflow run using its `id`. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/re-run-workflow @@ -17271,9 +17714,10 @@ paths: "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs": post: summary: Re-run failed jobs from a workflow run - description: Re-run all of the failed jobs and their dependent jobs in a workflow - run using the `id` of the workflow run. You must authenticate using an access - token with the `repo` scope to use this endpoint. + description: |- + Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/re-run-workflow-failed-jobs @@ -17320,7 +17764,9 @@ paths: description: |- Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + 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. tags: - actions operationId: actions/get-workflow-run-usage @@ -17353,9 +17799,9 @@ paths: Lists all secrets available in a repository without revealing their encrypted values. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-repo-secrets @@ -17403,9 +17849,8 @@ paths: encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. - If the repository is private you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-repo-public-key @@ -17436,9 +17881,9 @@ paths: description: |- Gets a single repository secret without revealing its encrypted value. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. + The authenticated user must have collaborator access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-repo-secret @@ -17470,9 +17915,9 @@ paths: Creates or updates a repository secret with an encrypted value. 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)." - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-or-update-repo-secret @@ -17527,9 +17972,9 @@ paths: description: |- Deletes a secret in a repository using the secret name. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-repo-secret @@ -17553,9 +17998,10 @@ paths: summary: List repository variables description: |- Lists all repository variables. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/list-repo-variables @@ -17600,9 +18046,9 @@ paths: description: |- Creates a repository variable that you can reference in a GitHub Actions workflow. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/create-repo-variable @@ -17654,9 +18100,9 @@ paths: description: |- Gets a specific variable in a repository. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. + The authenticated user must have collaborator access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/get-repo-variable @@ -17687,9 +18133,9 @@ paths: description: |- Updates a repository variable that you can reference in a GitHub Actions workflow. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/update-repo-variable @@ -17731,9 +18177,9 @@ paths: description: |- Deletes a repository variable using the variable name. - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/delete-repo-variable @@ -17755,10 +18201,12 @@ paths: "/repos/{owner}/{repo}/actions/workflows": get: summary: List repository workflows - description: Lists the workflows in a repository. Anyone with read access to - the repository can use this endpoint. If the repository is private you must - use an access token with the `repo` scope. GitHub Apps must have the `actions:read` - permission to use this endpoint. + description: |- + Lists the workflows in a repository. + + 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. tags: - actions operationId: actions/list-repo-workflows @@ -17801,11 +18249,13 @@ paths: "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": get: summary: Get a workflow - description: Gets a specific workflow. You can replace `workflow_id` with the - workflow file name. For example, you could use `main.yaml`. Anyone with read - access to the repository can use this endpoint. If the repository is private - you must use an access token with the `repo` scope. GitHub Apps must have - the `actions:read` permission to use this endpoint. + description: |- + Gets a specific workflow. You can replace `workflow_id` with the workflow + file name. For example, you could use `main.yaml`. + + 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. tags: - actions operationId: actions/get-workflow @@ -17837,7 +18287,7 @@ paths: description: |- Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/disable-workflow @@ -17864,7 +18314,7 @@ paths: You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. operationId: actions/create-workflow-dispatch tags: - actions @@ -17917,7 +18367,7 @@ paths: description: |- Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - actions operationId: actions/enable-workflow @@ -17940,9 +18390,11 @@ paths: get: summary: List workflow runs for a workflow description: |- - List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/overview/resources-in-the-rest-api#parameters). + List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + + Anyone with read access to the repository can use this endpoint - Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - actions operationId: actions/list-workflow-runs @@ -17997,7 +18449,11 @@ paths: description: |- Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + + 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. tags: - actions operationId: actions/get-workflow-usage @@ -18191,9 +18647,9 @@ paths: subcategory: assignees "/repos/{owner}/{repo}/autolinks": get: - summary: List all autolinks of a repository + summary: Get all autolinks of a repository description: |- - This returns a list of autolinks configured for the given repository. + Gets all autolinks that are configured for a repository. Information about autolinks are only available to repository administrators. tags: @@ -18201,11 +18657,10 @@ paths: operationId: repos/list-autolinks externalDocs: description: API method documentation - url: https://docs.github.com/rest/repos/autolinks#list-all-autolinks-of-a-repository + url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/page" responses: '200': description: Response @@ -19674,7 +20129,7 @@ paths: description: |- Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: - repos operationId: repos/get-apps-with-access-to-protected-branch @@ -19709,7 +20164,7 @@ paths: description: |- Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: - repos operationId: repos/add-app-access-restrictions @@ -19773,7 +20228,7 @@ paths: description: |- Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: - repos operationId: repos/set-app-access-restrictions @@ -19837,7 +20292,7 @@ paths: description: |- Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. tags: - repos operationId: repos/remove-app-access-restrictions @@ -20366,17 +20821,9 @@ paths: **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". - The permissions required to use this endpoint depends on whether you are renaming the default branch. - - To rename a non-default branch: - - * Users must have push access. - * GitHub Apps must have the `contents:write` repository permission. + The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. - To rename the default branch: - - * Users must have admin or owner permissions. - * GitHub Apps must have the `administration:write` repository permission. + In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. tags: - repos operationId: repos/rename-branch @@ -20428,11 +20875,13 @@ paths: post: summary: Create a check run description: |- - **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + Creates a new check run for a specific commit in a repository. - Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs. + To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs. + + **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. tags: - checks operationId: checks/create @@ -20465,11 +20914,15 @@ paths: description: A reference for the run on the integrator's system. status: type: string - description: The current status. + description: The current status of the check run. Only GitHub Actions + can set a status of `waiting`, `pending`, or `requested`. enum: - queued - in_progress - completed + - waiting + - requested + - pending default: queued started_at: type: string @@ -20730,9 +21183,11 @@ paths: get: summary: Get a check run description: |- + Gets a single check run using its `id`. + **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. - Gets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/get @@ -20761,9 +21216,11 @@ paths: patch: summary: Update a check run description: |- - Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs. + Updates a check run for a specific commit in a repository. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + + OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: - checks operationId: checks/update @@ -20798,11 +21255,15 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' status: type: string - description: The current status. + description: The current status of the check run. Only GitHub Actions + can set a status of `waiting`, `pending`, or `requested`. enum: - queued - in_progress - completed + - waiting + - requested + - pending conclusion: type: string description: "**Required if you provide `completed_at` or a `status` @@ -21022,11 +21483,10 @@ paths: "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": get: summary: List check run annotations - description: Lists annotations for a check run using the annotation `id`. GitHub - Apps must have the `checks:read` permission on a private repository or pull - access to a public repository to get annotations for a check run. OAuth apps - and authenticated users must have the `repo` scope to get annotations for - a check run in a private repository. + description: |- + Lists annotations for a check run using the annotation `id`. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/list-annotations @@ -21065,9 +21525,9 @@ paths: description: |- Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - To rerequest a check run, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository. - For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)". + + OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: - checks operationId: checks/rerequest-run @@ -21112,9 +21572,11 @@ paths: post: summary: Create a check suite description: |- + Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". + **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)". Your GitHub App must have the `checks:write` permission to create check suites. + OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: - checks operationId: checks/create-suite @@ -21167,12 +21629,9 @@ paths: "/repos/{owner}/{repo}/check-suites/preferences": patch: summary: Update repository preferences for check suites - description: Changes the default automatic flow when creating check suites. - By default, a check suite is automatically created each time code is pushed - to a repository. When you disable the automatic creation of check suites, - you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). - You must have admin permissions in the repository to set preferences for check - suites. + description: |- + Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/rest/checks/suites#create-a-check-suite). + You must have admin permissions in the repository to set preferences for check suites. tags: - checks operationId: checks/set-suites-preferences @@ -21233,9 +21692,11 @@ paths: get: summary: Get a check suite description: |- + Gets a single check suite using its `id`. + **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. - Gets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/get-suite @@ -21265,9 +21726,11 @@ paths: get: summary: List check runs in a check suite description: |- - Lists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + Lists check runs for a check suite using its `id`. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/list-for-suite @@ -21327,7 +21790,7 @@ paths: description: |- Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared. - To rerequest a check suite, your GitHub App must have the `checks:write` permission on a private repository or pull access to a public repository. + OAuth apps and personal access tokens (classic) cannot use this endpoint. tags: - checks operationId: checks/rerequest-suite @@ -21359,11 +21822,11 @@ paths: description: |- Lists code scanning alerts. - To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope. - The response includes a `most_recent_instance` object. This provides details of the most recent instance of this alert for the default branch (or for the specified Git reference if you used `ref` in the request). + + 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/list-alerts-for-repo @@ -21431,10 +21894,10 @@ paths: "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": get: summary: Get a code scanning alert - description: Gets a single code scanning alert. You must use an access token - with the `security_events` scope to use this endpoint with private repos, - the `public_repo` scope also grants permission to read security events on - public repos only. + description: |- + Gets a single 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-alert @@ -21470,10 +21933,9 @@ paths: subcategory: code-scanning patch: summary: Update a code scanning alert - description: Updates the status of a single code scanning alert. You must use - an access token with the `security_events` scope to use this endpoint with - private repositories. You can also use tokens with the `public_repo` scope - for public repositories only. + description: |- + Updates the status of a single 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. operationId: code-scanning/update-alert tags: - code-scanning @@ -21532,8 +21994,8 @@ paths: summary: List instances of a code scanning alert description: |- Lists all instances of the specified code scanning alert. - You must use an access token with the `security_events` scope to use this endpoint with private repos, - the `public_repo` scope also grants permission to read security events on public repos only. + + 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/list-alert-instances @@ -21585,11 +22047,10 @@ paths: For very old analyses this data is not available, and `0` is returned in this field. - You must use an access token with the `security_events` scope to use this endpoint with private repos, - the `public_repo` scope also grants permission to read security events on public repos only. - **Deprecation notice**: The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. + + 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. operationId: code-scanning/list-recent-analyses tags: - code-scanning @@ -21655,8 +22116,6 @@ paths: summary: Get a code scanning analysis for a repository description: |- Gets a specified code scanning analysis for a repository. - You must use an access token with the `security_events` scope to use this endpoint with private repos, - the `public_repo` scope also grants permission to read security events on public repos only. The default JSON response contains fields that describe the analysis. This includes the Git reference and commit SHA to which the analysis relates, @@ -21668,10 +22127,11 @@ paths: For very old analyses this data is not available, and `0` is returned in this field. - If you use the Accept header `application/sarif+json`, - the response contains the analysis data that was uploaded. - This is formatted as - [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). + 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/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties. + + 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. operationId: code-scanning/get-analysis tags: - code-scanning @@ -21719,10 +22179,7 @@ paths: delete: summary: Delete a code scanning analysis from a repository description: |- - Deletes a specified code scanning analysis from a repository. For - private repositories, you must use an access token with the `repo` scope. For public repositories, - you must use an access token with `public_repo` scope. - GitHub Apps must have the `security_events` write permission to use this endpoint. + Deletes a specified code scanning analysis from a repository. You can delete one analysis at a time. To delete a series of analyses, start with the most recent analysis and work backwards. @@ -21784,6 +22241,8 @@ paths: * Parse the response for the value of `confirm_delete_url` and, if found, use this in the next iteration. The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely. + + 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. operationId: code-scanning/delete-analysis tags: - code-scanning @@ -21840,8 +22299,7 @@ paths: description: |- Lists the CodeQL databases that are available in a repository. - For private repositories, you must use an access token with the `security_events` scope. - For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + 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/list-codeql-databases @@ -21887,8 +22345,7 @@ paths: your HTTP client is configured to follow redirects or use the `Location` header to make a second request to get the redirect URL. - For private repositories, you must use an access token with the `security_events` scope. - For public repositories, you can use tokens with the `security_events` or `public_repo` scope. + 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-codeql-database @@ -21933,8 +22390,8 @@ paths: summary: Get a code scanning default setup configuration description: |- Gets a code scanning default setup configuration. - You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - scope for public repos. + + 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/get-default-setup @@ -21969,8 +22426,8 @@ paths: summary: Update a code scanning default setup configuration description: |- Updates a code scanning default setup configuration. - You must use an access token with the `repo` scope to use this endpoint with private repos or the `public_repo` - scope for public repos. + + 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/update-default-setup @@ -22025,12 +22482,8 @@ paths: post: summary: Upload an analysis as SARIF data description: "Uploads SARIF data containing the results of a code scanning analysis - to make the results available in a repository. You must use an access token - with the `security_events` scope to use this endpoint for private repositories. - You can also use tokens with the `public_repo` scope for public repositories - only. GitHub Apps must have the `security_events` write permission to use - this endpoint. For troubleshooting information, see \"[Troubleshooting SARIF - uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere + to make the results available in a repository. For troubleshooting information, + see \"[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif).\"\n\nThere are two places where you can upload code scanning results.\n - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, @@ -22040,7 +22493,7 @@ paths: see \"[Managing code scanning alerts for your repository](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository).\"\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip - -c analysis-data.sarif | base64 -w0\n```\n
\nSARIF upload supports a maximum + -c analysis-data.sarif | base64 -w0\n```\n\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping @@ -22063,7 +22516,10 @@ paths: \ | 20 | Only 10 tags will be included. |\n\n\nThe `202 Accepted` response includes an `id` value.\nYou can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.\nFor - more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"" + more information, see \"[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload).\"\n\nOAuth + 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." operationId: code-scanning/upload-sarif tags: - code-scanning @@ -22150,13 +22606,9 @@ paths: "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": get: summary: Get information about a SARIF upload - description: Gets information about a SARIF upload, including the status and - the URL of the analysis that was uploaded so that you can retrieve details - of the analysis. For more information, see "[Get a code scanning analysis - for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." - You must use an access token with the `security_events` scope to use this - endpoint with private repos, the `public_repo` scope also grants permission - to read security events on public repos only. + description: |- + Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." + 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. operationId: code-scanning/get-sarif tags: - code-scanning @@ -22243,9 +22695,7 @@ paths: description: |- Lists the codespaces associated to a specified repository and the authenticated user. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-in-repository-for-authenticated-user @@ -22295,9 +22745,7 @@ paths: description: |- Creates a codespace owned by the authenticated user in the specified repository. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-with-repo-for-authenticated-user @@ -22407,9 +22855,7 @@ paths: Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files specify launchpoint configurations for codespaces created within the repository. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-devcontainers-in-repository-for-authenticated-user @@ -22471,9 +22917,7 @@ paths: description: |- List the machine types available for a given repository based on its configuration. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/repo-machines-for-authenticated-user @@ -22543,9 +22987,7 @@ paths: description: |- Gets the default attributes for codespaces created by the user with the repository. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/pre-flight-with-repo-for-authenticated-user @@ -22612,9 +23054,7 @@ paths: description: |- Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/check-permissions-for-devcontainer @@ -22671,10 +23111,11 @@ paths: "/repos/{owner}/{repo}/codespaces/secrets": get: summary: List repository secrets - description: Lists all development environment secrets available in a repository - without revealing their encrypted values. You must authenticate using an access - token with the `repo` scope to use this endpoint. GitHub Apps must have write - access to the `codespaces_secrets` repository permission to use this endpoint. + description: |- + Lists all development environment secrets available in a repository without revealing their encrypted + values. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-repo-secrets @@ -22717,12 +23158,13 @@ paths: "/repos/{owner}/{repo}/codespaces/secrets/public-key": get: summary: Get a repository public key - description: Gets your public key, which you need to encrypt secrets. You need - to encrypt a secret before you can create or update secrets. Anyone with read - access to the repository can use this endpoint. If the repository is private - you must use an access token with the `repo` scope. GitHub Apps must have - write access to the `codespaces_secrets` repository permission to use this - endpoint. + description: |- + Gets your public key, which you need to encrypt secrets. You need to + encrypt a secret before you can create or update secrets. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-repo-public-key @@ -22750,10 +23192,10 @@ paths: "/repos/{owner}/{repo}/codespaces/secrets/{secret_name}": get: summary: Get a repository secret - description: Gets a single repository development environment secret without - revealing its encrypted value. You must authenticate using an access token - with the `repo` scope to use this endpoint. GitHub Apps must have write access - to the `codespaces_secrets` repository permission to use this endpoint. + description: |- + Gets a single repository development environment secret without revealing its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-repo-secret @@ -22785,9 +23227,7 @@ paths: Creates or updates a repository development environment secret with an encrypted value. 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)." - You must authenticate using an access - token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-or-update-repo-secret @@ -22839,10 +23279,10 @@ paths: subcategory: repository-secrets delete: summary: Delete a repository secret - description: Deletes a development environment secret in a repository using - the secret name. You must authenticate using an access token with the `repo` - scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - repository permission to use this endpoint. + description: |- + Deletes a development environment secret in a repository using the secret name. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-repo-secret @@ -22870,9 +23310,9 @@ paths: Team members will include the members of child teams. - You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - endpoint. + The authenticated user must have push access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos operationId: repos/list-collaborators @@ -22942,9 +23382,9 @@ paths: Team members will include the members of child teams. - You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - endpoint. + The authenticated user must have push access to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. tags: - repos operationId: repos/check-collaborator @@ -22978,7 +23418,7 @@ paths: Cannot assign {member} permission of {role name} ``` - Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." The invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [API](https://docs.github.com/rest/collaborators/invitations). @@ -23133,9 +23573,14 @@ paths: get: summary: List commit comments for a repository description: |- - Commit Comments use [these custom media types](https://docs.github.com/rest/overview/media-types). You can read more about the use of media types in the API [here](https://docs.github.com/rest/overview/media-types/). + Lists the commit comments for a specified repository. Comments are ordered by ascending ID. + + 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)." - Comments are ordered by ascending ID. + - **`application/vnd.github-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/list-commit-comments-for-repo @@ -23170,7 +23615,15 @@ paths: "/repos/{owner}/{repo}/comments/{comment_id}": get: summary: Get a commit comment - description: '' + description: |- + Gets a specified commit comment. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/get-commit-comment @@ -23200,7 +23653,15 @@ paths: subcategory: comments patch: summary: Update a commit comment - description: '' + description: |- + Updates the contents of a specified commit comment. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/update-commit-comment @@ -23550,6 +24011,8 @@ paths: "$ref": "#/components/examples/branch-short-items" '422': "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23558,8 +24021,15 @@ paths: "/repos/{owner}/{repo}/commits/{commit_sha}/comments": get: summary: List commit comments - description: Use the `:commit_sha` to specify the commit that will have its - comments listed. + description: |- + Lists the comments for a specified commit. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/list-comments-for-commit @@ -23598,6 +24068,13 @@ paths: Create a comment for a commit using its `:commit_sha`. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - repos operationId: repos/create-commit-comment @@ -23696,6 +24173,8 @@ paths: headers: Link: "$ref": "#/components/headers/link" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23707,11 +24186,13 @@ paths: description: |- Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint. - **Note:** If there are more than 300 files in the commit diff, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. + **Note:** If there are more than 300 files in the commit diff and the default JSON media type is requested, the response will include pagination link headers for the remaining files, up to a limit of 3000 files. Each page contains the static commit information, and the only changes are to the file listing. - You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property. + 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)." Pagination query parameters are not supported for these media types. - To return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. + - **`application/vnd.github.diff`**: Returns the diff of the commit. Larger diffs may time out and return a 5xx status code. + - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. Larger diffs may time out and return a 5xx status code. + - **`application/vnd.github.sha`**: Returns the commit's SHA-1 hash. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag. **Signature verification object** @@ -23771,6 +24252,8 @@ paths: "$ref": "#/components/responses/internal_error" '503': "$ref": "#/components/responses/service_unavailable" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23780,11 +24263,13 @@ paths: get: summary: List check runs for a Git reference description: |- - Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository. + Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array. If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/list-for-ref @@ -23847,9 +24332,11 @@ paths: get: summary: List check suites for a Git reference description: |- - Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository. + Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. tags: - checks operationId: checks/list-suites-for-ref @@ -24023,9 +24510,14 @@ paths: get: summary: Compare two commits description: |- - Compares two commits against one another. You can compare branches in the same repository, or you can compare branches that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + Compares two commits against one another. You can compare refs (branches or tags) and commit SHAs in the same repository, or you can compare refs and commit SHAs that exist in different repositories within the same repository network, including fork branches. For more information about how to view a repository's network, see "[Understanding connections between repositories](https://docs.github.com/repositories/viewing-activity-and-data-for-your-repository/understanding-connections-between-repositories)." + + This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. + + 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)." - This endpoint is equivalent to running the `git log BASE..HEAD` command, but it returns commits in a different order. The `git log BASE..HEAD` command returns commits in reverse chronological order, whereas the API returns commits in chronological order. You can pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + - **`application/vnd.github.diff`**: Returns the diff of the commit. + - **`application/vnd.github.patch`**: Returns the patch of the commit. Diffs with binary data will have no `patch` property. The API response includes details about the files that were changed between the two commits. This includes the status of the change (if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file. @@ -24113,44 +24605,32 @@ paths: "/repos/{owner}/{repo}/contents/{path}": get: summary: Get repository content - description: "Gets the contents of a file or directory in a repository. Specify - the file path or directory in `:path`. If you omit\n`:path`, you will receive - the contents of the repository's root directory. See the description below - regarding what the API response includes for directories. \n\nFiles and symlinks - support [a custom media type](https://docs.github.com/rest/overview/media-types) - for\nretrieving the raw content or rendered HTML (when supported). All content - types support [a custom media\ntype](https://docs.github.com/rest/overview/media-types) - to ensure the content is returned in a consistent\nobject format.\n\n**Notes**:\n* - \ To get a repository's contents recursively, you can [recursively get the - tree](https://docs.github.com/rest/git/trees#get-a-tree).\n* This API has - an upper limit of 1,000 files for a directory. If you need to retrieve more - files, use the [Git Trees\nAPI](https://docs.github.com/rest/git/trees#get-a-tree).\n - * Download URLs expire and are meant to be used just once. To ensure the - download URL does not expire, please use the contents API to obtain a fresh - download URL for each download.\n Size limits:\nIf the requested file's size - is:\n* 1 MB or smaller: All features of this endpoint are supported.\n* Between - 1-100 MB: Only the `raw` or `object` [custom media types](https://docs.github.com/rest/repos/contents#custom-media-types-for-repository-contents) - are supported. Both will work as normal, except that when using the `object` - media type, the `content` field will be an empty string and the `encoding` - field will be `\"none\"`. To get the contents of these larger files, use the - `raw` media type.\n * Greater than 100 MB: This endpoint is not supported.\n\n - If the content is a directory:\nThe response will be an array of objects, - one object for each item in the directory.\nWhen listing the contents of a - directory, submodules have their \"type\" specified as \"file\". Logically, - the value\n_should_ be \"submodule\". This behavior exists in API v3 [for - backwards compatibility purposes](https://git.io/v1YCW).\nIn the next major - version of the API, the type will be returned as \"submodule\".\n\n If the - content is a symlink: \nIf the requested `:path` points to a symlink, and - the symlink's target is a normal file in the repository, then the\nAPI responds - with the content of the file (in the format shown in the example. Otherwise, - the API responds with an object \ndescribing the symlink itself.\n\n If the - content is a submodule:\nThe `submodule_git_url` identifies the location of - the submodule repository, and the `sha` identifies a specific\ncommit within - the submodule repository. Git uses the given URL when cloning the submodule - repository, and checks out\nthe submodule at that specific commit.\n\nIf the - submodule repository is not hosted on github.com, the Git URLs (`git_url` - and `_links[\"git\"]`) and the\ngithub.com URLs (`html_url` and `_links[\"html\"]`) - will have null values." + description: |- + Gets the contents of a file or directory in a repository. Specify the file path or directory with the `path` parameter. If you omit the `path` parameter, you will receive the contents of the repository's root directory. + + 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 file contents for files and symlinks. + - **`application/vnd.github.html+json`**: Returns the file contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). + - **`application/vnd.github.object+json`**: Returns the contents in a consistent object format regardless of the content type. For example, instead of an array of objects for a directory, the response will be an object with an `entries` attribute containing the array of objects. + + If the content is a directory, the response will be an array of objects, one object for each item in the directory. When listing the contents of a directory, submodules have their "type" specified as "file". Logically, the value _should_ be "submodule". This behavior exists [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as "submodule". + + If the content is a symlink and the symlink's target is a normal file in the repository, then the API responds with the content of the file. Otherwise, the API responds with an object describing the symlink itself. + + If the content is a submodule, the `submodule_git_url` field identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit. If the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links["git"]`) and the github.com URLs (`html_url` and `_links["html"]`) will have null values. + + **Notes**: + + - To get a repository's contents recursively, you can [recursively get the tree](https://docs.github.com/rest/git/trees#get-a-tree). + - This API has an upper limit of 1,000 files for a directory. If you need to retrieve + more files, use the [Git Trees API](https://docs.github.com/rest/git/trees#get-a-tree). + - Download URLs expire and are meant to be used just once. To ensure the download URL does not expire, please use the contents API to obtain a fresh download URL for each download. + - If the requested file's size is: + - 1 MB or smaller: All features of this endpoint are supported. + - Between 1-100 MB: Only the `raw` or `object` custom media types are supported. Both will work as normal, except that when using the `object` media type, the `content` field will be an empty + string and the `encoding` field will be `"none"`. To get the contents of these larger files, use the `raw` media type. + - Greater than 100 MB: This endpoint is not supported. tags: - repos operationId: repos/get-content @@ -24216,9 +24696,11 @@ paths: put: summary: Create or update file contents description: |- - Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. + Creates a new file or replaces an existing file in a repository. **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. tags: - repos operationId: repos/create-or-update-file-contents @@ -24497,10 +24979,9 @@ paths: "/repos/{owner}/{repo}/dependabot/alerts": get: summary: List Dependabot alerts for a repository - description: |- - You must use an access token with the `security_events` scope to use this endpoint with private repositories. - You can also use tokens with the `public_repo` scope for public repositories only. - GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + description: OAuth app tokens and personal access tokens (classic) need the + `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: - dependabot operationId: dependabot/list-alerts-for-repo @@ -24527,7 +25008,8 @@ paths: type: integer default: 1 - name: per_page - description: The number of results per page (max 100). + 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)." deprecated: true in: query schema: @@ -24568,10 +25050,9 @@ paths: "/repos/{owner}/{repo}/dependabot/alerts/{alert_number}": get: summary: Get a Dependabot alert - description: |- - You must use an access token with the `security_events` scope to use this endpoint with private repositories. - You can also use tokens with the `public_repo` scope for public repositories only. - GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + description: OAuth app tokens and personal access tokens (classic) need the + `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: - dependabot operationId: dependabot/get-alert @@ -24607,11 +25088,9 @@ paths: patch: summary: Update a Dependabot alert description: |- - You must use an access token with the `security_events` scope to use this endpoint with private repositories. - You can also use tokens with the `public_repo` scope for public repositories only. - GitHub Apps must have **Dependabot alerts** write permission to use this endpoint. + The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." - To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + OAuth app tokens and personal access tokens (classic) need the `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: - dependabot operationId: dependabot/update-alert @@ -24690,10 +25169,11 @@ paths: "/repos/{owner}/{repo}/dependabot/secrets": get: summary: List repository secrets - description: Lists all secrets available in a repository without revealing their - encrypted values. You must authenticate using an access token with the `repo` - scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` - repository permission to use this endpoint. + description: |- + Lists all secrets available in a repository without revealing their encrypted + values. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependabot operationId: dependabot/list-repo-secrets @@ -24736,11 +25216,12 @@ paths: "/repos/{owner}/{repo}/dependabot/secrets/public-key": get: summary: Get a repository public key - description: Gets your public key, which you need to encrypt secrets. You need - to encrypt a secret before you can create or update secrets. Anyone with read - access to the repository can use this endpoint. If the repository is private - you must use an access token with the `repo` scope. GitHub Apps must have - the `dependabot_secrets` repository permission to use this endpoint. + description: |- + Gets your public key, which you need to encrypt secrets. You need to + encrypt a secret before you can create or update secrets. 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 if the repository is private. tags: - dependabot operationId: dependabot/get-repo-public-key @@ -24768,10 +25249,10 @@ paths: "/repos/{owner}/{repo}/dependabot/secrets/{secret_name}": get: summary: Get a repository secret - description: Gets a single repository secret without revealing its encrypted - value. You must authenticate using an access token with the `repo` scope to - use this endpoint. GitHub Apps must have the `dependabot_secrets` repository - permission to use this endpoint. + description: |- + Gets a single repository secret without revealing its encrypted value. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependabot operationId: dependabot/get-repo-secret @@ -24803,9 +25284,7 @@ paths: Creates or updates a repository secret with an encrypted value. 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)." - You must authenticate using an access - token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository - permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependabot operationId: dependabot/create-or-update-repo-secret @@ -24857,10 +25336,10 @@ paths: subcategory: secrets delete: summary: Delete a repository secret - description: Deletes a secret in a repository using the secret name. You must - authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `dependabot_secrets` repository permission to use - this endpoint. + description: |- + Deletes a secret in a repository using the secret name. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependabot operationId: dependabot/delete-repo-secret @@ -24963,9 +25442,12 @@ paths: "/repos/{owner}/{repo}/dependency-graph/snapshots": post: summary: Create a snapshot of dependencies for a repository - description: Create a new snapshot of a repository's dependencies. You must - authenticate using an access token with the `repo` scope to use this endpoint - for a repository that the requesting user has access to. + description: |- + Create a new snapshot of a repository's dependencies. + + The authenticated user must have access to the repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - dependency-graph operationId: dependency-graph/create-repository-snapshot @@ -25117,8 +25599,6 @@ paths: be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled. - Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. - Merged branch response: You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating @@ -25139,6 +25619,8 @@ paths: This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. tags: - repos operationId: repos/create-deployment @@ -25290,7 +25772,7 @@ paths: delete: summary: Delete a deployment description: |- - If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. + If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. To set a deployment as inactive, you must: @@ -25298,6 +25780,8 @@ paths: * Mark the active deployment as inactive by adding any non-successful deployment status. For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. tags: - repos operationId: repos/delete-deployment @@ -25363,7 +25847,7 @@ paths: description: |- Users with `push` access can create deployment statuses for a given deployment. - GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. + OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. tags: - repos operationId: repos/create-deployment-status @@ -25509,12 +25993,9 @@ paths: The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. - This endpoint requires write access to the repository by providing either: - - - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. - This input example shows how you can use the `client_payload` as a test to debug your workflow. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-dispatch-event @@ -25556,6 +26037,8 @@ paths: responses: '204': description: Response + '404': + "$ref": "#/components/responses/not_found" '422': "$ref": "#/components/responses/validation_failed" x-github: @@ -25569,7 +26052,9 @@ paths: description: |- Lists the environments for a repository. - Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + 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. tags: - repos operationId: repos/get-all-environments @@ -25611,9 +26096,9 @@ paths: description: |- **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." - Anyone with read access to the repository can use this endpoint. If the - repository is private, you must use an access token with the `repo` scope. GitHub - Apps must have the `actions:read` permission to use this endpoint. + 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. tags: - repos operationId: repos/get-environment @@ -25648,7 +26133,7 @@ paths: **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-or-update-environment @@ -25730,8 +26215,8 @@ paths: subcategory: environments delete: summary: Delete an environment - description: You must authenticate using an access token with the repo scope - to use this endpoint. + description: OAuth app tokens and personal access tokens (classic) need the + `repo` scope to use this endpoint. tags: - repos operationId: repos/delete-an-environment @@ -25756,7 +26241,9 @@ paths: description: |- Lists the deployment branch policies for an environment. - Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + 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. tags: - repos operationId: repos/list-deployment-branch-policies @@ -25802,7 +26289,7 @@ paths: description: |- Creates a deployment branch or tag policy for an environment. - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-deployment-branch-policy @@ -25864,7 +26351,9 @@ paths: description: |- Gets a deployment branch or tag policy for an environment. - Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + 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. tags: - repos operationId: repos/get-deployment-branch-policy @@ -25896,7 +26385,7 @@ paths: description: |- Updates a deployment branch or tag policy for an environment. - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/update-deployment-branch-policy @@ -25938,7 +26427,7 @@ paths: description: |- Deletes a deployment branch or tag policy for an environment. - You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/delete-deployment-branch-policy @@ -25962,9 +26451,11 @@ paths: get: summary: Get all deployment protection rules for an environment description: |- - Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/get-all-deployment-protection-rules @@ -26025,9 +26516,11 @@ paths: description: |- Enable a custom deployment protection rule for an environment. - You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. + The authenticated user must have admin or owner permissions to the repository to use this endpoint. For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-deployment-protection-rule @@ -26072,11 +26565,13 @@ paths: get: summary: List custom deployment rule integrations available for an environment description: |- - Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. + Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. - For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/list-custom-deployment-rule-integrations @@ -26119,9 +26614,11 @@ paths: get: summary: Get a custom deployment protection rule description: |- - Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/get-custom-deployment-protection-rule @@ -26153,7 +26650,9 @@ paths: description: |- Disables a custom deployment protection rule for an environment. - You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)". + The authenticated user must have admin or owner permissions to the repository to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/disable-deployment-protection-rule @@ -26173,6 +26672,425 @@ paths: enabledForGitHubApps: true category: deployments subcategory: protection-rules + "/repos/{owner}/{repo}/environments/{environment_name}/secrets": + get: + summary: List environment secrets + description: |- + Lists all secrets available in an environment without revealing their + encrypted values. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-environment-secrets + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#list-environment-secrets + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + - "$ref": "#/components/parameters/per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - secrets + properties: + total_count: + type: integer + secrets: + type: array + items: + "$ref": "#/components/schemas/actions-secret" + examples: + default: + "$ref": "#/components/examples/actions-secret-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/public-key": + get: + summary: Get an environment public key + description: |- + Get the public key for an environment, which you need to encrypt environment + secrets. You need to encrypt a secret before you can create or update secrets. + + Anyone with read access to the repository can use this endpoint. + + If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-environment-public-key + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-public-key" + examples: + default: + "$ref": "#/components/examples/actions-public-key" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + "/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}": + get: + summary: Get an environment secret + description: |- + Gets a single environment secret without revealing its encrypted value. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-environment-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + - "$ref": "#/components/parameters/secret-name" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-secret" + examples: + default: + "$ref": "#/components/examples/actions-secret" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + put: + summary: Create or update an environment secret + description: |- + Creates or updates an environment secret with an encrypted value. 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)." + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/create-or-update-environment-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + - "$ref": "#/components/parameters/secret-name" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + encrypted_value: + type: string + description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) + using the public key retrieved from the [Get an environment public + key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) + endpoint. + pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + key_id: + type: string + description: ID of the key you used to encrypt the secret. + required: + - encrypted_value + - key_id + examples: + default: + value: + encrypted_value: c2VjcmV0 + key_id: '012345678912345678' + responses: + '201': + description: Response when creating a secret + content: + application/json: + schema: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + '204': + description: Response when updating a secret + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + delete: + summary: Delete an environment secret + description: |- + Deletes a secret in an environment using the secret name. + + Authenticated users must have collaborator access to a repository to create, update, or read secrets. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-environment-secret + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + - "$ref": "#/components/parameters/secret-name" + responses: + '204': + description: Default response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: secrets + "/repos/{owner}/{repo}/environments/{environment_name}/variables": + get: + summary: List environment variables + description: |- + Lists all environment variables. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/list-environment-variables + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#list-environment-variables + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + - "$ref": "#/components/parameters/variables-per-page" + - "$ref": "#/components/parameters/page" + responses: + '200': + description: Response + content: + application/json: + schema: + type: object + required: + - total_count + - variables + properties: + total_count: + type: integer + variables: + type: array + items: + "$ref": "#/components/schemas/actions-variable" + examples: + default: + "$ref": "#/components/examples/actions-variables-paginated" + headers: + Link: + "$ref": "#/components/headers/link" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + post: + summary: Create an environment variable + description: |- + Create an environment variable that you can reference in a GitHub Actions workflow. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/create-environment-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#create-an-environment-variable + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + required: + - name + - value + examples: + default: + value: + name: USERNAME + value: octocat + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/empty-object" + examples: + default: + value: + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + "/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}": + get: + summary: Get an environment variable + description: |- + Gets a specific variable in an environment. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/get-environment-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#get-an-environment-variable + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/environment-name" + - "$ref": "#/components/parameters/variable-name" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/actions-variable" + examples: + default: + "$ref": "#/components/examples/actions-variable" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + patch: + summary: Update an environment variable + description: |- + Updates an environment variable that you can reference in a GitHub Actions workflow. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/update-environment-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#update-an-environment-variable + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/variable-name" + - "$ref": "#/components/parameters/environment-name" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the variable. + value: + type: string + description: The value of the variable. + examples: + default: + value: + name: USERNAME + value: octocat + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables + delete: + summary: Delete an environment variable + description: |- + Deletes an environment variable using the variable name. + + Authenticated users must have collaborator access to a repository to create, update, or read variables. + + OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + tags: + - actions + operationId: actions/delete-environment-variable + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/variable-name" + - "$ref": "#/components/parameters/environment-name" + responses: + '204': + description: Response + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: actions + subcategory: variables "/repos/{owner}/{repo}/events": get: summary: List repository events @@ -26390,7 +27308,12 @@ paths: description: |- The `content` in the response will always be Base64 encoded. - _Note_: This API supports blobs up to 100 megabytes in size. + 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 blob data. + - **`application/vnd.github+json`**: Returns a JSON representation of the blob with `content` as a base64 encoded string. This is the default if no media type is specified. + + **Note** This endpoint supports blobs up to 100 megabytes in size. tags: - git operationId: git/get-blob @@ -26421,6 +27344,8 @@ paths: "$ref": "#/components/responses/validation_failed" '403': "$ref": "#/components/responses/forbidden" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26590,6 +27515,8 @@ paths: "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26653,6 +27580,8 @@ paths: "$ref": "#/components/examples/git-commit-2" '404': "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26678,7 +27607,7 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/commit-ref" + - "$ref": "#/components/parameters/git-ref-only" responses: '200': description: Response @@ -26694,6 +27623,8 @@ paths: headers: Link: "$ref": "#/components/headers/link" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26715,7 +27646,7 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/commit-ref" + - "$ref": "#/components/parameters/git-ref-only" responses: '200': description: Response @@ -26728,6 +27659,8 @@ paths: "$ref": "#/components/examples/git-ref" '404': "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26788,6 +27721,8 @@ paths: type: string '422': "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26796,7 +27731,9 @@ paths: "/repos/{owner}/{repo}/git/refs/{ref}": patch: summary: Update a reference - description: '' + description: Updates the provided reference to point to a new SHA. For more + information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. tags: - git operationId: git/update-ref @@ -26806,17 +27743,7 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - name: ref - description: The name of the reference to update (for example, `heads/featureA`). - Can be a branch name (`heads/BRANCH_NAME`) or tag name (`tags/TAG_NAME`). - For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" - in the Git documentation. - in: path - required: true - example: heads/featureA - schema: - type: string - x-multi-segment: true + - "$ref": "#/components/parameters/git-ref-only" requestBody: required: true content: @@ -26852,6 +27779,8 @@ paths: "$ref": "#/components/examples/git-ref" '422': "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26859,7 +27788,7 @@ paths: subcategory: refs delete: summary: Delete a reference - description: '' + description: Deletes the provided reference. tags: - git operationId: git/delete-ref @@ -26869,12 +27798,14 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" - - "$ref": "#/components/parameters/commit-ref" + - "$ref": "#/components/parameters/git-ref-only" responses: '204': description: Response '422': "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27001,6 +27932,8 @@ paths: type: string '422': "$ref": "#/components/responses/validation_failed" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27064,6 +27997,8 @@ paths: "$ref": "#/components/examples/git-tag" '404': "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27175,6 +28110,8 @@ paths: "$ref": "#/components/responses/not_found" '403': "$ref": "#/components/responses/forbidden" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27232,6 +28169,8 @@ paths: "$ref": "#/components/responses/validation_failed" '404': "$ref": "#/components/responses/not_found" + '409': + "$ref": "#/components/responses/conflict" x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27313,12 +28252,6 @@ paths: "$ref": "#/components/schemas/webhook-config-secret" insecure_ssl: "$ref": "#/components/schemas/webhook-config-insecure-ssl" - token: - type: string - example: '"abc"' - digest: - type: string - example: '"sha256"' events: type: array description: Determines what [events](https://docs.github.com/webhooks/event-payloads) @@ -27427,25 +28360,7 @@ paths: type: object properties: config: - type: object - description: Key/value pairs to provide settings for this webhook. - properties: - url: - "$ref": "#/components/schemas/webhook-config-url" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - secret: - "$ref": "#/components/schemas/webhook-config-secret" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - address: - type: string - example: '"bar@example.com"' - room: - type: string - example: '"The Serious Room"' - required: - - url + "$ref": "#/components/schemas/webhook-config" events: type: array description: Determines what [events](https://docs.github.com/webhooks/event-payloads) @@ -27525,7 +28440,7 @@ paths: description: |- Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." - Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. tags: - repos operationId: repos/get-webhook-config-for-repo @@ -27556,7 +28471,7 @@ paths: description: |- Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." - Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. tags: - repos operationId: repos/update-webhook-config-for-repo @@ -28503,6 +29418,13 @@ paths: reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + 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-for-repo @@ -28600,6 +29522,13 @@ paths: This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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/create @@ -28718,6 +29647,13 @@ paths: You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. By default, issue comments are ordered by ascending ID. + + 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-comments-for-repo @@ -28767,8 +29703,15 @@ paths: "/repos/{owner}/{repo}/issues/comments/{comment_id}": get: summary: Get an issue comment - description: You can use the REST API to get comments on issues and pull requests. - Every pull request is an issue, but not every issue is a pull request. + description: |- + You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + + 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/get-comment @@ -28798,8 +29741,15 @@ paths: subcategory: comments patch: summary: Update an issue comment - description: You can use the REST API to update comments on issues and pull - requests. Every pull request is an issue, but not every issue is a pull request. + description: |- + You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. + + 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/update-comment @@ -29092,7 +30042,7 @@ paths: get: summary: Get an issue description: |- - The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was + The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api#follow-redirects) if the issue was [transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read @@ -29103,6 +30053,13 @@ paths: reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + 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/get @@ -29138,7 +30095,15 @@ paths: subcategory: issues patch: summary: Update an issue - description: Issue owners and users with push access can edit an issue. + description: |- + Issue owners and users with push access can edit 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/update @@ -29406,6 +30371,13 @@ paths: You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. Issue comments are ordered by ascending ID. + + 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-comments @@ -29445,14 +30417,20 @@ paths: subcategory: comments post: summary: Create an issue comment - description: |2- - + description: |- You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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/create-comment @@ -29845,7 +30823,7 @@ paths: description: |- Users with push access can lock an issue or pull request's conversation. - Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - issues operationId: issues/lock @@ -30521,7 +31499,10 @@ paths: description: |- This method returns the contents of the repository's license file, if one is detected. - Similar to [Get repository content](https://docs.github.com/rest/repos/contents#get-repository-content), this method also supports [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw license content or rendered license HTML. + 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 contents of the license. + - **`application/vnd.github.html+json`**: Returns the license contents in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). tags: - licenses operationId: licenses/get-for-repo @@ -30531,6 +31512,7 @@ paths: parameters: - "$ref": "#/components/parameters/owner" - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/git-ref" responses: '200': description: Response @@ -31058,7 +32040,7 @@ paths: description: |- Gets information about a GitHub Pages site. - A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/get-pages @@ -31090,7 +32072,9 @@ paths: description: |- Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." - To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/create-pages-site @@ -31172,7 +32156,9 @@ paths: description: |- Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/update-information-about-pages-site @@ -31273,7 +32259,9 @@ paths: description: |- Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). - To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/delete-pages-site @@ -31303,7 +32291,7 @@ paths: description: |- Lists builts of a GitHub Pages site. - A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/list-pages-builds @@ -31371,7 +32359,7 @@ paths: description: |- Gets information about the single most recent build of a GitHub Pages site. - A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/get-latest-pages-build @@ -31402,7 +32390,7 @@ paths: description: |- Gets information about a GitHub Pages build. - A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/get-pages-build @@ -31432,13 +32420,13 @@ paths: enabledForGitHubApps: true category: pages subcategory: pages - "/repos/{owner}/{repo}/pages/deployment": + "/repos/{owner}/{repo}/pages/deployments": post: summary: Create a GitHub Pages deployment description: |- Create a GitHub Pages deployment for a repository. - Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint. + The authenticated user must have write permission to the repository. tags: - repos operationId: repos/create-pages-deployment @@ -31456,10 +32444,16 @@ paths: type: object description: The object used to create GitHub Pages deployment properties: + artifact_id: + type: number + description: The ID of an artifact that contains the .zip or .tar + of static assets to deploy. The artifact belongs to the repository. + Either `artifact_id` or `artifact_url` are required. artifact_url: type: string description: The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. + Either `artifact_id` or `artifact_url` are required. environment: type: string description: The target environment for this GitHub Pages deployment. @@ -31474,7 +32468,6 @@ paths: description: The OIDC token issued by GitHub Actions certifying the origin of the deployment. required: - - artifact_url - pages_build_version - oidc_token examples: @@ -31506,6 +32499,67 @@ paths: enabledForGitHubApps: true category: pages subcategory: pages + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}": + get: + summary: Get the status of a GitHub Pages deployment + description: |- + Gets the current status of a GitHub Pages deployment. + + The authenticated user must have read permission for the GitHub Pages site. + tags: + - repos + operationId: repos/get-pages-deployment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pages-deployment-id" + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/pages-deployment-status" + examples: + default: + "$ref": "#/components/examples/pages-deployment-status" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages + "/repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel": + post: + summary: Cancel a GitHub Pages deployment + description: |- + Cancels a GitHub Pages deployment. + + The authenticated user must have write permissions for the GitHub Pages site. + tags: + - repos + operationId: repos/cancel-pages-deployment + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/pages-deployment-id" + responses: + '204': + "$ref": "#/components/responses/no_content" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: pages + subcategory: pages "/repos/{owner}/{repo}/pages/health": get: summary: Get a DNS health check for GitHub Pages @@ -31514,7 +32568,9 @@ paths: The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. - To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions. + The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - repos operationId: repos/get-pages-health-check @@ -31555,6 +32611,45 @@ paths: category: pages subcategory: pages "/repos/{owner}/{repo}/private-vulnerability-reporting": + get: + summary: Check if private vulnerability reporting is enabled for a repository + description: Returns a boolean indicating whether or not private vulnerability + reporting is enabled for the repository. For more information, see "[Evaluating + the security settings of a repository](https://docs.github.com/code-security/security-advisories/working-with-repository-security-advisories/evaluating-the-security-settings-of-a-repository)". + tags: + - repos + operationId: repos/check-private-vulnerability-reporting + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/repos#check-if-private-vulnerability-reporting-is-enabled-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + responses: + '200': + description: Private vulnerability reporting status + content: + application/json: + schema: + type: object + properties: + enabled: + type: boolean + description: Whether or not private vulnerability reporting is + enabled for the repository. + required: + - enabled + examples: + default: + value: + enabled: true + '422': + "$ref": "#/components/responses/bad_request" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: repos put: summary: Enable private vulnerability reporting for a repository description: Enables private vulnerability reporting for a repository. The authenticated @@ -31758,14 +32853,73 @@ paths: enabledForGitHubApps: true category: repos subcategory: custom-properties + patch: + summary: Create or update custom property values for a repository + description: |- + Create new or update existing custom property values for a repository. + Using a value of `null` for a custom property will remove or 'unset' the property value from the repository. + + Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. + tags: + - repos + operationId: repos/create-or-update-custom-properties-values + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/repos/custom-properties#create-or-update-custom-property-values-for-a-repository + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + properties: + type: array + description: A list of custom property names and associated values + to apply to the repositories. + items: + "$ref": "#/components/schemas/custom-property-value" + required: + - properties + examples: + default: + "$ref": "#/components/examples/create-or-update-custom-properties-values" + responses: + '204': + description: No Content when custom property values are successfully created + or updated + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + "$ref": "#/components/responses/validation_failed" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: repos + subcategory: custom-properties "/repos/{owner}/{repo}/pulls": get: summary: List pull requests - description: Draft pull requests are available in public repositories with GitHub - Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository - billing plans, and in public and private repositories with GitHub Team and - GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) + description: |- + Lists pull requests in a specified repository. + + Draft pull requests are available in public repositories with GitHub + Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing + plans, and in public and private repositories with GitHub Team and GitHub Enterprise + Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. + + 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: - pulls operationId: pulls/list @@ -31859,6 +33013,13 @@ paths: To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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: - pulls operationId: pulls/create @@ -31955,8 +33116,16 @@ paths: "/repos/{owner}/{repo}/pulls/comments": get: summary: List review comments in a repository - description: Lists review comments for all pull requests in a repository. By - default, review comments are in ascending order by ID. + description: |- + Lists review comments for all pull requests in a repository. By default, + review comments are in ascending order by ID. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list-review-comments-for-repo @@ -32010,7 +33179,15 @@ paths: "/repos/{owner}/{repo}/pulls/comments/{comment_id}": get: summary: Get a review comment for a pull request - description: Provides details for a review comment. + description: |- + Provides details for a specified review comment. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/get-review-comment @@ -32040,7 +33217,15 @@ paths: subcategory: comments patch: summary: Update a review comment for a pull request - description: Enables you to edit a review comment. + description: |- + Edits the content of a specified review comment. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/update-review-comment @@ -32271,6 +33456,14 @@ paths: * If [rebased](https://docs.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to. Pass the appropriate [media type](https://docs.github.com/rest/overview/media-types/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. + + 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`. + - **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message. tags: - pulls operationId: pulls/get @@ -32296,6 +33489,8 @@ paths: "$ref": "#/components/responses/not_modified" '404': "$ref": "#/components/responses/not_found" + '406': + "$ref": "#/components/responses/unacceptable" '500': "$ref": "#/components/responses/internal_error" '503': @@ -32311,6 +33506,13 @@ paths: Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. + + 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: - pulls operationId: pulls/update @@ -32382,9 +33584,7 @@ paths: description: |- Creates a codespace owned by the authenticated user for the specified pull request. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-with-pr-for-authenticated-user @@ -32485,8 +33685,16 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/comments": get: summary: List review comments on a pull request - description: Lists all review comments for a pull request. By default, review - comments are in ascending order by ID. + description: |- + Lists all review comments for a specified pull request. By default, review comments + are in ascending order by ID. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list-review-comments @@ -32532,16 +33740,22 @@ paths: subcategory: comments post: summary: Create a review comment for a pull request - description: |2- + description: |- + Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." - Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Create an issue comment](https://docs.github.com/rest/issues/comments#create-an-issue-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. + If your comment applies to more than one line in the pull request diff, you should use the parameters `line`, `side`, and optionally `start_line` and `start_side` in your request. The `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. - **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/create-review-comment @@ -32572,10 +33786,15 @@ paths: description: The relative path to the file that necessitates a comment. position: type: integer - description: "**This parameter is deprecated. Use `line` instead**. + description: '**This parameter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. - For help finding the position value, read the note above." + The position value equals the number of lines down from the first + "@@" hunk header in the file you want to add a comment. The line + just below the "@@" line is position 1, the next line is position + 2, and so on. The position in the diff continues to increase through + lines of whitespace and additional hunks until the beginning of + a new file.' deprecated: true x-github: deprecationDate: '2022-11-01' @@ -32679,6 +33898,13 @@ paths: This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/create-reply-for-review-comment @@ -32732,10 +33958,17 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/commits": get: summary: List commits on a pull request - description: Lists a maximum of 250 commits for a pull request. To receive a - complete commit list for pull requests with more than 250 commits, use the - [List commits](https://docs.github.com/rest/commits/commits#list-commits) + description: |- + Lists a maximum of 250 commits for a pull request. To receive a complete + commit list for pull requests with more than 250 commits, use the [List commits](https://docs.github.com/rest/commits/commits#list-commits) endpoint. + + 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: - pulls operationId: pulls/list-commits @@ -32771,8 +34004,18 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/files": get: summary: List pull requests files - description: "**Note:** Responses include a maximum of 3000 files. The paginated - response returns 30 files per page by default." + description: |- + Lists the files in a specified pull request. + + **Note:** Responses include a maximum of 3000 files. The paginated response + returns 30 files per page by default. + + 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: - pulls operationId: pulls/list-files @@ -33098,7 +34341,15 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": get: summary: List reviews for a pull request - description: The list of reviews returns in chronological order. + description: |- + Lists all reviews for a specified pull request. The list of reviews returns in chronological order. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list-reviews @@ -33134,13 +34385,22 @@ paths: post: summary: Create a review for a pull request description: |- + Creates a review on a specified pull request. + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." Pull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see "[Submit a review for a pull request](https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request)." - **Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. + **Note:** To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the `application/vnd.github.v3.diff` media type to the `Accept` header of a call to the [Get a pull request](https://docs.github.com/rest/pulls/pulls#get-a-pull-request) endpoint. The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/create-review @@ -33195,8 +34455,13 @@ paths: type: integer description: The position in the diff where you want to add a review comment. Note this value is not the same as the - line number in the file. For help finding the position value, - read the note below. + line number in the file. The `position` value equals the + number of lines down from the first "@@" hunk header in + the file you want to add a comment. The line just below + the "@@" line is position 1, the next line is position 2, + and so on. The position in the diff continues to increase + through lines of whitespace and additional hunks until the + beginning of a new file. body: type: string description: Text of the review comment. @@ -33249,7 +34514,15 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": get: summary: Get a review for a pull request - description: Retrieves a pull request review by its ID. + description: |- + Retrieves a pull request review by its ID. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/get-review @@ -33280,7 +34553,15 @@ paths: subcategory: reviews put: summary: Update a review for a pull request - description: Update the review summary comment with new text. + description: |- + Updates the contents of a specified review summary comment. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/update-review @@ -33328,8 +34609,15 @@ paths: subcategory: reviews delete: summary: Delete a pending review for a pull request - description: Deletes a pull request review that has not been submitted. Submitted - reviews cannot be deleted. + description: |- + Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/delete-pending-review @@ -33363,7 +34651,15 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": get: summary: List comments for a pull request review - description: List comments for a specific pull request review. + description: |- + Lists comments for a specific pull request review. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/list-comments-for-review @@ -33402,9 +34698,19 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": put: summary: Dismiss a review for a pull request - description: "**Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), - you must be a repository administrator or be included in the list of people - or teams who can dismiss pull request reviews." + description: |- + Dismisses a specified review on a pull request. + + **Note:** To dismiss a pull request review on a [protected branch](https://docs.github.com/rest/branches/branch-protection), + you must be a repository administrator or be included in the list of people or teams + who can dismiss pull request reviews. + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/dismiss-review @@ -33460,9 +34766,15 @@ paths: "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": post: summary: Submit a review for a pull request - description: Submits a pending review for a pull request. For more information - about creating a pending review for a pull request, see "[Create a review - for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." + description: |- + Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "[Create a review for a pull request](https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request)." + + 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-commitcomment.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-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`. + - **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`. + - **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`. tags: - pulls operationId: pulls/submit-review @@ -33592,7 +34904,10 @@ paths: description: |- Gets the preferred README for a repository. - READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + 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 file contents. This is the default if you do not specify a media type. + - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). tags: - repos operationId: repos/get-readme @@ -33634,7 +34949,10 @@ paths: description: |- Gets the README from a repository directory. - READMEs support [custom media types](https://docs.github.com/rest/overview/media-types) for retrieving the raw content or rendered HTML. + 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 file contents. This is the default if you do not specify a media type. + - **`application/vnd.github.html+json`**: Returns the README in HTML. Markup languages are rendered to HTML using GitHub's open-source [Markup library](https://github.com/github/markup). tags: - repos operationId: repos/get-readme-in-directory @@ -34081,8 +35399,12 @@ paths: "/repos/{owner}/{repo}/releases/{release_id}": get: summary: Get a release - description: "**Note:** This returns an `upload_url` key corresponding to the - endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia)." + description: |- + Gets a public release with the specified release ID. + + **Note:** This returns an `upload_url` key corresponding to the endpoint + for uploading release assets. This key is a hypermedia resource. For more information, see + "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)." tags: - repos operationId: repos/get-release @@ -34095,8 +35417,9 @@ paths: - "$ref": "#/components/parameters/release-id" responses: '200': - description: "**Note:** This returns an `upload_url` key corresponding to - the endpoint for uploading release assets. This key is a [hypermedia resource](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia)." + description: '**Note:** This returns an `upload_url` key corresponding to + the endpoint for uploading release assets. This key is a hypermedia resource. + For more information, see "[Getting started with the REST API](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia)."' content: application/json: schema: @@ -34262,7 +35585,7 @@ paths: subcategory: assets post: summary: Upload a release asset - description: "This endpoint makes use of [a Hypermedia relation](https://docs.github.com/rest/overview/resources-in-the-rest-api#hypermedia) + description: "This endpoint makes use of a [Hypermedia relation](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in\nthe response of the [Create a release endpoint](https://docs.github.com/rest/releases/releases#create-a-release) @@ -34593,10 +35916,14 @@ paths: description: The name of the ruleset. target: type: string - description: The target of the ruleset. + description: |- + The target of the ruleset + + **Note**: The `push` target is in beta and is subject to change. enum: - branch - tag + - push enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -34807,10 +36134,14 @@ paths: description: The name of the ruleset. target: type: string - description: The target of the ruleset. + description: |- + The target of the ruleset + + **Note**: The `push` target is in beta and is subject to change. enum: - branch - tag + - push enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -34896,10 +36227,10 @@ paths: summary: List secret scanning alerts for a repository description: |- Lists secret scanning alerts for an eligible repository, from newest to oldest. - To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - For public repositories, you may instead use the `public_repo` scope. - GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + + 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/list-alerts-for-repo @@ -34946,10 +36277,10 @@ paths: summary: Get a secret scanning alert description: |- Gets a single secret scanning alert detected in an eligible repository. - To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - For public repositories, you may instead use the `public_repo` scope. - GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + + 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-alert @@ -34986,10 +36317,10 @@ paths: summary: Update a secret scanning alert description: |- Updates the status of a secret scanning alert in an eligible repository. - To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - For public repositories, you may instead use the `public_repo` scope. - GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + + 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. operationId: secret-scanning/update-alert tags: - secret-scanning @@ -35050,10 +36381,10 @@ paths: summary: List locations for a secret scanning alert description: |- Lists all locations for a given secret scanning alert for an eligible repository. - To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - For public repositories, you may instead use the `public_repo` scope. - GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + + 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/list-locations-for-alert @@ -35097,10 +36428,10 @@ paths: summary: List repository security advisories description: |- Lists security advisories in a repository. - You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to. - You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory. + The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. tags: - security-advisories operationId: security-advisories/list-repository-advisories @@ -35125,7 +36456,8 @@ paths: - "$ref": "#/components/parameters/pagination-before" - "$ref": "#/components/parameters/pagination-after" - name: per_page - description: Number of advisories to return per page. + description: The number of advisories to return per page. 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: @@ -35170,9 +36502,10 @@ paths: summary: Create a repository security advisory description: |- Creates a new repository security advisory. - You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. - In order to create a draft repository security advisory, you must be a security manager or administrator of that repository. + In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. tags: - security-advisories operationId: security-advisories/create-repository-advisory @@ -35324,12 +36657,13 @@ paths: summary: Get a repository security advisory description: |- Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - You can access any published security advisory on a public repository. - You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to. - You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a + Anyone can access any published security advisory on a public repository. + + The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on the security advisory. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. tags: - security-advisories operationId: security-advisories/get-repository-advisory @@ -35363,10 +36697,11 @@ paths: summary: Update a repository security advisory description: |- Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. - In order to update any security advisory, you must be a security manager or administrator of that repository, + In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, or a collaborator on the repository security advisory. + + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. tags: - security-advisories operationId: security-advisories/update-repository-advisory @@ -35464,9 +36799,9 @@ paths: You may request a CVE for public repositories, but cannot do so for private repositories. - You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. - In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. tags: - security-advisories operationId: security-advisories/create-repository-advisory-cve-request @@ -35493,13 +36828,55 @@ paths: enabledForGitHubApps: true category: security-advisories subcategory: repository-advisories + "/repos/{owner}/{repo}/security-advisories/{ghsa_id}/forks": + post: + summary: Create a temporary private fork + description: |- + Create a temporary private fork to collaborate on fixing a security vulnerability in your repository. + + **Note**: Forking a repository happens asynchronously. You may have to wait up to 5 minutes before you can access the fork. + tags: + - security-advisories + operationId: security-advisories/create-fork + externalDocs: + description: API method documentation + url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork + parameters: + - "$ref": "#/components/parameters/owner" + - "$ref": "#/components/parameters/repo" + - "$ref": "#/components/parameters/ghsa_id" + responses: + '202': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/full-repository" + examples: + default: + "$ref": "#/components/examples/full-repository" + '400': + "$ref": "#/components/responses/bad_request" + '422': + "$ref": "#/components/responses/validation_failed" + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: false + enabledForGitHubApps: true + category: security-advisories + subcategory: repository-advisories "/repos/{owner}/{repo}/stargazers": get: summary: List stargazers description: |- Lists the people that have starred the repository. - You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + 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.star+json`**: Includes a timestamp of when the star was created. tags: - activity operationId: activity/list-stargazers-for-repo @@ -35542,8 +36919,12 @@ paths: "/repos/{owner}/{repo}/stats/code_frequency": get: summary: Get the weekly commit activity - description: Returns a weekly aggregate of the number of additions and deletions - pushed to a repository. + description: |2 + + Returns a weekly aggregate of the number of additions and deletions pushed to a repository. + + **Note:** This endpoint can only be used for repositories with fewer than 10,000 commits. If the repository contains + 10,000 or more commits, a 422 status code will be returned. tags: - repos operationId: repos/get-code-frequency-stats @@ -35570,6 +36951,8 @@ paths: "$ref": "#/components/responses/accepted" '204': "$ref": "#/components/responses/no_content" + '422': + description: Repository contains more than 10,000 commits x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35617,10 +37000,12 @@ paths: Returns the `total` number of commits authored by the contributor. In addition, the response includes a Weekly Hash (`weeks` array) with the following information: - * `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time). + * `w` - Start of the week, given as a [Unix timestamp](https://en.wikipedia.org/wiki/Unix_time). * `a` - Number of additions * `d` - Number of deletions * `c` - Number of commits + + **Note:** This endpoint will return `0` values for all addition and deletion counts in repositories with 10,000 or more commits. tags: - repos operationId: repos/get-contributors-stats @@ -36146,11 +37531,7 @@ paths: For a public repository, a team is listed only if that team added the public repository explicitly. - Personal access tokens require the following scopes: - * `public_repo` to call this endpoint on a public repository - * `repo` to call this endpoint on a private repository (this scope also includes public repositories) - - This endpoint is not compatible with fine-grained personal access tokens. + OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. tags: - repos operationId: repos/list-teams @@ -36405,9 +37786,11 @@ paths: "/repos/{owner}/{repo}/transfer": post: summary: Transfer a repository - description: |- - A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). - You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. + description: A transfer request will need to be accepted by the new owner when + transferring a personal repository to another user. The response will contain + the original `owner`, and the transfer will continue asynchronously. For more + details on the requirements to transfer personal and organization-owned repositories, + see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). tags: - repos operationId: repos/transfer @@ -36575,12 +37958,7 @@ paths: description: |- Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. - **OAuth scope requirements** - - When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - - * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * `repo` scope to create a private repository + OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. tags: - repos operationId: repos/create-using-template @@ -36647,10 +38025,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/repository" + "$ref": "#/components/schemas/full-repository" examples: default: - "$ref": "#/components/examples/repository-3" + "$ref": "#/components/examples/full-repository" headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -36704,416 +38082,6 @@ paths: enabledForGitHubApps: true category: repos subcategory: repos - "/repositories/{repository_id}/environments/{environment_name}/secrets": - get: - summary: List environment secrets - description: |- - Lists all secrets available in an environment without revealing their - encrypted values. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - tags: - - actions - operationId: actions/list-environment-secrets - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#list-environment-secrets - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - - "$ref": "#/components/parameters/per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - secrets - properties: - total_count: - type: integer - secrets: - type: array - items: - "$ref": "#/components/schemas/actions-secret" - examples: - default: - "$ref": "#/components/examples/actions-secret-paginated" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": - get: - summary: Get an environment public key - description: |- - Get the public key for an environment, which you need to encrypt environment - secrets. You need to encrypt a secret before you can create or update secrets. - - Anyone with read access to the repository can use this endpoint. - If the repository is private you must use an access token with the `repo` scope. - GitHub Apps must have the `secrets` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - tags: - - actions - operationId: actions/get-environment-public-key - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-public-key" - examples: - default: - "$ref": "#/components/examples/actions-public-key" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": - get: - summary: Get an environment secret - description: |- - Gets a single environment secret without revealing its encrypted value. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - tags: - - actions - operationId: actions/get-environment-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - - "$ref": "#/components/parameters/secret-name" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-secret" - examples: - default: - "$ref": "#/components/examples/actions-secret" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - put: - summary: Create or update an environment secret - description: |- - Creates or updates an environment secret with an encrypted value. 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)." - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - tags: - - actions - operationId: actions/create-or-update-environment-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - - "$ref": "#/components/parameters/secret-name" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - encrypted_value: - type: string - description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) - using the public key retrieved from the [Get an environment public - key](https://docs.github.com/rest/actions/secrets#get-an-environment-public-key) - endpoint. - pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - key_id: - type: string - description: ID of the key you used to encrypt the secret. - required: - - encrypted_value - - key_id - examples: - default: - value: - encrypted_value: c2VjcmV0 - key_id: '012345678912345678' - responses: - '201': - description: Response when creating a secret - content: - application/json: - schema: - "$ref": "#/components/schemas/empty-object" - examples: - default: - value: - '204': - description: Response when updating a secret - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - delete: - summary: Delete an environment secret - description: |- - Deletes a secret in an environment using the secret name. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `secrets` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read secrets. - tags: - - actions - operationId: actions/delete-environment-secret - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - - "$ref": "#/components/parameters/secret-name" - responses: - '204': - description: Default response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: secrets - "/repositories/{repository_id}/environments/{environment_name}/variables": - get: - summary: List environment variables - description: |- - Lists all environment variables. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `environments:read` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. - tags: - - actions - operationId: actions/list-environment-variables - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#list-environment-variables - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - - "$ref": "#/components/parameters/variables-per-page" - - "$ref": "#/components/parameters/page" - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - required: - - total_count - - variables - properties: - total_count: - type: integer - variables: - type: array - items: - "$ref": "#/components/schemas/actions-variable" - examples: - default: - "$ref": "#/components/examples/actions-variables-paginated" - headers: - Link: - "$ref": "#/components/headers/link" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - post: - summary: Create an environment variable - description: |- - Create an environment variable that you can reference in a GitHub Actions workflow. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `environment:write` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. - tags: - - actions - operationId: actions/create-environment-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#create-an-environment-variable - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the variable. - value: - type: string - description: The value of the variable. - required: - - name - - value - examples: - default: - value: - name: USERNAME - value: octocat - responses: - '201': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/empty-object" - examples: - default: - value: - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - "/repositories/{repository_id}/environments/{environment_name}/variables/{name}": - get: - summary: Get an environment variable - description: |- - Gets a specific variable in an environment. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `environments:read` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. - tags: - - actions - operationId: actions/get-environment-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#get-an-environment-variable - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/environment-name" - - "$ref": "#/components/parameters/variable-name" - responses: - '200': - description: Response - content: - application/json: - schema: - "$ref": "#/components/schemas/actions-variable" - examples: - default: - "$ref": "#/components/examples/actions-variable" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - patch: - summary: Update an environment variable - description: |- - Updates an environment variable that you can reference in a GitHub Actions workflow. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `environment:write` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. - tags: - - actions - operationId: actions/update-environment-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#update-an-environment-variable - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/variable-name" - - "$ref": "#/components/parameters/environment-name" - requestBody: - required: true - content: - application/json: - schema: - type: object - properties: - name: - type: string - description: The name of the variable. - value: - type: string - description: The value of the variable. - examples: - default: - value: - name: USERNAME - value: octocat - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables - delete: - summary: Delete an environment variable - description: |- - Deletes an environment variable using the variable name. - - You must authenticate using an access token with the `repo` scope to use this endpoint. - GitHub Apps must have the `environment:write` repository permission to use this endpoint. - Authenticated users must have collaborator access to a repository to create, update, or read variables. - tags: - - actions - operationId: actions/delete-environment-variable - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable - parameters: - - "$ref": "#/components/parameters/repository-id" - - "$ref": "#/components/parameters/variable-name" - - "$ref": "#/components/parameters/environment-name" - responses: - '204': - description: Response - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: actions - subcategory: variables "/search/code": get: summary: Search code @@ -37870,7 +38838,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. - List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List all discussions on a team's page. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/list-discussions-legacy @@ -37910,9 +38880,11 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. - Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Creates a new discussion post on a team's page. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/create-discussion-legacy @@ -37974,7 +38946,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. - Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Get a specific discussion on a team's page. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/get-discussion-legacy @@ -38007,7 +38981,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. - Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Edits the title and body text of a discussion post. Only the parameters you provide are updated. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/update-discussion-legacy @@ -38057,7 +39033,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. - Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Delete a discussion from a team's page. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/delete-discussion-legacy @@ -38084,7 +39062,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. - List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List all comments on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/list-discussion-comments-legacy @@ -38125,9 +39105,11 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. - Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Creates a new comment on a team discussion. This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). 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/overview/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)." + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/create-discussion-comment-legacy @@ -38178,7 +39160,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. - Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Get a specific comment on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - teams operationId: teams/get-discussion-comment-legacy @@ -38212,7 +39196,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. - Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Edits the body text of a discussion comment. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/update-discussion-comment-legacy @@ -38262,7 +39248,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. - Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + Deletes a comment on a team discussion. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - teams operationId: teams/delete-discussion-comment-legacy @@ -38290,7 +39278,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. - List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/list-for-team-discussion-comment-legacy @@ -38347,7 +39337,11 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. - Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + + A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/create-for-team-discussion-comment-legacy @@ -38408,7 +39402,9 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. - List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + + OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/list-for-team-discussion-legacy @@ -38464,7 +39460,11 @@ paths: description: |- **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. - Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + + A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + + OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. tags: - reactions operationId: reactions/create-for-team-discussion-legacy @@ -38655,7 +39655,7 @@ paths: **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://docs.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - teams operationId: teams/add-member-legacy @@ -38967,7 +39967,7 @@ paths: what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you''ll need to set `Content-Length` to zero when calling this endpoint. For more - information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)."' + information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)."' enum: - read - write @@ -39128,7 +40128,7 @@ paths: To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. - Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - teams operationId: teams/add-or-update-repo-permissions-legacy @@ -39252,10 +40252,8 @@ paths: "/user": get: summary: Get the authenticated user - description: |- - If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information. - - If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + description: OAuth app tokens and personal access tokens (classic) need the + `user` scope in order for the response to include private profile information. tags: - users operationId: users/get-authenticated @@ -39505,9 +40503,7 @@ paths: description: |- Lists the authenticated user's codespaces. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-for-authenticated-user @@ -39560,9 +40556,7 @@ paths: This endpoint requires either a `repository_id` OR a `pull_request` but not both. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-for-authenticated-user @@ -39718,9 +40712,9 @@ paths: Lists all development environment secrets available for a user's codespaces without revealing their encrypted values. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + The authenticated user must have Codespaces access to use this endpoint. - GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-secrets-for-authenticated-user @@ -39764,9 +40758,9 @@ paths: description: |- Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + The authenticated user must have Codespaces access to use this endpoint. - GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-public-key-for-authenticated-user @@ -39794,9 +40788,9 @@ paths: description: |- Gets a development environment secret available to a user's codespaces without revealing its encrypted value. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + The authenticated user must have Codespaces access to use this endpoint. - GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-secret-for-authenticated-user @@ -39826,9 +40820,9 @@ paths: Creates or updates a development environment secret for a user's codespace with an encrypted value. 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)." - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. + The authenticated user must have Codespaces access to use this endpoint. - GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/create-or-update-secret-for-authenticated-user @@ -39902,9 +40896,9 @@ paths: description: |- Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + The authenticated user must have Codespaces access to use this endpoint. - GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-secret-for-authenticated-user @@ -39927,9 +40921,9 @@ paths: description: |- List the repositories that have been granted the ability to use a user's development environment secret. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + The authenticated user must have Codespaces access to use this endpoint. - GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/list-repositories-for-secret-for-authenticated-user @@ -39976,9 +40970,9 @@ paths: description: |- Select the repositories that will use a user's development environment secret. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + The authenticated user must have Codespaces access to use this endpoint. - GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/set-repositories-for-secret-for-authenticated-user @@ -40033,8 +41027,10 @@ paths: summary: Add a selected repository to a user secret description: |- Adds a repository to the selected repositories for a user's development environment secret. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. + + The authenticated user must have Codespaces access to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/add-repository-for-secret-for-authenticated-user @@ -40068,8 +41064,10 @@ paths: summary: Remove a selected repository from a user secret description: |- Removes a repository from the selected repositories for a user's development environment secret. - You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + + The authenticated user must have Codespaces access to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. tags: - codespaces operationId: codespaces/remove-repository-for-secret-for-authenticated-user @@ -40105,9 +41103,7 @@ paths: description: |- Gets information about a user's codespace. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have read access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-for-authenticated-user @@ -40148,9 +41144,7 @@ paths: If you specify a new machine type it will be applied the next time your codespace is started. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/update-for-authenticated-user @@ -40209,9 +41203,7 @@ paths: description: |- Deletes a user's codespace. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/delete-for-authenticated-user @@ -40246,9 +41238,7 @@ paths: If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. - You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/export-for-authenticated-user @@ -40288,9 +41278,7 @@ paths: description: |- Gets information about an export of a codespace. - You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/get-export-details-for-authenticated-user @@ -40323,9 +41311,7 @@ paths: description: |- List the machine types a codespace can transition to use. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/codespace-machines-for-authenticated-user @@ -40379,9 +41365,7 @@ paths: This will fail for a codespace that is already published, meaning it has an associated repository. - You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/publish-for-authenticated-user @@ -40437,9 +41421,7 @@ paths: description: |- Starts a user's codespace. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/start-for-authenticated-user @@ -40489,9 +41471,7 @@ paths: description: |- Stops a user's codespace. - You must authenticate using an access token with the `codespace` scope to use this endpoint. - - GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. tags: - codespaces operationId: codespaces/stop-for-authenticated-user @@ -40528,7 +41508,8 @@ paths: summary: Get list of conflicting packages during Docker migration for authenticated-user description: |- Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. tags: - packages operationId: packages/list-docker-migration-conflicting-packages-for-authenticated-user @@ -40613,8 +41594,11 @@ paths: "/user/emails": get: summary: List email addresses for the authenticated user - description: Lists all of your email addresses, and specifies which one is visible - to the public. This endpoint is accessible with the `user:email` scope. + description: |- + Lists all of your email addresses, and specifies which one is visible + to the public. + + OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. tags: - users operationId: users/list-emails-for-authenticated-user @@ -40654,7 +41638,8 @@ paths: subcategory: emails post: summary: Add an email address for the authenticated user - description: This endpoint is accessible with the `user` scope. + description: OAuth app tokens and personal access tokens (classic) need the + `user` scope to use this endpoint. tags: - users operationId: users/add-email-for-authenticated-user @@ -40731,7 +41716,8 @@ paths: subcategory: emails delete: summary: Delete an email address for the authenticated user - description: This endpoint is accessible with the `user` scope. + description: OAuth app tokens and personal access tokens (classic) need the + `user` scope to use this endpoint. tags: - users operationId: users/delete-email-for-authenticated-user @@ -40908,9 +41894,9 @@ paths: put: summary: Follow a user description: |- - Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." - Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. tags: - users operationId: users/follow @@ -40937,8 +41923,8 @@ paths: subcategory: followers delete: summary: Unfollow a user - description: Unfollowing a user requires the user to be logged in and authenticated - with basic auth or OAuth with the `user:follow` scope. + description: OAuth app tokens and personal access tokens (classic) need the + `user:follow` scope to use this endpoint. tags: - users operationId: users/unfollow @@ -40966,8 +41952,10 @@ paths: "/user/gpg_keys": get: summary: List GPG keys for the authenticated user - description: Lists the current user's GPG keys. Requires that you are authenticated - via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + Lists the current user's GPG keys. + + OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. tags: - users operationId: users/list-gpg-keys-for-authenticated-user @@ -41007,9 +41995,10 @@ paths: subcategory: gpg-keys post: summary: Create a GPG key for the authenticated user - description: Adds a GPG key to the authenticated user's GitHub account. Requires - that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` - [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + Adds a GPG key to the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. operationId: users/create-gpg-key-for-authenticated-user tags: - users @@ -41070,8 +42059,10 @@ paths: "/user/gpg_keys/{gpg_key_id}": get: summary: Get a GPG key for the authenticated user - description: View extended details for a single GPG key. Requires that you are - authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + View extended details for a single GPG key. + + OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. tags: - users operationId: users/get-gpg-key-for-authenticated-user @@ -41105,9 +42096,10 @@ paths: subcategory: gpg-keys delete: summary: Delete a GPG key for the authenticated user - description: Removes a GPG key from the authenticated user's GitHub account. - Requires that you are authenticated via Basic Auth or via OAuth with at least - `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + Removes a GPG key from the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. tags: - users operationId: users/delete-gpg-key-for-authenticated-user @@ -41140,8 +42132,6 @@ paths: description: |- Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. - You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. You can find the permissions for the installation under the `permissions` key. @@ -41197,8 +42187,6 @@ paths: The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. - You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - The access the user has to each repository is included in the hash under the `permissions` key. tags: - apps @@ -41250,10 +42238,8 @@ paths: "/user/installations/{installation_id}/repositories/{repository_id}": put: summary: Add a repository to an app installation - description: |- - Add a single repository to an installation. The authenticated user must have admin access to the repository. - - You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + description: Add a single repository to an installation. The authenticated user + must have admin access to the repository. tags: - apps operationId: apps/add-repo-to-installation-for-authenticated-user @@ -41279,10 +42265,9 @@ paths: subcategory: installations delete: summary: Remove a repository from an app installation - description: |- - Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. - - You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. + description: Remove a single repository from an installation. The authenticated + user must have admin access to the repository. The installation must have + the `repository_selection` of `selected`. tags: - apps operationId: apps/remove-repo-from-installation-for-authenticated-user @@ -41409,6 +42394,13 @@ paths: reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint. + + 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-for-authenticated-user @@ -41488,9 +42480,10 @@ paths: "/user/keys": get: summary: List public SSH keys for the authenticated user - description: Lists the public SSH keys for the authenticated user's GitHub account. - Requires that you are authenticated via Basic Auth or via OAuth with at least - `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + Lists the public SSH keys for the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. tags: - users operationId: users/list-public-ssh-keys-for-authenticated-user @@ -41530,9 +42523,10 @@ paths: subcategory: keys post: summary: Create a public SSH key for the authenticated user - description: Adds a public SSH key to the authenticated user's GitHub account. - Requires that you are authenticated via Basic Auth, or OAuth with at least - `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + Adds a public SSH key to the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. operationId: users/create-public-ssh-key-for-authenticated-user tags: - users @@ -41590,9 +42584,10 @@ paths: "/user/keys/{key_id}": get: summary: Get a public SSH key for the authenticated user - description: View extended details for a single public SSH key. Requires that - you are authenticated via Basic Auth or via OAuth with at least `read:public_key` - [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + View extended details for a single public SSH key. + + OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. tags: - users operationId: users/get-public-ssh-key-for-authenticated-user @@ -41626,9 +42621,10 @@ paths: subcategory: keys delete: summary: Delete a public SSH key for the authenticated user - description: Removes a public SSH key from the authenticated user's GitHub account. - Requires that you are authenticated via Basic Auth or via OAuth with at least - `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + description: |- + Removes a public SSH key from the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. tags: - users operationId: users/delete-public-ssh-key-for-authenticated-user @@ -41656,10 +42652,7 @@ paths: "/user/marketplace_purchases": get: summary: List subscriptions for the authenticated user - description: Lists the active subscriptions for the authenticated user. GitHub - Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), - created for a user who has authorized your GitHub App, to access this endpoint. - OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + description: Lists the active subscriptions for the authenticated user. tags: - apps operationId: apps/list-subscriptions-for-authenticated-user @@ -41698,10 +42691,7 @@ paths: "/user/marketplace_purchases/stubbed": get: summary: List subscriptions for the authenticated user (stubbed) - description: Lists the active subscriptions for the authenticated user. GitHub - Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), - created for a user who has authorized your GitHub App, to access this endpoint. - OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + description: Lists the active subscriptions for the authenticated user. tags: - apps operationId: apps/list-subscriptions-for-authenticated-user-stubbed @@ -42225,9 +43215,7 @@ paths: description: |- List organizations for the authenticated user. - **OAuth scope requirements** - - This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. tags: - orgs operationId: orgs/list-for-authenticated-user @@ -42269,7 +43257,7 @@ paths: description: |- Lists packages owned by the authenticated user within the user's namespace. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-authenticated-user @@ -42322,7 +43310,7 @@ paths: description: |- Gets a specific package for a package owned by the authenticated user. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-authenticated-user @@ -42352,8 +43340,7 @@ paths: description: |- Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-authenticated-user @@ -42387,7 +43374,7 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-authenticated-user @@ -42423,7 +43410,7 @@ paths: description: |- Lists package versions for a package owned by the authenticated user. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-authenticated-user @@ -42474,7 +43461,7 @@ paths: description: |- Gets a specific package version for a package owned by the authenticated user. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-authenticated-user @@ -42505,8 +43492,9 @@ paths: description: |- Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. - To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + The authenticated user must have admin permissions in the organization to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-authenticated-user @@ -42541,7 +43529,7 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-authenticated-user @@ -42631,9 +43619,12 @@ paths: "/user/public_emails": get: summary: List public email addresses for the authenticated user - description: Lists your publicly visible email address, which you can set with - the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) - endpoint. This endpoint is accessible with the `user:email` scope. + description: |- + Lists your publicly visible email address, which you can set with the + [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + endpoint. + + OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. tags: - users operationId: users/list-public-emails-for-authenticated-user @@ -42777,12 +43768,7 @@ paths: description: |- Creates a new repository for the authenticated user. - **OAuth scope requirements** - - When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - - * `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository. - * `repo` scope to create a private repository. + OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. tags: - repos operationId: repos/create-for-authenticated-user @@ -42947,10 +43933,10 @@ paths: content: application/json: schema: - "$ref": "#/components/schemas/repository" + "$ref": "#/components/schemas/full-repository" examples: default: - "$ref": "#/components/examples/repository" + "$ref": "#/components/examples/full-repository" headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -43113,8 +44099,10 @@ paths: subcategory: social-accounts post: summary: Add social accounts for the authenticated user - description: Add one or more social accounts to the authenticated user's profile. - This endpoint is accessible with the `user` scope. + description: |- + Add one or more social accounts to the authenticated user's profile. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. tags: - users operationId: users/add-social-account-for-authenticated-user @@ -43178,8 +44166,10 @@ paths: subcategory: social-accounts delete: summary: Delete social accounts for the authenticated user - description: Deletes one or more social accounts from the authenticated user's - profile. This endpoint is accessible with the `user` scope. + description: |- + Deletes one or more social accounts from the authenticated user's profile. + + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. tags: - users operationId: users/delete-social-account-for-authenticated-user @@ -43235,10 +44225,10 @@ paths: "/user/ssh_signing_keys": get: summary: List SSH signing keys for the authenticated user - description: Lists the SSH signing keys for the authenticated user's GitHub - account. You must authenticate with Basic Authentication, or you must authenticate - with OAuth with at least `read:ssh_signing_key` scope. For more information, - see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + description: |- + Lists the SSH signing keys for the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. tags: - users operationId: users/list-ssh-signing-keys-for-authenticated-user @@ -43279,10 +44269,10 @@ paths: subcategory: ssh-signing-keys post: summary: Create a SSH signing key for the authenticated user - description: Creates an SSH signing key for the authenticated user's GitHub - account. You must authenticate with Basic Authentication, or you must authenticate - with OAuth with at least `write:ssh_signing_key` scope. For more information, - see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + description: |- + Creates an SSH signing key for the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. operationId: users/create-ssh-signing-key-for-authenticated-user tags: - users @@ -43342,10 +44332,10 @@ paths: "/user/ssh_signing_keys/{ssh_signing_key_id}": get: summary: Get an SSH signing key for the authenticated user - description: Gets extended details for an SSH signing key. You must authenticate - with Basic Authentication, or you must authenticate with OAuth with at least - `read:ssh_signing_key` scope. For more information, see "[Understanding scopes - for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + description: |- + Gets extended details for an SSH signing key. + + OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. tags: - users operationId: users/get-ssh-signing-key-for-authenticated-user @@ -43379,10 +44369,10 @@ paths: subcategory: ssh-signing-keys delete: summary: Delete an SSH signing key for the authenticated user - description: Deletes an SSH signing key from the authenticated user's GitHub - account. You must authenticate with Basic Authentication, or you must authenticate - with OAuth with at least `admin:ssh_signing_key` scope. For more information, - see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + description: |- + Deletes an SSH signing key from the authenticated user's GitHub account. + + OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. tags: - users operationId: users/delete-ssh-signing-key-for-authenticated-user @@ -43413,7 +44403,9 @@ paths: description: |- Lists repositories the authenticated user has starred. - You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + 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.star+json`**: Includes a timestamp of when the star was created. tags: - activity operationId: activity/list-repos-starred-by-authenticated-user @@ -43495,7 +44487,7 @@ paths: put: summary: Star a repository for the authenticated user description: Note that you'll need to set `Content-Length` to zero when calling - out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-verbs)." + out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." tags: - activity operationId: activity/star-repo-for-authenticated-user @@ -43592,15 +44584,13 @@ paths: "/user/teams": get: summary: List teams for the authenticated user - description: List all of the teams across all of the organizations to which - the authenticated user belongs. This method requires `user`, `repo`, or `read:org` - [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) - when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). - When using a fine-grained personal access token, the resource owner of the - token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), - and have at least read-only member organization permissions. The response - payload only contains the teams from a single organization when using a fine-grained - personal access token. + description: |- + List all of the teams across all of the organizations to which the authenticated + user belongs. + + OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + + When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. tags: - teams operationId: teams/list-for-authenticated-user @@ -43682,9 +44672,7 @@ paths: description: |- Provides publicly available information about someone with a GitHub account. - GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" - - The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/overview/resources-in-the-rest-api#authentication). + The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". tags: @@ -43721,7 +44709,8 @@ paths: summary: Get list of conflicting packages during Docker migration for user description: |- Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. tags: - packages operationId: packages/list-docker-migration-conflicting-packages-for-user @@ -44018,14 +45007,11 @@ paths: get: summary: Get contextual information for a user description: |- - Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. - The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: + The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository, you would use a `subject_type` value of `repository` and a `subject_id` value of `1300192` (the ID of the `Spoon-Knife` repository). - ```shell - curl -u username:token - https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 - ``` + OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. tags: - users operationId: users/get-context-for-user @@ -44181,7 +45167,7 @@ paths: description: |- Lists all packages in a user's namespace for which the requesting user has access. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/list-packages-for-user @@ -44239,7 +45225,7 @@ paths: description: |- Gets a specific package metadata for a public package owned by a user. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-for-user @@ -44270,9 +45256,9 @@ paths: description: |- Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. - To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-for-user @@ -44307,9 +45293,9 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-for-user @@ -44346,7 +45332,7 @@ paths: description: |- Lists package versions for a public package owned by a specified user. - To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-all-package-versions-for-package-owned-by-user @@ -44386,7 +45372,7 @@ paths: description: |- Gets a specific package version for a public package owned by a specified user. - At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/get-package-version-for-user @@ -44418,9 +45404,9 @@ paths: description: |- Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. - To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/delete-package-version-for-user @@ -44456,9 +45442,9 @@ paths: - The package was deleted within the last 30 days. - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. - To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + + OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." tags: - packages operationId: packages/restore-package-version-for-user @@ -44534,9 +45520,9 @@ paths: "/users/{username}/received_events": get: summary: List events received by the authenticated user - description: These are events that you've received by watching repos and following - users. If you are authenticated as the given user, you will see private events. - Otherwise, you'll only see public events. + description: These are events that you've received by watching repositories + and following users. If you are authenticated as the given user, you will + see private events. Otherwise, you'll only see public events. tags: - activity operationId: activity/list-received-events-for-user @@ -44598,8 +45584,7 @@ paths: "/users/{username}/repos": get: summary: List repositories for a user - description: 'Lists public repositories for the specified user. Note: For GitHub - AE, this endpoint will list internal repositories for the specified user.' + description: Lists public repositories for the specified user. tags: - repos operationId: repos/list-for-user @@ -44671,7 +45656,7 @@ paths: Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". - Access tokens must have the `user` scope. + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. operationId: billing/get-github-actions-billing-user tags: - billing @@ -44703,7 +45688,7 @@ paths: Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - Access tokens must have the `user` scope. + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. operationId: billing/get-github-packages-billing-user tags: - billing @@ -44735,7 +45720,7 @@ paths: Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." - Access tokens must have the `user` scope. + OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. operationId: billing/get-shared-storage-billing-user tags: - billing @@ -44835,7 +45820,9 @@ paths: description: |- Lists repositories a user has starred. - You can also find out _when_ stars were created by passing the following custom [media type](https://docs.github.com/rest/overview/media-types/) via the `Accept` header: `application/vnd.github.star+json`. + 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.star+json`**: Includes a timestamp of when the star was created. tags: - activity operationId: activity/list-repos-starred-by-user @@ -46690,7 +47677,8 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. - description: A Dependabot alert was automatically closed. + description: A Dependabot alert was automatically closed by a Dependabot auto-triage + rule. operationId: dependabot-alert/auto-dismissed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert @@ -46758,7 +47746,9 @@ x-webhooks: To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission. **Note**: Webhook events for Dependabot alerts are currently in beta and subject to change. - description: A Dependabot alert was automatically reopened. + description: A Dependabot alert, that had been automatically closed by a Dependabot + auto-triage rule, was automatically reopened because the alert metadata or + rule changed. operationId: dependabot-alert/auto-reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#dependabot_alert @@ -53217,12 +54207,14 @@ x-webhooks: project-card-converted: post: summary: |- - This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A note in a classic project was converted to an issue. + description: A note in a project (classic) was converted to an issue. operationId: project-card/converted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card @@ -53283,12 +54275,14 @@ x-webhooks: project-card-created: post: summary: |- - This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card was added to a classic project. + description: A card was added to a project (classic). operationId: project-card/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card @@ -53349,12 +54343,14 @@ x-webhooks: project-card-deleted: post: summary: |- - This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card on a classic project was deleted. + description: A card on a project (classic) was deleted. operationId: project-card/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card @@ -53415,12 +54411,14 @@ x-webhooks: project-card-edited: post: summary: |- - This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. - For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A note on a classic project was edited. + description: A note on a project (classic) was edited. operationId: project-card/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card @@ -53481,13 +54479,15 @@ x-webhooks: project-card-moved: post: summary: |- - This event occurs when there is activity relating to a card on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project or a column on a project, use the `project` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A card on a classic project was moved to another column or to another - position in its column. + description: A card on a project (classic) was moved to another column or to + another position in its column. operationId: project-card/moved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_card @@ -53548,12 +54548,14 @@ x-webhooks: project-closed: post: summary: |- - This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A classic project was closed. + description: A project (classic) was closed. operationId: project/closed externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project @@ -53614,12 +54616,14 @@ x-webhooks: project-column-created: post: summary: |- - This event occurs when there is activity relating to a column on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was added to a classic project. + description: A column was added to a project (classic). operationId: project-column/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column @@ -53680,12 +54684,14 @@ x-webhooks: project-column-deleted: post: summary: |- - This event occurs when there is activity relating to a column on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - For activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was deleted from a classic project. + description: A column was deleted from a project (classic). operationId: project-column/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column @@ -53746,12 +54752,14 @@ x-webhooks: project-column-edited: post: summary: |- - This event occurs when there is activity relating to a column on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: The name of a column on a classic project was changed. + description: The name of a column on a project (classic) was changed. operationId: project-column/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column @@ -53812,12 +54820,14 @@ x-webhooks: project-column-moved: post: summary: |- - This event occurs when there is activity relating to a column on a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event. - For activity relating to a project or a card on a project, use the `project` and `project_card` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A column was moved to a new position on a classic project. + description: A column was moved to a new position on a project (classic). operationId: project-column/moved externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project_column @@ -53878,12 +54888,14 @@ x-webhooks: project-created: post: summary: |- - This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A classic project was created. + description: A project (classic) was created. operationId: project/created externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project @@ -53944,12 +54956,14 @@ x-webhooks: project-deleted: post: summary: |- - This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A classic project was deleted. + description: A project (classic) was deleted. operationId: project/deleted externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project @@ -54010,12 +55024,14 @@ x-webhooks: project-edited: post: summary: |- - This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. - For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. + + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: The name or description of a classic project was changed. + description: The name or description of a project (classic) was changed. operationId: project/edited externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project @@ -54076,12 +55092,14 @@ x-webhooks: project-reopened: post: summary: |- - This event occurs when there is activity relating to a classic project. For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/rest/projects)" in the REST API documentation. + + For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event. - For activity relating to a card or column on a project, use the `project_card` and `project_column` event. For activity relating to Projects instead of Projects (classic), use the `projects_v2` event instead. + This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead. To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission. - description: A classic project was closed. + description: A project (classic) was closed. operationId: project/reopened externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#project @@ -57918,11 +58936,9 @@ x-webhooks: repository-dispatch-sample.collected: post: summary: |- - This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). + This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission. - description: The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` - request body. operationId: repository-dispatch/sample.collected externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch @@ -59228,16 +60244,18 @@ x-webhooks: - repository - organization - app - security-advisory-published: + secret-scanning-alert-validated: post: summary: |- - This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/rest/secret-scanning)" in the REST API documentation. - GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A security advisory was published to the GitHub community. - operationId: security-advisory/published + For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event. + + 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 alert was validated. + operationId: secret-scanning-alert/validated externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory + url: https://docs.github.com/webhooks/webhook-events-and-payloads#secret_scanning_alert parameters: - name: User-Agent in: header @@ -59279,7 +60297,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-published" + "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59287,18 +60305,19 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_advisory + subcategory: secret_scanning_alert supported-webhook-types: + - repository + - organization - app - security-advisory-updated: + security-advisory-published: post: summary: |- - This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: The metadata or description of a security advisory was changed, - or the security advisory was withdrawn. - operationId: security-advisory/updated + description: A security advisory was published to the GitHub community. + operationId: security-advisory/published externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: @@ -59342,7 +60361,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-updated" + "$ref": "#/components/schemas/webhook-security-advisory-published" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59353,14 +60372,14 @@ x-webhooks: subcategory: security_advisory supported-webhook-types: - app - security-advisory-withdrawn: + security-advisory-updated: post: summary: |- - This event occurs when there is activity relating to a security advisory that was reviewed by GitHub. A GitHub-reviewed security advisory provides information about security-related vulnerabilities in software on GitHub. For more information about security advisories, see "[About GitHub Security Advisories for repositories](https://docs.github.com/code-security/repository-security-advisories/about-github-security-advisories-for-repositories)." For information about the API to manage security advisories, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." - description: A previously published security advisory was withdrawn. - operationId: security-advisory/withdrawn + description: The metadata or description of a security advisory was changed. + operationId: security-advisory/updated externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: @@ -59404,7 +60423,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" + "$ref": "#/components/schemas/webhook-security-advisory-updated" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59415,15 +60434,16 @@ x-webhooks: subcategory: security_advisory supported-webhook-types: - app - security-and-analysis: + security-advisory-withdrawn: post: summary: |- - This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." + This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#securityadvisory). - To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. - operationId: security-and-analysis + GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." + description: A previously published security advisory was withdrawn. + operationId: security-advisory/withdrawn externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_advisory parameters: - name: User-Agent in: header @@ -59465,7 +60485,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-security-and-analysis" + "$ref": "#/components/schemas/webhook-security-advisory-withdrawn" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59473,24 +60493,18 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: security_and_analysis + subcategory: security_advisory supported-webhook-types: - - repository - - organization - app - sponsorship-cancelled: + security-and-analysis: post: summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). - - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsorship was cancelled and the last billing cycle has ended. + This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/code-security/getting-started/github-security-features)." - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/cancelled + To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission. + operationId: security-and-analysis externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + url: https://docs.github.com/webhooks/webhook-events-and-payloads#security_and_analysis parameters: - name: User-Agent in: header @@ -59532,7 +60546,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-cancelled" + "$ref": "#/components/schemas/webhook-security-and-analysis" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59540,82 +60554,22 @@ x-webhooks: x-github: githubCloudOnly: false category: webhooks - subcategory: sponsorship + subcategory: security_and_analysis supported-webhook-types: - - sponsors_listing - sponsorship-created: + - repository + - organization + - app + sponsorship-cancelled: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A sponsor created a sponsorship for a sponsored account. This event - occurs once the payment is successfully processed. - operationId: sponsorship/created - externalDocs: - url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship - 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-sponsorship-created" - responses: - '200': - description: Return a 200 status to indicate that the data was received - successfully - x-github: - githubCloudOnly: false - category: webhooks - subcategory: sponsorship - supported-webhook-types: - - sponsors_listing - sponsorship-edited: - post: - summary: |- - This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + description: |- + A sponsorship was cancelled and the last billing cycle has ended. - You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: A monthly sponsor changed who can see their sponsorship. If you - recognize your sponsors publicly, you may want to update your sponsor recognition - to reflect the change when this event occurs. - operationId: sponsorship/edited + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/cancelled externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -59659,7 +60613,7 @@ x-webhooks: content: application/json: schema: - "$ref": "#/components/schemas/webhook-sponsorship-edited" + "$ref": "#/components/schemas/webhook-sponsorship-cancelled" responses: '200': description: Return a 200 status to indicate that the data was received @@ -59670,17 +60624,144 @@ x-webhooks: subcategory: sponsorship supported-webhook-types: - sponsors_listing - sponsorship-pending-cancellation: + sponsorship-created: post: summary: |- This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." - description: |- - A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. - - This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. - operationId: sponsorship/pending-cancellation + description: A sponsor created a sponsorship for a sponsored account. This event + occurs once the payment is successfully processed. + operationId: sponsorship/created + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + 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-sponsorship-created" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + sponsorship-edited: + post: + summary: |- + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: A monthly sponsor changed who can see their sponsorship. If you + recognize your sponsors publicly, you may want to update your sponsor recognition + to reflect the change when this event occurs. + operationId: sponsorship/edited + externalDocs: + url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship + 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-sponsorship-edited" + responses: + '200': + description: Return a 200 status to indicate that the data was received + successfully + x-github: + githubCloudOnly: false + category: webhooks + subcategory: sponsorship + supported-webhook-types: + - sponsors_listing + sponsorship-pending-cancellation: + post: + summary: |- + This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/graphql/reference/objects#sponsorship). + + You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)." + description: |- + A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date. + + This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships. + operationId: sponsorship/pending-cancellation externalDocs: url: https://docs.github.com/webhooks/webhook-events-and-payloads#sponsorship parameters: @@ -61088,6 +62169,7 @@ components: hub_url: type: string format: uri-template + deprecated: true issue_search_url: type: string format: uri-template @@ -61161,7 +62243,6 @@ components: - followers_url - following_url - gists_url - - hub_url - issue_search_url - issues_url - keys_url @@ -61198,6 +62279,45 @@ components: - pub - other - swift + vulnerability: + description: A vulnerability describing the product and its affected versions + within a GitHub Security Advisory. + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: object + nullable: true + properties: + ecosystem: + "$ref": "#/components/schemas/security-advisory-ecosystems" + name: + type: string + description: The unique package name within its ecosystem. + nullable: true + required: + - ecosystem + - name + vulnerable_version_range: + type: string + description: The range of the package versions affected by the vulnerability. + nullable: true + first_patched_version: + type: string + description: The package version that resolves the vulnerability. + nullable: true + vulnerable_functions: + type: array + description: The functions in the package that are affected by the vulnerability. + nullable: true + readOnly: true + items: + type: string + required: + - package + - vulnerable_version_range + - first_patched_version + - vulnerable_functions simple-user: title: Simple User description: A GitHub user. @@ -61431,43 +62551,7 @@ components: advisory. nullable: true items: - type: object - properties: - package: - description: The name of the package affected by the vulnerability. - type: object - nullable: true - properties: - ecosystem: - "$ref": "#/components/schemas/security-advisory-ecosystems" - name: - type: string - description: The unique package name within its ecosystem. - nullable: true - required: - - ecosystem - - name - vulnerable_version_range: - type: string - description: The range of the package versions affected by the vulnerability. - nullable: true - first_patched_version: - type: string - description: The package version that resolve the vulnerability. - nullable: true - vulnerable_functions: - type: array - description: The functions in the package that are affected by the - vulnerability. - nullable: true - readOnly: true - items: - type: string - required: - - package - - vulnerable_version_range - - first_patched_version - - vulnerable_functions + "$ref": "#/components/schemas/vulnerability" cvss: type: object nullable: true @@ -61672,6 +62756,7 @@ components: repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object + nullable: true properties: id: description: Unique identifier of the GitHub app @@ -62147,6 +63232,13 @@ components: enum: - read - write + codespaces: + type: string + description: The level of permission to grant the access token to create, + edit, delete, and list Codespaces. + enum: + - read + - write contents: type: string description: The level of permission to grant the access token for repository @@ -62154,6 +63246,13 @@ components: enum: - read - write + dependabot_secrets: + type: string + description: The leve of permission to grant the access token to manage + Dependabot secrets. + enum: + - read + - write deployments: type: string description: The level of permission to grant the access token for deployments @@ -62203,6 +63302,13 @@ components: enum: - read - write + repository_custom_properties: + type: string + description: The level of permission to grant the access token to view and + edit custom properties for a repository, when allowed by the property. + enum: + - read + - write repository_hooks: type: string description: The level of permission to grant the access token to manage @@ -62283,8 +63389,14 @@ components: organization_custom_roles: type: string description: The level of permission to grant the access token for custom - repository roles management. This property is in beta and is subject to - change. + repository roles management. + enum: + - read + - write + organization_custom_org_roles: + type: string + description: The level of permission to grant the access token for custom + organization roles management. enum: - read - write @@ -62296,6 +63408,13 @@ components: - read - write - admin + organization_copilot_seat_management: + type: string + description: The level of permission to grant the access token for managing + access to GitHub Copilot for members of an organization with a Copilot + Business subscription. This property is in beta and is subject to change. + enum: + - write organization_announcement_banners: type: string description: The level of permission to grant the access token to view and @@ -62303,6 +63422,12 @@ components: enum: - read - write + organization_events: + type: string + description: The level of permission to grant the access token to view events + triggered by an activity in an organization. + enum: + - read organization_hooks: type: string description: The level of permission to grant the access token to manage @@ -62374,6 +63499,54 @@ components: enum: - read - write + email_addresses: + type: string + description: The level of permission to grant the access token to manage + the email addresses belonging to a user. + enum: + - read + - write + followers: + type: string + description: The level of permission to grant the access token to manage + the followers belonging to a user. + enum: + - read + - write + git_ssh_keys: + type: string + description: The level of permission to grant the access token to manage + git SSH keys. + enum: + - read + - write + gpg_keys: + type: string + description: The level of permission to grant the access token to view and + manage GPG keys belonging to a user. + enum: + - read + - write + interaction_limits: + type: string + description: The level of permission to grant the access token to view and + manage interaction limits on a repository. + enum: + - read + - write + profile: + type: string + description: The level of permission to grant the access token to manage + the profile settings belonging to a user. + enum: + - write + starring: + type: string + description: The level of permission to grant the access token to list and + manage repositories a user is starring. + enum: + - read + - write example: contents: read issues: read @@ -62533,8 +63706,6 @@ components: example: octocat/Hello-World license: "$ref": "#/components/schemas/nullable-license-simple" - organization: - "$ref": "#/components/schemas/nullable-simple-user" forks: type: integer permissions: @@ -62731,8 +63902,8 @@ components: type: integer example: 80 size: - description: The size of the repository. Size is calculated hourly. When - a repository is initially created, the size is 0. + description: The size of the repository, in kilobytes. Size is calculated + hourly. When a repository is initially created, the size is 0. type: integer example: 108 default_branch: @@ -62811,270 +63982,6 @@ components: default: true type: boolean example: true - template_repository: - nullable: true - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - full_name: - type: string - owner: - type: object - properties: - login: - type: string - id: - type: integer - node_id: - type: string - avatar_url: - type: string - gravatar_id: - type: string - url: - type: string - html_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - starred_url: - type: string - subscriptions_url: - type: string - organizations_url: - type: string - repos_url: - type: string - events_url: - type: string - received_events_url: - type: string - type: - type: string - site_admin: - type: boolean - private: - type: boolean - html_url: - type: string - description: - type: string - fork: - type: boolean - url: - type: string - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - downloads_url: - type: string - events_url: - type: string - forks_url: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - git_url: - type: string - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - notifications_url: - type: string - pulls_url: - type: string - releases_url: - type: string - ssh_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - clone_url: - type: string - mirror_url: - type: string - hooks_url: - type: string - svn_url: - type: string - homepage: - type: string - language: - type: string - forks_count: - type: integer - stargazers_count: - type: integer - watchers_count: - type: integer - size: - type: integer - default_branch: - type: string - open_issues_count: - type: integer - is_template: - type: boolean - topics: - type: array - items: - type: string - has_issues: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - has_pages: - type: boolean - has_downloads: - type: boolean - archived: - type: boolean - disabled: - type: boolean - visibility: - type: string - pushed_at: - type: string - created_at: - type: string - updated_at: - type: string - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - allow_rebase_merge: - type: boolean - temp_clone_token: - type: string - allow_squash_merge: - type: boolean - allow_auto_merge: - type: boolean - delete_branch_on_merge: - type: boolean - allow_update_branch: - type: boolean - use_squash_pr_title_as_default: - type: boolean - squash_merge_commit_title: - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - squash_merge_commit_message: - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - merge_commit_title: - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - merge_commit_message: - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - allow_merge_commit: - type: boolean - subscribers_count: - type: integer - network_count: - type: integer temp_clone_token: type: string allow_squash_merge: @@ -63162,10 +64069,6 @@ components: description: Whether to require contributors to sign off on web-based commits default: false type: boolean - subscribers_count: - type: integer - network_count: - type: integer open_issues: type: integer watchers: @@ -63924,6 +64827,89 @@ components: - html_url - key - name + 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 alert-number: type: integer description: The security alert number. @@ -64749,6 +65735,7 @@ components: repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub. type: object + nullable: true properties: id: description: Unique identifier of the GitHub app @@ -64844,7 +65831,6 @@ components: - updated_at - permissions - events - nullable: true author-association: title: author_association type: string @@ -66216,6 +67202,12 @@ components: type: string example: - example.com + actions: + type: array + items: + type: string + example: + - example.com required: - verifiable_password_authentication security-and-analysis: @@ -66437,8 +67429,8 @@ components: watchers_count: type: integer size: - description: The size of the repository. Size is calculated hourly. When - a repository is initially created, the size is 0. + description: The size of the repository, in kilobytes. Size is calculated + hourly. When a repository is initially created, the size is 0. type: integer default_branch: type: string @@ -67409,7 +68401,7 @@ components: description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - code-scanning-alert-rule: + code-scanning-alert-rule-summary: type: object properties: id: @@ -67419,6 +68411,12 @@ components: name: type: string description: The name of the rule used to detect the alert. + tags: + nullable: true + type: array + description: A set of tags applicable for the rule. + items: + type: string severity: nullable: true type: string @@ -67440,24 +68438,6 @@ components: description: type: string description: A short description of the rule used to detect the alert. - full_description: - type: string - description: description of the rule used to detect the alert. - tags: - nullable: true - type: array - description: A set of tags applicable for the rule. - items: - type: string - help: - nullable: true - type: string - description: Detailed documentation for the rule as GitHub Flavored Markdown. - help_uri: - nullable: true - type: string - description: A link to the documentation for the rule used to detect the - alert. code-scanning-analysis-tool-version: nullable: true type: string @@ -67573,7 +68553,7 @@ components: dismissed_comment: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" rule: - "$ref": "#/components/schemas/code-scanning-alert-rule" + "$ref": "#/components/schemas/code-scanning-alert-rule-summary" tool: "$ref": "#/components/schemas/code-scanning-analysis-tool" most_recent_instance: @@ -67976,7 +68956,7 @@ components: - block - unconfigured - unknown - copilot_chat: + ide_chat: type: string description: The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor. @@ -67984,6 +68964,22 @@ components: - enabled - disabled - unconfigured + platform_chat: + type: string + description: The organization policy for allowing or disallowing organization + members to use Copilot features within github.com. + enum: + - enabled + - disabled + - unconfigured + cli: + type: string + description: The organization policy for allowing or disallowing organization + members to use Copilot within their CLI. + enum: + - enabled + - disabled + - unconfigured seat_management_setting: type: string description: The mode of assigning new seats. @@ -68537,8 +69533,8 @@ components: watchers_count: type: integer size: - description: The size of the repository. Size is calculated hourly. When - a repository is initially created, the size is 0. + description: The size of the repository, in kilobytes. Size is calculated + hourly. When a repository is initially created, the size is 0. type: integer default_branch: type: string @@ -69407,7 +70403,11 @@ components: type: boolean description: Whether the property is required. default_value: - type: string + oneOf: + - type: string + - type: array + items: + type: string nullable: true description: Default value of the property description: @@ -69418,8 +70418,20 @@ components: 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. + values_editable_by: + type: string nullable: true - description: Ordered list of allowed values of the property + enum: + - org_actors + - org_and_repo_actors + example: org_actors + description: Who can edit the values of the property required: - property_name - value_type @@ -69432,7 +70444,11 @@ components: type: string description: The name of the property value: - type: string + oneOf: + - type: string + - type: array + items: + type: string description: The value assigned to the property nullable: true required: @@ -69462,2147 +70478,887 @@ components: - repository_name - repository_full_name - properties - repository-rule-enforcement: - type: string - description: The enforcement level of the ruleset. `evaluate` allows admins - to test rules before enforcing them. Admins can view insights on the Rule - Insights page (`evaluate` is only available with GitHub Enterprise). - enum: - - disabled - - active - - evaluate - repository-ruleset-bypass-actor: - title: Repository Ruleset Bypass Actor + nullable-repository: + title: Repository + description: A repository on GitHub. type: object - description: An actor that can bypass rules in a ruleset - required: - - actor_id - - actor_type - - bypass_mode properties: - actor_id: + id: + description: Unique identifier of the repository + example: 42 type: integer - description: The ID of the actor that can bypass a ruleset. If `actor_type` - is `OrganizationAdmin`, this should be `1`. - actor_type: - type: string - enum: - - RepositoryRole - - Team - - Integration - - OrganizationAdmin - description: The type of actor that can bypass a ruleset - bypass_mode: + node_id: type: string - description: When the specified actor can bypass the ruleset. `pull_request` - means that an actor can only bypass rules on pull requests. - enum: - - always - - pull_request - repository-ruleset-conditions: - title: Repository ruleset conditions for ref names - type: object - description: Parameters for a repository ruleset ref name condition - properties: - ref_name: - type: object - properties: - include: - type: array - description: Array of ref names or patterns to include. One of these - patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` - to include the default branch or `~ALL` to include all branches. - items: - type: string - exclude: - type: array - description: Array of ref names or patterns to exclude. The condition - will not pass if any of these patterns match. - items: - type: string - repository-ruleset-conditions-repository-name-target: - title: Repository ruleset conditions for repository names - type: object - description: Parameters for a repository name condition - properties: - repository_name: - type: object - properties: - include: - type: array - description: Array of repository names or patterns to include. One of - these patterns must match for the condition to pass. Also accepts - `~ALL` to include all repositories. - items: - type: string - exclude: - type: array - description: Array of repository names or patterns to exclude. The condition - will not pass if any of these patterns match. - items: - type: string - protected: - type: boolean - description: Whether renaming of target repositories is prevented. - required: - - repository_name - repository-ruleset-conditions-repository-id-target: - title: Repository ruleset conditions for repository IDs - type: object - description: Parameters for a repository ID condition - properties: - repository_id: - type: object - properties: - repository_ids: - type: array - description: The repository IDs that the ruleset applies to. One of - these IDs must match for the condition to pass. - items: - type: integer - required: - - repository_id - org-ruleset-conditions: - title: Organization ruleset conditions - type: object - description: 'Conditions for an organization ruleset. The conditions object - should contain both `repository_name` and `ref_name` properties or both `repository_id` - and `ref_name` properties. - -' - oneOf: - - type: object - title: repository_name_and_ref_name - description: Conditions to target repositories by name and refs by name - allOf: - - "$ref": "#/components/schemas/repository-ruleset-conditions" - - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" - - type: object - title: repository_id_and_ref_name - description: Conditions to target repositories by id and refs by name - allOf: - - "$ref": "#/components/schemas/repository-ruleset-conditions" - - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" - repository-rule-creation: - title: creation - description: Only allow users with bypass permission to create matching refs. - type: object - required: - - type - properties: - type: + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. type: string - enum: - - creation - repository-rule-update: - title: update - description: Only allow users with bypass permission to update matching refs. - type: object - required: - - type - properties: - type: + example: Team Environment + full_name: type: string - enum: - - update - parameters: + example: octocat/Hello-World + license: + "$ref": "#/components/schemas/nullable-license-simple" + forks: + type: integer + permissions: type: object properties: - update_allows_fetch_and_merge: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: type: boolean - description: Branch can pull changes from its upstream repository required: - - update_allows_fetch_and_merge - repository-rule-deletion: - title: deletion - description: Only allow users with bypass permissions to delete matching refs. - type: object - required: - - type - properties: - type: + - admin + - pull + - push + owner: + "$ref": "#/components/schemas/simple-user" + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: type: string - enum: - - deletion - repository-rule-required-linear-history: - title: required_linear_history - description: Prevent merge commits from being pushed to matching refs. - type: object - required: - - type - properties: - type: + format: uri + example: https://github.com/octocat/Hello-World + description: type: string - enum: - - required_linear_history - repository-rule-required-deployments: - title: required_deployments - description: Choose which environments must be successfully deployed to before - refs can be pushed into a ref that matches this rule. - type: object - required: - - type - properties: - type: + example: This your first repo! + nullable: true + fork: + type: boolean + url: type: string - enum: - - required_deployments - parameters: - type: object - properties: - required_deployment_environments: - type: array - description: The environments that must be successfully deployed to - before branches can be merged. - items: - type: string - required: - - required_deployment_environments - repository-rule-required-signatures: - title: required_signatures - description: Commits pushed to matching refs must have verified signatures. - type: object - required: - - type - properties: - type: + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: type: string - enum: - - required_signatures - repository-rule-pull-request: - title: pull_request - description: Require all commits be made to a non-target branch and submitted - via a pull request before they can be merged. - type: object - required: - - type - properties: - type: + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: type: string - enum: - - pull_request - parameters: - type: object - properties: - dismiss_stale_reviews_on_push: - type: boolean - description: New, reviewable commits pushed will dismiss previous pull - request review approvals. - require_code_owner_review: - type: boolean - description: Require an approving review in pull requests that modify - files that have a designated code owner. - require_last_push_approval: - type: boolean - description: Whether the most recent reviewable push must be approved - by someone other than the person who pushed it. - required_approving_review_count: - type: integer - description: The number of approving reviews that are required before - a pull request can be merged. - minimum: 0 - maximum: 10 - required_review_thread_resolution: - type: boolean - description: All conversations on code must be resolved before a pull - request can be merged. - required: - - dismiss_stale_reviews_on_push - - require_code_owner_review - - require_last_push_approval - - required_approving_review_count - - required_review_thread_resolution - repository-rule-params-status-check-configuration: - title: StatusCheckConfiguration - description: Required status check - type: object - properties: - context: + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: type: string - description: The status check context name that must be present on the commit. - integration_id: - type: integer - description: The optional integration ID that this status check must originate - from. - required: - - context - repository-rule-required-status-checks: - title: required_status_checks - description: Choose which status checks must pass before the ref is updated. - When enabled, commits must first be pushed to another ref where the checks - pass. - type: object - required: - - type - properties: - type: + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: type: string - enum: - - required_status_checks - parameters: - type: object - properties: - required_status_checks: - type: array - description: Status checks that are required. - items: - "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" - strict_required_status_checks_policy: - type: boolean - description: Whether pull requests targeting a matching branch must - be tested with the latest code. This setting will not take effect - unless at least one status check is enabled. - required: - - required_status_checks - - strict_required_status_checks_policy - repository-rule-non-fast-forward: - title: non_fast_forward - description: Prevent users with push access from force pushing to refs. - type: object - required: - - type - properties: - type: + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: type: string - enum: - - non_fast_forward - repository-rule-commit-message-pattern: - title: commit_message_pattern - description: Parameters to be used for the commit_message_pattern rule - type: object - required: - - type - properties: - type: + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: type: string - enum: - - commit_message_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-commit-author-email-pattern: - title: commit_author_email_pattern - description: Parameters to be used for the commit_author_email_pattern rule - type: object - required: - - type - properties: - type: + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: type: string - enum: - - commit_author_email_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-committer-email-pattern: - title: committer_email_pattern - description: Parameters to be used for the committer_email_pattern rule - type: object - required: - - type - properties: - type: + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: type: string - enum: - - committer_email_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-branch-name-pattern: - title: branch_name_pattern - description: Parameters to be used for the branch_name_pattern rule - type: object - required: - - type - properties: - type: + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: type: string - enum: - - branch_name_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-tag-name-pattern: - title: tag_name_pattern - description: Parameters to be used for the tag_name_pattern rule - type: object - required: - - type - properties: - type: + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: type: string - enum: - - tag_name_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-params-workflow-file-reference: - title: WorkflowFileReference - description: A workflow that must run for this rule to pass - type: object - properties: - path: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: type: string - description: The path to the workflow file - ref: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: type: string - description: The ref (branch or tag) of the workflow file to use - repository_id: - type: integer - description: The ID of the repository where the workflow is defined - sha: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: type: string - description: The commit SHA of the workflow file to use - required: - - path - - repository_id - repository-rule-workflows: - title: workflows - description: Require all changes made to a targeted branch to pass the specified - workflows before they can be merged. - type: object - required: - - type - properties: - type: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: type: string - enum: - - workflows - parameters: - type: object - properties: - workflows: - type: array - description: Workflows that must pass for this rule to pass. - items: - "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" - required: - - workflows - repository-rule: - title: Repository Rule - type: object - description: A repository rule. - oneOf: - - "$ref": "#/components/schemas/repository-rule-creation" - - "$ref": "#/components/schemas/repository-rule-update" - - "$ref": "#/components/schemas/repository-rule-deletion" - - "$ref": "#/components/schemas/repository-rule-required-linear-history" - - "$ref": "#/components/schemas/repository-rule-required-deployments" - - "$ref": "#/components/schemas/repository-rule-required-signatures" - - "$ref": "#/components/schemas/repository-rule-pull-request" - - "$ref": "#/components/schemas/repository-rule-required-status-checks" - - "$ref": "#/components/schemas/repository-rule-non-fast-forward" - - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" - - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" - - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" - - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - - "$ref": "#/components/schemas/repository-rule-workflows" - repository-ruleset: - title: Repository ruleset - type: object - description: A set of rules to apply when specified conditions are met. - required: - - id - - name - - source - - enforcement - properties: - id: - type: integer - description: The ID of the ruleset - name: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: type: string - description: The name of the ruleset - target: + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: type: string - description: The target of the ruleset - enum: - - branch - - tag - source_type: + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: type: string - description: The type of the source of the ruleset - enum: - - Repository - - Organization - source: + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: type: string - description: The name of the source - enforcement: - "$ref": "#/components/schemas/repository-rule-enforcement" - bypass_actors: - type: array - description: The actors that can bypass the rules in this ruleset - items: - "$ref": "#/components/schemas/repository-ruleset-bypass-actor" - current_user_can_bypass: + example: git:github.com/octocat/Hello-World.git + issue_comment_url: type: string - description: |- - The bypass type of the user making the API request for this ruleset. This field is only returned when - querying the repository-level endpoint. - enum: - - always - - pull_requests_only - - never - node_id: + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: type: string - _links: - type: object - properties: - self: - type: object - properties: - href: - type: string - description: The URL of the ruleset - html: - type: object - properties: - href: - type: string - description: The html URL of the ruleset - conditions: - anyOf: - - "$ref": "#/components/schemas/repository-ruleset-conditions" - - "$ref": "#/components/schemas/org-ruleset-conditions" - rules: - type: array - items: - "$ref": "#/components/schemas/repository-rule" - created_at: + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: type: string - format: date-time - updated_at: + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: type: string - format: date-time - rule-suites: - title: Rule Suites - description: Response - type: array - items: - type: object - properties: - id: - type: integer - description: The unique identifier of the rule insight. - actor_id: - type: integer - description: The number that identifies the user. - actor_name: - type: string - description: The handle for the GitHub user account. - before_sha: - type: string - description: The first commit sha before the push evaluation. - after_sha: - type: string - description: The last commit sha in the push evaluation. - ref: - type: string - description: The ref name that the evaluation ran on. - repository_id: - type: integer - description: The ID of the repository associated with the rule evaluation. - repository_name: - type: string - description: The name of the repository without the `.git` extension. - pushed_at: - type: string - format: date-time - example: '2011-01-26T19:06:43Z' - result: - type: string - enum: - - pass - - fail - - bypass - description: The result of the rule evaluations for rules with the `active` - enforcement status. - evaluation_result: - type: string - enum: - - pass - - fail - description: The result of the rule evaluations for rules with the `active` - and `evaluate` enforcement statuses, demonstrating whether rules would - pass or fail if all rules in the rule suite were `active`. - rule-suite: - title: Rule Suite - description: Response - type: object - properties: - id: - type: integer - description: The unique identifier of the rule insight. - actor_id: - type: integer - description: The number that identifies the user. - actor_name: + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: type: string - description: The handle for the GitHub user account. - before_sha: + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: type: string - description: The first commit sha before the push evaluation. - after_sha: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: type: string - description: The last commit sha in the push evaluation. - ref: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: type: string - description: The ref name that the evaluation ran on. - repository_id: - type: integer - description: The ID of the repository associated with the rule evaluation. - repository_name: + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: type: string - description: The name of the repository without the `.git` extension. - pushed_at: + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: type: string - format: date-time - example: '2011-01-26T19:06:43Z' - result: + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: type: string - enum: - - pass - - fail - - bypass - description: The result of the rule evaluations for rules with the `active` - enforcement status. - evaluation_result: + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: type: string - enum: - - pass - - fail - description: The result of the rule evaluations for rules with the `active` - and `evaluate` enforcement statuses, demonstrating whether rules would - pass or fail if all rules in the rule suite were `active`. - rule_evaluations: - type: array - description: Details on the evaluated rules. - items: - type: object - properties: - rule_source: - type: object - properties: - type: - type: string - description: The type of rule source. - id: - type: integer - nullable: true - description: The ID of the rule source. - name: - type: string - nullable: true - description: The name of the rule source. - enforcement: - type: string - enum: - - active - - evaluate - - deleted ruleset - description: The enforcement level of this rule source. - result: - type: string - enum: - - pass - - fail - description: The result of the evaluation of the individual rule. - rule_type: - type: string - description: The type of rule. - details: - type: string - description: Any associated details with the rule evaluation. - repository-advisory-vulnerability: - description: A product affected by the vulnerability detailed in a repository - security advisory. - type: object - properties: - package: - description: The name of the package affected by the vulnerability. - type: object - nullable: true - properties: - ecosystem: - "$ref": "#/components/schemas/security-advisory-ecosystems" - name: - type: string - description: The unique package name within its ecosystem. - nullable: true - required: - - ecosystem - - name - vulnerable_version_range: + example: git@github.com:octocat/Hello-World.git + stargazers_url: type: string - description: The range of the package versions affected by the vulnerability. - nullable: true - patched_versions: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: type: string - description: The package version(s) that resolve the vulnerability. - nullable: true - vulnerable_functions: - type: array - description: The functions in the package that are affected. - nullable: true - items: - type: string - required: - - package - - vulnerable_version_range - - patched_versions - - vulnerable_functions - additionalProperties: false - repository-advisory-credit: - description: A credit given to a user for a repository security advisory. - type: object - properties: - user: - "$ref": "#/components/schemas/simple-user" - type: - "$ref": "#/components/schemas/security-advisory-credit-types" - state: + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: type: string - description: The state of the user's acceptance of the credit. - enum: - - accepted - - declined - - pending - required: - - user - - type - - state - additionalProperties: false - repository-advisory: - description: A repository security advisory. - type: object - properties: - ghsa_id: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: type: string - description: The GitHub Security Advisory ID. - readOnly: true - cve_id: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: type: string - description: The Common Vulnerabilities and Exposures (CVE) ID. - nullable: true - url: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: type: string format: uri - description: The API URL for the advisory. - readOnly: true - html_url: + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: type: string format: uri - description: The URL for the advisory. - readOnly: true - summary: + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: type: string - description: A short summary of the advisory. - maxLength: 1024 - description: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: type: string - description: A detailed description of what the advisory entails. - maxLength: 65535 + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com nullable: true - severity: + language: type: string - description: The severity of the advisory. nullable: true - enum: - - critical - - high - - medium - - low - author: - readOnly: true - nullable: true - description: The author of the advisory. - allOf: - - "$ref": "#/components/schemas/simple-user" - publisher: - readOnly: true - nullable: true - description: The publisher of the advisory. - allOf: - - "$ref": "#/components/schemas/simple-user" - identifiers: + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated + hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + example: true + topics: type: array items: - type: object - properties: - type: - type: string - description: The type of identifier. - enum: - - CVE - - GHSA - value: - type: string - description: The identifier value. - required: - - type - - value - readOnly: true - state: + type: string + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + deprecated: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public type: string - description: The state of the advisory. - enum: - - published - - closed - - withdrawn - - draft - - triage - created_at: + pushed_at: type: string format: date-time - description: The date and time of when the advisory was created, in ISO - 8601 format. - readOnly: true + example: '2011-01-26T19:06:43Z' nullable: true - updated_at: + created_at: type: string format: date-time - description: The date and time of when the advisory was last updated, in - ISO 8601 format. - readOnly: true + example: '2011-01-26T19:01:12Z' nullable: true - published_at: + updated_at: type: string format: date-time - description: The date and time of when the advisory was published, in ISO - 8601 format. - readOnly: true + example: '2011-01-26T19:14:43Z' nullable: true - closed_at: + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + temp_clone_token: type: string - format: date-time - description: The date and time of when the advisory was closed, in ISO 8601 - format. - readOnly: true - nullable: true - withdrawn_at: + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its + base branch can always be updated even if it is not required to be up + to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title + as default. **This property has been deprecated. Please use `squash_merge_commit_title` + instead. + default: false + deprecated: true + squash_merge_commit_title: type: string - format: date-time - description: The date and time of when the advisory was withdrawn, in ISO - 8601 format. - readOnly: true - nullable: true - submission: - type: object - nullable: true - readOnly: true - properties: - accepted: - type: boolean - description: Whether a private vulnerability report was accepted by - the repository's administrators. - readOnly: true - required: - - accepted - vulnerabilities: - type: array - nullable: true - items: - "$ref": "#/components/schemas/repository-advisory-vulnerability" - cvss: - type: object - nullable: true - properties: - vector_string: - type: string - description: The CVSS vector. - nullable: true - score: - type: number - description: The CVSS score. - minimum: 0 - maximum: 10 - nullable: true - readOnly: true - required: - - vector_string - - score - cwes: - type: array - nullable: true - items: - type: object - properties: - cwe_id: - type: string - description: The Common Weakness Enumeration (CWE) identifier. - name: - type: string - description: The name of the CWE. - readOnly: true - required: - - cwe_id - - name - readOnly: true - cwe_ids: - type: array - description: A list of only the CWE IDs. - nullable: true - items: - type: string - credits: - type: array - nullable: true - items: - type: object - properties: - login: - type: string - description: The username of the user credited. - type: - "$ref": "#/components/schemas/security-advisory-credit-types" - credits_detailed: - type: array - nullable: true - items: - "$ref": "#/components/schemas/repository-advisory-credit" - readOnly: true - collaborating_users: - type: array - description: A list of users that collaborate on the advisory. - nullable: true - items: - "$ref": "#/components/schemas/simple-user" - collaborating_teams: - type: array - description: A list of teams that collaborate on the advisory. - nullable: true - items: - "$ref": "#/components/schemas/team" - private_fork: - readOnly: true - nullable: true - description: A temporary private fork of the advisory's repository for collaborating - on a fix. - allOf: - - "$ref": "#/components/schemas/simple-repository" + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this repository required: - - ghsa_id - - cve_id - - url - - html_url - - summary + - archive_url + - assignees_url + - blobs_url + - branches_url + - collaborators_url + - comments_url + - commits_url + - compare_url + - contents_url + - contributors_url + - deployments_url - description - - severity - - author - - publisher - - identifiers - - state + - 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 + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count - created_at - updated_at - - published_at - - closed_at - - withdrawn_at - - submission - - vulnerabilities - - cvss - - cwes - - cwe_ids - - credits - - credits_detailed - - collaborating_users - - collaborating_teams - - private_fork - additionalProperties: false - team-simple: - title: Team Simple - description: Groups of organization members that gives permissions on specified - repositories. + nullable: true + code-of-conduct-simple: + title: Code Of Conduct Simple + description: Code of Conduct Simple 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: + example: https://api.github.com/repos/github/docs/community/code_of_conduct + key: type: string - example: https://api.github.com/organizations/1/team/1/members{/member} + example: citizen_code_of_conduct 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 + example: Citizen Code of Conduct html_url: type: string + nullable: true 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 + example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md required: - - id - - node_id - url - - members_url + - key - name - - description - - permission - html_url - - repositories_url - - slug - actions-billing-usage: - type: object - properties: - total_minutes_used: - type: integer - description: The sum of the free and paid GitHub Actions minutes used. - total_paid_minutes_used: - type: integer - description: The total paid GitHub Actions minutes used. - included_minutes: - type: integer - description: The amount of free GitHub Actions minutes available. - minutes_used_breakdown: - type: object - properties: - UBUNTU: - type: integer - description: Total minutes used on Ubuntu runner machines. - MACOS: - type: integer - description: Total minutes used on macOS runner machines. - WINDOWS: - type: integer - description: Total minutes used on Windows runner machines. - ubuntu_4_core: - type: integer - description: Total minutes used on Ubuntu 4 core runner machines. - ubuntu_8_core: - type: integer - description: Total minutes used on Ubuntu 8 core runner machines. - ubuntu_16_core: - type: integer - description: Total minutes used on Ubuntu 16 core runner machines. - ubuntu_32_core: - type: integer - description: Total minutes used on Ubuntu 32 core runner machines. - ubuntu_64_core: - type: integer - description: Total minutes used on Ubuntu 64 core runner machines. - windows_4_core: - type: integer - description: Total minutes used on Windows 4 core runner machines. - windows_8_core: - type: integer - description: Total minutes used on Windows 8 core runner machines. - windows_16_core: - type: integer - description: Total minutes used on Windows 16 core runner machines. - windows_32_core: - type: integer - description: Total minutes used on Windows 32 core runner machines. - windows_64_core: - type: integer - description: Total minutes used on Windows 64 core runner machines. - macos_12_core: - type: integer - description: Total minutes used on macOS 12 core runner machines. - total: - type: integer - description: Total minutes used on all runner machines. - required: - - total_minutes_used - - total_paid_minutes_used - - included_minutes - - minutes_used_breakdown - packages-billing-usage: - type: object - properties: - total_gigabytes_bandwidth_used: - type: integer - description: Sum of the free and paid storage space (GB) for GitHuub Packages. - total_paid_gigabytes_bandwidth_used: - type: integer - description: Total paid storage space (GB) for GitHuub Packages. - included_gigabytes_bandwidth: - type: integer - description: Free storage space (GB) for GitHub Packages. - required: - - total_gigabytes_bandwidth_used - - total_paid_gigabytes_bandwidth_used - - included_gigabytes_bandwidth - combined-billing-usage: - type: object - properties: - days_left_in_billing_cycle: - type: integer - description: Numbers of days left in billing cycle. - estimated_paid_storage_for_month: - type: integer - description: Estimated storage space (GB) used in billing cycle. - estimated_storage_for_month: - type: integer - description: Estimated sum of free and paid storage space (GB) used in billing - cycle. - required: - - days_left_in_billing_cycle - - estimated_paid_storage_for_month - - estimated_storage_for_month - team-organization: - title: Team Organization - description: Team Organization + full-repository: + title: Full Repository + description: Full Repository type: object properties: - login: - type: string - example: github id: type: integer - example: 1 + example: 1296269 node_id: type: string - example: MDEyOk9yZ2FuaXphdGlvbjE= + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + type: string + example: Hello-World + full_name: + type: string + example: octocat/Hello-World + owner: + "$ref": "#/components/schemas/simple-user" + private: + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean url: type: string format: uri - example: https://api.github.com/orgs/github - repos_url: + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: type: string format: uri - example: https://api.github.com/orgs/github/repos + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri - example: https://api.github.com/orgs/github/events - hooks_url: + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: type: string - example: https://api.github.com/orgs/github/hooks + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string - example: https://api.github.com/orgs/github/issues - members_url: + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: type: string - example: https://api.github.com/orgs/github/members{/member} - public_members_url: + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: type: string - example: https://api.github.com/orgs/github/public_members{/member} - avatar_url: + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: type: string - example: https://github.com/images/error/octocat_happy.gif - description: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: type: string - example: A great organization - nullable: true - name: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: type: string - example: github - company: + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: type: string - example: GitHub - blog: + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: type: string format: uri - example: https://github.com/blog - location: + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: type: string - example: San Francisco - email: + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: type: string - format: email - example: octocat@github.com - twitter_username: + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: type: string - example: github + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World nullable: true - is_verified: - type: boolean - example: true - has_organization_projects: - type: boolean - example: true - has_repository_projects: - type: boolean - example: true - public_repos: - type: integer - example: 2 - public_gists: - type: integer - example: 1 - followers: - type: integer - example: 20 - following: - type: integer - example: 0 - html_url: + hooks_url: type: string format: uri - example: https://github.com/octocat - created_at: + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: type: string - format: date-time - example: '2008-01-14T04:33:35Z' - type: + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: type: string - example: Organization - total_private_repos: - type: integer - example: 100 - owned_private_repos: + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: type: integer - example: 100 - private_gists: + example: 9 + stargazers_count: type: integer - example: 81 - nullable: true - disk_usage: + example: 80 + watchers_count: type: integer - example: 10000 - nullable: true - collaborators: + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated + hourly. When a repository is initially created, the size is 0. type: integer - example: 8 - nullable: true - billing_email: - type: string - format: email - example: org@example.com - nullable: true - plan: - type: object - properties: - name: - type: string - space: - type: integer - private_repos: - type: integer - filled_seats: - type: integer - seats: - type: integer - required: - - name - - space - - private_repos - default_repository_permission: + example: 108 + default_branch: type: string - nullable: true - members_can_create_repositories: - type: boolean - example: true - nullable: true - two_factor_requirement_enabled: + example: master + open_issues_count: + type: integer + example: 0 + is_template: type: boolean example: true - nullable: true - members_allowed_repository_creation_type: - type: string - example: all - members_can_create_public_repositories: + topics: + type: array + items: + type: string + example: + - octocat + - atom + - electron + - API + has_issues: type: boolean example: true - members_can_create_private_repositories: + has_projects: type: boolean example: true - members_can_create_internal_repositories: + has_wiki: type: boolean example: true - members_can_create_pages: + has_pages: type: boolean - example: true - members_can_create_public_pages: + has_downloads: type: boolean example: true - members_can_create_private_pages: + has_discussions: type: boolean example: true - members_can_fork_private_repositories: + archived: type: boolean - example: false - nullable: true - web_commit_signoff_required: + disabled: type: boolean - example: false - updated_at: + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' type: string - format: date-time - archived_at: + example: public + pushed_at: type: string format: date-time - nullable: true - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - - html_url - - has_organization_projects - - has_repository_projects - - public_repos - - public_gists - - followers - - following - - type - - created_at - - updated_at - - archived_at - team-full: - title: Full Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - id: - description: Unique identifier of the team - example: 42 - type: integer - node_id: - type: string - example: MDQ6VGVhbTE= - url: - description: URL for the team - example: https://api.github.com/organizations/1/team/1 - type: string - format: uri - html_url: - type: string - format: uri - example: https://github.com/orgs/rails/teams/core - name: - description: Name of the team - example: Developers + example: '2011-01-26T19:06:43Z' + created_at: type: string - slug: + format: date-time + example: '2011-01-26T19:01:12Z' + updated_at: type: string - example: justice-league - description: + format: date-time + example: '2011-01-26T19:14:43Z' + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + required: + - admin + - pull + - push + allow_rebase_merge: + type: boolean + example: true + template_repository: + "$ref": "#/components/schemas/nullable-repository" + temp_clone_token: type: string - example: A great team. nullable: true - privacy: - description: The level of privacy this team should have + allow_squash_merge: + type: boolean + example: true + allow_auto_merge: + type: boolean + example: false + delete_branch_on_merge: + type: boolean + example: false + allow_merge_commit: + type: boolean + example: true + allow_update_branch: + type: boolean + example: true + use_squash_pr_title_as_default: + type: boolean + example: false + squash_merge_commit_title: type: string + example: PR_TITLE enum: - - closed - - secret - example: closed - notification_setting: - description: The notification setting the team has set + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: type: string + example: PR_BODY enum: - - notifications_enabled - - notifications_disabled - example: notifications_enabled - permission: - description: Permission that the team will have for its repositories - example: push - type: string - members_url: - type: string - example: https://api.github.com/organizations/1/team/1/members{/member} - repositories_url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/1/repos - parent: - "$ref": "#/components/schemas/nullable-team-simple" - members_count: - type: integer - example: 3 - repos_count: - type: integer - example: 10 - created_at: - type: string - format: date-time - example: '2017-07-14T16:53:42Z' - updated_at: - type: string - format: date-time - example: '2017-08-17T12:37:15Z' - organization: - "$ref": "#/components/schemas/team-organization" - 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 - - created_at - - updated_at - - members_count - - repos_count - - organization - team-discussion: - title: Team Discussion - description: A team discussion is a persistent record of a free-form conversation - within a team. - type: object - properties: - author: - "$ref": "#/components/schemas/nullable-simple-user" - body: - description: The main text of the discussion. - example: Please suggest improvements to our workflow in comments. - type: string - body_html: - type: string - example: "

Hi! This is an area for us to collaborate as a team

" - body_version: - description: The current version of the body content. If provided, this - update operation will be rejected if the given version does not match - the latest version on the server. - example: 0307116bbf7ced493b8d8a346c650b71 - type: string - comments_count: - type: integer - example: 0 - comments_url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments - created_at: - type: string - format: date-time - example: '2018-01-25T18:56:31Z' - last_edited_at: - type: string - format: date-time - nullable: true - html_url: - type: string - format: uri - example: https://github.com/orgs/github/teams/justice-league/discussions/1 - node_id: - type: string - example: MDE0OlRlYW1EaXNjdXNzaW9uMQ== - number: - description: The unique sequence number of a team discussion. - example: 42 - type: integer - pinned: - description: Whether or not this discussion should be pinned for easy retrieval. - example: true - type: boolean - private: - description: Whether or not this discussion should be restricted to team - members and organization owners. - example: true - type: boolean - team_url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/2343027 - title: - description: The title of the discussion. - example: How can we improve our workflow? - type: string - updated_at: - type: string - format: date-time - example: '2018-01-25T18:56:31Z' - url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: - "$ref": "#/components/schemas/reaction-rollup" - required: - - author - - body - - body_html - - body_version - - comments_count - - comments_url - - created_at - - last_edited_at - - html_url - - pinned - - private - - node_id - - number - - team_url - - title - - updated_at - - url - team-discussion-comment: - title: Team Discussion Comment - description: A reply to a discussion within a team. - type: object - properties: - author: - "$ref": "#/components/schemas/nullable-simple-user" - body: - description: The main text of the comment. - example: I agree with this suggestion. - type: string - body_html: - type: string - example: "

Do you like apples?

" - body_version: - description: The current version of the body content. If provided, this - update operation will be rejected if the given version does not match - the latest version on the server. - example: 0307116bbf7ced493b8d8a346c650b71 - type: string - created_at: - type: string - format: date-time - example: '2018-01-15T23:53:58Z' - last_edited_at: - type: string - format: date-time - nullable: true - discussion_url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/2403582/discussions/1 - html_url: - type: string - format: uri - example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 - node_id: - type: string - example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= - number: - description: The unique sequence number of a team discussion comment. - example: 42 - type: integer - updated_at: - type: string - format: date-time - example: '2018-01-15T23:53:58Z' - url: - type: string - format: uri - example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: - "$ref": "#/components/schemas/reaction-rollup" - required: - - author - - body - - body_html - - body_version - - created_at - - last_edited_at - - discussion_url - - html_url - - node_id - - number - - updated_at - - url - reaction: - title: Reaction - description: Reactions to conversations provide a way to help people express - their feelings more simply and effectively. - type: object - properties: - id: - type: integer - example: 1 - node_id: - type: string - example: MDg6UmVhY3Rpb24x - user: - "$ref": "#/components/schemas/nullable-simple-user" - content: - description: The reaction to use - example: heart - type: string - enum: - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - rocket - - eyes - created_at: - type: string - format: date-time - example: '2016-05-20T20:09:31Z' - required: - - id - - node_id - - user - - content - - created_at - team-membership: - title: Team Membership - description: Team Membership - type: object - properties: - url: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: type: string - format: uri - role: - description: The role of the user in the team. + example: PR_TITLE enum: - - member - - maintainer - default: member - example: member - type: string - state: - description: The state of the user's membership in the team. + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: type: string + example: PR_BODY enum: - - active - - pending - required: - - role - - state - - url - team-project: - title: Team Project - description: A team's access to a project. - type: object - properties: - owner_url: - type: string - url: - type: string - html_url: - type: string - columns_url: - type: string - id: - type: integer - node_id: - type: string - name: - type: string - body: - type: string - nullable: true - number: - type: integer - state: - type: string - creator: - "$ref": "#/components/schemas/simple-user" - created_at: - type: string - updated_at: - type: string - organization_permission: - description: The organization permission for this project. Only present - when owner is an organization. - type: string - private: - description: Whether the project is private or not. Only present when owner - is an organization. - type: boolean - permissions: - type: object - properties: - read: - type: boolean - write: - type: boolean - admin: - type: boolean - required: - - read - - write - - admin - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at - - permissions - team-repository: - title: Team Repository - description: A team's access to a repository. - type: object - properties: - id: - description: Unique identifier of the repository - example: 42 - type: integer - node_id: - type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: - description: The name of the repository. - type: string - example: Team Environment - full_name: - type: string - example: octocat/Hello-World - license: - "$ref": "#/components/schemas/nullable-license-simple" - forks: - type: integer - permissions: - type: object - properties: - admin: - type: boolean - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - required: - - admin - - pull - - push - role_name: - type: string - example: admin - owner: - "$ref": "#/components/schemas/nullable-simple-user" - private: - description: Whether the repository is private or public. - default: false - type: boolean - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World - description: - type: string - example: This your first repo! - nullable: true - fork: - type: boolean - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World - archive_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/downloads - events_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/events - forks_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: - type: string - example: git:github.com/octocat/Hello-World.git - issue_comment_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/languages - merges_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/merges - milestones_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: - type: string - example: git@github.com:octocat/Hello-World.git - stargazers_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscription - tags_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/tags - teams_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/teams - trees_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: - type: string - example: https://github.com/octocat/Hello-World.git - mirror_url: - type: string - format: uri - example: git:git.example.com/octocat/Hello-World - nullable: true - hooks_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/hooks - svn_url: - type: string - format: uri - example: https://svn.github.com/octocat/Hello-World - homepage: - type: string - format: uri - example: https://github.com - nullable: true - language: - type: string - nullable: true - forks_count: - type: integer - example: 9 - stargazers_count: - type: integer - example: 80 - watchers_count: - type: integer - example: 80 - size: - type: integer - example: 108 - default_branch: - description: The default branch of the repository. - type: string - example: master - open_issues_count: - type: integer - example: 0 - is_template: - description: Whether this repository acts as a template that can be used - to generate new repositories. - default: false - type: boolean - example: true - topics: - type: array - items: - type: string - has_issues: - description: Whether issues are enabled. - default: true - type: boolean - example: true - has_projects: - description: Whether projects are enabled. - default: true - type: boolean - example: true - has_wiki: - description: Whether the wiki is enabled. - default: true - type: boolean - example: true - has_pages: - type: boolean - has_downloads: - description: Whether downloads are enabled. - default: true - type: boolean - example: true - archived: - description: Whether the repository is archived. - default: false - type: boolean - disabled: - type: boolean - description: Returns whether or not this repository disabled. - visibility: - description: 'The repository visibility: public, private, or internal.' - default: public - type: string - pushed_at: - type: string - format: date-time - example: '2011-01-26T19:06:43Z' - nullable: true - created_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - nullable: true - updated_at: - type: string - format: date-time - example: '2011-01-26T19:14:43Z' - nullable: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - default: true - type: boolean - example: true - temp_clone_token: - type: string - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - default: true - type: boolean - example: true - allow_auto_merge: - description: Whether to allow Auto-merge to be used on pull requests. - default: false - type: boolean - example: false - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are merged - default: false - type: boolean - example: false - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - default: true - type: boolean - example: true + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. allow_forking: - description: Whether to allow forking this repo - default: false type: boolean - example: false + example: true web_commit_signoff_required: - description: Whether to require contributors to sign off on web-based commits - default: false type: boolean example: false subscribers_count: type: integer + example: 42 network_count: type: integer + example: 0 + license: + "$ref": "#/components/schemas/nullable-license-simple" + organization: + "$ref": "#/components/schemas/nullable-simple-user" + parent: + "$ref": "#/components/schemas/repository" + source: + "$ref": "#/components/schemas/repository" + forks: + type: integer + master_branch: + type: string open_issues: type: integer watchers: type: integer - master_branch: - type: string + anonymous_access_enabled: + description: Whether anonymous git access is allowed. + default: true + type: boolean + code_of_conduct: + "$ref": "#/components/schemas/code-of-conduct-simple" + security_and_analysis: + "$ref": "#/components/schemas/security-and-analysis" + custom_properties: + type: object + description: The custom properties that were defined for the repository. + The keys are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true required: - archive_url - assignees_url @@ -71655,11 +71411,11 @@ components: - forks - forks_count - git_url - - has_downloads - has_issues - has_projects - has_wiki - has_pages + - has_discussions - homepage - language - archived @@ -71677,1321 +71433,2352 @@ components: - watchers_count - created_at - updated_at - project-card: - title: Project Card - description: Project cards represent a scope of work. + - network_count + - subscribers_count + repository-rule-enforcement: + type: string + description: The enforcement level of the ruleset. `evaluate` allows admins + to test rules before enforcing them. Admins can view insights on the Rule + Insights page (`evaluate` is only available with GitHub Enterprise). + enum: + - disabled + - active + - evaluate + repository-ruleset-bypass-actor: + title: Repository Ruleset Bypass Actor type: object + description: An actor that can bypass rules in a ruleset + required: + - actor_type + - bypass_mode properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/cards/1478 - id: - description: The project card's ID - example: 42 + actor_id: type: integer - node_id: - type: string - example: MDExOlByb2plY3RDYXJkMTQ3OA== - note: - type: string - example: Add payload for delete Project column nullable: true - creator: - "$ref": "#/components/schemas/nullable-simple-user" - created_at: - type: string - format: date-time - example: '2016-09-05T14:21:06Z' - updated_at: - type: string - format: date-time - example: '2016-09-05T14:20:22Z' - archived: - description: Whether or not the card is archived - example: false - type: boolean - column_name: - type: string - project_id: - type: string - column_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - content_url: + description: 'The ID of the actor that can bypass a ruleset. If `actor_type` + is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, + this should be null. `OrganizationAdmin` is not applicable for personal + repositories. + + ' + actor_type: type: string - format: uri - example: https://api.github.com/repos/api-playground/projects-test/issues/3 - project_url: + enum: + - Integration + - OrganizationAdmin + - RepositoryRole + - Team + - DeployKey + description: 'The type of actor that can bypass a ruleset. + + ' + bypass_mode: type: string - format: uri - example: https://api.github.com/projects/120 + description: 'When the specified actor can bypass the ruleset. `pull_request` + means that an actor can only bypass rules on pull requests. `pull_request` + is not applicable for the `DeployKey` actor type. + + ' + enum: + - always + - pull_request + repository-ruleset-conditions: + title: Repository ruleset conditions for ref names + type: object + description: Parameters for a repository ruleset ref name condition + properties: + ref_name: + type: object + properties: + include: + type: array + description: Array of ref names or patterns to include. One of these + patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` + to include the default branch or `~ALL` to include all branches. + items: + type: string + exclude: + type: array + description: Array of ref names or patterns to exclude. The condition + will not pass if any of these patterns match. + items: + type: string + repository-ruleset-conditions-repository-name-target: + title: Repository ruleset conditions for repository names + type: object + description: Parameters for a repository name condition + properties: + repository_name: + type: object + properties: + include: + type: array + description: Array of repository names or patterns to include. One of + these patterns must match for the condition to pass. Also accepts + `~ALL` to include all repositories. + items: + type: string + exclude: + type: array + description: Array of repository names or patterns to exclude. The condition + will not pass if any of these patterns match. + items: + type: string + protected: + type: boolean + description: Whether renaming of target repositories is prevented. required: - - id - - node_id - - note - - url - - column_url - - project_url - - creator - - created_at - - updated_at - project-column: - title: Project Column - description: Project columns contain cards of work. + - repository_name + repository-ruleset-conditions-repository-id-target: + title: Repository ruleset conditions for repository IDs type: object + description: Parameters for a repository ID condition + properties: + repository_id: + type: object + properties: + repository_ids: + type: array + description: The repository IDs that the ruleset applies to. One of + these IDs must match for the condition to pass. + items: + type: integer + required: + - repository_id + repository-ruleset-conditions-repository-property-spec: + title: Repository ruleset property targeting definition + type: object + description: Parameters for a targeting a repository property properties: - url: - type: string - format: uri - example: https://api.github.com/projects/columns/367 - project_url: - type: string - format: uri - example: https://api.github.com/projects/120 - cards_url: - type: string - format: uri - example: https://api.github.com/projects/columns/367/cards - id: - description: The unique identifier of the project column - example: 42 - type: integer - node_id: - type: string - example: MDEzOlByb2plY3RDb2x1bW4zNjc= name: - description: Name of the project column - example: Remaining tasks - type: string - created_at: - type: string - format: date-time - example: '2016-09-05T14:18:44Z' - updated_at: type: string - format: date-time - example: '2016-09-05T14:22:28Z' + description: The name of the repository property to target + property_values: + type: array + description: The values to match for the repository property + items: + type: string required: - - id - - node_id - - url - - project_url - - cards_url - name - - created_at - - updated_at - project-collaborator-permission: - title: Project Collaborator Permission - description: Project Collaborator Permission + - property_values + repository-ruleset-conditions-repository-property-target: + title: Repository ruleset conditions for repository properties type: object + description: Parameters for a repository property condition properties: - permission: - type: string - user: - "$ref": "#/components/schemas/nullable-simple-user" + repository_property: + type: object + properties: + include: + type: array + description: The repository properties and values to include. All of + these properties must match for the condition to pass. + items: + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + exclude: + type: array + description: The repository properties and values to exclude. The condition + will not pass if any of these properties match. + items: + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" required: - - permission - - user - rate-limit: - title: Rate Limit + - repository_property + org-ruleset-conditions: + title: Organization ruleset conditions + type: object + description: 'Conditions for an organization ruleset. The conditions object + should contain both `repository_name` and `ref_name` properties or both `repository_id` + and `ref_name` properties. + + ' + oneOf: + - type: object + title: repository_name_and_ref_name + description: Conditions to target repositories by name and refs by name + allOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + - type: object + title: repository_id_and_ref_name + description: Conditions to target repositories by id and refs by name + allOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" + - type: object + title: repository_property_and_ref_name + description: Conditions to target repositories by property and refs by name + allOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + repository-rule-creation: + title: creation + description: Only allow users with bypass permission to create matching refs. type: object - properties: - limit: - type: integer - remaining: - type: integer - reset: - type: integer - used: - type: integer required: - - limit - - remaining - - reset - - used - rate-limit-overview: - title: Rate Limit Overview - description: Rate Limit Overview + - type + properties: + type: + type: string + enum: + - creation + repository-rule-update: + title: update + description: Only allow users with bypass permission to update matching refs. type: object + required: + - type properties: - resources: + type: + type: string + enum: + - update + parameters: type: object properties: - core: - "$ref": "#/components/schemas/rate-limit" - graphql: - "$ref": "#/components/schemas/rate-limit" - search: - "$ref": "#/components/schemas/rate-limit" - code_search: - "$ref": "#/components/schemas/rate-limit" - source_import: - "$ref": "#/components/schemas/rate-limit" - integration_manifest: - "$ref": "#/components/schemas/rate-limit" - code_scanning_upload: - "$ref": "#/components/schemas/rate-limit" - actions_runner_registration: - "$ref": "#/components/schemas/rate-limit" - scim: - "$ref": "#/components/schemas/rate-limit" - dependency_snapshots: - "$ref": "#/components/schemas/rate-limit" + update_allows_fetch_and_merge: + type: boolean + description: Branch can pull changes from its upstream repository required: - - core - - search - rate: - "$ref": "#/components/schemas/rate-limit" - required: - - rate - - resources - nullable-repository: - title: Repository - description: A repository on GitHub. + - update_allows_fetch_and_merge + repository-rule-deletion: + title: deletion + description: Only allow users with bypass permissions to delete matching refs. type: object + required: + - type properties: - id: - description: Unique identifier of the repository - example: 42 - type: integer - node_id: + type: type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: - description: The name of the repository. + enum: + - deletion + repository-rule-required-linear-history: + title: required_linear_history + description: Prevent merge commits from being pushed to matching refs. + type: object + required: + - type + properties: + type: type: string - example: Team Environment - full_name: + enum: + - required_linear_history + repository-rule-required-deployments: + title: required_deployments + description: Choose which environments must be successfully deployed to before + refs can be pushed into a ref that matches this rule. + type: object + required: + - type + properties: + type: type: string - example: octocat/Hello-World - license: - "$ref": "#/components/schemas/nullable-license-simple" - organization: - "$ref": "#/components/schemas/nullable-simple-user" - forks: - type: integer - permissions: + enum: + - required_deployments + parameters: type: object properties: - admin: - type: boolean - pull: + required_deployment_environments: + type: array + description: The environments that must be successfully deployed to + before branches can be merged. + items: + type: string + required: + - required_deployment_environments + repository-rule-required-signatures: + title: required_signatures + description: Commits pushed to matching refs must have verified signatures. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_signatures + repository-rule-pull-request: + title: pull_request + description: Require all commits be made to a non-target branch and submitted + via a pull request before they can be merged. + type: object + required: + - type + properties: + type: + type: string + enum: + - pull_request + parameters: + type: object + properties: + dismiss_stale_reviews_on_push: type: boolean - triage: + description: New, reviewable commits pushed will dismiss previous pull + request review approvals. + require_code_owner_review: type: boolean - push: + description: Require an approving review in pull requests that modify + files that have a designated code owner. + require_last_push_approval: type: boolean - maintain: + description: Whether the most recent reviewable push must be approved + by someone other than the person who pushed it. + required_approving_review_count: + type: integer + description: The number of approving reviews that are required before + a pull request can be merged. + minimum: 0 + maximum: 10 + required_review_thread_resolution: type: boolean + description: All conversations on code must be resolved before a pull + request can be merged. required: - - admin - - pull - - push - owner: - "$ref": "#/components/schemas/simple-user" - private: - description: Whether the repository is private or public. - default: false - type: boolean - html_url: - type: string - format: uri - example: https://github.com/octocat/Hello-World - description: - type: string - example: This your first repo! - nullable: true - fork: - type: boolean - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World - archive_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: + - dismiss_stale_reviews_on_push + - require_code_owner_review + - require_last_push_approval + - required_approving_review_count + - required_review_thread_resolution + repository-rule-params-status-check-configuration: + title: StatusCheckConfiguration + description: Required status check + type: object + properties: + context: type: string - example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: + description: The status check context name that must be present on the commit. + integration_id: + type: integer + description: The optional integration ID that this status check must originate + from. + required: + - context + repository-rule-required-status-checks: + title: required_status_checks + description: Choose which status checks must pass before the ref is updated. + When enabled, commits must first be pushed to another ref where the checks + pass. + type: object + required: + - type + properties: + type: type: string - example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: + enum: + - required_status_checks + parameters: + type: object + properties: + required_status_checks: + type: array + description: Status checks that are required. + items: + "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" + strict_required_status_checks_policy: + type: boolean + description: Whether pull requests targeting a matching branch must + be tested with the latest code. This setting will not take effect + unless at least one status check is enabled. + required: + - required_status_checks + - strict_required_status_checks_policy + repository-rule-non-fast-forward: + title: non_fast_forward + description: Prevent users with push access from force pushing to refs. + type: object + required: + - type + properties: + type: type: string - example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: + enum: + - non_fast_forward + repository-rule-commit-message-pattern: + title: commit_message_pattern + description: Parameters to be used for the commit_message_pattern rule + type: object + required: + - type + properties: + type: type: string - example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: + enum: + - commit_message_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-commit-author-email-pattern: + title: commit_author_email_pattern + description: Parameters to be used for the commit_author_email_pattern rule + type: object + required: + - type + properties: + type: type: string - example: http://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: + enum: + - commit_author_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-committer-email-pattern: + title: committer_email_pattern + description: Parameters to be used for the committer_email_pattern rule + type: object + required: + - type + properties: + type: type: string - example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: + enum: + - committer_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-branch-name-pattern: + title: branch_name_pattern + description: Parameters to be used for the branch_name_pattern rule + type: object + required: + - type + properties: + type: type: string - example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: + enum: + - branch_name_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-tag-name-pattern: + title: tag_name_pattern + description: Parameters to be used for the tag_name_pattern rule + type: object + required: + - type + properties: + type: type: string - example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: + enum: + - tag_name_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-params-restricted-commits: + title: RestrictedCommits + description: Restricted commit + type: object + properties: + oid: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: + description: Full or abbreviated commit hash to reject + reason: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: + description: Reason for restriction + required: + - oid + repository-rule-params-workflow-file-reference: + title: WorkflowFileReference + description: A workflow that must run for this rule to pass + type: object + properties: + path: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/downloads - events_url: + description: The path to the workflow file + ref: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/events - forks_url: + description: The ref (branch or tag) of the workflow file to use + repository_id: + type: integer + description: The ID of the repository where the workflow is defined + sha: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: + description: The commit SHA of the workflow file to use + required: + - path + - repository_id + repository-rule-workflows: + title: workflows + description: Require all changes made to a targeted branch to pass the specified + workflows before they can be merged. + type: object + required: + - type + properties: + type: type: string - example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: + enum: + - workflows + parameters: + type: object + properties: + workflows: + type: array + description: Workflows that must pass for this rule to pass. + items: + "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" + required: + - workflows + repository-rule-params-code-scanning-tool: + title: CodeScanningTool + description: A tool that must provide code scanning results for this rule to + pass. + type: object + properties: + alerts_threshold: type: string - example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: + description: The severity level at which code scanning results that raise + alerts block a reference update. For more information on alert severity + levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - errors + - errors_and_warnings + - all + security_alerts_threshold: type: string - example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: + description: The severity level at which code scanning results that raise + security alerts block a reference update. For more information on security + severity levels, see "[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - critical + - high_or_higher + - medium_or_higher + - all + tool: type: string - example: git:github.com/octocat/Hello-World.git - issue_comment_url: + description: The name of a code scanning tool + required: + - alerts_threshold + - security_alerts_threshold + - tool + repository-rule: + title: Repository Rule + type: object + description: A repository rule. + oneOf: + - "$ref": "#/components/schemas/repository-rule-creation" + - "$ref": "#/components/schemas/repository-rule-update" + - "$ref": "#/components/schemas/repository-rule-deletion" + - "$ref": "#/components/schemas/repository-rule-required-linear-history" + - "$ref": "#/components/schemas/repository-rule-required-deployments" + - "$ref": "#/components/schemas/repository-rule-required-signatures" + - "$ref": "#/components/schemas/repository-rule-pull-request" + - "$ref": "#/components/schemas/repository-rule-required-status-checks" + - "$ref": "#/components/schemas/repository-rule-non-fast-forward" + - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + - title: file_path_restriction + description: |- + Note: file_path_restriction is in beta and subject to change. + + Prevent commits that include changes in specified file paths from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted from being pushed + to the commit graph. + items: + type: string + required: + - restricted_file_paths + - title: max_file_path_length + description: |- + Note: max_file_path_length is in beta and subject to change. + + Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed in file paths + minimum: 1 + maximum: 256 + required: + - max_file_path_length + - title: file_extension_restriction + description: |- + Note: file_extension_restriction is in beta and subject to change. + + Prevent commits that include files with specified file extensions from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted from being pushed + to the commit graph. + items: + type: string + required: + - restricted_file_extensions + - title: max_file_size + description: |- + Note: max_file_size is in beta and subject to change. + + Prevent commits that exceed a specified file size limit from being pushed to the commit. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. This limit + does not apply to Git Large File Storage (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size + - "$ref": "#/components/schemas/repository-rule-workflows" + repository-ruleset: + title: Repository ruleset + type: object + description: A set of rules to apply when specified conditions are met. + required: + - id + - name + - source + - enforcement + properties: + id: + type: integer + description: The ID of the ruleset + name: type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: + description: The name of the ruleset + target: type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: + description: |- + The target of the ruleset + + **Note**: The `push` target is in beta and is subject to change. + enum: + - branch + - tag + - push + source_type: type: string - example: http://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: + description: The type of the source of the ruleset + enum: + - Repository + - Organization + source: type: string - example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: + description: The name of the source + enforcement: + "$ref": "#/components/schemas/repository-rule-enforcement" + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + current_user_can_bypass: type: string - example: http://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: + description: |- + The bypass type of the user making the API request for this ruleset. This field is only returned when + querying the repository-level endpoint. + enum: + - always + - pull_requests_only + - never + node_id: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/languages - merges_url: + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + description: The URL of the ruleset + html: + type: object + properties: + href: + type: string + description: The html URL of the ruleset + conditions: + nullable: true + anyOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/org-ruleset-conditions" + rules: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + created_at: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/merges - milestones_url: + format: date-time + updated_at: type: string - example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: + format: date-time + rule-suites: + title: Rule Suites + description: Response + type: array + items: + type: object + properties: + id: + type: integer + description: The unique identifier of the rule insight. + actor_id: + type: integer + description: The number that identifies the user. + actor_name: + type: string + description: The handle for the GitHub user account. + before_sha: + type: string + description: The first commit sha before the push evaluation. + after_sha: + type: string + description: The last commit sha in the push evaluation. + ref: + type: string + description: The ref name that the evaluation ran on. + repository_id: + type: integer + description: The ID of the repository associated with the rule evaluation. + repository_name: + type: string + description: The name of the repository without the `.git` extension. + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + result: + type: string + enum: + - pass + - fail + - bypass + description: The result of the rule evaluations for rules with the `active` + enforcement status. + evaluation_result: + type: string + enum: + - pass + - fail + description: The result of the rule evaluations for rules with the `active` + and `evaluate` enforcement statuses, demonstrating whether rules would + pass or fail if all rules in the rule suite were `active`. + rule-suite: + title: Rule Suite + description: Response + type: object + properties: + id: + type: integer + description: The unique identifier of the rule insight. + actor_id: + type: integer + description: The number that identifies the user. + nullable: true + actor_name: type: string - example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: + description: The handle for the GitHub user account. + nullable: true + before_sha: type: string - example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: + description: The first commit sha before the push evaluation. + after_sha: type: string - example: http://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: + description: The last commit sha in the push evaluation. + ref: type: string - example: git@github.com:octocat/Hello-World.git - stargazers_url: + description: The ref name that the evaluation ran on. + repository_id: + type: integer + description: The ID of the repository associated with the rule evaluation. + repository_name: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: + description: The name of the repository without the `.git` extension. + pushed_at: type: string - example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: + format: date-time + example: '2011-01-26T19:06:43Z' + result: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: + enum: + - pass + - fail + - bypass + description: The result of the rule evaluations for rules with the `active` + enforcement status. + evaluation_result: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscription - tags_url: + enum: + - pass + - fail + description: The result of the rule evaluations for rules with the `active` + and `evaluate` enforcement statuses, demonstrating whether rules would + pass or fail if all rules in the rule suite were `active`. + rule_evaluations: + type: array + description: Details on the evaluated rules. + items: + type: object + properties: + rule_source: + type: object + properties: + type: + type: string + description: The type of rule source. + id: + type: integer + nullable: true + description: The ID of the rule source. + name: + type: string + nullable: true + description: The name of the rule source. + enforcement: + type: string + enum: + - active + - evaluate + - deleted ruleset + description: The enforcement level of this rule source. + result: + type: string + enum: + - pass + - fail + description: The result of the evaluation of the individual rule. + rule_type: + type: string + description: The type of rule. + details: + type: string + description: Any associated details with the rule evaluation. + repository-advisory-vulnerability: + description: A product affected by the vulnerability detailed in a repository + security advisory. + type: object + properties: + package: + description: The name of the package affected by the vulnerability. + type: object + nullable: true + properties: + ecosystem: + "$ref": "#/components/schemas/security-advisory-ecosystems" + name: + type: string + description: The unique package name within its ecosystem. + nullable: true + required: + - ecosystem + - name + vulnerable_version_range: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/tags - teams_url: + description: The range of the package versions affected by the vulnerability. + nullable: true + patched_versions: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/teams - trees_url: + description: The package version(s) that resolve the vulnerability. + nullable: true + vulnerable_functions: + type: array + description: The functions in the package that are affected. + nullable: true + items: + type: string + required: + - package + - vulnerable_version_range + - patched_versions + - vulnerable_functions + additionalProperties: false + repository-advisory-credit: + description: A credit given to a user for a repository security advisory. + type: object + properties: + user: + "$ref": "#/components/schemas/simple-user" + type: + "$ref": "#/components/schemas/security-advisory-credit-types" + state: type: string - example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: + description: The state of the user's acceptance of the credit. + enum: + - accepted + - declined + - pending + required: + - user + - type + - state + additionalProperties: false + repository-advisory: + description: A repository security advisory. + type: object + properties: + ghsa_id: type: string - example: https://github.com/octocat/Hello-World.git - mirror_url: + description: The GitHub Security Advisory ID. + readOnly: true + cve_id: type: string - format: uri - example: git:git.example.com/octocat/Hello-World + description: The Common Vulnerabilities and Exposures (CVE) ID. nullable: true - hooks_url: + url: type: string format: uri - example: http://api.github.com/repos/octocat/Hello-World/hooks - svn_url: + description: The API URL for the advisory. + readOnly: true + html_url: type: string format: uri - example: https://svn.github.com/octocat/Hello-World - homepage: + description: The URL for the advisory. + readOnly: true + summary: type: string - format: uri - example: https://github.com - nullable: true - language: + description: A short summary of the advisory. + maxLength: 1024 + description: type: string + description: A detailed description of what the advisory entails. + maxLength: 65535 nullable: true - forks_count: - type: integer - example: 9 - stargazers_count: - type: integer - example: 80 - watchers_count: - type: integer - example: 80 - size: - description: The size of the repository. Size is calculated hourly. When - a repository is initially created, the size is 0. - type: integer - example: 108 - default_branch: - description: The default branch of the repository. + severity: type: string - example: master - open_issues_count: - type: integer - example: 0 - is_template: - description: Whether this repository acts as a template that can be used - to generate new repositories. - default: false - type: boolean - example: true - topics: + description: The severity of the advisory. + nullable: true + enum: + - critical + - high + - medium + - low + author: + readOnly: true + nullable: true + description: The author of the advisory. + allOf: + - "$ref": "#/components/schemas/simple-user" + publisher: + readOnly: true + nullable: true + description: The publisher of the advisory. + allOf: + - "$ref": "#/components/schemas/simple-user" + identifiers: type: array items: - type: string - has_issues: - description: Whether issues are enabled. - default: true - type: boolean - example: true - has_projects: - description: Whether projects are enabled. - default: true - type: boolean - example: true - has_wiki: - description: Whether the wiki is enabled. - default: true - type: boolean - example: true - has_pages: - type: boolean - has_downloads: - description: Whether downloads are enabled. - default: true - type: boolean - example: true - deprecated: true - has_discussions: - description: Whether discussions are enabled. - default: false - type: boolean - example: true - archived: - description: Whether the repository is archived. - default: false - type: boolean - disabled: - type: boolean - description: Returns whether or not this repository disabled. - visibility: - description: 'The repository visibility: public, private, or internal.' - default: public + type: object + properties: + type: + type: string + description: The type of identifier. + enum: + - CVE + - GHSA + value: + type: string + description: The identifier value. + required: + - type + - value + readOnly: true + state: type: string - pushed_at: + description: The state of the advisory. + enum: + - published + - closed + - withdrawn + - draft + - triage + created_at: type: string format: date-time - example: '2011-01-26T19:06:43Z' + description: The date and time of when the advisory was created, in ISO + 8601 format. + readOnly: true nullable: true - created_at: + updated_at: type: string format: date-time - example: '2011-01-26T19:01:12Z' + description: The date and time of when the advisory was last updated, in + ISO 8601 format. + readOnly: true nullable: true - updated_at: + published_at: type: string format: date-time - example: '2011-01-26T19:14:43Z' + description: The date and time of when the advisory was published, in ISO + 8601 format. + readOnly: true nullable: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - default: true - type: boolean - example: true - template_repository: + closed_at: + type: string + format: date-time + description: The date and time of when the advisory was closed, in ISO 8601 + format. + readOnly: true nullable: true + withdrawn_at: + type: string + format: date-time + description: The date and time of when the advisory was withdrawn, in ISO + 8601 format. + readOnly: true + nullable: true + submission: type: object + nullable: true + readOnly: true properties: - id: - type: integer - node_id: - type: string - name: - type: string - full_name: - type: string - owner: - type: object - properties: - login: - type: string - id: - type: integer - node_id: - type: string - avatar_url: - type: string - gravatar_id: - type: string - url: - type: string - html_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - starred_url: - type: string - subscriptions_url: - type: string - organizations_url: - type: string - repos_url: - type: string - events_url: - type: string - received_events_url: - type: string - type: - type: string - site_admin: - type: boolean - private: - type: boolean - html_url: - type: string - description: - type: string - fork: + accepted: type: boolean - url: - type: string - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - downloads_url: - type: string - events_url: - type: string - forks_url: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - git_url: - type: string - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - notifications_url: - type: string - pulls_url: - type: string - releases_url: - type: string - ssh_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - clone_url: - type: string - mirror_url: - type: string - hooks_url: - type: string - svn_url: - type: string - homepage: - type: string - language: - type: string - forks_count: - type: integer - stargazers_count: - type: integer - watchers_count: - type: integer - size: - type: integer - default_branch: + description: Whether a private vulnerability report was accepted by + the repository's administrators. + readOnly: true + required: + - accepted + vulnerabilities: + type: array + nullable: true + items: + "$ref": "#/components/schemas/repository-advisory-vulnerability" + cvss: + type: object + nullable: true + properties: + vector_string: type: string - open_issues_count: - type: integer - is_template: - type: boolean - topics: - type: array - items: + description: The CVSS vector. + nullable: true + score: + type: number + description: The CVSS score. + minimum: 0 + maximum: 10 + nullable: true + readOnly: true + required: + - vector_string + - score + cwes: + type: array + nullable: true + items: + type: object + properties: + cwe_id: type: string - has_issues: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - has_pages: - type: boolean - has_downloads: - type: boolean - archived: - type: boolean - disabled: - type: boolean - visibility: - type: string - pushed_at: - type: string - created_at: - type: string - updated_at: - type: string - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - allow_rebase_merge: - type: boolean - temp_clone_token: - type: string - allow_squash_merge: - type: boolean - allow_auto_merge: - type: boolean - delete_branch_on_merge: - type: boolean - allow_update_branch: - type: boolean - use_squash_pr_title_as_default: - type: boolean - squash_merge_commit_title: - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - squash_merge_commit_message: - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - merge_commit_title: - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - merge_commit_message: - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - allow_merge_commit: - type: boolean - subscribers_count: - type: integer - network_count: - type: integer - temp_clone_token: - type: string - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - default: true - type: boolean - example: true - allow_auto_merge: - description: Whether to allow Auto-merge to be used on pull requests. - default: false - type: boolean - example: false - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are merged - default: false - type: boolean - example: false - allow_update_branch: - description: Whether or not a pull request head branch that is behind its - base branch can always be updated even if it is not required to be up - to date before merging. - default: false - type: boolean - example: false - use_squash_pr_title_as_default: - type: boolean - description: Whether a squash merge commit can use the pull request title - as default. **This property has been deprecated. Please use `squash_merge_commit_title` - instead. - default: false - deprecated: true - squash_merge_commit_title: - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - squash_merge_commit_message: - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - merge_commit_title: - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - merge_commit_message: - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - default: true - type: boolean - example: true - allow_forking: - description: Whether to allow forking this repo - type: boolean - web_commit_signoff_required: - description: Whether to require contributors to sign off on web-based commits - default: false - type: boolean - subscribers_count: - type: integer - network_count: - type: integer - open_issues: - type: integer - watchers: - type: integer - master_branch: - type: string - starred_at: - type: string - example: '"2020-07-09T00:17:42Z"' - anonymous_access_enabled: - type: boolean - description: Whether anonymous git access is enabled for this repository + description: The Common Weakness Enumeration (CWE) identifier. + name: + type: string + description: The name of the CWE. + readOnly: true + required: + - cwe_id + - name + readOnly: true + cwe_ids: + type: array + description: A list of only the CWE IDs. + nullable: true + items: + type: string + credits: + type: array + nullable: true + items: + type: object + properties: + login: + type: string + description: The username of the user credited. + type: + "$ref": "#/components/schemas/security-advisory-credit-types" + credits_detailed: + type: array + nullable: true + items: + "$ref": "#/components/schemas/repository-advisory-credit" + readOnly: true + collaborating_users: + type: array + description: A list of users that collaborate on the advisory. + nullable: true + items: + "$ref": "#/components/schemas/simple-user" + collaborating_teams: + type: array + description: A list of teams that collaborate on the advisory. + nullable: true + items: + "$ref": "#/components/schemas/team" + private_fork: + readOnly: true + nullable: true + description: A temporary private fork of the advisory's repository for collaborating + on a fix. + allOf: + - "$ref": "#/components/schemas/simple-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 + - ghsa_id + - cve_id - url - - clone_url - - default_branch - - forks - - forks_count - - git_url - - has_downloads - - has_issues - - has_projects - - has_wiki - - has_pages - - homepage - - language - - archived - - disabled - - mirror_url - - open_issues - - open_issues_count - - license - - pushed_at - - size - - ssh_url - - stargazers_count - - svn_url - - watchers - - watchers_count + - html_url + - summary + - description + - severity + - author + - publisher + - identifiers + - state - created_at - updated_at - nullable: true - code-of-conduct-simple: - title: Code Of Conduct Simple - description: Code of Conduct Simple + - published_at + - closed_at + - withdrawn_at + - submission + - vulnerabilities + - cvss + - cwes + - cwe_ids + - credits + - credits_detailed + - collaborating_users + - collaborating_teams + - private_fork + additionalProperties: false + 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/repos/github/docs/community/code_of_conduct - key: + example: https://api.github.com/organizations/1/team/1 + members_url: type: string - example: citizen_code_of_conduct + example: https://api.github.com/organizations/1/team/1/members{/member} name: + description: Name of the team type: string - example: Citizen Code of Conduct - html_url: + example: Justice League + description: + description: Description of the team type: string nullable: true - format: uri - example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: - - url - - key - - name - - html_url - full-repository: - title: Full Repository - description: Full Repository - type: object - properties: - id: - type: integer - example: 1296269 - node_id: + example: A great team. + permission: + description: Permission that the team will have for its repositories type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: + example: admin + privacy: + description: The level of privacy this team should have type: string - example: Hello-World - full_name: + example: closed + notification_setting: + description: The notification setting the team has set type: string - example: octocat/Hello-World - owner: - "$ref": "#/components/schemas/simple-user" - private: - type: boolean + example: notifications_enabled html_url: type: string format: uri - example: https://github.com/octocat/Hello-World - description: - type: string - example: This your first repo! - nullable: true - fork: - type: boolean - url: + example: https://github.com/orgs/rails/teams/core + repositories_url: type: string format: uri - example: https://api.github.com/repos/octocat/Hello-World - archive_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: + example: https://api.github.com/organizations/1/team/1/repos + slug: type: string - example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: + 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 - example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + actions-billing-usage: + type: object + properties: + total_minutes_used: + type: integer + description: The sum of the free and paid GitHub Actions minutes used. + total_paid_minutes_used: + type: integer + description: The total paid GitHub Actions minutes used. + included_minutes: + type: integer + description: The amount of free GitHub Actions minutes available. + minutes_used_breakdown: + type: object + properties: + UBUNTU: + type: integer + description: Total minutes used on Ubuntu runner machines. + MACOS: + type: integer + description: Total minutes used on macOS runner machines. + WINDOWS: + type: integer + description: Total minutes used on Windows runner machines. + ubuntu_4_core: + type: integer + description: Total minutes used on Ubuntu 4 core runner machines. + ubuntu_8_core: + type: integer + description: Total minutes used on Ubuntu 8 core runner machines. + ubuntu_16_core: + type: integer + description: Total minutes used on Ubuntu 16 core runner machines. + ubuntu_32_core: + type: integer + description: Total minutes used on Ubuntu 32 core runner machines. + ubuntu_64_core: + type: integer + description: Total minutes used on Ubuntu 64 core runner machines. + windows_4_core: + type: integer + description: Total minutes used on Windows 4 core runner machines. + windows_8_core: + type: integer + description: Total minutes used on Windows 8 core runner machines. + windows_16_core: + type: integer + description: Total minutes used on Windows 16 core runner machines. + windows_32_core: + type: integer + description: Total minutes used on Windows 32 core runner machines. + windows_64_core: + type: integer + description: Total minutes used on Windows 64 core runner machines. + macos_12_core: + type: integer + description: Total minutes used on macOS 12 core runner machines. + total: + type: integer + description: Total minutes used on all runner machines. + required: + - total_minutes_used + - total_paid_minutes_used + - included_minutes + - minutes_used_breakdown + packages-billing-usage: + type: object + properties: + total_gigabytes_bandwidth_used: + type: integer + description: Sum of the free and paid storage space (GB) for GitHuub Packages. + total_paid_gigabytes_bandwidth_used: + type: integer + description: Total paid storage space (GB) for GitHuub Packages. + included_gigabytes_bandwidth: + type: integer + description: Free storage space (GB) for GitHub Packages. + required: + - total_gigabytes_bandwidth_used + - total_paid_gigabytes_bandwidth_used + - included_gigabytes_bandwidth + combined-billing-usage: + type: object + properties: + days_left_in_billing_cycle: + type: integer + description: Numbers of days left in billing cycle. + estimated_paid_storage_for_month: + type: integer + description: Estimated storage space (GB) used in billing cycle. + estimated_storage_for_month: + type: integer + description: Estimated sum of free and paid storage space (GB) used in billing + cycle. + required: + - days_left_in_billing_cycle + - estimated_paid_storage_for_month + - estimated_storage_for_month + team-organization: + title: Team Organization + description: Team Organization + type: object + properties: + login: type: string - example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: + example: github + id: + type: integer + example: 1 + node_id: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: + example: MDEyOk9yZ2FuaXphdGlvbjE= + url: type: string format: uri - example: http://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: + example: https://api.github.com/orgs/github + repos_url: type: string format: uri - example: http://api.github.com/repos/octocat/Hello-World/downloads + example: https://api.github.com/orgs/github/repos events_url: type: string format: uri - example: http://api.github.com/repos/octocat/Hello-World/events - forks_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: - type: string - example: git:github.com/octocat/Hello-World.git - issue_comment_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: + example: https://api.github.com/orgs/github/events + hooks_url: type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + example: https://api.github.com/orgs/github/hooks issues_url: type: string - example: http://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/languages - merges_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/merges - milestones_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: + example: https://api.github.com/orgs/github/issues + members_url: type: string - example: git@github.com:octocat/Hello-World.git - stargazers_url: + example: https://api.github.com/orgs/github/members{/member} + public_members_url: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: + example: https://api.github.com/orgs/github/public_members{/member} + avatar_url: type: string - example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: + example: https://github.com/images/error/octocat_happy.gif + description: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: + example: A great organization + nullable: true + name: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscription - tags_url: + example: github + company: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/tags - teams_url: + example: GitHub + blog: type: string format: uri - example: http://api.github.com/repos/octocat/Hello-World/teams - trees_url: + example: https://github.com/blog + location: type: string - example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: + example: San Francisco + email: type: string - example: https://github.com/octocat/Hello-World.git - mirror_url: + format: email + example: octocat@github.com + twitter_username: type: string - format: uri - example: git:git.example.com/octocat/Hello-World + example: github nullable: true - hooks_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/hooks - svn_url: + is_verified: + type: boolean + example: true + has_organization_projects: + type: boolean + example: true + has_repository_projects: + type: boolean + example: true + public_repos: + type: integer + example: 2 + public_gists: + type: integer + example: 1 + followers: + type: integer + example: 20 + following: + type: integer + example: 0 + html_url: type: string format: uri - example: https://svn.github.com/octocat/Hello-World - homepage: + example: https://github.com/octocat + created_at: type: string - format: uri - example: https://github.com - nullable: true - language: + format: date-time + example: '2008-01-14T04:33:35Z' + type: type: string - nullable: true - forks_count: + example: Organization + total_private_repos: type: integer - example: 9 - stargazers_count: + example: 100 + owned_private_repos: type: integer - example: 80 - watchers_count: + example: 100 + private_gists: type: integer - example: 80 - size: - description: The size of the repository. Size is calculated hourly. When - a repository is initially created, the size is 0. + example: 81 + nullable: true + disk_usage: type: integer - example: 108 - default_branch: - type: string - example: master - open_issues_count: + example: 10000 + nullable: true + collaborators: type: integer - example: 0 - is_template: + example: 8 + nullable: true + billing_email: + type: string + format: email + example: org@example.com + nullable: true + plan: + type: object + properties: + name: + type: string + space: + type: integer + private_repos: + type: integer + filled_seats: + type: integer + seats: + type: integer + required: + - name + - space + - private_repos + default_repository_permission: + type: string + nullable: true + members_can_create_repositories: type: boolean example: true - topics: - type: array - items: - type: string - example: - - octocat - - atom - - electron - - API - has_issues: + nullable: true + two_factor_requirement_enabled: type: boolean example: true - has_projects: + nullable: true + members_allowed_repository_creation_type: + type: string + example: all + members_can_create_public_repositories: type: boolean example: true - has_wiki: + members_can_create_private_repositories: type: boolean example: true - has_pages: + members_can_create_internal_repositories: type: boolean - has_downloads: + example: true + members_can_create_pages: type: boolean example: true - has_discussions: + members_can_create_public_pages: type: boolean example: true - archived: + members_can_create_private_pages: type: boolean - disabled: + example: true + members_can_fork_private_repositories: type: boolean - description: Returns whether or not this repository disabled. - visibility: - description: 'The repository visibility: public, private, or internal.' - type: string - example: public - pushed_at: - type: string - format: date-time - example: '2011-01-26T19:06:43Z' - created_at: + example: false + nullable: true + web_commit_signoff_required: + type: boolean + example: false + updated_at: type: string format: date-time - example: '2011-01-26T19:01:12Z' - updated_at: + archived_at: type: string format: date-time - example: '2011-01-26T19:14:43Z' - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - required: - - admin - - pull - - push - allow_rebase_merge: + nullable: true + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + - html_url + - has_organization_projects + - has_repository_projects + - public_repos + - public_gists + - followers + - following + - type + - created_at + - updated_at + - archived_at + team-full: + title: Full Team + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + example: 42 + type: integer + node_id: + type: string + example: MDQ6VGVhbTE= + url: + description: URL for the team + example: https://api.github.com/organizations/1/team/1 + type: string + format: uri + html_url: + type: string + format: uri + example: https://github.com/orgs/rails/teams/core + name: + description: Name of the team + example: Developers + type: string + slug: + type: string + example: justice-league + description: + type: string + example: A great team. + nullable: true + privacy: + description: The level of privacy this team should have + type: string + enum: + - closed + - secret + example: closed + notification_setting: + description: The notification setting the team has set + type: string + enum: + - notifications_enabled + - notifications_disabled + example: notifications_enabled + permission: + description: Permission that the team will have for its repositories + example: push + type: string + members_url: + type: string + example: https://api.github.com/organizations/1/team/1/members{/member} + repositories_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/1/repos + parent: + "$ref": "#/components/schemas/nullable-team-simple" + members_count: + type: integer + example: 3 + repos_count: + type: integer + example: 10 + created_at: + type: string + format: date-time + example: '2017-07-14T16:53:42Z' + updated_at: + type: string + format: date-time + example: '2017-08-17T12:37:15Z' + organization: + "$ref": "#/components/schemas/team-organization" + 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 + - created_at + - updated_at + - members_count + - repos_count + - organization + team-discussion: + title: Team Discussion + description: A team discussion is a persistent record of a free-form conversation + within a team. + type: object + properties: + author: + "$ref": "#/components/schemas/nullable-simple-user" + body: + description: The main text of the discussion. + example: Please suggest improvements to our workflow in comments. + type: string + body_html: + type: string + example: "

Hi! This is an area for us to collaborate as a team

" + body_version: + description: The current version of the body content. If provided, this + update operation will be rejected if the given version does not match + the latest version on the server. + example: 0307116bbf7ced493b8d8a346c650b71 + type: string + comments_count: + type: integer + example: 0 + comments_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments + created_at: + type: string + format: date-time + example: '2018-01-25T18:56:31Z' + last_edited_at: + type: string + format: date-time + nullable: true + html_url: + type: string + format: uri + example: https://github.com/orgs/github/teams/justice-league/discussions/1 + node_id: + type: string + example: MDE0OlRlYW1EaXNjdXNzaW9uMQ== + number: + description: The unique sequence number of a team discussion. + example: 42 + type: integer + pinned: + description: Whether or not this discussion should be pinned for easy retrieval. + example: true type: boolean + private: + description: Whether or not this discussion should be restricted to team + members and organization owners. example: true - template_repository: - "$ref": "#/components/schemas/nullable-repository" - temp_clone_token: + type: boolean + team_url: type: string + format: uri + example: https://api.github.com/organizations/1/team/2343027 + title: + description: The title of the discussion. + example: How can we improve our workflow? + type: string + updated_at: + type: string + format: date-time + example: '2018-01-25T18:56:31Z' + url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/2343027/discussions/1 + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - author + - body + - body_html + - body_version + - comments_count + - comments_url + - created_at + - last_edited_at + - html_url + - pinned + - private + - node_id + - number + - team_url + - title + - updated_at + - url + team-discussion-comment: + title: Team Discussion Comment + description: A reply to a discussion within a team. + type: object + properties: + author: + "$ref": "#/components/schemas/nullable-simple-user" + body: + description: The main text of the comment. + example: I agree with this suggestion. + type: string + body_html: + type: string + example: "

Do you like apples?

" + body_version: + description: The current version of the body content. If provided, this + update operation will be rejected if the given version does not match + the latest version on the server. + example: 0307116bbf7ced493b8d8a346c650b71 + type: string + created_at: + type: string + format: date-time + example: '2018-01-15T23:53:58Z' + last_edited_at: + type: string + format: date-time nullable: true - allow_squash_merge: + discussion_url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/2403582/discussions/1 + html_url: + type: string + format: uri + example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1 + node_id: + type: string + example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE= + number: + description: The unique sequence number of a team discussion comment. + example: 42 + type: integer + updated_at: + type: string + format: date-time + example: '2018-01-15T23:53:58Z' + url: + type: string + format: uri + example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 + reactions: + "$ref": "#/components/schemas/reaction-rollup" + required: + - author + - body + - body_html + - body_version + - created_at + - last_edited_at + - discussion_url + - html_url + - node_id + - number + - updated_at + - url + reaction: + title: Reaction + description: Reactions to conversations provide a way to help people express + their feelings more simply and effectively. + type: object + properties: + id: + type: integer + example: 1 + node_id: + type: string + example: MDg6UmVhY3Rpb24x + user: + "$ref": "#/components/schemas/nullable-simple-user" + content: + description: The reaction to use + example: heart + type: string + enum: + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - rocket + - eyes + created_at: + type: string + format: date-time + example: '2016-05-20T20:09:31Z' + required: + - id + - node_id + - user + - content + - created_at + team-membership: + title: Team Membership + description: Team Membership + type: object + properties: + url: + type: string + format: uri + role: + description: The role of the user in the team. + enum: + - member + - maintainer + default: member + example: member + type: string + state: + description: The state of the user's membership in the team. + type: string + enum: + - active + - pending + required: + - role + - state + - url + team-project: + title: Team Project + description: A team's access to a project. + type: object + properties: + owner_url: + type: string + url: + type: string + html_url: + type: string + columns_url: + type: string + id: + type: integer + node_id: + type: string + name: + type: string + body: + type: string + nullable: true + number: + type: integer + state: + type: string + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + updated_at: + type: string + organization_permission: + description: The organization permission for this project. Only present + when owner is an organization. + type: string + private: + description: Whether the project is private or not. Only present when owner + is an organization. + type: boolean + permissions: + type: object + properties: + read: + type: boolean + write: + type: boolean + admin: + type: boolean + required: + - read + - write + - admin + required: + - owner_url + - url + - html_url + - columns_url + - id + - node_id + - name + - body + - number + - state + - creator + - created_at + - updated_at + - permissions + team-repository: + title: Team Repository + description: A team's access to a repository. + type: object + properties: + id: + description: Unique identifier of the repository + example: 42 + type: integer + node_id: + type: string + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + "$ref": "#/components/schemas/nullable-license-simple" + forks: + type: integer + permissions: + type: object + properties: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + role_name: + type: string + example: admin + owner: + "$ref": "#/components/schemas/nullable-simple-user" + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false type: boolean example: true - allow_auto_merge: + topics: + type: array + items: + type: string + has_issues: + description: Whether issues are enabled. + default: true type: boolean - example: false - delete_branch_on_merge: + example: true + has_projects: + description: Whether projects are enabled. + default: true type: boolean - example: false - allow_merge_commit: + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true type: boolean example: true - allow_update_branch: + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true type: boolean example: true - use_squash_pr_title_as_default: + archived: + description: Whether the repository is archived. + default: false type: boolean - example: false - squash_merge_commit_title: + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public type: string - example: PR_TITLE - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - squash_merge_commit_message: + pushed_at: type: string - example: PR_BODY - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - merge_commit_title: + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: type: string - example: PR_TITLE - enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - merge_commit_message: + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: type: string - example: PR_BODY - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - allow_forking: + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true type: boolean example: true + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + default: false + type: boolean + example: false web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false type: boolean example: false subscribers_count: type: integer - example: 42 network_count: type: integer - example: 0 - license: - "$ref": "#/components/schemas/nullable-license-simple" - organization: - "$ref": "#/components/schemas/nullable-simple-user" - parent: - "$ref": "#/components/schemas/repository" - source: - "$ref": "#/components/schemas/repository" - forks: - type: integer - master_branch: - type: string open_issues: type: integer watchers: type: integer - anonymous_access_enabled: - description: Whether anonymous git access is allowed. - default: true - type: boolean - code_of_conduct: - "$ref": "#/components/schemas/code-of-conduct-simple" - security_and_analysis: - "$ref": "#/components/schemas/security-and-analysis" + master_branch: + type: string required: - archive_url - assignees_url @@ -73044,11 +73831,11 @@ components: - forks - forks_count - git_url + - has_downloads - has_issues - has_projects - has_wiki - has_pages - - has_discussions - homepage - language - archived @@ -73066,8 +73853,176 @@ components: - watchers_count - created_at - updated_at - - network_count - - subscribers_count + project-card: + title: Project Card + description: Project cards represent a scope of work. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/projects/columns/cards/1478 + id: + description: The project card's ID + example: 42 + type: integer + node_id: + type: string + example: MDExOlByb2plY3RDYXJkMTQ3OA== + note: + type: string + example: Add payload for delete Project column + nullable: true + creator: + "$ref": "#/components/schemas/nullable-simple-user" + created_at: + type: string + format: date-time + example: '2016-09-05T14:21:06Z' + updated_at: + type: string + format: date-time + example: '2016-09-05T14:20:22Z' + archived: + description: Whether or not the card is archived + example: false + type: boolean + column_name: + type: string + project_id: + type: string + column_url: + type: string + format: uri + example: https://api.github.com/projects/columns/367 + content_url: + type: string + format: uri + example: https://api.github.com/repos/api-playground/projects-test/issues/3 + project_url: + type: string + format: uri + example: https://api.github.com/projects/120 + required: + - id + - node_id + - note + - url + - column_url + - project_url + - creator + - created_at + - updated_at + project-column: + title: Project Column + description: Project columns contain cards of work. + type: object + properties: + url: + type: string + format: uri + example: https://api.github.com/projects/columns/367 + project_url: + type: string + format: uri + example: https://api.github.com/projects/120 + cards_url: + type: string + format: uri + example: https://api.github.com/projects/columns/367/cards + id: + description: The unique identifier of the project column + example: 42 + type: integer + node_id: + type: string + example: MDEzOlByb2plY3RDb2x1bW4zNjc= + name: + description: Name of the project column + example: Remaining tasks + type: string + created_at: + type: string + format: date-time + example: '2016-09-05T14:18:44Z' + updated_at: + type: string + format: date-time + example: '2016-09-05T14:22:28Z' + required: + - id + - node_id + - url + - project_url + - cards_url + - name + - created_at + - updated_at + project-collaborator-permission: + title: Project Collaborator Permission + description: Project Collaborator Permission + type: object + properties: + permission: + type: string + user: + "$ref": "#/components/schemas/nullable-simple-user" + required: + - permission + - user + rate-limit: + title: Rate Limit + type: object + properties: + limit: + type: integer + remaining: + type: integer + reset: + type: integer + used: + type: integer + required: + - limit + - remaining + - reset + - used + rate-limit-overview: + title: Rate Limit Overview + description: Rate Limit Overview + type: object + properties: + resources: + type: object + properties: + core: + "$ref": "#/components/schemas/rate-limit" + graphql: + "$ref": "#/components/schemas/rate-limit" + search: + "$ref": "#/components/schemas/rate-limit" + code_search: + "$ref": "#/components/schemas/rate-limit" + source_import: + "$ref": "#/components/schemas/rate-limit" + integration_manifest: + "$ref": "#/components/schemas/rate-limit" + code_scanning_upload: + "$ref": "#/components/schemas/rate-limit" + actions_runner_registration: + "$ref": "#/components/schemas/rate-limit" + scim: + "$ref": "#/components/schemas/rate-limit" + dependency_snapshots: + "$ref": "#/components/schemas/rate-limit" + required: + - core + - search + rate: + "$ref": "#/components/schemas/rate-limit" + required: + - rate + - resources artifact: title: Artifact description: An artifact @@ -73223,6 +74178,8 @@ components: - in_progress - completed - waiting + - requested + - pending conclusion: description: The outcome of the job. example: success @@ -73457,7 +74414,7 @@ components: Defines the level of access that workflows outside of the repository have to actions and reusable workflows within the repository. - `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repos only. `organization` level access allows sharing across the organization. + `none` means the access is only possible from workflows in this repository. `user` level access allows sharing across user owned private repositories only. `organization` level access allows sharing across the organization. enum: - none - user @@ -75255,12 +76212,17 @@ components: nullable: true status: description: The phase of the lifecycle that the check is currently in. + Statuses of waiting, requested, and pending are reserved for GitHub Actions + check runs. example: queued type: string enum: - queued - in_progress - completed + - waiting + - requested + - pending conclusion: type: string example: neutral @@ -75480,11 +76442,17 @@ components: type: string status: type: string + description: The phase of the lifecycle that the check suite is currently + in. Statuses of waiting, requested, and pending are reserved for GitHub + Actions check suites. example: completed enum: - queued - in_progress - completed + - waiting + - requested + - pending nullable: true conclusion: type: string @@ -75583,34 +76551,6 @@ components: - setting repository: "$ref": "#/components/schemas/minimal-repository" - code-scanning-alert-rule-summary: - type: object - properties: - id: - nullable: true - type: string - description: A unique identifier for the rule used to detect the alert. - name: - type: string - description: The name of the rule used to detect the alert. - tags: - nullable: true - type: array - description: A set of tags applicable for the rule. - items: - type: string - severity: - nullable: true - type: string - description: The severity of the alert. - enum: - - none - - note - - warning - - error - description: - type: string - description: A short description of the rule used to detect the alert. code-scanning-alert-items: type: object properties: @@ -75657,6 +76597,55 @@ components: - rule - tool - most_recent_instance + code-scanning-alert-rule: + type: object + properties: + id: + nullable: true + type: string + description: A unique identifier for the rule used to detect the alert. + name: + type: string + description: The name of the rule used to detect the alert. + severity: + nullable: true + type: string + description: The severity of the alert. + enum: + - none + - note + - warning + - error + security_severity_level: + nullable: true + type: string + description: The security severity of the alert. + enum: + - low + - medium + - high + - critical + description: + type: string + description: A short description of the rule used to detect the alert. + full_description: + type: string + description: description of the rule used to detect the alert. + tags: + nullable: true + type: array + description: A set of tags applicable for the rule. + items: + type: string + help: + nullable: true + type: string + description: Detailed documentation for the rule as GitHub Flavored Markdown. + help_uri: + nullable: true + type: string + description: A link to the documentation for the rule used to detect the + alert. code-scanning-alert: type: object properties: @@ -75953,8 +76942,8 @@ components: type: string description: |- The full Git reference, formatted as `refs/heads/`, - `refs/pull//merge`, or `refs/pull//head`. - pattern: "^refs/(heads|pull)/.*$" + `refs/tags/`, `refs/pull//merge`, or `refs/pull//head`. + pattern: "^refs/(heads|tags|pull)/.*$" example: refs/heads/main code-scanning-analysis-sarif-file: description: A Base64 string representing the SARIF file to upload. You must @@ -78828,34 +79817,7 @@ components: - push - pull_request config: - type: object - properties: - email: - type: string - example: '"foo@bar.com"' - password: - type: string - example: '"foo"' - room: - type: string - example: '"roomer"' - subdomain: - type: string - example: '"foo"' - url: - "$ref": "#/components/schemas/webhook-config-url" - insecure_ssl: - "$ref": "#/components/schemas/webhook-config-insecure-ssl" - content_type: - "$ref": "#/components/schemas/webhook-config-content-type" - digest: - type: string - example: '"sha256"' - secret: - "$ref": "#/components/schemas/webhook-config-secret" - token: - type: string - example: '"abc"' + "$ref": "#/components/schemas/webhook-config" updated_at: type: string format: date-time @@ -81187,11 +82149,17 @@ components: description: The GitHub Pages deployment status. type: object properties: + id: + oneOf: + - type: integer + - type: string + description: The ID of the GitHub Pages deployment. This is the Git SHA + of the deployed commit. status_url: type: string description: The URI to monitor GitHub Pages deployment status. format: uri - example: https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status + example: https://api.github.com/repos/github/hello-world/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251 page_url: type: string description: The URI to the deployed GitHub Pages. @@ -81203,8 +82171,28 @@ components: format: uri example: monalisa-1231a2312sa32-23sda74.drafts.github.io required: + - id - status_url - page_url + pages-deployment-status: + title: GitHub Pages deployment status + type: object + properties: + status: + type: string + description: The current status of the deployment. + enum: + - deployment_in_progress + - syncing_files + - finished_file_sync + - updating_pages + - purging_cdn + - deployment_cancelled + - deployment_failed + - deployment_content_failed + - deployment_attempt_error + - deployment_lost + - succeed pages-health-check: title: Pages Health Check Status description: Pages Health Check Status @@ -83122,6 +84110,56 @@ components: - blob_url - commit_sha - commit_url + secret-scanning-location-wiki-commit: + description: Represents a 'wiki_commit' secret scanning location type. This + location type shows that a secret was detected inside a commit to a repository + wiki. + type: object + properties: + path: + type: string + description: The file path of the wiki page + example: "/example/Home.md" + start_line: + type: number + description: Line number at which the secret starts in the file + end_line: + type: number + description: Line number at which the secret ends in the file + start_column: + type: number + description: The column at which the secret starts within the start line + when the file is interpreted as 8-bit ASCII. + end_column: + type: number + description: The column at which the secret ends within the end line when + the file is interpreted as 8-bit ASCII. + blob_sha: + type: string + description: SHA-1 hash ID of the associated blob + example: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: + type: string + description: The GitHub URL to get the associated wiki page + example: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: + type: string + description: SHA-1 hash ID of the associated commit + example: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: + type: string + description: The GitHub URL to get the associated wiki commit + example: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + required: + - path + - start_line + - end_line + - start_column + - end_column + - blob_sha + - page_url + - commit_sha + - commit_url secret-scanning-location-issue-title: description: Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. @@ -83158,6 +84196,111 @@ components: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url + secret-scanning-location-discussion-title: + description: Represents a 'discussion_title' secret scanning location type. + This location type shows that a secret was detected in the title of a discussion. + type: object + properties: + discussion_title_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082 + required: + - discussion_title_url + secret-scanning-location-discussion-body: + description: Represents a 'discussion_body' secret scanning location type. This + location type shows that a secret was detected in the body of a discussion. + type: object + properties: + discussion_body_url: + type: string + format: uri + description: The URL to the discussion where the secret was detected. + example: https://github.com/community/community/discussions/39082#discussion-4566270 + required: + - discussion_body_url + secret-scanning-location-discussion-comment: + description: Represents a 'discussion_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a discussion. + type: object + properties: + discussion_comment_url: + type: string + format: uri + description: The API URL to get the discussion comment where the secret + was detected. + example: https://github.com/community/community/discussions/39082#discussioncomment-4158232 + required: + - discussion_comment_url + secret-scanning-location-pull-request-title: + description: Represents a 'pull_request_title' secret scanning location type. + This location type shows that a secret was detected in the title of a pull + request. + type: object + properties: + pull_request_title_url: + 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 + required: + - pull_request_title_url + secret-scanning-location-pull-request-body: + description: Represents a 'pull_request_body' secret scanning location type. + This location type shows that a secret was detected in the body of a pull + request. + type: object + properties: + pull_request_body_url: + 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 + required: + - pull_request_body_url + secret-scanning-location-pull-request-comment: + description: Represents a 'pull_request_comment' secret scanning location type. + This location type shows that a secret was detected in a comment on a pull + request. + type: object + properties: + pull_request_comment_url: + type: string + format: uri + description: The API URL to get the pull request comment where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + required: + - pull_request_comment_url + secret-scanning-location-pull-request-review: + description: Represents a 'pull_request_review' secret scanning location type. + This location type shows that a secret was detected in a review on a pull + request. + type: object + properties: + pull_request_review_url: + type: string + format: uri + description: The API URL to get the pull request review where the secret + was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + required: + - pull_request_review_url + secret-scanning-location-pull-request-review-comment: + description: Represents a 'pull_request_review_comment' secret scanning location + type. This location type shows that a secret was detected in a review comment + on a pull request. + type: object + properties: + pull_request_review_comment_url: + type: string + format: uri + description: The API URL to get the pull request review comment where the + secret was detected. + example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 + required: + - pull_request_review_comment_url secret-scanning-location: type: object properties: @@ -83165,22 +84308,37 @@ components: type: string enum: - commit + - wiki_commit - issue_title - issue_body - issue_comment + - discussion_title + - discussion_body + - discussion_comment + - pull_request_title + - pull_request_body + - pull_request_comment + - pull_request_review + - pull_request_review_comment description: The location type. Because secrets may be found in different - types of resources (ie. code, comments, issues), this field identifies - the type of resource where the secret was found. + types of resources (ie. code, comments, issues, pull requests, discussions), + this field identifies the type of resource where the secret was found. example: commit details: oneOf: - "$ref": "#/components/schemas/secret-scanning-location-commit" + - "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" - "$ref": "#/components/schemas/secret-scanning-location-issue-title" - "$ref": "#/components/schemas/secret-scanning-location-issue-body" - "$ref": "#/components/schemas/secret-scanning-location-issue-comment" - required: - - type - - details + - "$ref": "#/components/schemas/secret-scanning-location-discussion-title" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-body" + - "$ref": "#/components/schemas/secret-scanning-location-discussion-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-title" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-body" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-comment" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review" + - "$ref": "#/components/schemas/secret-scanning-location-pull-request-review-comment" repository-advisory-create: type: object properties: @@ -83270,6 +84428,11 @@ components: description: The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. nullable: true + start_private_fork: + type: boolean + description: Whether to create a temporary private fork of the repository + to collaborate on a fix. + default: false required: - summary - description @@ -83344,6 +84507,11 @@ components: description: The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`. nullable: true + start_private_fork: + type: boolean + description: Whether to create a temporary private fork of the repository + to collaborate on a fix. + default: false required: - summary - description @@ -85811,8 +86979,8 @@ components: type: integer example: 80 size: - description: The size of the repository. Size is calculated hourly. When - a repository is initially created, the size is 0. + description: The size of the repository, in kilobytes. Size is calculated + hourly. When a repository is initially created, the size is 0. type: integer example: 108 default_branch: @@ -86433,6 +87601,136 @@ components: - subscriptions_url - type - url + webhooks_rule: + title: branch protection rule + description: The branch protection rule. Includes a `name` and all the [branch + protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) + applied to branches that match the name. Binary settings are boolean. Multi-level + configurations are one of `off`, `non_admins`, or `everyone`. Actor and build + lists are arrays of strings. + type: object + properties: + admin_enforced: + type: boolean + allow_deletions_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + allow_force_pushes_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + authorized_actor_names: + type: array + items: + type: string + authorized_actors_only: + type: boolean + authorized_dismissal_actors_only: + type: boolean + create_protected: + type: boolean + created_at: + type: string + format: date-time + dismiss_stale_reviews_on_push: + type: boolean + id: + type: integer + ignore_approvals_from_contributors: + type: boolean + linear_history_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + merge_queue_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + name: + type: string + pull_request_reviews_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + repository_id: + type: integer + require_code_owner_review: + type: boolean + require_last_push_approval: + description: Whether the most recent push must be approved by someone other + than the person who pushed it + type: boolean + required_approving_review_count: + type: integer + required_conversation_resolution_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_deployments_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + required_status_checks: + type: array + items: + type: string + required_status_checks_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + signature_requirement_enforcement_level: + type: string + enum: + - 'off' + - non_admins + - everyone + strict_required_status_checks_policy: + type: boolean + updated_at: + type: string + format: date-time + required: + - id + - repository_id + - name + - created_at + - updated_at + - pull_request_reviews_enforcement_level + - required_approving_review_count + - dismiss_stale_reviews_on_push + - require_code_owner_review + - authorized_dismissal_actors_only + - ignore_approvals_from_contributors + - required_status_checks + - required_status_checks_enforcement_level + - strict_required_status_checks_policy + - signature_requirement_enforcement_level + - linear_history_requirement_enforcement_level + - admin_enforced + - allow_force_pushes_enforcement_level + - allow_deletions_enforcement_level + - merge_queue_enforcement_level + - required_deployments_enforcement_level + - required_conversation_resolution_level + - authorized_actors_only + - authorized_actor_names simple-check-suite: description: A suite of checks performed on the code of a given code change type: object @@ -86615,18 +87913,475 @@ components: - output - app - pull_requests - discussion: - title: Discussion - description: A Discussion in a repository. + webhooks_code_scanning_commit_oid: + description: The commit SHA of the code scanning alert. When the action is `reopened_by_user` + or `closed_by_user`, the event was triggered by the `sender` and this value + will be empty. + type: string + webhooks_code_scanning_ref: + description: The Git reference of the code scanning alert. When the action is + `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` + and this value will be empty. + type: string + webhooks_deploy_pusher_type: + description: The pusher type for the event. Can be either `user` or a deploy + key. + type: string + webhooks_ref_0: + description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) + resource. + type: string + webhooks_deploy_key: + description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) + resource. type: object properties: - active_lock_reason: + added_by: type: string nullable: true - answer_chosen_at: + created_at: + type: string + id: + type: integer + key: + type: string + last_used: type: string nullable: true - answer_chosen_by: + read_only: + type: boolean + title: + type: string + url: + type: string + format: uri + verified: + type: boolean + required: + - id + - key + - url + - title + - verified + - created_at + - read_only + webhooks_workflow: + title: Workflow + type: object + nullable: true + properties: + badge_url: + type: string + format: uri + created_at: + type: string + format: date-time + html_url: + type: string + format: uri + id: + type: integer + name: + type: string + node_id: + type: string + path: + type: string + state: + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - badge_url + - created_at + - html_url + - id + - name + - node_id + - path + - state + - updated_at + - url + webhooks_approver: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + webhooks_reviewers: + type: array + items: + type: object + properties: + reviewer: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + type: + type: string + enum: + - User + webhooks_workflow_job_run: + type: object + properties: + conclusion: + nullable: true + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + nullable: true + status: + type: string + updated_at: + type: string + required: + - id + - name + - status + - conclusion + - html_url + - created_at + - updated_at + - environment + webhooks_user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + webhooks_answer: + type: object + properties: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + type: string + child_comment_count: + type: integer + created_at: + type: string + format: date-time + discussion_id: + type: integer + html_url: + type: string + id: + type: integer + node_id: + type: string + parent_id: + nullable: true + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + updated_at: + type: string + format: date-time + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - id + - node_id + - html_url + - parent_id + - child_comment_count + - repository_url + - discussion_id + - author_association + - user + - created_at + - updated_at + - body + discussion: + title: Discussion + description: A Discussion in a repository. + type: object + properties: + active_lock_reason: + type: string + nullable: true + answer_chosen_at: + type: string + nullable: true + answer_chosen_by: title: User type: object nullable: true @@ -86915,3596 +88670,4538 @@ components: - author_association - active_lock_reason - body - merge-group: + webhooks_comment: type: object - title: Merge Group - description: 'A group of pull requests that the merge queue has grouped together - to be merged. - -' properties: - head_sha: - description: The SHA of the merge group. + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. type: string - head_ref: - description: The full ref of the merge group. + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: type: string - base_sha: - description: The SHA of the merge group's parent commit. + child_comment_count: + type: integer + created_at: type: string - base_ref: - description: The full ref of the branch the merge group will be merged into. + discussion_id: + type: integer + html_url: type: string - head_commit: - "$ref": "#/components/schemas/simple-commit" - required: - - head_sha - - head_ref - - base_sha - - base_ref - - head_commit - nullable-repository-webhooks: - title: Repository - description: |- - The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property - when the event occurs from activity in a repository. - type: object - properties: id: - description: Unique identifier of the repository - example: 42 type: integer node_id: type: string - example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: - description: The name of the repository. + parent_id: + type: integer + nullable: true + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: type: string - example: Team Environment - full_name: + updated_at: type: string - example: octocat/Hello-World - license: - "$ref": "#/components/schemas/nullable-license-simple" - organization: - "$ref": "#/components/schemas/nullable-simple-user" - forks: - type: integer - permissions: + user: + title: User type: object + nullable: true properties: - admin: - type: boolean - pull: - type: boolean - triage: - type: boolean - push: + avatar_url: + type: string + format: uri + deleted: type: boolean - maintain: + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri required: - - admin - - pull - - push - owner: - "$ref": "#/components/schemas/simple-user" - private: - description: Whether the repository is private or public. - default: false - type: boolean - html_url: + - login + - id + required: + - id + - node_id + - html_url + - parent_id + - child_comment_count + - repository_url + - discussion_id + - author_association + - user + - created_at + - updated_at + - body + - reactions + webhooks_label: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying the + color' type: string - format: uri - example: https://github.com/octocat/Hello-World + default: + type: boolean description: type: string - example: This your first repo! nullable: true - fork: - type: boolean - url: - type: string - format: uri - example: https://api.github.com/repos/octocat/Hello-World - archive_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} - assignees_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} - blobs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} - branches_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} - collaborators_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} - comments_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/comments{/number} - commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} - compare_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} - contents_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} - contributors_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/contributors - deployments_url: - type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/deployments - downloads_url: + id: + type: integer + name: + description: The name of the label. type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/downloads - events_url: + node_id: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/events - forks_url: + url: + description: URL for the label type: string format: uri - example: http://api.github.com/repos/octocat/Hello-World/forks - git_commits_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} - git_refs_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} - git_tags_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} - git_url: - type: string - example: git:github.com/octocat/Hello-World.git - issue_comment_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} - issue_events_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} - issues_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/issues{/number} - keys_url: + required: + - id + - node_id + - url + - name + - color + - default + - description + webhooks_repositories: + description: An array of repository objects that the installation can access. + type: array + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + required: + - id + - node_id + - name + - full_name + - private + webhooks_repositories_added: + description: An array of repository objects, which were added to the installation. + type: array + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + required: + - id + - node_id + - name + - full_name + - private + webhooks_repository_selection: + description: Describe whether all repositories have been selected or there's + a selection involved + type: string + enum: + - all + - selected + webhooks_issue_comment: + title: issue comment + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) + itself. + type: object + properties: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. type: string - example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} - labels_url: + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue comment type: string - example: http://api.github.com/repos/octocat/Hello-World/labels{/name} - languages_url: + created_at: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/languages - merges_url: + format: date-time + html_url: type: string format: uri - example: http://api.github.com/repos/octocat/Hello-World/merges - milestones_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} - notifications_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} - pulls_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} - releases_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/releases{/id} - ssh_url: - type: string - example: git@github.com:octocat/Hello-World.git - stargazers_url: + id: + description: Unique identifier of the issue comment + type: integer + format: int64 + issue_url: type: string format: uri - example: http://api.github.com/repos/octocat/Hello-World/stargazers - statuses_url: - type: string - example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} - subscribers_url: + node_id: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscribers - subscription_url: + performed_via_github_app: + "$ref": "#/components/schemas/integration" + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + updated_at: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/subscription - tags_url: + format: date-time + url: + description: URL for the issue comment type: string format: uri - example: http://api.github.com/repos/octocat/Hello-World/tags - teams_url: + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + required: + - url + - html_url + - issue_url + - id + - node_id + - user + - created_at + - updated_at + - author_association + - performed_via_github_app + - body + - reactions + webhooks_changes: + description: The changes to the comment. + type: object + properties: + body: + type: object + properties: + from: + description: The previous version of the body. + type: string + required: + - from + webhooks_issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: type: string - format: uri - example: http://api.github.com/repos/octocat/Hello-World/teams - trees_url: + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. type: string - example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} - clone_url: + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue type: string - example: https://github.com/octocat/Hello-World.git - mirror_url: + nullable: true + closed_at: type: string - format: uri - example: git:git.example.com/octocat/Hello-World nullable: true - hooks_url: + format: date-time + comments: + type: integer + comments_url: type: string format: uri - example: http://api.github.com/repos/octocat/Hello-World/hooks - svn_url: + created_at: type: string - format: uri - example: https://svn.github.com/octocat/Hello-World - homepage: + format: date-time + draft: + type: boolean + events_url: type: string format: uri - example: https://github.com - nullable: true - language: - type: string - nullable: true - forks_count: - type: integer - example: 9 - stargazers_count: - type: integer - example: 80 - watchers_count: - type: integer - example: 80 - size: - description: The size of the repository. Size is calculated hourly. When - a repository is initially created, the size is 0. - type: integer - example: 108 - default_branch: - description: The default branch of the repository. + html_url: type: string - example: master - open_issues_count: + format: uri + id: type: integer - example: 0 - is_template: - description: Whether this repository acts as a template that can be used - to generate new repositories. - default: false - type: boolean - example: true - topics: + format: int64 + labels: type: array items: - type: string - custom_properties: - type: object - description: The custom properties that were defined for the repository. - The keys are the custom property names, and the values are the corresponding - custom property values. - additionalProperties: true - has_issues: - description: Whether issues are enabled. - default: true - type: boolean - example: true - has_projects: - description: Whether projects are enabled. - default: true - type: boolean - example: true - has_wiki: - description: Whether the wiki is enabled. - default: true - type: boolean - example: true - has_pages: - type: boolean - has_downloads: - description: Whether downloads are enabled. - default: true - type: boolean - example: true - has_discussions: - description: Whether discussions are enabled. - default: false - type: boolean - example: true - archived: - description: Whether the repository is archived. - default: false - type: boolean - disabled: - type: boolean - description: Returns whether or not this repository disabled. - visibility: - description: 'The repository visibility: public, private, or internal.' - default: public - type: string - pushed_at: - type: string - format: date-time - example: '2011-01-26T19:06:43Z' - nullable: true - created_at: - type: string - format: date-time - example: '2011-01-26T19:01:12Z' - nullable: true - updated_at: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: type: string - format: date-time - example: '2011-01-26T19:14:43Z' - nullable: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - default: true + format: uri-template + locked: type: boolean - example: true - template_repository: - nullable: true + milestone: + title: Milestone + description: A collection of related issues and pull requests. type: object + nullable: true properties: - id: - type: integer - node_id: - type: string - name: + closed_at: type: string - full_name: + nullable: true + format: date-time + closed_issues: + type: integer + created_at: type: string - owner: + format: date-time + creator: + title: User type: object + nullable: true properties: - login: - type: string - id: - type: integer - node_id: - type: string avatar_url: type: string - gravatar_id: - type: string - url: + format: uri + deleted: + type: boolean + email: type: string - html_url: + nullable: true + events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string - starred_url: + format: uri-template + gravatar_id: type: string - subscriptions_url: + html_url: type: string - organizations_url: + format: uri + id: + type: integer + login: type: string - repos_url: + name: type: string - events_url: + node_id: type: string + organizations_url: + type: string + format: uri received_events_url: type: string - type: + format: uri + repos_url: type: string + format: uri site_admin: type: boolean - private: - type: boolean - html_url: - type: string + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id description: type: string - fork: - type: boolean - url: + nullable: true + due_on: type: string - archive_url: + nullable: true + format: date-time + html_url: type: string - assignees_url: + format: uri + id: + type: integer + labels_url: type: string - blobs_url: + format: uri + node_id: type: string - branches_url: + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. type: string - collaborators_url: + enum: + - open + - closed + title: + description: The title of the milestone. type: string - comments_url: + updated_at: type: string - commits_url: + format: date-time + url: type: string - compare_url: + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: 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. + type: object + nullable: true + properties: + created_at: type: string - contents_url: + nullable: true + format: date-time + description: type: string - contributors_url: + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + external_url: type: string - deployments_url: + nullable: true + format: uri + html_url: type: string - downloads_url: + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app type: string - events_url: + node_id: type: string - forks_url: + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app type: string - git_commits_url: + updated_at: type: string - git_refs_url: + nullable: true + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: type: string - git_tags_url: + format: uri + html_url: type: string - git_url: + format: uri + merged_at: type: string - issue_comment_url: + nullable: true + format: date-time + patch_url: type: string - issue_events_url: + format: uri + url: type: string - issues_url: + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: type: string - keys_url: + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: type: string - labels_url: + format: uri + deleted: + type: boolean + email: type: string - languages_url: + nullable: true + events_url: type: string - merges_url: + format: uri-template + followers_url: type: string - milestones_url: + format: uri + following_url: type: string - notifications_url: + format: uri-template + gists_url: type: string - pulls_url: + format: uri-template + gravatar_id: type: string - releases_url: + html_url: type: string - ssh_url: + format: uri + id: + type: integer + login: type: string - stargazers_url: + name: type: string - statuses_url: + node_id: type: string - subscribers_url: + organizations_url: type: string - subscription_url: + format: uri + received_events_url: type: string - tags_url: + format: uri + repos_url: type: string - teams_url: + format: uri + site_admin: + type: boolean + starred_url: type: string - trees_url: + format: uri-template + subscriptions_url: type: string - clone_url: + format: uri + type: type: string - mirror_url: + enum: + - Bot + - User + - Organization + - Mannequin + url: type: string - hooks_url: + format: uri + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + webhooks_milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: type: string - svn_url: + format: uri + deleted: + type: boolean + email: type: string - homepage: + nullable: true + events_url: type: string - language: + format: uri-template + followers_url: type: string - forks_count: - type: integer - stargazers_count: - type: integer - watchers_count: - type: integer - size: - type: integer - default_branch: + format: uri + following_url: type: string - open_issues_count: + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: type: integer - is_template: - type: boolean - topics: - type: array - items: - type: string - has_issues: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - has_pages: - type: boolean - has_downloads: - type: boolean - archived: - type: boolean - disabled: - type: boolean - visibility: + login: type: string - pushed_at: + name: type: string - created_at: + node_id: type: string - updated_at: + organizations_url: type: string - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - push: - type: boolean - triage: - type: boolean - pull: - type: boolean - allow_rebase_merge: - type: boolean - temp_clone_token: + format: uri + received_events_url: type: string - allow_squash_merge: - type: boolean - allow_auto_merge: - type: boolean - delete_branch_on_merge: - type: boolean - allow_update_branch: - type: boolean - use_squash_pr_title_as_default: + format: uri + repos_url: + type: string + format: uri + site_admin: type: boolean - squash_merge_commit_title: + starred_url: type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - squash_merge_commit_message: + format: uri-template + subscriptions_url: type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - merge_commit_title: + format: uri + type: type: string enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - merge_commit_message: + - Bot + - User + - Organization + - Mannequin + url: type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - allow_merge_commit: - type: boolean - subscribers_count: - type: integer - network_count: - type: integer - temp_clone_token: + format: uri + required: + - login + - id + description: type: string - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - default: true - type: boolean - example: true - allow_auto_merge: - description: Whether to allow Auto-merge to be used on pull requests. - default: false - type: boolean - example: false - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are merged - default: false - type: boolean - example: false - allow_update_branch: - description: Whether or not a pull request head branch that is behind its - base branch can always be updated even if it is not required to be up - to date before merging. - default: false - type: boolean - example: false - use_squash_pr_title_as_default: - type: boolean - description: Whether a squash merge commit can use the pull request title - as default. **This property has been deprecated. Please use `squash_merge_commit_title` - instead. - default: false - deprecated: true - squash_merge_commit_title: + nullable: true + due_on: type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - squash_merge_commit_message: + nullable: true + format: date-time + html_url: type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - merge_commit_title: + format: uri + id: + type: integer + labels_url: type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - merge_commit_message: + format: uri + node_id: type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - default: true - type: boolean - example: true - allow_forking: - description: Whether to allow forking this repo - type: boolean - web_commit_signoff_required: - description: Whether to require contributors to sign off on web-based commits - default: false - type: boolean - subscribers_count: - type: integer - network_count: + number: + description: The number of the milestone. type: integer open_issues: type: integer - watchers: - type: integer - master_branch: + state: + description: The state of the milestone. type: string - starred_at: + enum: + - open + - closed + title: + description: The title of the milestone. type: string - example: '"2020-07-09T00:17:42Z"' - anonymous_access_enabled: - type: boolean - description: Whether anonymous git access is enabled for this repository + updated_at: + type: string + format: date-time + url: + type: string + format: uri 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 + - url - html_url + - labels_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 - - clone_url - - default_branch - - forks - - forks_count - - git_url - - has_downloads - - has_issues - - has_projects - - has_wiki - - has_pages - - homepage - - language - - archived - - disabled - - mirror_url + - number + - title + - description + - creator - open_issues - - open_issues_count - - license - - pushed_at - - size - - ssh_url - - stargazers_count - - svn_url - - watchers - - watchers_count + - closed_issues + - state - created_at - updated_at - nullable: true - personal-access-token-request: - title: Personal Access Token Request - description: Details of a Personal Access Token Request. + - due_on + - closed_at + webhooks_issue_2: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. type: object properties: - id: - type: integer - description: Unique identifier of the request for access via fine-grained - personal access token. Used as the `pat_request_id` parameter in the list - and review API calls. - owner: - "$ref": "#/components/schemas/simple-user" - permissions_added: + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User type: object - description: New requested permissions, categorized by type of permission. + nullable: true properties: - organization: - type: object - additionalProperties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: + title: User + type: object + nullable: true + properties: + avatar_url: type: string - repository: - type: object - additionalProperties: + format: uri + deleted: + type: boolean + email: type: string - other: - type: object - additionalProperties: + nullable: true + events_url: type: string - permissions_upgraded: - type: object - description: Requested permissions that elevate access for a previously - approved request for access, categorized by type of permission. - properties: - organization: - type: object - additionalProperties: + format: uri-template + followers_url: type: string - repository: - type: object - additionalProperties: + format: uri + following_url: type: string - other: - type: object - additionalProperties: + format: uri-template + gists_url: type: string - permissions_result: - type: object - description: Permissions requested, categorized by type of permission. This - field incorporates `permissions_added` and `permissions_upgraded`. - properties: - organization: - type: object - additionalProperties: + format: uri-template + gravatar_id: type: string - repository: - type: object - additionalProperties: + html_url: type: string - other: - type: object - additionalProperties: + format: uri + id: + type: integer + login: type: string - repository_selection: - type: string - description: Type of repository selection requested. - enum: - - none - - all - - subset - repository_count: - description: The number of repositories the token is requesting access to. - This field is only populated when `repository_selection` is `subset`. - type: integer - nullable: true - repositories: - type: array - description: An array of repository objects the token is requesting access - to. This field is only populated when `repository_selection` is `subset`. - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer name: - description: The name of the repository. type: string node_id: type: string - private: - description: Whether the repository is private or public. + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri required: + - login - id - - node_id - - name - - full_name - - private - nullable: true - created_at: - type: string - description: Date and time when the request for access was created. - token_expired: - type: boolean - description: Whether the associated fine-grained personal access token has - expired. - token_expires_at: - type: string - description: Date and time when the associated fine-grained personal access - token expires. - nullable: true - token_last_used_at: - type: string - description: Date and time when the associated fine-grained personal access - token was last used for authentication. - nullable: true - required: - - id - - owner - - permissions_added - - permissions_upgraded - - permissions_result - - repository_selection - - repository_count - - repositories - - created_at - - token_expired - - token_expires_at - - token_last_used_at - projects-v2: - title: Projects v2 Project - description: A projects v2 project - type: object - properties: - id: - type: number - node_id: - type: string - owner: - "$ref": "#/components/schemas/simple-user" - creator: - "$ref": "#/components/schemas/simple-user" - title: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. type: string - description: + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue type: string nullable: true - public: - type: boolean closed_at: type: string - format: date-time - example: '2022-04-28T12:00:00Z' nullable: true - created_at: - type: string format: date-time - example: '2022-04-28T12:00:00Z' - updated_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - number: + comments: type: integer - short_description: - type: string - nullable: true - deleted_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - nullable: true - deleted_by: - "$ref": "#/components/schemas/nullable-simple-user" - required: - - id - - node_id - - owner - - creator - - title - - description - - public - - closed_at - - created_at - - updated_at - - number - - short_description - - deleted_at - - deleted_by - projects-v2-item-content-type: - title: Projects v2 Item Content Type - description: The type of content tracked in a project item - type: string - enum: - - Issue - - PullRequest - - DraftIssue - projects-v2-item: - title: Projects v2 Item - description: An item belonging to a project - type: object - properties: - id: - type: number - node_id: - type: string - project_node_id: - type: string - content_node_id: + comments_url: type: string - content_type: - "$ref": "#/components/schemas/projects-v2-item-content-type" - creator: - "$ref": "#/components/schemas/simple-user" + format: uri created_at: type: string format: date-time - example: '2022-04-28T12:00:00Z' - updated_at: - type: string - format: date-time - example: '2022-04-28T12:00:00Z' - archived_at: + draft: + type: boolean + events_url: type: string - format: date-time - example: '2022-04-28T12:00:00Z' - nullable: true - required: - - id - - content_node_id - - content_type - - created_at - - updated_at - - archived_at - secret-scanning-alert-resolution-webhook: - type: string - description: The reason for resolving the alert. - nullable: true - enum: - - false_positive - - wont_fix - - revoked - - used_in_tests - - pattern_deleted - - pattern_edited - secret-scanning-alert-webhook: - type: object - properties: - number: - "$ref": "#/components/schemas/alert-number" - created_at: - "$ref": "#/components/schemas/alert-created-at" - updated_at: - "$ref": "#/components/schemas/nullable-alert-updated-at" - url: - "$ref": "#/components/schemas/alert-url" + format: uri html_url: - "$ref": "#/components/schemas/alert-html-url" - locations_url: type: string format: uri - description: The REST API URL of the code locations for this alert. - resolution: - "$ref": "#/components/schemas/secret-scanning-alert-resolution-webhook" - resolved_at: - type: string - format: date-time - description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - resolved_by: - "$ref": "#/components/schemas/nullable-simple-user" - resolution_comment: - type: string - description: An optional comment to resolve an alert. - nullable: true - secret_type: + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: type: string - description: The type of secret that secret scanning detected. - push_protection_bypassed: + format: uri-template + locked: type: boolean - description: Whether push protection was bypassed for the detected secret. - nullable: true - push_protection_bypassed_by: - "$ref": "#/components/schemas/nullable-simple-user" - push_protection_bypassed_at: - type: string - format: date-time - description: 'The time that push protection was bypassed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - webhook-branch-protection-configuration-disabled: - title: branch protection configuration disabled event - type: object - properties: - action: - type: string - enum: - - disabled - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-branch-protection-configuration-enabled: - title: branch protection configuration enabled event - type: object - properties: - action: - type: string - enum: - - enabled - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-branch-protection-rule-created: - title: branch protection rule created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - rule: - title: branch protection rule - description: The branch protection rule. Includes a `name` and all the [branch - protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) - applied to branches that match the name. Binary settings are boolean. - Multi-level configurations are one of `off`, `non_admins`, or `everyone`. - Actor and build lists are arrays of strings. + milestone: + title: Milestone + description: A collection of related issues and pull requests. type: object + nullable: true properties: - admin_enforced: - type: boolean - allow_deletions_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - allow_force_pushes_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - authorized_actor_names: - type: array - items: - type: string - authorized_actors_only: - type: boolean - authorized_dismissal_actors_only: - type: boolean - create_protected: - type: boolean - created_at: + closed_at: type: string + nullable: true format: date-time - dismiss_stale_reviews_on_push: - type: boolean - id: + closed_issues: type: integer - ignore_approvals_from_contributors: - type: boolean - linear_history_requirement_enforcement_level: + created_at: type: string - enum: - - 'off' - - non_admins - - everyone - merge_queue_enforcement_level: + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + description: type: string - enum: - - 'off' - - non_admins - - everyone - name: + nullable: true + due_on: type: string - pull_request_reviews_enforcement_level: + nullable: true + format: date-time + html_url: type: string - enum: - - 'off' - - non_admins - - everyone - repository_id: - type: integer - require_code_owner_review: - type: boolean - require_last_push_approval: - description: Whether the most recent push must be approved by someone - other than the person who pushed it - type: boolean - required_approving_review_count: + format: uri + id: type: integer - required_conversation_resolution_level: + labels_url: type: string - enum: - - 'off' - - non_admins - - everyone - required_deployments_enforcement_level: + format: uri + node_id: type: string - enum: - - 'off' - - non_admins - - everyone - required_status_checks: - type: array - items: - type: string - required_status_checks_enforcement_level: + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. type: string enum: - - 'off' - - non_admins - - everyone - signature_requirement_enforcement_level: + - open + - closed + title: + description: The title of the milestone. type: string - enum: - - 'off' - - non_admins - - everyone - strict_required_status_checks_policy: - type: boolean updated_at: type: string format: date-time + url: + type: string + format: uri required: + - url + - html_url + - labels_url - id - - repository_id - - name + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state - created_at - updated_at - - pull_request_reviews_enforcement_level - - required_approving_review_count - - dismiss_stale_reviews_on_push - - require_code_owner_review - - authorized_dismissal_actors_only - - ignore_approvals_from_contributors - - required_status_checks - - required_status_checks_enforcement_level - - strict_required_status_checks_policy - - signature_requirement_enforcement_level - - linear_history_requirement_enforcement_level - - admin_enforced - - allow_force_pushes_enforcement_level - - allow_deletions_enforcement_level - - merge_queue_enforcement_level - - required_deployments_enforcement_level - - required_conversation_resolution_level - - authorized_actors_only - - authorized_actor_names - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - rule - - repository - - sender - webhook-branch-protection-rule-deleted: - title: branch protection rule deleted event - type: object - properties: - action: + - due_on + - closed_at + node_id: type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - rule: - title: branch protection rule - description: The branch protection rule. Includes a `name` and all the [branch - protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) - applied to branches that match the name. Binary settings are boolean. - Multi-level configurations are one of `off`, `non_admins`, or `everyone`. - Actor and build lists are arrays of strings. + number: + type: integer + performed_via_github_app: + title: 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. type: object + nullable: true properties: - admin_enforced: - type: boolean - allow_deletions_enforcement_level: + created_at: type: string - enum: - - 'off' - - non_admins - - everyone - allow_force_pushes_enforcement_level: + nullable: true + format: date-time + description: type: string - enum: - - 'off' - - non_admins - - everyone - authorized_actor_names: + nullable: true + events: + description: The list of events for the GitHub app type: array items: type: string - authorized_actors_only: - type: boolean - authorized_dismissal_actors_only: - type: boolean - create_protected: - type: boolean - created_at: + enum: + - 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 + external_url: type: string - format: date-time - dismiss_stale_reviews_on_push: - type: boolean + nullable: true + format: uri + html_url: + type: string + format: uri id: + description: Unique identifier of the GitHub app type: integer - ignore_approvals_from_contributors: - type: boolean - linear_history_requirement_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - merge_queue_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone + nullable: true name: + description: The name of the GitHub app type: string - pull_request_reviews_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - repository_id: - type: integer - require_code_owner_review: - type: boolean - require_last_push_approval: - description: Whether the most recent push must be approved by someone - other than the person who pushed it - type: boolean - required_approving_review_count: - type: integer - required_conversation_resolution_level: - type: string - enum: - - 'off' - - non_admins - - everyone - required_deployments_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - required_status_checks: - type: array - items: - type: string - required_status_checks_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - signature_requirement_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - strict_required_status_checks_policy: - type: boolean - updated_at: + node_id: type: string - format: date-time - required: - - id - - repository_id - - name - - created_at - - updated_at - - pull_request_reviews_enforcement_level - - required_approving_review_count - - dismiss_stale_reviews_on_push - - require_code_owner_review - - authorized_dismissal_actors_only - - ignore_approvals_from_contributors - - required_status_checks - - required_status_checks_enforcement_level - - strict_required_status_checks_policy - - signature_requirement_enforcement_level - - linear_history_requirement_enforcement_level - - admin_enforced - - allow_force_pushes_enforcement_level - - allow_deletions_enforcement_level - - merge_queue_enforcement_level - - required_deployments_enforcement_level - - required_conversation_resolution_level - - authorized_actors_only - - authorized_actor_names - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - rule - - repository - - sender - webhook-branch-protection-rule-edited: - title: branch protection rule edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: If the action was `edited`, the changes to the rule. - type: object - properties: - admin_enforced: - type: object - properties: - from: - type: boolean - nullable: true - required: - - from - authorized_actor_names: - type: object - properties: - from: - type: array - items: - type: string - required: - - from - authorized_actors_only: + owner: + title: User type: object + nullable: true properties: - from: + avatar_url: + type: string + format: uri + deleted: type: boolean + email: + type: string nullable: true - required: - - from - authorized_dismissal_actors_only: - type: object - properties: - from: + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: type: boolean - nullable: true - required: - - from - linear_history_requirement_enforcement_level: - type: object - properties: - from: + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string enum: - - 'off' - - non_admins - - everyone - required: - - from - required_status_checks: - type: object - properties: - from: - type: array - items: - type: string + - Bot + - User + - Organization + url: + type: string + format: uri required: - - from - required_status_checks_enforcement_level: + - login + - id + permissions: + description: The set of permissions for the GitHub app type: object properties: - from: + actions: type: string enum: - - 'off' - - non_admins - - everyone - required: - - from - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - rule: - title: branch protection rule - description: The branch protection rule. Includes a `name` and all the [branch - protection settings](https://docs.github.com/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) - applied to branches that match the name. Binary settings are boolean. - Multi-level configurations are one of `off`, `non_admins`, or `everyone`. - Actor and build lists are arrays of strings. + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: string + nullable: true + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: type: object properties: - admin_enforced: - type: boolean - allow_deletions_enforcement_level: + diff_url: type: string - enum: - - 'off' - - non_admins - - everyone - allow_force_pushes_enforcement_level: + format: uri + html_url: type: string - enum: - - 'off' - - non_admins - - everyone - authorized_actor_names: - type: array - items: - type: string - authorized_actors_only: - type: boolean - authorized_dismissal_actors_only: - type: boolean - create_protected: - type: boolean - created_at: + format: uri + merged_at: type: string + nullable: true format: date-time - dismiss_stale_reviews_on_push: - type: boolean - id: - type: integer - ignore_approvals_from_contributors: - type: boolean - linear_history_requirement_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - merge_queue_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - name: + patch_url: type: string - pull_request_reviews_enforcement_level: + format: uri + url: type: string - enum: - - 'off' - - non_admins - - everyone - repository_id: + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": type: integer - require_code_owner_review: - type: boolean - require_last_push_approval: - description: Whether the most recent push must be approved by someone - other than the person who pushed it - type: boolean - required_approving_review_count: + "-1": type: integer - required_conversation_resolution_level: - type: string - enum: - - 'off' - - non_admins - - everyone - required_deployments_enforcement_level: - type: string - enum: - - 'off' - - non_admins - - everyone - required_status_checks: - type: array - items: - type: string - required_status_checks_enforcement_level: + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: type: string - enum: - - 'off' - - non_admins - - everyone - signature_requirement_enforcement_level: + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: type: string - enum: - - 'off' - - non_admins - - everyone - strict_required_status_checks_policy: + format: uri + deleted: type: boolean - updated_at: + email: type: string - format: date-time + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri required: + - login - id - - repository_id - - name - - created_at - - updated_at - - pull_request_reviews_enforcement_level - - required_approving_review_count - - dismiss_stale_reviews_on_push - - require_code_owner_review - - authorized_dismissal_actors_only - - ignore_approvals_from_contributors - - required_status_checks - - required_status_checks_enforcement_level - - strict_required_status_checks_policy - - signature_requirement_enforcement_level - - linear_history_requirement_enforcement_level - - admin_enforced - - allow_force_pushes_enforcement_level - - allow_deletions_enforcement_level - - merge_queue_enforcement_level - - required_deployments_enforcement_level - - required_conversation_resolution_level - - authorized_actors_only - - authorized_actor_names - sender: - "$ref": "#/components/schemas/simple-user-webhooks" required: - - action - - rule - - repository - - sender - webhook-check-run-completed: - title: Check Run Completed Event + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + webhooks_user_mannequin: + title: User type: object + nullable: true properties: - action: + avatar_url: type: string - enum: - - completed - check_run: - "$ref": "#/components/schemas/check-run-with-simple-check-suite" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - check_run - - repository - - sender - webhook-check-run-completed-form-encoded: - title: Check Run Completed Event - description: The check_run.completed webhook encoded with URL encoding - type: object - properties: - payload: - description: A URL-encoded string of the check_run.completed JSON payload. - The decoded payload is a JSON object. + format: uri + deleted: + type: boolean + email: type: string - required: - - payload - webhook-check-run-created: - title: Check Run Created Event - type: object - properties: - action: + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string enum: - - created - check_run: - "$ref": "#/components/schemas/check-run-with-simple-check-suite" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - check_run - - repository - - sender - webhook-check-run-created-form-encoded: - title: Check Run Created Event - description: The check_run.created webhook encoded with URL encoding - type: object - properties: - payload: - description: A URL-encoded string of the check_run.created JSON payload. - The decoded payload is a JSON object. + - Bot + - User + - Organization + - Mannequin + url: type: string + format: uri required: - - payload - webhook-check-run-requested-action: - title: Check Run Requested Action Event + - login + - id + webhooks_marketplace_purchase: + title: Marketplace Purchase type: object + required: + - account + - billing_cycle + - free_trial_ends_on + - next_billing_date + - on_free_trial + - plan + - unit_count properties: - action: + account: + type: object + required: + - type + - id + - node_id + - login + - organization_billing_email + properties: + id: + type: integer + login: + type: string + node_id: + type: string + organization_billing_email: + type: string + nullable: true + type: + type: string + billing_cycle: type: string - enum: - - requested_action - check_run: - "$ref": "#/components/schemas/check-run-with-simple-check-suite" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - requested_action: - description: The action requested by the user. + free_trial_ends_on: + type: string + nullable: true + next_billing_date: + type: string + nullable: true + on_free_trial: + type: boolean + plan: type: object + required: + - id + - name + - description + - monthly_price_in_cents + - yearly_price_in_cents + - price_model + - has_free_trial + - unit_name + - bullets properties: - identifier: - description: The integrator reference of the action requested by the - user. + bullets: + type: array + items: + type: string + nullable: true + description: type: string - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - check_run - - repository - - sender - webhook-check-run-requested-action-form-encoded: - title: Check Run Requested Action Event - description: The check_run.requested_action webhook encoded with URL encoding + has_free_trial: + type: boolean + id: + type: integer + monthly_price_in_cents: + type: integer + name: + type: string + price_model: + type: string + enum: + - FREE + - FLAT_RATE + - PER_UNIT + unit_name: + type: string + nullable: true + yearly_price_in_cents: + type: integer + unit_count: + type: integer + webhooks_previous_marketplace_purchase: + title: Marketplace Purchase type: object properties: - payload: - description: A URL-encoded string of the check_run.requested_action JSON - payload. The decoded payload is a JSON object. + account: + type: object + properties: + id: + type: integer + login: + type: string + node_id: + type: string + organization_billing_email: + type: string + nullable: true + type: + type: string + required: + - type + - id + - node_id + - login + - organization_billing_email + billing_cycle: + type: string + free_trial_ends_on: + nullable: true + next_billing_date: type: string + nullable: true + on_free_trial: + type: boolean + plan: + type: object + properties: + bullets: + type: array + items: + type: string + description: + type: string + has_free_trial: + type: boolean + id: + type: integer + monthly_price_in_cents: + type: integer + name: + type: string + price_model: + type: string + enum: + - FREE + - FLAT_RATE + - PER_UNIT + unit_name: + type: string + nullable: true + yearly_price_in_cents: + type: integer + required: + - id + - name + - description + - monthly_price_in_cents + - yearly_price_in_cents + - price_model + - has_free_trial + - unit_name + - bullets + unit_count: + type: integer required: - - payload - webhook-check-run-rerequested: - title: Check Run Re-Requested Event + - account + - billing_cycle + - unit_count + - on_free_trial + - free_trial_ends_on + - plan + webhooks_team: + title: Team + description: Groups of organization members that gives permissions on specified + repositories. type: object properties: - action: + deleted: + type: boolean + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: object + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + notification_setting: + description: Whether team members will receive notifications when their + team is @mentioned + type: string + enum: + - notifications_enabled + - notifications_disabled + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - notification_setting + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: type: string enum: - - rerequested - check_run: - "$ref": "#/components/schemas/check-run-with-simple-check-suite" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" + - open + - closed + - secret + notification_setting: + type: string + enum: + - notifications_enabled + - notifications_disabled + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri required: - - check_run - - repository - - sender - webhook-check-run-rerequested-form-encoded: - title: Check Run Re-Requested Event - description: The check_run.rerequested webhook encoded with URL encoding + - name + - id + merge-group: type: object + title: Merge Group + description: 'A group of pull requests that the merge queue has grouped together + to be merged. + + ' properties: - payload: - description: A URL-encoded string of the check_run.rerequested JSON payload. - The decoded payload is a JSON object. + head_sha: + description: The SHA of the merge group. + type: string + head_ref: + description: The full ref of the merge group. type: string + base_sha: + description: The SHA of the merge group's parent commit. + type: string + base_ref: + description: The full ref of the branch the merge group will be merged into. + type: string + head_commit: + "$ref": "#/components/schemas/simple-commit" required: - - payload - webhook-check-suite-completed: - title: check_suite completed event + - head_sha + - head_ref + - base_sha + - base_ref + - head_commit + nullable-repository-webhooks: + title: Repository + description: |- + The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property + when the event occurs from activity in a repository. type: object properties: - action: + id: + description: Unique identifier of the repository + example: 42 + type: integer + node_id: type: string - enum: - - completed - check_suite: - description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). + example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: + description: The name of the repository. + type: string + example: Team Environment + full_name: + type: string + example: octocat/Hello-World + license: + "$ref": "#/components/schemas/nullable-license-simple" + organization: + "$ref": "#/components/schemas/nullable-simple-user" + forks: + type: integer + permissions: type: object properties: - after: + admin: + type: boolean + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + required: + - admin + - pull + - push + owner: + "$ref": "#/components/schemas/simple-user" + private: + description: Whether the repository is private or public. + default: false + type: boolean + html_url: + type: string + format: uri + example: https://github.com/octocat/Hello-World + description: + type: string + example: This your first repo! + nullable: true + fork: + type: boolean + url: + type: string + format: uri + example: https://api.github.com/repos/octocat/Hello-World + archive_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} + assignees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} + blobs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} + branches_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} + collaborators_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} + comments_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/comments{/number} + commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} + compare_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} + contents_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} + contributors_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/contributors + deployments_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/deployments + downloads_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/downloads + events_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/events + forks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/forks + git_commits_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} + git_refs_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} + git_tags_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} + git_url: + type: string + example: git:github.com/octocat/Hello-World.git + issue_comment_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} + issue_events_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number} + issues_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/issues{/number} + keys_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} + labels_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/labels{/name} + languages_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/languages + merges_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/merges + milestones_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} + notifications_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} + pulls_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} + releases_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/releases{/id} + ssh_url: + type: string + example: git@github.com:octocat/Hello-World.git + stargazers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/stargazers + statuses_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} + subscribers_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscribers + subscription_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/subscription + tags_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/tags + teams_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/teams + trees_url: + type: string + example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} + clone_url: + type: string + example: https://github.com/octocat/Hello-World.git + mirror_url: + type: string + format: uri + example: git:git.example.com/octocat/Hello-World + nullable: true + hooks_url: + type: string + format: uri + example: http://api.github.com/repos/octocat/Hello-World/hooks + svn_url: + type: string + format: uri + example: https://svn.github.com/octocat/Hello-World + homepage: + type: string + format: uri + example: https://github.com + nullable: true + language: + type: string + nullable: true + forks_count: + type: integer + example: 9 + stargazers_count: + type: integer + example: 80 + watchers_count: + type: integer + example: 80 + size: + description: The size of the repository, in kilobytes. Size is calculated + hourly. When a repository is initially created, the size is 0. + type: integer + example: 108 + default_branch: + description: The default branch of the repository. + type: string + example: master + open_issues_count: + type: integer + example: 0 + is_template: + description: Whether this repository acts as a template that can be used + to generate new repositories. + default: false + type: boolean + example: true + topics: + type: array + items: + type: string + custom_properties: + type: object + description: The custom properties that were defined for the repository. + The keys are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + has_issues: + description: Whether issues are enabled. + default: true + type: boolean + example: true + has_projects: + description: Whether projects are enabled. + default: true + type: boolean + example: true + has_wiki: + description: Whether the wiki is enabled. + default: true + type: boolean + example: true + has_pages: + type: boolean + has_downloads: + description: Whether downloads are enabled. + default: true + type: boolean + example: true + has_discussions: + description: Whether discussions are enabled. + default: false + type: boolean + example: true + archived: + description: Whether the repository is archived. + default: false + type: boolean + disabled: + type: boolean + description: Returns whether or not this repository disabled. + visibility: + description: 'The repository visibility: public, private, or internal.' + default: public + type: string + pushed_at: + type: string + format: date-time + example: '2011-01-26T19:06:43Z' + nullable: true + created_at: + type: string + format: date-time + example: '2011-01-26T19:01:12Z' + nullable: true + updated_at: + type: string + format: date-time + example: '2011-01-26T19:14:43Z' + nullable: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + default: true + type: boolean + example: true + template_repository: + nullable: true + type: object + properties: + id: + type: integer + node_id: type: string - nullable: true - app: - title: 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. + name: + type: string + full_name: + type: string + owner: type: object properties: - created_at: + login: type: string - nullable: true - format: date-time - description: + id: + type: integer + node_id: type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - - merge_group - - pull_request_review_thread - - workflow_job - - merge_queue_entry - - security_and_analysis - - projects_v2_item - - secret_scanning_alert_location - external_url: + avatar_url: + type: string + gravatar_id: + type: string + url: type: string - nullable: true - format: uri html_url: type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app + followers_url: type: string - node_id: + following_url: type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app + gists_url: type: string - updated_at: + starred_url: type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - before: + subscriptions_url: + type: string + organizations_url: + type: string + repos_url: + type: string + events_url: + type: string + received_events_url: + type: string + type: + type: string + site_admin: + type: boolean + private: + type: boolean + html_url: type: string - nullable: true - check_runs_url: + description: type: string - format: uri - conclusion: - description: The summary conclusion for all check runs that are part - of the check suite. This value will be `null` until the check run - has `completed`. + fork: + type: boolean + url: type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - - - skipped - - startup_failure - created_at: + archive_url: type: string - format: date-time - head_branch: - description: The head branch name the changes are on. + assignees_url: type: string - nullable: true - head_commit: - title: SimpleCommit - type: object - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - required: - - id - - tree_id - - message - - timestamp - - author - - committer - head_sha: - description: The SHA of the head commit that is being checked. + blobs_url: type: string - id: + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + downloads_url: + type: string + events_url: + type: string + forks_url: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + git_url: + type: string + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + notifications_url: + type: string + pulls_url: + type: string + releases_url: + type: string + ssh_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + clone_url: + type: string + mirror_url: + type: string + hooks_url: + type: string + svn_url: + type: string + homepage: + type: string + language: + type: string + forks_count: type: integer - latest_check_runs_count: + stargazers_count: type: integer - node_id: + watchers_count: + type: integer + size: + type: integer + default_branch: type: string - pull_requests: - description: An array of pull requests that match this check suite. - A pull request matches a check suite if they have the same `head_sha` - and `head_branch`. When the check suite's `head_branch` is in a forked - repository it will be `null` and the `pull_requests` array will be - empty. + open_issues_count: + type: integer + is_template: + type: boolean + topics: type: array items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - rerequestable: + type: string + has_issues: type: boolean - runs_rerequestable: + has_projects: type: boolean - status: - description: The summary status for all check runs that are part of - the check suite. Can be `requested`, `in_progress`, or `completed`. + has_wiki: + type: boolean + has_pages: + type: boolean + has_downloads: + type: boolean + archived: + type: boolean + disabled: + type: boolean + visibility: + type: string + pushed_at: + type: string + created_at: type: string - nullable: true - enum: - - requested - - in_progress - - completed - - queued - - - - pending updated_at: type: string - format: date-time + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + push: + type: boolean + triage: + type: boolean + pull: + type: boolean + allow_rebase_merge: + type: boolean + temp_clone_token: + type: string + allow_squash_merge: + type: boolean + allow_auto_merge: + type: boolean + delete_branch_on_merge: + type: boolean + allow_update_branch: + type: boolean + use_squash_pr_title_as_default: + type: boolean + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + temp_clone_token: + type: string + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + default: true + type: boolean + example: true + allow_auto_merge: + description: Whether to allow Auto-merge to be used on pull requests. + default: false + type: boolean + example: false + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged + default: false + type: boolean + example: false + allow_update_branch: + description: Whether or not a pull request head branch that is behind its + base branch can always be updated even if it is not required to be up + to date before merging. + default: false + type: boolean + example: false + use_squash_pr_title_as_default: + type: boolean + description: Whether a squash merge commit can use the pull request title + as default. **This property has been deprecated. Please use `squash_merge_commit_title` + instead. + default: false + deprecated: true + squash_merge_commit_title: + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + squash_merge_commit_message: + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + merge_commit_title: + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + merge_commit_message: + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + default: true + type: boolean + example: true + allow_forking: + description: Whether to allow forking this repo + type: boolean + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based commits + default: false + type: boolean + subscribers_count: + type: integer + network_count: + type: integer + open_issues: + type: integer + watchers: + type: integer + master_branch: + type: string + starred_at: + type: string + example: '"2020-07-09T00:17:42Z"' + anonymous_access_enabled: + type: boolean + description: Whether anonymous git access is enabled for this 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 + - clone_url + - default_branch + - forks + - forks_count + - git_url + - has_downloads + - has_issues + - has_projects + - has_wiki + - has_pages + - homepage + - language + - archived + - disabled + - mirror_url + - open_issues + - open_issues_count + - license + - pushed_at + - size + - ssh_url + - stargazers_count + - svn_url + - watchers + - watchers_count + - created_at + - updated_at + nullable: true + webhooks_milestone_3: + title: Milestone + description: A collection of related issues and pull requests. + type: object + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: - description: URL that points to the check suite API resource. type: string format: uri required: + - login - id - - node_id - - head_branch - - head_sha - - status - - conclusion - - url - - before - - after - - pull_requests - - app - - created_at - - updated_at - - latest_check_runs_count - - check_runs_url - - head_commit - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri required: - - action - - check_suite - - repository - - sender - webhook-check-suite-requested: - title: check_suite requested event + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + webhooks_membership: + title: Membership + description: The membership between the user and the organization. Not present + when the action is `member_invited`. type: object properties: - action: + organization_url: type: string - enum: - - requested - check_suite: - description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). + format: uri + role: + type: string + state: + type: string + url: + type: string + format: uri + user: + title: User type: object + nullable: true properties: - after: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: string nullable: true - app: - title: 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. - type: object - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - - workflow_job - - merge_queue_entry - - security_and_analysis - - secret_scanning_alert_location - - projects_v2_item - - merge_group - - repository_import - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - before: + events_url: type: string - nullable: true - check_runs_url: + format: uri-template + followers_url: type: string format: uri - conclusion: - description: The summary conclusion for all check runs that are part - of the check suite. This value will be `null` until the check run - has completed. + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string - nullable: true enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - - - skipped - created_at: + - Bot + - User + - Organization + url: type: string - format: date-time - head_branch: - description: The head branch name the changes are on. + format: uri + required: + - login + - id + required: + - url + - state + - role + - organization_url + - user + personal-access-token-request: + title: Personal Access Token Request + description: Details of a Personal Access Token Request. + type: object + properties: + id: + type: integer + description: Unique identifier of the request for access via fine-grained + personal access token. Used as the `pat_request_id` parameter in the list + and review API calls. + owner: + "$ref": "#/components/schemas/simple-user" + permissions_added: + type: object + description: New requested permissions, categorized by type of permission. + properties: + organization: + type: object + additionalProperties: + type: string + repository: + type: object + additionalProperties: + type: string + other: + type: object + additionalProperties: + type: string + permissions_upgraded: + type: object + description: Requested permissions that elevate access for a previously + approved request for access, categorized by type of permission. + properties: + organization: + type: object + additionalProperties: + type: string + repository: + type: object + additionalProperties: + type: string + other: + type: object + additionalProperties: + type: string + permissions_result: + type: object + description: Permissions requested, categorized by type of permission. This + field incorporates `permissions_added` and `permissions_upgraded`. + properties: + organization: + type: object + additionalProperties: + type: string + repository: + type: object + additionalProperties: + type: string + other: + type: object + additionalProperties: + type: string + repository_selection: + type: string + description: Type of repository selection requested. + enum: + - none + - all + - subset + repository_count: + description: The number of repositories the token is requesting access to. + This field is only populated when `repository_selection` is `subset`. + type: integer + nullable: true + repositories: + type: array + description: An array of repository objects the token is requesting access + to. This field is only populated when `repository_selection` is `subset`. + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + required: + - id + - node_id + - name + - full_name + - private + nullable: true + created_at: + type: string + description: Date and time when the request for access was created. + token_expired: + type: boolean + description: Whether the associated fine-grained personal access token has + expired. + token_expires_at: + type: string + description: Date and time when the associated fine-grained personal access + token expires. + nullable: true + token_last_used_at: + type: string + description: Date and time when the associated fine-grained personal access + token was last used for authentication. + nullable: true + required: + - id + - owner + - permissions_added + - permissions_upgraded + - permissions_result + - repository_selection + - repository_count + - repositories + - created_at + - token_expired + - token_expires_at + - token_last_used_at + webhooks_project_card: + title: Project Card + type: object + properties: + after_id: + type: integer + nullable: true + archived: + description: Whether or not the card is archived + type: boolean + column_id: + type: integer + column_url: + type: string + format: uri + content_url: + type: string + format: uri + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: string nullable: true - head_commit: - title: SimpleCommit - type: object - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - required: - - id - - tree_id - - message - - timestamp - - author - - committer - head_sha: - description: The SHA of the head commit that is being checked. + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: type: string + html_url: + type: string + format: uri id: type: integer - latest_check_runs_count: - type: integer + login: + type: string + name: + type: string node_id: type: string - pull_requests: - description: An array of pull requests that match this check suite. - A pull request matches a check suite if they have the same `head_sha` - and `head_branch`. When the check suite's `head_branch` is in a forked - repository it will be `null` and the `pull_requests` array will be - empty. - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - rerequestable: + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: type: boolean - runs_rerequestable: + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + id: + description: The project card's ID + type: integer + node_id: + type: string + note: + type: string + nullable: true + project_url: + type: string + format: uri + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - project_url + - column_url + - column_id + - id + - node_id + - note + - archived + - creator + - created_at + - updated_at + webhooks_project: + title: Project + type: object + properties: + body: + description: Body of the project + type: string + nullable: true + columns_url: + type: string + format: uri + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: type: boolean - status: - description: The summary status for all check runs that are part of - the check suite. Can be `requested`, `in_progress`, or `completed`. + email: type: string nullable: true - enum: - - requested - - in_progress - - completed - - queued - - - updated_at: + events_url: type: string - format: date-time + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: - description: URL that points to the check suite API resource. type: string format: uri required: + - login - id - - node_id - - head_branch - - head_sha - - status - - conclusion - - url - - before - - after - - pull_requests - - app - - created_at - - updated_at - - latest_check_runs_count - - check_runs_url - - head_commit - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" + html_url: + type: string + format: uri + id: + type: integer + name: + description: Name of the project + type: string + node_id: + type: string + number: + type: integer + owner_url: + type: string + format: uri + state: + description: State of the project; either 'open' or 'closed' + type: string + enum: + - open + - closed + updated_at: + type: string + format: date-time + url: + type: string + format: uri required: - - action - - check_suite - - repository - - sender - webhook-check-suite-rerequested: - title: check_suite rerequested event + - owner_url + - url + - html_url + - columns_url + - id + - node_id + - name + - body + - number + - state + - creator + - created_at + - updated_at + webhooks_project_column: + title: Project Column type: object properties: - action: + after_id: + type: integer + nullable: true + cards_url: type: string - enum: - - rerequested - check_suite: - description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). + format: uri + created_at: + type: string + format: date-time + id: + description: The unique identifier of the project column + type: integer + name: + description: Name of the project column + type: string + node_id: + type: string + project_url: + type: string + format: uri + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - project_url + - cards_url + - id + - node_id + - name + - created_at + - updated_at + projects-v2: + title: Projects v2 Project + description: A projects v2 project + type: object + properties: + id: + type: number + node_id: + type: string + owner: + "$ref": "#/components/schemas/simple-user" + creator: + "$ref": "#/components/schemas/simple-user" + title: + type: string + description: + type: string + nullable: true + public: + type: boolean + closed_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + number: + type: integer + short_description: + type: string + nullable: true + deleted_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + deleted_by: + "$ref": "#/components/schemas/nullable-simple-user" + required: + - id + - node_id + - owner + - creator + - title + - description + - public + - closed_at + - created_at + - updated_at + - number + - short_description + - deleted_at + - deleted_by + webhooks_project_changes: + type: object + properties: + archived_at: type: object properties: - after: + from: type: string nullable: true - app: - title: 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. - type: object - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - - merge_queue_entry - - workflow_job - external_url: + format: date-time + to: + type: string + nullable: true + format: date-time + projects-v2-item-content-type: + title: Projects v2 Item Content Type + description: The type of content tracked in a project item + type: string + enum: + - Issue + - PullRequest + - DraftIssue + projects-v2-item: + title: Projects v2 Item + description: An item belonging to a project + type: object + properties: + id: + type: number + node_id: + type: string + project_node_id: + type: string + content_node_id: + type: string + content_type: + "$ref": "#/components/schemas/projects-v2-item-content-type" + creator: + "$ref": "#/components/schemas/simple-user" + created_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + updated_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + archived_at: + type: string + format: date-time + example: '2022-04-28T12:00:00Z' + nullable: true + required: + - id + - content_node_id + - content_type + - created_at + - updated_at + - archived_at + webhooks_number: + description: The pull request number. + type: integer + pull-request-webhook: + allOf: + - "$ref": "#/components/schemas/pull-request" + - type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_update_branch: + description: Whether to allow updating the pull request's branch. + type: boolean + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are merged. + type: boolean + default: false + merge_commit_message: + description: |- + The default value for a merge commit message. + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull request title + as default. **This property has been deprecated. Please use `squash_merge_commit_title` + instead.** + type: boolean + default: false + webhooks_pull_request_5: + title: Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: type: string - nullable: true - format: uri - html_url: + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: type: string - node_id: + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: type: string - updated_at: + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: type: string - nullable: true - format: date-time + format: uri-template required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - before: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: string nullable: true - check_runs_url: + events_url: + type: string + format: uri-template + followers_url: type: string format: uri - conclusion: - description: The summary conclusion for all check runs that are part - of the check suite. This value will be `null` until the check run - has completed. + following_url: type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - - created_at: + format: uri-template + gists_url: type: string - format: date-time - head_branch: - description: The head branch name the changes are on. + format: uri-template + gravatar_id: type: string - nullable: true - head_commit: - title: SimpleCommit - type: object - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - required: - - id - - tree_id - - message - - timestamp - - author - - committer - head_sha: - description: The SHA of the head commit that is being checked. + html_url: type: string + format: uri id: type: integer - latest_check_runs_count: - type: integer + login: + type: string + name: + type: string node_id: type: string - pull_requests: - description: An array of pull requests that match this check suite. - A pull request matches a check suite if they have the same `head_sha` - and `head_branch`. When the check suite's `head_branch` is in a forked - repository it will be `null` and the `pull_requests` array will be - empty. - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - rerequestable: - type: boolean - runs_rerequestable: + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: type: boolean - status: - description: The summary status for all check runs that are part of - the check suite. Can be `requested`, `in_progress`, or `completed`. + starred_url: type: string - nullable: true - enum: - - requested - - in_progress - - completed - - queued - - - updated_at: + format: uri-template + subscriptions_url: type: string - format: date-time + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin url: - description: URL that points to the check suite API resource. type: string format: uri required: + - login - id - - node_id - - head_branch - - head_sha - - status - - conclusion - - url - - before - - after - - pull_requests - - app - - created_at - - updated_at - - latest_check_runs_count - - check_runs_url - - head_commit - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - check_suite - - repository - - sender - webhook-code-scanning-alert-appeared-in-branch: - title: code_scanning_alert appeared_in_branch event - type: object - properties: - action: + assignees: + type: array + items: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. type: string enum: - - appeared_in_branch - alert: - description: The code scanning alert involved in the event. + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. type: object + nullable: true properties: - created_at: - description: 'The time that the alert was created in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ.`' + commit_message: + description: Commit message for the merge commit. type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + commit_title: + description: Title for the merge commit message. type: string nullable: true - format: date-time - dismissed_by: + enabled_by: title: User type: object nullable: true @@ -90571,672 +93268,533 @@ components: required: - login - id - dismissed_reason: - description: The reason for dismissing or closing the alert. + merge_method: + description: The merge method to use. type: string - nullable: true enum: - - false positive - - won't fix - - used in tests - - - html_url: - description: The GitHub URL of the alert resource. + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: type: string - format: uri - most_recent_instance: - title: Alert Instance + ref: + type: string + repo: + title: Repository + description: A git repository type: object - nullable: true properties: - analysis_key: - description: Identifies the configuration under which the analysis - was executed. For example, in GitHub Actions this includes the - workflow filename and job name. + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: type: string - category: - description: Identifies the configuration under which the analysis - was executed. + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: type: string - classifications: - type: array - items: - type: string - commit_sha: + format: uri-template + blobs_url: type: string - environment: - description: Identifies the variable values associated with the - environment in which the analysis that generated this alert instance - was performed, such as the language that was analyzed. + format: uri-template + branches_url: type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. + format: uri-template + clone_url: type: string - state: - description: State of a code scanning alert. + format: uri + collaborators_url: type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect the - alert. + format: uri-template + comments_url: type: string - id: - description: A unique identifier for the rule used to detect the - alert. + format: uri-template + commits_url: type: string - severity: - description: The severity of the alert. + format: uri-template + compare_url: type: string - nullable: true - enum: - - none - - note - - warning - - error - - - required: - - id - - severity - - description - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - tool: - type: object - properties: - name: - description: The name of the tool used to generate the code scanning - analysis alert. + format: uri-template + contents_url: type: string - version: - description: The version of the tool used to detect the alert. + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: type: string nullable: true - required: - - name - - version - url: - type: string - format: uri - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - description: The commit SHA of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - ref: - description: The Git reference of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - webhook-code-scanning-alert-closed-by-user: - title: code_scanning_alert closed_by_user event - type: object - properties: - action: - type: string - enum: - - closed_by_user - alert: - description: The code scanning alert involved in the event. - type: object - properties: - created_at: - description: 'The time that the alert was created in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - type: string - format: date-time - dismissed_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: + disabled: + description: Returns whether or not this repository is disabled. type: boolean - email: + downloads_url: type: string - nullable: true + format: uri events_url: type: string - format: uri-template - followers_url: + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: type: string format: uri - following_url: + full_name: + type: string + git_commits_url: type: string format: uri-template - gists_url: + git_refs_url: type: string format: uri-template - gravatar_id: + git_tags_url: type: string - html_url: + format: uri-template + git_url: type: string format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: type: string - format: uri - received_events_url: + nullable: true + hooks_url: type: string format: uri - repos_url: + html_url: type: string format: uri - site_admin: + id: + description: Unique identifier of the repository + type: integer + is_template: type: boolean - starred_url: + issue_comment_url: type: string format: uri-template - subscriptions_url: - type: string - format: uri - type: + issue_events_url: type: string - enum: - - Bot - - User - - Organization - url: + format: uri-template + issues_url: type: string - format: uri - required: - - login - - id - dismissed_reason: - description: The reason for dismissing or closing the alert. - type: string - nullable: true - enum: - - false positive - - won't fix - - used in tests - - - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - most_recent_instance: - title: Alert Instance - type: object - nullable: true - properties: - analysis_key: - description: Identifies the configuration under which the analysis - was executed. For example, in GitHub Actions this includes the - workflow filename and job name. + format: uri-template + keys_url: type: string - category: - description: Identifies the configuration under which the analysis - was executed. + format: uri-template + labels_url: type: string - classifications: - type: array - items: - type: string - commit_sha: + format: uri-template + language: type: string - environment: - description: Identifies the variable values associated with the - environment in which the analysis that generated this alert instance - was performed, such as the language that was analyzed. + nullable: true + languages_url: type: string - location: + format: uri + license: + title: License type: object + nullable: true properties: - end_column: - type: integer - end_line: - type: integer - path: + key: type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: + name: type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: type: string - state: - description: State of a code scanning alert. + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. type: string enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect the - alert. - type: string - full_description: - type: string - help: - type: string - nullable: true - help_uri: - description: A link to the documentation for the rule used to detect - the alert. - type: string - nullable: true - id: - description: A unique identifier for the rule used to detect the - alert. - type: string - name: - type: string - severity: - description: The severity of the alert. + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). type: string - nullable: true enum: - - none - - note - - warning - - error - - - tags: - type: array - nullable: true - items: - type: string - required: - - id - - severity - - description - state: - description: State of a code scanning alert. - type: string - enum: - - dismissed - - fixed - tool: - type: object - properties: - guid: + - PR_TITLE + - MERGE_MESSAGE + merges_url: type: string - nullable: true - name: - description: The name of the tool used to generate the code scanning - analysis alert. + format: uri + milestones_url: type: string - version: - description: The version of the tool used to detect the alert. + format: uri-template + mirror_url: type: string nullable: true - required: - - name - - version - url: - type: string - format: uri - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - description: The commit SHA of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - ref: - description: The Git reference of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - webhook-code-scanning-alert-created: - title: code_scanning_alert created event - type: object - properties: - action: - type: string - enum: - - created - alert: - description: The code scanning alert involved in the event. - type: object - properties: - created_at: - description: 'The time that the alert was created in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - nullable: true - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - dismissed_by: - nullable: true - dismissed_comment: - "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" - dismissed_reason: - description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' - nullable: true - fixed_at: - nullable: true - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - instances_url: - type: string - most_recent_instance: - title: Alert Instance - type: object - nullable: true - properties: - analysis_key: - description: Identifies the configuration under which the analysis - was executed. For example, in GitHub Actions this includes the - workflow filename and job name. + format: uri + name: + description: The name of the repository. type: string - category: - description: Identifies the configuration under which the analysis - was executed. + node_id: type: string - classifications: - type: array - items: - type: string - commit_sha: + notifications_url: type: string - environment: - description: Identifies the variable values associated with the - environment in which the analysis that generated this alert instance - was performed, such as the language that was analyzed. + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: type: string - location: + owner: + title: User type: object + nullable: true properties: - end_column: - type: integer - end_line: - type: integer - path: + avatar_url: type: string - start_column: - type: integer - start_line: + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: type: integer - message: + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: type: object properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: type: string - state: - description: State of a code scanning alert. + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. type: string enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect the - alert. + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). type: string - full_description: + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: type: string - help: + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: type: string - nullable: true - help_uri: - description: A link to the documentation for the rule used to detect - the alert. + format: uri + statuses_url: type: string - nullable: true - id: - description: A unique identifier for the rule used to detect the - alert. + format: uri-template + subscribers_url: type: string - name: + format: uri + subscription_url: type: string - severity: - description: The severity of the alert. + format: uri + svn_url: type: string - nullable: true - enum: - - none - - note - - warning - - error - - - tags: + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: type: array - nullable: true items: type: string - required: - - id - - severity - - description - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - tool: - type: object - nullable: true - properties: - guid: + trees_url: type: string - nullable: true - name: - description: The name of the tool used to generate the code scanning - analysis alert. + format: uri-template + updated_at: type: string - version: - description: The version of the tool used to detect the alert. + format: date-time + url: type: string - nullable: true + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull request + title as default. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based + commits + type: boolean required: + - id + - node_id - name - - version - updated_at: - type: string - nullable: true - url: - type: string - format: uri - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - description: The commit SHA of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - ref: - description: The Git reference of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - webhook-code-scanning-alert-fixed: - title: code_scanning_alert fixed event - type: object - properties: - action: - type: string - enum: - - fixed - alert: - description: The code scanning alert involved in the event. - type: object - properties: - created_at: - description: 'The time that the alert was created in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: type: string - nullable: true - format: date-time - dismissed_by: + user: title: User type: object nullable: true @@ -91303,673 +93861,775 @@ components: required: - login - id - dismissed_reason: - description: The reason for dismissing or closing the alert. - type: string - nullable: true - enum: - - false positive - - won't fix - - used in tests - - - html_url: - description: The GitHub URL of the alert resource. + required: + - label + - ref + - sha + - user + - repo + body: + type: string + nullable: true + changed_files: + type: integer + closed_at: + type: string + nullable: true + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + commits: + type: integer + commits_url: + type: string + format: uri + created_at: + type: string + format: date-time + deletions: + type: integer + diff_url: + type: string + format: uri + draft: + description: Indicates whether or not the pull request is a draft. + type: boolean + head: + type: object + properties: + label: type: string - format: uri - instances_url: + ref: type: string - format: uri - most_recent_instance: - title: Alert Instance + repo: + title: Repository + description: A git repository type: object - nullable: true properties: - analysis_key: - description: Identifies the configuration under which the analysis - was executed. For example, in GitHub Actions this includes the - workflow filename and job name. + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: type: string - category: - description: Identifies the configuration under which the analysis - was executed. + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: type: string - classifications: - type: array - items: - type: string - commit_sha: + format: uri-template + blobs_url: type: string - environment: - description: Identifies the variable values associated with the - environment in which the analysis that generated this alert instance - was performed, such as the language that was analyzed. + format: uri-template + branches_url: type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. + format: uri-template + clone_url: type: string - state: - description: State of a code scanning alert. + format: uri + collaborators_url: type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect the - alert. + format: uri-template + comments_url: type: string - full_description: + format: uri-template + commits_url: type: string - help: + format: uri-template + compare_url: type: string - nullable: true - help_uri: - description: A link to the documentation for the rule used to detect - the alert. + format: uri-template + contents_url: type: string - nullable: true - id: - description: A unique identifier for the rule used to detect the - alert. + format: uri-template + contributors_url: type: string - name: + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. type: string - severity: - description: The severity of the alert. + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: type: string - nullable: true - enum: - - none - - note - - warning - - error - - - tags: - type: array - nullable: true - items: - type: string - required: - - id - - severity - - description - state: - description: State of a code scanning alert. - type: string - enum: - - fixed - tool: - type: object - properties: - guid: + format: uri + description: type: string nullable: true - name: - description: The name of the tool used to generate the code scanning - analysis alert. + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: type: string - version: - description: The version of the tool used to detect the alert. + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: type: string nullable: true - required: - - name - - version - url: - type: string - format: uri - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - description: The commit SHA of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - ref: - description: The Git reference of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - webhook-code-scanning-alert-reopened: - title: code_scanning_alert reopened event - type: object - properties: - action: - type: string - enum: - - reopened - alert: - description: The code scanning alert involved in the event. - type: object - nullable: true - properties: - created_at: - description: 'The time that the alert was created in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - type: string - nullable: true - dismissed_by: - type: object - nullable: true - dismissed_reason: - description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' - type: string - nullable: true - html_url: - description: The GitHub URL of the alert resource. - type: string - format: uri - most_recent_instance: - title: Alert Instance - type: object - nullable: true - properties: - analysis_key: - description: Identifies the configuration under which the analysis - was executed. For example, in GitHub Actions this includes the - workflow filename and job name. + hooks_url: type: string - category: - description: Identifies the configuration under which the analysis - was executed. + format: uri + html_url: type: string - classifications: - type: array - items: - type: string - commit_sha: + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: type: string - environment: - description: Identifies the variable values associated with the - environment in which the analysis that generated this alert instance - was performed, such as the language that was analyzed. + format: uri-template + issue_events_url: type: string - location: + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: string + nullable: true + languages_url: + type: string + format: uri + license: + title: License type: object + nullable: true properties: - end_column: - type: integer - end_line: - type: integer - path: + key: type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: + name: type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: type: string - state: - description: State of a code scanning alert. + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. type: string enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect the - alert. + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). type: string - full_description: + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: type: string - help: + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: type: string nullable: true - help_uri: - description: A link to the documentation for the rule used to detect - the alert. + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: type: string + owner: + title: User + type: object nullable: true - id: - description: A unique identifier for the rule used to detect the - alert. + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: type: string - name: + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: type: string - severity: - description: The severity of the alert. + format: uri-template + role_name: type: string nullable: true + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string enum: - - none - - note - - warning - - error - - - tags: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: type: array - nullable: true items: type: string - required: - - id - - severity - - description - state: - description: State of a code scanning alert. - type: string - enum: - - open - - dismissed - - fixed - tool: - type: object - properties: - guid: + trees_url: type: string - nullable: true - name: - description: The name of the tool used to generate the code scanning - analysis alert. + format: uri-template + updated_at: type: string - version: - description: The version of the tool used to detect the alert. + format: date-time + url: type: string - nullable: true + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull request + title as default. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based + commits + type: boolean required: + - id + - node_id - name - - version - url: - type: string - format: uri - required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - description: The commit SHA of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - nullable: true - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - ref: - description: The Git reference of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. - type: string - nullable: true - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - webhook-code-scanning-alert-reopened-by-user: - title: code_scanning_alert reopened_by_user event - type: object - properties: - action: - type: string - enum: - - reopened_by_user - alert: - description: The code scanning alert involved in the event. - type: object - properties: - created_at: - description: 'The time that the alert was created in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ.`' - type: string - format: date-time - dismissed_at: - description: 'The time that the alert was dismissed in ISO 8601 format: - `YYYY-MM-DDTHH:MM:SSZ`.' - nullable: true - dismissed_by: - nullable: true - dismissed_reason: - description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' - nullable: true - html_url: - description: The GitHub URL of the alert resource. + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: type: string - format: uri - most_recent_instance: - title: Alert Instance + user: + title: User type: object nullable: true properties: - analysis_key: - description: Identifies the configuration under which the analysis - was executed. For example, in GitHub Actions this includes the - workflow filename and job name. + avatar_url: type: string - category: - description: Identifies the configuration under which the analysis - was executed. + format: uri + deleted: + type: boolean + email: type: string - classifications: - type: array - items: - type: string - commit_sha: + nullable: true + events_url: type: string - environment: - description: Identifies the variable values associated with the - environment in which the analysis that generated this alert instance - was performed, such as the language that was analyzed. + format: uri-template + followers_url: type: string - location: - type: object - properties: - end_column: - type: integer - end_line: - type: integer - path: - type: string - start_column: - type: integer - start_line: - type: integer - message: - type: object - properties: - text: - type: string - ref: - description: The full Git reference, formatted as `refs/heads/`. + format: uri + following_url: type: string - state: - description: State of a code scanning alert. + format: uri-template + gists_url: type: string - enum: - - open - - dismissed - - fixed - required: - - ref - - analysis_key - - environment - - state - number: - description: The code scanning alert number. - type: integer - rule: - type: object - properties: - description: - description: A short description of the rule used to detect the - alert. + format: uri-template + gravatar_id: type: string - id: - description: A unique identifier for the rule used to detect the - alert. + html_url: type: string - severity: - description: The severity of the alert. + format: uri + id: + type: integer + login: type: string - nullable: true - enum: - - none - - note - - warning - - error - - - required: - - id - - severity - - description - state: - description: State of a code scanning alert. - type: string - enum: - - open - - fixed - tool: - type: object - properties: name: - description: The name of the tool used to generate the code scanning - analysis alert. type: string - version: - description: The version of the tool used to detect the alert. + node_id: type: string - nullable: true + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri required: - - name - - version - url: - type: string - format: uri + - login + - id required: - - number - - created_at - - url - - html_url - - state - - dismissed_by - - dismissed_at - - dismissed_reason - - rule - - tool - commit_oid: - description: The commit SHA of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. + - label + - ref + - sha + - user + - repo + html_url: type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - ref: - description: The Git reference of the code scanning alert. When the action - is `reopened_by_user` or `closed_by_user`, the event was triggered by - the `sender` and this value will be empty. + format: uri + id: + type: integer + issue_url: type: string - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - ref - - commit_oid - - repository - - sender - webhook-commit-comment-created: - title: commit_comment created event - type: object - properties: - action: - description: The action performed. Can be `created`. + format: uri + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + merge_commit_sha: type: string - enum: - - created - comment: - description: The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) - resource. + nullable: true + mergeable: + type: boolean + nullable: true + mergeable_state: + type: string + merged: + type: boolean + nullable: true + merged_at: + type: string + nullable: true + format: date-time + merged_by: + title: User type: object + nullable: true properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. + avatar_url: type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. + format: uri + deleted: + type: boolean + email: type: string - commit_id: - description: The SHA of the commit to which the comment applies. + nullable: true + events_url: type: string - created_at: + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: type: string html_url: type: string format: uri id: - description: The ID of the commit comment. - type: integer - line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment type: integer - nullable: true + login: + type: string + name: + type: string node_id: - description: The node ID of the commit comment. type: string - path: - description: The relative path of the file to which the comment applies. + organizations_url: type: string - nullable: true - position: - description: The line index in the diff to which the comment applies. - type: integer - nullable: true - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - updated_at: + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin url: type: string format: uri - user: + required: + - login + - id + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: title: User type: object nullable: true @@ -92030,530 +94690,83 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri required: - login - id - required: - - url - - html_url - - id - - node_id - - user - - position - - line - - path - - commit_id - - created_at - - updated_at - - author_association - - body - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - comment - - repository - - sender - webhook-create: - title: create event - type: object - properties: - description: - description: The repository's current description. - type: string - nullable: true - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - master_branch: - description: The name of the repository's default branch (usually `main`). - type: string - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pusher_type: - description: The pusher type for the event. Can be either `user` or a deploy - key. - type: string - ref: - description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) - resource. - type: string - ref_type: - description: The type of Git ref object created in the repository. - type: string - enum: - - tag - - branch - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - ref - - ref_type - - master_branch - - description - - pusher_type - - repository - - sender - webhook-custom-property-created: - title: custom property created event - type: object - properties: - action: - type: string - enum: - - created - definition: - "$ref": "#/components/schemas/org-custom-property" - 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-webhooks" - required: - - action - - definition - - organization - webhook-custom-property-deleted: - title: custom property deleted event - type: object - properties: - action: - type: string - enum: - - deleted - definition: - type: object - properties: - property_name: + description: type: string - description: The name of the property that was deleted. - required: - - property_name - 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-webhooks" - required: - - action - - definition - - organization - webhook-custom-property-updated: - title: custom property updated event - type: object - properties: - action: - type: string - enum: - - updated - definition: - "$ref": "#/components/schemas/org-custom-property" - 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-webhooks" - required: - - action - - definition - - organization - webhook-custom-property-values-updated: - title: Custom property values updated event - type: object - properties: - action: - type: string - enum: - - updated - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - repository: - "$ref": "#/components/schemas/repository-webhooks" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - new_property_values: - type: array - description: The new custom property values for the repository. - items: - "$ref": "#/components/schemas/custom-property-value" - old_property_values: - type: array - description: The old custom property values for the repository. - items: - "$ref": "#/components/schemas/custom-property-value" - required: - - action - - repository - - organization - - new_property_values - - old_property_values - webhook-delete: - title: delete event - type: object - properties: - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pusher_type: - description: The pusher type for the event. Can be either `user` or a deploy - key. - type: string - ref: - description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) - resource. - type: string - ref_type: - description: The type of Git ref object deleted in the repository. - type: string - enum: - - tag - - branch - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - ref - - ref_type - - pusher_type - - repository - - sender - webhook-dependabot-alert-auto-dismissed: - title: Dependabot alert auto-dismissed event - type: object - properties: - action: - type: string - enum: - - auto_dismissed - alert: - "$ref": "#/components/schemas/dependabot-alert" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-dependabot-alert-auto-reopened: - title: Dependabot alert auto-reopened event - type: object - properties: - action: - type: string - enum: - - auto_reopened - alert: - "$ref": "#/components/schemas/dependabot-alert" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-dependabot-alert-created: - title: Dependabot alert created event - type: object - properties: - action: - type: string - enum: - - created - alert: - "$ref": "#/components/schemas/dependabot-alert" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-dependabot-alert-dismissed: - title: Dependabot alert dismissed event - type: object - properties: - action: - type: string - enum: - - dismissed - alert: - "$ref": "#/components/schemas/dependabot-alert" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-dependabot-alert-fixed: - title: Dependabot alert fixed event - type: object - properties: - action: - type: string - enum: - - fixed - alert: - "$ref": "#/components/schemas/dependabot-alert" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-dependabot-alert-reintroduced: - title: Dependabot alert reintroduced event - type: object - properties: - action: - type: string - enum: - - reintroduced - alert: - "$ref": "#/components/schemas/dependabot-alert" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-dependabot-alert-reopened: - title: Dependabot alert reopened event - type: object - properties: - action: - type: string - enum: - - reopened - alert: - "$ref": "#/components/schemas/dependabot-alert" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-deploy-key-created: - title: deploy_key created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - key: - description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) - resource. - type: object - properties: - added_by: + nullable: true + due_on: type: string nullable: true - created_at: + format: date-time + html_url: type: string + format: uri id: type: integer - key: - type: string - last_used: - type: string - nullable: true - read_only: - type: boolean - title: - type: string - url: + labels_url: type: string format: uri - verified: - type: boolean - required: - - id - - key - - url - - title - - verified - - created_at - - read_only - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - key - - repository - - sender - webhook-deploy-key-deleted: - title: deploy_key deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - key: - description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) - resource. - type: object - properties: - added_by: - type: string - nullable: true - created_at: + node_id: type: string - id: + number: + description: The number of the milestone. type: integer - key: - type: string - last_used: + open_issues: + type: integer + state: + description: The state of the milestone. type: string - nullable: true - read_only: - type: boolean + enum: + - open + - closed title: + description: The title of the milestone. + type: string + updated_at: type: string + format: date-time url: type: string format: uri - verified: - type: boolean required: - - id - - key - url + - html_url + - labels_url + - id + - node_id + - number - title - - verified + - description + - creator + - open_issues + - closed_issues + - state - created_at - - read_only - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - key - - repository - - sender - webhook-deployment-created: - title: deployment created event - type: object - properties: - action: + - updated_at + - due_on + - closed_at + node_id: type: string - enum: - - created - deployment: - title: Deployment - description: The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). - type: object - properties: - created_at: - type: string - creator: - title: User + number: + description: Number uniquely identifying the pull request within its repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: boolean + nullable: true + requested_reviewers: + type: array + items: + oneOf: + - title: User type: object nullable: true properties: @@ -92619,1944 +94832,802 @@ components: required: - login - id - description: - type: string - nullable: true - environment: - type: string - id: - type: integer - node_id: - type: string - original_environment: - type: string - payload: - oneOf: - - type: object - - type: string - performed_via_github_app: - title: 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. + - title: Team + description: Groups of organization members that gives permissions on + specified repositories. type: object - nullable: true properties: - created_at: - type: string - nullable: true - format: date-time + deleted: + type: boolean description: + description: Description of the team type: string nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - - workflow_job - - pull_request_review_thread - - merge_queue_entry - - secret_scanning_alert_location - - merge_group - external_url: - type: string - nullable: true - format: uri html_url: type: string format: uri id: - description: Unique identifier of the GitHub app + description: Unique identifier of the team type: integer - nullable: true + members_url: + type: string + format: uri-template name: - description: The name of the GitHub app + description: Name of the team type: string node_id: type: string - owner: - title: User + parent: type: object nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + description: + description: Description of the team type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string html_url: type: string format: uri id: + description: Unique identifier of the team type: integer - login: + members_url: type: string + format: uri-template name: + description: Name of the team type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: + permission: + description: Permission that the team will have for its repositories type: string - format: uri - site_admin: - type: boolean - starred_url: + privacy: type: string - format: uri-template - subscriptions_url: + enum: + - open + - closed + - secret + repositories_url: type: string format: uri - type: + slug: type: string - enum: - - Bot - - User - - Organization url: + description: URL for the team type: string format: uri required: - - login + - name - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - production_environment: - type: boolean - ref: - type: string - repository_url: - type: string - format: uri - sha: - type: string - statuses_url: - type: string - format: uri - task: - type: string - transient_environment: - type: boolean - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - id - - node_id - - sha - - ref - - task - - payload - - original_environment - - environment - - description - - creator - - created_at - - updated_at - - statuses_url - - repository_url - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - workflow: - title: Workflow - type: object - nullable: true - properties: - badge_url: - type: string - format: uri - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - node_id: - type: string - path: - type: string - state: - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - badge_url - - created_at - - html_url - - id - - name - - node_id - - path - - state - - updated_at - - url - workflow_run: - title: Deployment Workflow Run - type: object - nullable: true - properties: - actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories type: string - format: uri-template - gravatar_id: + privacy: type: string - html_url: + enum: + - open + - closed + - secret + repositories_url: type: string format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: + slug: type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: + url: + description: URL for the team type: string format: uri required: - - login + - name - id - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions on + specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: object + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments: + type: integer + review_comments_url: + type: string + format: uri + state: + description: State of this Pull Request. Either `open` or `closed`. + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: type: string - conclusion: + format: uri + deleted: + type: boolean + email: type: string nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - - created_at: + events_url: type: string - format: date-time - display_title: + format: uri-template + followers_url: type: string - event: + format: uri + following_url: type: string - head_branch: + format: uri-template + gists_url: type: string - head_commit: - nullable: true - head_repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - head_sha: + format: uri-template + gravatar_id: type: string html_url: type: string format: uri id: type: integer - jobs_url: - type: string - logs_url: + login: type: string name: type: string node_id: type: string - path: + organizations_url: type: string - previous_attempt_url: - nullable: true - pull_requests: - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - referenced_workflows: - type: array - nullable: true - items: - type: object - properties: - path: - type: string - ref: - type: string - sha: - type: string - required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: + format: uri + received_events_url: type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: + format: uri + repos_url: type: string - format: date-time - status: + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string enum: - - requested - - in_progress - - completed - - queued - - waiting - - pending - triggering_actor: - title: User + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft + webhooks_review_comment: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link type: object - nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: + href: type: string format: uri-template - gists_url: + required: + - href + pull_request: + title: Link + type: object + properties: + href: type: string format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: + required: + - href + self: + title: Link + type: object + properties: + href: type: string format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri required: - - login - - id - updated_at: - type: string - format: date-time + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment applies. The last + line of the range for a multi-line comment + type: integer + nullable: true + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the comment applies. + type: string + original_line: + description: The line of the blob to which the comment applies. The last + line of the range for a multi-line comment + type: integer + original_position: + description: The index of the original line in the diff to which the comment + applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line comment. + type: integer + nullable: true + path: + description: The relative path of the file to which the comment applies. + type: string + position: + description: The line index in the diff to which the comment applies. + type: integer + nullable: true + pull_request_review_id: + description: The ID of the pull request review to which the comment belongs. + type: integer + nullable: true + pull_request_url: + description: URL for the pull request that the review comment belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer url: type: string format: uri - workflow_id: - type: integer - workflow_url: - type: string required: - - id - - name - - node_id - - head_branch - - head_sha - - run_number - - event - - status - - conclusion - - workflow_id - - check_suite_id - - check_suite_node_id - url - - html_url - - path - - pull_requests - - created_at - - updated_at - - actor - - run_attempt - - run_started_at - - display_title - required: - - action - - deployment - - workflow - - workflow_run - - repository - - sender - webhook-deployment-protection-rule-requested: - title: deployment protection rule requested event - type: object - properties: - action: + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for a multi-line comment. type: string enum: - - requested - environment: - description: The name of the environment that has the deployment protection - rule. + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line comment. + type: integer + nullable: true + start_side: + description: The side of the first line of the range for a multi-line comment. type: string - event: - description: The event that triggered the deployment protection rule. + nullable: true + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, can be a diff line + or a file. type: string - deployment_callback_url: - description: The URL to review the deployment protection rule. + enum: + - line + - file + updated_at: type: string - format: uri - deployment: - "$ref": "#/components/schemas/deployment" - pull_requests: - type: array - items: - "$ref": "#/components/schemas/pull-request" - repository: - "$ref": "#/components/schemas/repository-webhooks" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - webhook-deployment-review-approved: - type: object - properties: - action: + format: date-time + url: + description: URL for the pull request review comment type: string - enum: - - approved - approver: + format: uri + user: + title: User type: object + nullable: true properties: avatar_url: type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string + format: uri-template gravatar_id: type: string html_url: type: string + format: uri id: type: integer login: type: string + name: + type: string node_id: type: string organizations_url: type: string + format: uri received_events_url: type: string + format: uri repos_url: type: string + format: uri site_admin: type: boolean starred_url: type: string + format: uri-template subscriptions_url: type: string + format: uri type: type: string + enum: + - Bot + - User + - Organization url: type: string - comment: + format: uri + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + webhooks_review: + description: The review that was affected. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - reviewers: - type: array - items: - type: object - properties: - reviewer: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - type: - type: string - enum: - - User - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - since: + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the review. type: string - workflow_job_run: - type: object - properties: - conclusion: - nullable: true - created_at: - type: string - environment: - type: string - html_url: - type: string - id: - type: integer - name: - nullable: true - status: - type: string - updated_at: - type: string - required: - - id - - name - - status - - conclusion - - html_url - - created_at - - updated_at - - environment - workflow_job_runs: - type: array - items: - type: object - properties: - conclusion: - nullable: true - created_at: - type: string - environment: - type: string - html_url: - type: string - id: - type: integer - name: - type: string - nullable: true - status: - type: string - updated_at: - type: string - workflow_run: - title: Deployment Workflow Run + nullable: true + commit_id: + description: A commit SHA for the review. + type: string + html_url: + type: string + format: uri + id: + description: Unique identifier of the review + type: integer + node_id: + type: string + pull_request_url: + type: string + format: uri + state: + type: string + submitted_at: + type: string + nullable: true + format: date-time + user: + title: User type: object nullable: true properties: - actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - conclusion: - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - - created_at: - type: string - format: date-time - display_title: - type: string - event: - type: string - head_branch: - type: string - head_commit: - type: object - nullable: true - head_repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - head_sha: - type: string - html_url: + avatar_url: type: string format: uri - id: - type: integer - jobs_url: - type: string - logs_url: - type: string - name: - type: string - node_id: - type: string - path: - type: string - previous_attempt_url: - type: string - nullable: true - pull_requests: - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - referenced_workflows: - type: array - nullable: true - items: - type: object - properties: - path: - type: string - ref: - type: string - sha: - type: string - required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: - type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: + deleted: + type: boolean + email: type: string - enum: - - requested - - in_progress - - completed - - queued - - waiting - - pending - triggering_actor: - title: User - type: object nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - required: - - id - - name - - node_id - - head_branch - - head_sha - - run_number - - event - - status - - conclusion - - workflow_id - - check_suite_id - - check_suite_node_id - - url - - html_url - - path - - pull_requests - - created_at - - updated_at - - actor - - triggering_actor - - run_attempt - - run_started_at - - display_title - required: - - action - - workflow_run - - since - - repository - - organization - - sender - webhook-deployment-review-rejected: - type: object - properties: - action: - type: string - enum: - - rejected - approver: - type: object - properties: - avatar_url: - type: string events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string + format: uri-template gravatar_id: type: string html_url: type: string + format: uri id: type: integer login: type: string + name: + type: string node_id: type: string organizations_url: type: string + format: uri received_events_url: type: string + format: uri repos_url: type: string + format: uri site_admin: type: boolean starred_url: type: string + format: uri-template subscriptions_url: type: string + format: uri type: type: string + enum: + - Bot + - User + - Organization url: type: string - comment: - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - reviewers: + format: uri + required: + - login + - id + required: + - id + - node_id + - user + - body + - commit_id + - submitted_at + - state + - html_url + - pull_request_url + - author_association + - _links + webhooks_nullable_string: + type: string + nullable: true + webhooks_release: + title: Release + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) + object. + type: object + properties: + assets: type: array items: + title: Release Asset + description: Data related to a release. type: object properties: - reviewer: + browser_download_url: + type: string + format: uri + content_type: + type: string + created_at: + type: string + format: date-time + download_count: + type: integer + id: + type: integer + label: + type: string + nullable: true + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: title: User type: object nullable: true @@ -94623,761 +95694,282 @@ components: required: - login - id - type: + url: type: string - enum: - - User - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - since: + format: uri + required: + - url + - browser_download_url + - id + - node_id + - name + - label + - state + - content_type + - size + - download_count + - created_at + - updated_at + assets_url: type: string - workflow_job_run: + format: uri + author: + title: User type: object + nullable: true properties: - conclusion: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string nullable: true - created_at: + events_url: type: string - environment: + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: type: string html_url: type: string + format: uri id: type: integer - name: - nullable: true - status: + login: type: string - updated_at: + name: type: string - required: - - id - - name - - status - - conclusion - - html_url - - created_at - - updated_at - - environment - workflow_job_runs: - type: array - items: - type: object - properties: - conclusion: - type: string - nullable: true - created_at: - type: string - environment: - type: string - html_url: - type: string - id: - type: integer - name: - type: string - nullable: true - status: - type: string - updated_at: - type: string - workflow_run: - title: Deployment Workflow Run - type: object - nullable: true - properties: - actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - artifacts_url: + node_id: type: string - cancel_url: + organizations_url: type: string - check_suite_id: - type: integer - check_suite_node_id: + format: uri + received_events_url: type: string - check_suite_url: + format: uri + repos_url: type: string - conclusion: + format: uri + site_admin: + type: boolean + starred_url: type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - - created_at: + format: uri-template + subscriptions_url: type: string - format: date-time - event: + format: uri + type: type: string - head_branch: - type: string - head_commit: - type: object - nullable: true - head_repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - jobs_url: - type: string - logs_url: - type: string - name: - type: string - node_id: - type: string - path: - type: string - previous_attempt_url: - type: string - nullable: true - pull_requests: - type: array - items: - title: Check Run Pull Request - type: object - properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: - type: string - format: uri - required: - - url - - id - - number - - head - - base - referenced_workflows: - type: array - nullable: true - items: - type: object - properties: - path: - type: string - ref: - type: string - sha: - type: string - required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: - type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: - type: string - enum: - - requested - - in_progress - - completed - - queued - - waiting - triggering_actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - updated_at: - type: string - format: date-time - url: + enum: + - Bot + - User + - Organization + url: type: string format: uri - workflow_id: - type: integer - workflow_url: - type: string - display_title: - type: string required: + - login - id - - name - - node_id - - head_branch - - head_sha - - run_number - - event - - status - - conclusion - - workflow_id - - check_suite_id - - check_suite_node_id - - url - - html_url - - path - - pull_requests - - created_at - - updated_at - - actor - - triggering_actor - - run_attempt - - run_started_at - - display_title - required: - - action - - workflow_run - - since - - repository - - organization - - sender - webhook-deployment-review-requested: - type: object - properties: - action: + body: type: string - enum: - - requested - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - environment: + nullable: true + created_at: + type: string + nullable: true + format: date-time + discussion_url: + type: string + format: uri + draft: + description: Whether the release is a draft or published + type: boolean + html_url: + type: string + format: uri + id: + type: integer + name: + type: string + nullable: true + node_id: + type: string + prerelease: + description: Whether the release is identified as a prerelease or a full + release. + type: boolean + published_at: type: string - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - requestor: - title: User - type: object nullable: true + format: date-time + reactions: + title: Reactions + type: object properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization url: type: string format: uri required: - - login - - id - reviewers: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + tag_name: + description: The name of the tag. + type: string + tarball_url: + type: string + nullable: true + format: uri + target_commitish: + description: Specifies the commitish value that determines where the Git + tag is created from. + type: string + upload_url: + type: string + format: uri-template + url: + type: string + format: uri + zipball_url: + type: string + nullable: true + format: uri + required: + - url + - assets_url + - upload_url + - html_url + - id + - node_id + - tag_name + - target_commitish + - name + - draft + - author + - prerelease + - created_at + - published_at + - assets + - tarball_url + - zipball_url + - body + webhooks_release_1: + title: Release + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) + object. + type: object + required: + - assets + - assets_url + - author + - body + - created_at + - draft + - html_url + - id + - name + - node_id + - prerelease + - published_at + - tag_name + - tarball_url + - target_commitish + - upload_url + - url + - zipball_url + properties: + assets: type: array items: + title: Release Asset + description: Data related to a release. type: object + required: + - url + - browser_download_url + - id + - node_id + - name + - label + - state + - content_type + - size + - download_count + - created_at + - updated_at + nullable: true properties: - reviewer: + browser_download_url: + type: string + format: uri + content_type: + type: string + created_at: + type: string + format: date-time + download_count: + type: integer + id: + type: integer + label: + type: string + nullable: true + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -95438,831 +96030,1194 @@ components: url: type: string format: uri - required: - - id - type: + url: type: string - enum: - - User - - Team - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - since: + format: uri + assets_url: type: string - workflow_job_run: + format: uri + author: + title: User type: object + nullable: true + required: + - login + - id properties: - conclusion: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string nullable: true - created_at: + events_url: type: string - environment: + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: type: string html_url: type: string + format: uri id: type: integer + login: + type: string name: type: string - nullable: true - status: + node_id: type: string - updated_at: + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + body: + type: string + nullable: true + created_at: + type: string + nullable: true + format: date-time + discussion_url: + type: string + format: uri + draft: + description: Whether the release is a draft or published + type: boolean + html_url: + type: string + format: uri + id: + type: integer + name: + type: string + nullable: true + node_id: + type: string + prerelease: + description: Whether the release is identified as a prerelease or a full + release. + type: boolean + published_at: + type: string + nullable: true + format: date-time + reactions: + title: Reactions + type: object required: - - id - - name - - status - - conclusion - - html_url - - created_at - - updated_at - - environment - workflow_run: - title: Deployment Workflow Run + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + tag_name: + description: The name of the tag. + type: string + tarball_url: + type: string + nullable: true + format: uri + target_commitish: + description: Specifies the commitish value that determines where the Git + tag is created from. + type: string + upload_url: + type: string + format: uri-template + url: + type: string + format: uri + zipball_url: + type: string + nullable: true + format: uri + webhooks_alert: + title: Repository Vulnerability Alert Alert + description: The security alert of the vulnerable dependency. + type: object + required: + - affected_package_name + - affected_range + - created_at + - external_identifier + - external_reference + - ghsa_id + - id + - node_id + - number + - severity + - state + properties: + affected_package_name: + type: string + affected_range: + type: string + created_at: + type: string + dismiss_reason: + type: string + dismissed_at: + type: string + dismisser: + title: User type: object nullable: true + required: + - login + - id properties: - actor: - title: User - type: object + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - artifacts_url: + events_url: type: string - cancel_url: + format: uri-template + followers_url: type: string - check_suite_id: - type: integer - check_suite_node_id: + format: uri + following_url: type: string - check_suite_url: + format: uri-template + gists_url: type: string - conclusion: + format: uri-template + gravatar_id: type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - - created_at: + html_url: type: string - format: date-time - event: + format: uri + id: + type: integer + login: type: string - head_branch: + name: type: string - head_commit: - type: object - nullable: true - head_repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - head_sha: + node_id: type: string - html_url: + organizations_url: type: string format: uri - id: - type: integer - jobs_url: + received_events_url: type: string - logs_url: + format: uri + repos_url: type: string - name: + format: uri + site_admin: + type: boolean + starred_url: type: string - node_id: + format: uri-template + subscriptions_url: type: string - path: + format: uri + type: type: string - previous_attempt_url: + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + external_identifier: + type: string + external_reference: + type: string + nullable: true + format: uri + fix_reason: + type: string + fixed_at: + type: string + format: date-time + fixed_in: + type: string + ghsa_id: + type: string + id: + type: integer + node_id: + type: string + number: + type: integer + severity: + type: string + state: + type: string + enum: + - open + secret-scanning-alert-resolution-webhook: + type: string + description: The reason for resolving the alert. + nullable: true + enum: + - false_positive + - wont_fix + - revoked + - used_in_tests + - pattern_deleted + - pattern_edited + secret-scanning-alert-webhook: + type: object + properties: + number: + "$ref": "#/components/schemas/alert-number" + created_at: + "$ref": "#/components/schemas/alert-created-at" + updated_at: + "$ref": "#/components/schemas/nullable-alert-updated-at" + url: + "$ref": "#/components/schemas/alert-url" + html_url: + "$ref": "#/components/schemas/alert-html-url" + locations_url: + type: string + format: uri + description: The REST API URL of the code locations for this alert. + resolution: + "$ref": "#/components/schemas/secret-scanning-alert-resolution-webhook" + resolved_at: + type: string + format: date-time + description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + resolved_by: + "$ref": "#/components/schemas/nullable-simple-user" + resolution_comment: + type: string + description: An optional comment to resolve an alert. + nullable: true + secret_type: + type: string + description: The type of secret that secret scanning detected. + validity: + type: string + description: The token status as of the latest validity check. + enum: + - active + - inactive + - unknown + push_protection_bypassed: + type: boolean + description: Whether push protection was bypassed for the detected secret. + nullable: true + push_protection_bypassed_by: + "$ref": "#/components/schemas/nullable-simple-user" + push_protection_bypassed_at: + type: string + format: date-time + description: 'The time that push protection was bypassed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + webhooks_security_advisory: + description: The details of the security advisory, including summary, description, + and severity. + type: object + properties: + cvss: + type: object + properties: + score: + type: number + vector_string: type: string nullable: true - pull_requests: - type: array - items: - title: Check Run Pull Request + required: + - vector_string + - score + cwes: + type: array + items: + type: object + properties: + cwe_id: + type: string + name: + type: string + required: + - cwe_id + - name + description: + type: string + ghsa_id: + type: string + identifiers: + type: array + items: + type: object + properties: + type: + type: string + value: + type: string + required: + - value + - type + published_at: + type: string + references: + type: array + items: + type: object + properties: + url: + type: string + format: uri + required: + - url + severity: + type: string + summary: + type: string + updated_at: + type: string + vulnerabilities: + type: array + items: + type: object + properties: + first_patched_version: type: object + nullable: true properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: integer - number: - type: integer - url: + identifier: type: string - format: uri required: - - url - - id - - number - - head - - base - referenced_workflows: - type: array - nullable: true - items: + - identifier + package: type: object properties: - path: - type: string - ref: + ecosystem: type: string - sha: + name: type: string required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: + - ecosystem + - name + severity: + type: string + vulnerable_version_range: + type: string + required: + - package + - severity + - vulnerable_version_range + - first_patched_version + withdrawn_at: + type: string + nullable: true + required: + - cvss + - cwes + - ghsa_id + - summary + - description + - severity + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + - vulnerabilities + webhooks_sponsorship: + type: object + properties: + created_at: + type: string + maintainer: + type: object + properties: + avatar_url: type: string - run_attempt: - type: integer - run_number: + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: type: integer - run_started_at: + login: type: string - format: date-time - status: + node_id: type: string - enum: - - requested - - in_progress - - completed - - queued - - waiting - - pending - triggering_actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - updated_at: + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: type: string - format: date-time url: type: string + node_id: + type: string + privacy_level: + type: string + sponsor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string format: uri - workflow_id: + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: type: integer - workflow_url: + login: type: string - display_title: + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri required: + - login - id - - name - - node_id - - head_branch - - head_sha - - run_number - - event - - status - - conclusion - - workflow_id - - check_suite_id - - check_suite_node_id - - url - - html_url - - path - - pull_requests - - created_at - - updated_at - - actor - - triggering_actor - - run_attempt - - run_started_at - - display_title - required: - - action - - workflow_run - - since - - workflow_job_run - - environment - - reviewers - - requestor - - repository - - organization - - sender - webhook-deployment-status-created: - title: deployment_status created event - type: object - properties: - action: - type: string - enum: - - created - check_run: + sponsorable: + title: User type: object nullable: true properties: - completed_at: + avatar_url: type: string - nullable: true - format: date-time - conclusion: - description: The result of the completed check run. This value will - be `null` until the check run has completed. + format: uri + deleted: + type: boolean + email: type: string nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - skipped - - - details_url: + events_url: + type: string + format: uri-template + followers_url: type: string format: uri - external_id: + following_url: type: string - head_sha: - description: The SHA of the commit that is being checked. + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: type: string html_url: type: string format: uri id: - description: The id of the check. type: integer + login: + type: string name: - description: The name of the check run. type: string node_id: type: string - started_at: + organizations_url: type: string - format: date-time - status: - description: The current status of the check run. Can be `queued`, `in_progress`, - or `completed`. + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string enum: - - queued - - in_progress - - completed - - waiting - - pending + - Bot + - User + - Organization url: type: string format: uri required: + - login - id - - name - - node_id - - head_sha - - external_id - - url - - html_url - - details_url - - status - - conclusion - - started_at - - completed_at - deployment: - title: Deployment - description: The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). + tier: + title: Sponsorship Tier + description: The `tier_changed` and `pending_tier_change` will include the + original tier before the change or pending change. For more information, + see the pending tier change payload. type: object properties: created_at: type: string - creator: - title: User + description: + type: string + is_custom_ammount: + type: boolean + is_custom_amount: + type: boolean + is_one_time: + type: boolean + monthly_price_in_cents: + type: integer + monthly_price_in_dollars: + type: integer + name: + type: string + node_id: + type: string + required: + - node_id + - created_at + - description + - monthly_price_in_cents + - monthly_price_in_dollars + - name + - is_one_time + required: + - node_id + - created_at + - sponsorable + - sponsor + - privacy_level + - tier + webhooks_effective_date: + description: The `pending_cancellation` and `pending_tier_change` event types + will include the date the cancellation or tier change will take effect. + type: string + webhooks_changes_8: + type: object + properties: + tier: + type: object + properties: + from: + title: Sponsorship Tier + description: The `tier_changed` and `pending_tier_change` will include + the original tier before the change or pending change. For more information, + see the pending tier change payload. type: object - nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: + created_at: type: string - html_url: + description: type: string - format: uri - id: + is_custom_ammount: + type: boolean + is_custom_amount: + type: boolean + is_one_time: + type: boolean + monthly_price_in_cents: + type: integer + monthly_price_in_dollars: type: integer - login: - type: string name: type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri required: - - login - - id + - node_id + - created_at + - description + - monthly_price_in_cents + - monthly_price_in_dollars + - name + - is_one_time + required: + - from + required: + - tier + webhooks_team_1: + title: Team + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: object + nullable: true + properties: description: + description: Description of the team type: string nullable: true - environment: + html_url: type: string + format: uri id: + description: Unique identifier of the team type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string node_id: type: string - original_environment: + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + notification_setting: + description: Whether team members will receive notifications when their + team is @mentioned + type: string + enum: + - notifications_enabled + - notifications_disabled + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - notification_setting + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + notification_setting: + description: Whether team members will receive notifications when their + team is @mentioned + type: string + enum: + - notifications_enabled + - notifications_disabled + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + webhook-branch-protection-configuration-disabled: + title: branch protection configuration disabled event + type: object + properties: + action: + type: string + enum: + - disabled + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-branch-protection-configuration-enabled: + title: branch protection configuration enabled event + type: object + properties: + action: + type: string + enum: + - enabled + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-branch-protection-rule-created: + title: branch protection rule created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + rule: + "$ref": "#/components/schemas/webhooks_rule" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - rule + - repository + - sender + webhook-branch-protection-rule-deleted: + title: branch protection rule deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + rule: + "$ref": "#/components/schemas/webhooks_rule" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - rule + - repository + - sender + webhook-branch-protection-rule-edited: + title: branch protection rule edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + description: If the action was `edited`, the changes to the rule. + type: object + properties: + admin_enforced: + type: object + properties: + from: + type: boolean + nullable: true + required: + - from + authorized_actor_names: + type: object + properties: + from: + type: array + items: + type: string + required: + - from + authorized_actors_only: + type: object + properties: + from: + type: boolean + nullable: true + required: + - from + authorized_dismissal_actors_only: + type: object + properties: + from: + type: boolean + nullable: true + required: + - from + linear_history_requirement_enforcement_level: + type: object + properties: + from: + type: string + enum: + - 'off' + - non_admins + - everyone + required: + - from + required_status_checks: + type: object + properties: + from: + type: array + items: + type: string + required: + - from + required_status_checks_enforcement_level: + type: object + properties: + from: + type: string + enum: + - 'off' + - non_admins + - everyone + required: + - from + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + rule: + "$ref": "#/components/schemas/webhooks_rule" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - rule + - repository + - sender + webhook-check-run-completed: + title: Check Run Completed Event + type: object + properties: + action: + type: string + enum: + - completed + check_run: + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - check_run + - repository + - sender + webhook-check-run-completed-form-encoded: + title: Check Run Completed Event + description: The check_run.completed webhook encoded with URL encoding + type: object + properties: + payload: + description: A URL-encoded string of the check_run.completed JSON payload. + The decoded payload is a JSON object. + type: string + required: + - payload + webhook-check-run-created: + title: Check Run Created Event + type: object + properties: + action: + type: string + enum: + - created + check_run: + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - check_run + - repository + - sender + webhook-check-run-created-form-encoded: + title: Check Run Created Event + description: The check_run.created webhook encoded with URL encoding + type: object + properties: + payload: + description: A URL-encoded string of the check_run.created JSON payload. + The decoded payload is a JSON object. + type: string + required: + - payload + webhook-check-run-requested-action: + title: Check Run Requested Action Event + type: object + properties: + action: + type: string + enum: + - requested_action + check_run: + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requested_action: + description: The action requested by the user. + type: object + properties: + identifier: + description: The integrator reference of the action requested by the + user. + type: string + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - check_run + - repository + - sender + webhook-check-run-requested-action-form-encoded: + title: Check Run Requested Action Event + description: The check_run.requested_action webhook encoded with URL encoding + type: object + properties: + payload: + description: A URL-encoded string of the check_run.requested_action JSON + payload. The decoded payload is a JSON object. + type: string + required: + - payload + webhook-check-run-rerequested: + title: Check Run Re-Requested Event + type: object + properties: + action: + type: string + enum: + - rerequested + check_run: + "$ref": "#/components/schemas/check-run-with-simple-check-suite" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - check_run + - repository + - sender + webhook-check-run-rerequested-form-encoded: + title: Check Run Re-Requested Event + description: The check_run.rerequested webhook encoded with URL encoding + type: object + properties: + payload: + description: A URL-encoded string of the check_run.rerequested JSON payload. + The decoded payload is a JSON object. + type: string + required: + - payload + webhook-check-suite-completed: + title: check_suite completed event + type: object + properties: + action: + type: string + enum: + - completed + check_suite: + description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: type: string - payload: - oneOf: - - type: string - - type: object - nullable: true - performed_via_github_app: - title: 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. - type: object nullable: true + app: + title: 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. + type: object properties: created_at: type: string @@ -96322,11 +97277,13 @@ components: - watch - workflow_dispatch - workflow_run - - merge_queue_entry - - workflow_job + - merge_group - pull_request_review_thread + - workflow_job + - merge_queue_entry + - security_and_analysis + - projects_v2_item - secret_scanning_alert_location - - merge_group external_url: type: string nullable: true @@ -96504,6 +97461,7 @@ components: enum: - read - write + - admin organization_secrets: type: string enum: @@ -96544,6 +97502,7 @@ components: enum: - read - write + - admin secret_scanning_alerts: type: string enum: @@ -96606,142 +97565,257 @@ components: - html_url - created_at - updated_at - production_environment: - type: boolean - ref: - type: string - repository_url: - type: string - format: uri - sha: + before: type: string - statuses_url: + nullable: true + check_runs_url: type: string format: uri - task: - type: string - transient_environment: - type: boolean - updated_at: - type: string - url: + conclusion: + description: The summary conclusion for all check runs that are part + of the check suite. This value will be `null` until the check run + has `completed`. type: string - format: uri - required: - - url - - id - - node_id - - sha - - ref - - task - - payload - - original_environment - - environment - - description - - creator - - created_at - - updated_at - - statuses_url - - repository_url - deployment_status: - description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). - type: object - properties: + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - skipped + - startup_failure created_at: type: string - creator: - title: User - type: object + format: date-time + head_branch: + description: The head branch name the changes are on. + type: string nullable: true + head_commit: + title: SimpleCommit + type: object properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri + author: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: string + nullable: true + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: string + nullable: true + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: type: string - format: uri-template - subscriptions_url: + message: type: string - format: uri - type: + timestamp: type: string - enum: - - Bot - - User - - Organization - url: + tree_id: type: string - format: uri required: - - login - id - deployment_url: + - tree_id + - message + - timestamp + - author + - committer + head_sha: + description: The SHA of the head commit that is being checked. type: string - format: uri - description: - description: The optional human-readable description added to the status. + id: + type: integer + latest_check_runs_count: + type: integer + node_id: type: string - environment: + pull_requests: + description: An array of pull requests that match this check suite. + A pull request matches a check suite if they have the same `head_sha` + and `head_branch`. When the check suite's `head_branch` is in a forked + repository it will be `null` and the `pull_requests` array will be + empty. + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + rerequestable: + type: boolean + runs_rerequestable: + type: boolean + status: + description: The summary status for all check runs that are part of + the check suite. Can be `requested`, `in_progress`, or `completed`. type: string - environment_url: + nullable: true + enum: + - requested + - in_progress + - completed + - queued + - + - pending + updated_at: type: string - format: uri - id: - type: integer - log_url: + format: date-time + url: + description: URL that points to the check suite API resource. type: string format: uri - node_id: + required: + - id + - node_id + - head_branch + - head_sha + - status + - conclusion + - url + - before + - after + - pull_requests + - app + - created_at + - updated_at + - latest_check_runs_count + - check_runs_url + - head_commit + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - check_suite + - repository + - sender + webhook-check-suite-requested: + title: check_suite requested event + type: object + properties: + action: + type: string + enum: + - requested + check_suite: + description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: type: string - performed_via_github_app: + nullable: true + app: title: 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. type: object - nullable: true properties: created_at: type: string @@ -96802,10 +97876,13 @@ components: - workflow_dispatch - workflow_run - pull_request_review_thread - - merge_queue_entry - workflow_job - - merge_group + - merge_queue_entry + - security_and_analysis - secret_scanning_alert_location + - projects_v2_item + - merge_group + - repository_import external_url: type: string nullable: true @@ -96983,6 +98060,7 @@ components: enum: - read - write + - admin organization_secrets: type: string enum: @@ -97023,6 +98101,7 @@ components: enum: - read - write + - admin secret_scanning_alerts: type: string enum: @@ -97085,168 +98164,16 @@ components: - html_url - created_at - updated_at - repository_url: - type: string - format: uri - state: - description: The new state. Can be `pending`, `success`, `failure`, - or `error`. - type: string - target_url: - description: The optional link added to the status. - type: string - updated_at: - type: string - url: - type: string - format: uri - required: - - url - - id - - node_id - - state - - creator - - description - - environment - - target_url - - created_at - - updated_at - - deployment_url - - repository_url - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - workflow: - title: Workflow - type: object - nullable: true - properties: - badge_url: - type: string - format: uri - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - node_id: - type: string - path: - type: string - state: - type: string - updated_at: - type: string - format: date-time - url: + before: type: string - format: uri - required: - - badge_url - - created_at - - html_url - - id - - name - - node_id - - path - - state - - updated_at - - url - workflow_run: - title: Deployment Workflow Run - type: object - nullable: true - properties: - actor: - title: User - type: object nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: + check_runs_url: type: string + format: uri conclusion: + description: The summary conclusion for all check runs that are part + of the check suite. This value will be `null` until the check run + has completed. type: string nullable: true enum: @@ -97258,170 +98185,88 @@ components: - action_required - stale - - - startup_failure + - skipped created_at: type: string format: date-time - display_title: - type: string - event: - type: string head_branch: + description: The head branch name the changes are on. type: string - head_commit: nullable: true - head_repository: + head_commit: + title: SimpleCommit type: object properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: + author: + title: Committer + description: Metaproperties for Git author/committer information. type: object properties: - avatar_url: - type: string - events_url: + date: type: string - followers_url: + format: date-time + email: type: string - following_url: + nullable: true + format: email + name: + description: The git author's name. type: string - gists_url: + username: type: string - gravatar_id: + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: type: string - html_url: + format: date-time + email: type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: + nullable: true + format: email + name: + description: The git author's name. type: string - url: + username: type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: + required: + - email + - name + id: type: string - teams_url: + message: type: string - trees_url: + timestamp: type: string - url: + tree_id: type: string + required: + - id + - tree_id + - message + - timestamp + - author + - committer head_sha: + description: The SHA of the head commit that is being checked. type: string - html_url: - type: string - format: uri id: type: integer - jobs_url: - type: string - logs_url: - type: string - name: - type: string + latest_check_runs_count: + type: integer node_id: type: string - path: - type: string - previous_attempt_url: - nullable: true pull_requests: + description: An array of pull requests that match this check suite. + A pull request matches a check suite if they have the same `head_sha` + and `head_branch`. When the check suite's `head_branch` is in a forked + repository it will be `null` and the `pull_requests` array will be + empty. type: array items: title: Check Run Pull Request @@ -97492,172 +98337,675 @@ components: - number - head - base - referenced_workflows: - type: array + rerequestable: + type: boolean + runs_rerequestable: + type: boolean + status: + description: The summary status for all check runs that are part of + the check suite. Can be `requested`, `in_progress`, or `completed`. + type: string nullable: true - items: - type: object - properties: - path: - type: string - ref: - type: string - sha: - type: string - required: - - path - - sha - repository: + enum: + - requested + - in_progress + - completed + - queued + - + updated_at: + type: string + format: date-time + url: + description: URL that points to the check suite API resource. + type: string + format: uri + required: + - id + - node_id + - head_branch + - head_sha + - status + - conclusion + - url + - before + - after + - pull_requests + - app + - created_at + - updated_at + - latest_check_runs_count + - check_runs_url + - head_commit + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - check_suite + - repository + - sender + webhook-check-suite-rerequested: + title: check_suite rerequested event + type: object + properties: + action: + type: string + enum: + - rerequested + check_suite: + description: The [check_suite](https://docs.github.com/rest/checks/suites#get-a-check-suite). + type: object + properties: + after: + type: string + nullable: true + app: + title: 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. type: object properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: + created_at: type: string - description: nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: + format: date-time + description: type: string - hooks_url: + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + - merge_queue_entry + - workflow_job + external_url: type: string + nullable: true + format: uri html_url: type: string + format: uri id: + description: Unique identifier of the GitHub app type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string + nullable: true name: + description: The name of the GitHub app type: string node_id: type: string - notifications_url: - type: string owner: + title: User type: object + nullable: true properties: avatar_url: type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string + format: uri-template gravatar_id: type: string html_url: type: string + format: uri id: type: integer login: type: string + name: + type: string node_id: type: string organizations_url: type: string + format: uri received_events_url: type: string + format: uri repos_url: type: string + format: uri site_admin: type: boolean starred_url: type: string + format: uri-template subscriptions_url: type: string + format: uri type: type: string + enum: + - Bot + - User + - Organization url: type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + - admin + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app type: string - subscription_url: + updated_at: type: string - tags_url: + nullable: true + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + before: + type: string + nullable: true + check_runs_url: + type: string + format: uri + conclusion: + description: The summary conclusion for all check runs that are part + of the check suite. This value will be `null` until the check run + has completed. + type: string + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + head_branch: + description: The head branch name the changes are on. + type: string + nullable: true + head_commit: + title: SimpleCommit + type: object + properties: + author: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: string + nullable: true + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: string + nullable: true + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - email + - name + id: type: string - teams_url: + message: type: string - trees_url: + timestamp: type: string - url: + tree_id: type: string - rerun_url: + required: + - id + - tree_id + - message + - timestamp + - author + - committer + head_sha: + description: The SHA of the head commit that is being checked. type: string - run_attempt: + id: type: integer - run_number: + latest_check_runs_count: type: integer - run_started_at: + node_id: type: string - format: date-time + pull_requests: + description: An array of pull requests that match this check suite. + A pull request matches a check suite if they have the same `head_sha` + and `head_branch`. When the check suite's `head_branch` is in a forked + repository it will be `null` and the `pull_requests` array will be + empty. + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + rerequestable: + type: boolean + runs_rerequestable: + type: boolean status: + description: The summary status for all check runs that are part of + the check suite. Can be `requested`, `in_progress`, or `completed`. type: string + nullable: true enum: - requested - in_progress - completed - queued - - waiting - - pending - triggering_actor: + - + updated_at: + type: string + format: date-time + url: + description: URL that points to the check suite API resource. + type: string + format: uri + required: + - id + - node_id + - head_branch + - head_sha + - status + - conclusion + - url + - before + - after + - pull_requests + - app + - created_at + - updated_at + - latest_check_runs_count + - check_runs_url + - head_commit + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - check_suite + - repository + - sender + webhook-code-scanning-alert-appeared-in-branch: + title: code_scanning_alert appeared_in_branch event + type: object + properties: + action: + type: string + enum: + - appeared_in_branch + alert: + description: The code scanning alert involved in the event. + type: object + properties: + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + type: string + nullable: true + format: date-time + dismissed_by: title: User type: object nullable: true @@ -97724,129 +99072,185 @@ components: required: - login - id - updated_at: + dismissed_reason: + description: The reason for dismissing or closing the alert. type: string - format: date-time - url: + nullable: true + enum: + - false positive + - won't fix + - used in tests + - + html_url: + description: The GitHub URL of the alert resource. type: string format: uri - workflow_id: + most_recent_instance: + title: Alert Instance + type: object + nullable: true + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. type: integer - workflow_url: + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + severity: + description: The severity of the alert. + type: string + nullable: true + enum: + - none + - note + - warning + - error + - + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: string + nullable: true + required: + - name + - version + url: type: string + format: uri required: - - id - - name - - node_id - - head_branch - - head_sha - - run_number - - event - - status - - conclusion - - workflow_id - - check_suite_id - - check_suite_node_id + - number + - created_at - url - html_url - - path - - pull_requests - - created_at - - updated_at - - actor - - triggering_actor - - run_attempt - - run_started_at - - display_title + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + commit_oid: + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + ref: + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - deployment_status - - deployment + - alert + - ref + - commit_oid - repository - sender - webhook-discussion-answered: - title: discussion answered event + webhook-code-scanning-alert-closed-by-user: + title: code_scanning_alert closed_by_user event type: object properties: action: type: string enum: - - answered - answer: + - closed_by_user + alert: + description: The code scanning alert involved in the event. type: object properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - child_comment_count: - type: integer created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' type: string format: date-time - discussion_id: - type: integer - html_url: - type: string - id: - type: integer - node_id: - type: string - parent_id: - nullable: true - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - updated_at: + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' type: string format: date-time - user: + dismissed_by: title: User type: object nullable: true @@ -97913,214 +99317,409 @@ components: required: - login - id - required: - - id - - node_id - - html_url - - parent_id - - child_comment_count - - repository_url - - discussion_id - - author_association - - user + dismissed_reason: + description: The reason for dismissing or closing the alert. + type: string + nullable: true + enum: + - false positive + - won't fix + - used in tests + - + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: object + nullable: true + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + full_description: + type: string + help: + type: string + nullable: true + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: string + nullable: true + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + name: + type: string + severity: + description: The severity of the alert. + type: string + nullable: true + enum: + - none + - note + - warning + - error + - + tags: + type: array + nullable: true + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: string + enum: + - dismissed + - fixed + tool: + type: object + properties: + guid: + type: string + nullable: true + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: string + nullable: true + required: + - name + - version + url: + type: string + format: uri + required: + - number - created_at - - updated_at - - body - discussion: - "$ref": "#/components/schemas/discussion" + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + commit_oid: + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" + ref: + "$ref": "#/components/schemas/webhooks_code_scanning_ref" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - discussion - - answer + - alert + - ref + - commit_oid - repository - sender - webhook-discussion-category-changed: - title: discussion category changed event + webhook-code-scanning-alert-created: + title: code_scanning_alert created event type: object properties: action: type: string enum: - - category_changed - changes: + - created + alert: + description: The code scanning alert involved in the event. type: object properties: - category: + created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' + type: string + nullable: true + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + dismissed_by: + nullable: true + dismissed_comment: + "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" + dismissed_reason: + description: 'The reason for dismissing or closing the alert. Can be + one of: `false positive`, `won''t fix`, and `used in tests`.' + nullable: true + fixed_at: + nullable: true + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + instances_url: + type: string + most_recent_instance: + title: Alert Instance type: object + nullable: true properties: - from: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: type: object properties: - created_at: - type: string - format: date-time - description: - type: string - emoji: - type: string - id: + end_column: type: integer - is_answerable: - type: boolean - name: - type: string - node_id: - type: string - repository_id: + end_line: type: integer - slug: + path: type: string - updated_at: + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: type: string - required: - - id - - repository_id - - emoji - - name - - description - - created_at - - updated_at - - slug - - is_answerable + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed required: - - from + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + full_description: + type: string + help: + type: string + nullable: true + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: string + nullable: true + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + name: + type: string + severity: + description: The severity of the alert. + type: string + nullable: true + enum: + - none + - note + - warning + - error + - + tags: + type: array + nullable: true + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + tool: + type: object + nullable: true + properties: + guid: + type: string + nullable: true + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: string + nullable: true + required: + - name + - version + updated_at: + type: string + nullable: true + url: + type: string + format: uri required: - - category - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - changes - - discussion - - repository - - sender - webhook-discussion-closed: - title: discussion closed event - type: object - properties: - action: - type: string - enum: - - closed - discussion: - "$ref": "#/components/schemas/discussion" + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + commit_oid: + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" + ref: + "$ref": "#/components/schemas/webhooks_code_scanning_ref" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - discussion + - alert + - ref + - commit_oid - repository - sender - webhook-discussion-comment-created: - title: discussion_comment created event + webhook-code-scanning-alert-fixed: + title: code_scanning_alert fixed event type: object properties: action: type: string enum: - - created - comment: + - fixed + alert: + description: The code scanning alert involved in the event. type: object properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - child_comment_count: - type: integer created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' type: string - discussion_id: - type: integer - html_url: - type: string - id: - type: integer - node_id: + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' type: string - parent_id: - type: integer nullable: true - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - updated_at: - type: string - user: + format: date-time + dismissed_by: title: User type: object nullable: true @@ -98187,298 +99786,646 @@ components: required: - login - id + dismissed_reason: + description: The reason for dismissing or closing the alert. + type: string + nullable: true + enum: + - false positive + - won't fix + - used in tests + - + html_url: + description: The GitHub URL of the alert resource. + type: string + format: uri + instances_url: + type: string + format: uri + most_recent_instance: + title: Alert Instance + type: object + nullable: true + properties: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. + type: string + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + full_description: + type: string + help: + type: string + nullable: true + help_uri: + description: A link to the documentation for the rule used to detect + the alert. + type: string + nullable: true + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + name: + type: string + severity: + description: The severity of the alert. + type: string + nullable: true + enum: + - none + - note + - warning + - error + - + tags: + type: array + nullable: true + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: string + enum: + - fixed + tool: + type: object + properties: + guid: + type: string + nullable: true + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: string + nullable: true + required: + - name + - version + url: + type: string + format: uri required: - - id - - node_id - - html_url - - parent_id - - child_comment_count - - repository_url - - discussion_id - - author_association - - user + - number - created_at - - updated_at - - body - - reactions - discussion: - "$ref": "#/components/schemas/discussion" + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + commit_oid: + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" + ref: + "$ref": "#/components/schemas/webhooks_code_scanning_ref" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - comment - - discussion + - alert + - ref + - commit_oid - repository - sender - webhook-discussion-comment-deleted: - title: discussion_comment deleted event + webhook-code-scanning-alert-reopened: + title: code_scanning_alert reopened event type: object properties: action: type: string enum: - - deleted - comment: + - reopened + alert: + description: The code scanning alert involved in the event. type: object + nullable: true properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - child_comment_count: - type: integer created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' type: string - discussion_id: - type: integer - html_url: - type: string - id: - type: integer - node_id: + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' type: string - parent_id: - type: integer nullable: true - reactions: - title: Reactions + dismissed_by: type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: + nullable: true + dismissed_reason: + description: 'The reason for dismissing or closing the alert. Can be + one of: `false positive`, `won''t fix`, and `used in tests`.' type: string - updated_at: + nullable: true + html_url: + description: The GitHub URL of the alert resource. type: string - user: - title: User + format: uri + most_recent_instance: + title: Alert Instance type: object nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. type: string - format: uri-template - followers_url: + category: + description: Identifies the configuration under which the analysis + was executed. type: string - format: uri - following_url: + classifications: + type: array + items: + type: string + commit_sha: type: string - format: uri-template - gists_url: + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. type: string - format: uri-template - gravatar_id: + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. type: string - html_url: + state: + description: State of a code scanning alert. type: string - format: uri - id: - type: integer - login: + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. type: string - name: + full_description: type: string - node_id: + help: type: string - organizations_url: + nullable: true + help_uri: + description: A link to the documentation for the rule used to detect + the alert. type: string - format: uri - received_events_url: + nullable: true + id: + description: A unique identifier for the rule used to detect the + alert. type: string - format: uri - repos_url: + name: type: string - format: uri - site_admin: - type: boolean - starred_url: + severity: + description: The severity of the alert. type: string - format: uri-template - subscriptions_url: + nullable: true + enum: + - none + - note + - warning + - error + - + tags: + type: array + nullable: true + items: + type: string + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + tool: + type: object + properties: + guid: type: string - format: uri - type: + nullable: true + name: + description: The name of the tool used to generate the code scanning + analysis alert. type: string - enum: - - Bot - - User - - Organization - url: + version: + description: The version of the tool used to detect the alert. type: string - format: uri + nullable: true required: - - login - - id + - name + - version + url: + type: string + format: uri required: - - id - - node_id - - html_url - - parent_id - - child_comment_count - - repository_url - - discussion_id - - author_association - - user + - number - created_at - - updated_at - - body - - reactions - discussion: - "$ref": "#/components/schemas/discussion" + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + commit_oid: + description: The commit SHA of the code scanning alert. When the action + is `reopened_by_user` or `closed_by_user`, the event was triggered by + the `sender` and this value will be empty. + type: string + nullable: true enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" + ref: + description: The Git reference of the code scanning alert. When the action + is `reopened_by_user` or `closed_by_user`, the event was triggered by + the `sender` and this value will be empty. + type: string + nullable: true repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - comment - - discussion + - alert + - ref + - commit_oid - repository - sender - webhook-discussion-comment-edited: - title: discussion_comment edited event + webhook-code-scanning-alert-reopened-by-user: + title: code_scanning_alert reopened_by_user event type: object properties: action: type: string enum: - - edited - changes: - type: object - properties: - body: - type: object - properties: - from: - type: string - required: - - from - required: - - body - comment: + - reopened_by_user + alert: + description: The code scanning alert involved in the event. type: object properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - child_comment_count: - type: integer created_at: + description: 'The time that the alert was created in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ.`' type: string - discussion_id: - type: integer + format: date-time + dismissed_at: + description: 'The time that the alert was dismissed in ISO 8601 format: + `YYYY-MM-DDTHH:MM:SSZ`.' + nullable: true + dismissed_by: + nullable: true + dismissed_reason: + description: 'The reason for dismissing or closing the alert. Can be + one of: `false positive`, `won''t fix`, and `used in tests`.' + nullable: true html_url: + description: The GitHub URL of the alert resource. type: string - id: - type: integer - node_id: - type: string - parent_id: - type: integer - nullable: true - reactions: - title: Reactions + format: uri + most_recent_instance: + title: Alert Instance type: object + nullable: true properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: + analysis_key: + description: Identifies the configuration under which the analysis + was executed. For example, in GitHub Actions this includes the + workflow filename and job name. type: string - format: uri - required: - - url + category: + description: Identifies the configuration under which the analysis + was executed. + type: string + classifications: + type: array + items: + type: string + commit_sha: + type: string + environment: + description: Identifies the variable values associated with the + environment in which the analysis that generated this alert instance + was performed, such as the language that was analyzed. + type: string + location: + type: object + properties: + end_column: + type: integer + end_line: + type: integer + path: + type: string + start_column: + type: integer + start_line: + type: integer + message: + type: object + properties: + text: + type: string + ref: + description: The full Git reference, formatted as `refs/heads/`. + type: string + state: + description: State of a code scanning alert. + type: string + enum: + - open + - dismissed + - fixed + required: + - ref + - analysis_key + - environment + - state + number: + description: The code scanning alert number. + type: integer + rule: + type: object + properties: + description: + description: A short description of the rule used to detect the + alert. + type: string + id: + description: A unique identifier for the rule used to detect the + alert. + type: string + severity: + description: The severity of the alert. + type: string + nullable: true + enum: + - none + - note + - warning + - error + - + required: + - id + - severity + - description + state: + description: State of a code scanning alert. + type: string + enum: + - open + - fixed + tool: + type: object + properties: + name: + description: The name of the tool used to generate the code scanning + analysis alert. + type: string + version: + description: The version of the tool used to detect the alert. + type: string + nullable: true + required: + - name + - version + url: + type: string + format: uri + required: + - number + - created_at + - url + - html_url + - state + - dismissed_by + - dismissed_at + - dismissed_reason + - rule + - tool + commit_oid: + "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + ref: + "$ref": "#/components/schemas/webhooks_code_scanning_ref" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - ref + - commit_oid + - repository + - sender + webhook-commit-comment-created: + title: commit_comment created event + type: object + properties: + action: + description: The action performed. Can be `created`. + type: string + enum: + - created + comment: + description: The [commit comment](https://docs.github.com/rest/commits/comments#get-a-commit-comment) + resource. + type: object + properties: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + html_url: + type: string + format: uri + id: + description: The ID of the commit comment. + type: integer + line: + description: The line of the blob to which the comment applies. The + last line of the range for a multi-line comment + type: integer + nullable: true + node_id: + description: The node ID of the commit comment. + type: string + path: + description: The relative path of the file to which the comment applies. + type: string + nullable: true + position: + description: The line index in the diff to which the comment applies. + type: integer + nullable: true + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url - total_count - "+1" - "-1" @@ -98488,10 +100435,11 @@ components: - hooray - eyes - rocket - repository_url: - type: string updated_at: type: string + url: + type: string + format: uri user: title: User type: object @@ -98560,21 +100508,19 @@ components: - login - id required: + - url + - html_url - id - node_id - - html_url - - parent_id - - child_comment_count - - repository_url - - discussion_id - - author_association - user + - position + - line + - path + - commit_id - created_at - updated_at + - author_association - body - - reactions - discussion: - "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -98587,645 +100533,373 @@ components: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - changes - comment - - discussion - repository - sender - webhook-discussion-created: - title: discussion created event + webhook-create: + title: create event type: object properties: - action: + description: + description: The repository's current description. type: string - enum: - - created - discussion: - allOf: - - title: Discussion - type: object - properties: - active_lock_reason: - type: string - nullable: true - answer_chosen_at: - type: string - nullable: true - answer_chosen_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - answer_html_url: - type: string - nullable: true - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - nullable: true - category: - type: object - properties: - created_at: - type: string - format: date-time - description: - type: string - emoji: - type: string - id: - type: integer - is_answerable: - type: boolean - name: - type: string - node_id: - type: string - repository_id: - type: integer - slug: - type: string - updated_at: - type: string - required: - - id - - repository_id - - emoji - - name - - description - - created_at - - updated_at - - slug - - is_answerable - comments: - type: integer - created_at: - type: string - format: date-time - html_url: - type: string - id: - type: integer - locked: - type: boolean - node_id: - type: string - number: - type: integer - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - state: - type: string - enum: - - open - - locked - - converting - - transferring - timeline_url: - type: string - title: - type: string - updated_at: - type: string - format: date-time - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - repository_url - - category - - answer_html_url - - answer_chosen_at - - answer_chosen_by - - html_url - - id - - node_id - - number - - title - - user - - state - - locked - - comments - - created_at - - updated_at - - author_association - - active_lock_reason - - body - - type: object - properties: - active_lock_reason: - nullable: true - answer_chosen_at: - nullable: true - answer_chosen_by: - nullable: true - answer_html_url: - type: string - nullable: true - author_association: - type: string - body: - type: string - nullable: true - category: - type: object - properties: - created_at: - type: string - description: - type: string - emoji: - type: string - id: - type: integer - is_answerable: - type: boolean - name: - type: string - node_id: - type: string - repository_id: - type: integer - slug: - type: string - updated_at: - type: string - comments: - type: integer - created_at: - type: string - html_url: - type: string - id: - type: integer - locked: - type: boolean - enum: - - false - node_id: - type: string - number: - type: integer - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - type: string - enum: - - open - - converting - - transferring - timeline_url: - type: string - title: - type: string - updated_at: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - required: - - state - - locked - - answer_html_url - - answer_chosen_at - - answer_chosen_by + nullable: true enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + master_branch: + description: The name of the repository's default branch (usually `main`). + type: string organization: "$ref": "#/components/schemas/organization-simple-webhooks" + pusher_type: + "$ref": "#/components/schemas/webhooks_deploy_pusher_type" + ref: + "$ref": "#/components/schemas/webhooks_ref_0" + ref_type: + description: The type of Git ref object created in the repository. + type: string + enum: + - tag + - branch repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - - action - - discussion + - ref + - ref_type + - master_branch + - description + - pusher_type - repository - sender - webhook-discussion-deleted: - title: discussion deleted event + webhook-custom-property-created: + title: custom property created event type: object properties: action: type: string enum: - - deleted - discussion: - "$ref": "#/components/schemas/discussion" + - created + definition: + "$ref": "#/components/schemas/org-custom-property" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - discussion - - repository - - sender - webhook-discussion-edited: - title: discussion edited event + - definition + - organization + webhook-custom-property-deleted: + title: custom property deleted event type: object properties: action: type: string enum: - - edited - changes: + - deleted + definition: type: object properties: - body: - type: object - properties: - from: - type: string - required: - - from - title: - type: object - properties: - from: - type: string - required: - - from - discussion: - "$ref": "#/components/schemas/discussion" + property_name: + type: string + description: The name of the property that was deleted. + required: + - property_name + 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-webhooks" + required: + - action + - definition + - organization + webhook-custom-property-updated: + title: custom property updated event + type: object + properties: + action: + type: string + enum: + - updated + definition: + "$ref": "#/components/schemas/org-custom-property" 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-webhooks" + required: + - action + - definition + - organization + webhook-custom-property-values-updated: + title: Custom property values updated event + type: object + properties: + action: + type: string + enum: + - updated + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" repository: "$ref": "#/components/schemas/repository-webhooks" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" + new_property_values: + type: array + description: The new custom property values for the repository. + items: + "$ref": "#/components/schemas/custom-property-value" + old_property_values: + type: array + description: The old custom property values for the repository. + items: + "$ref": "#/components/schemas/custom-property-value" required: - action - - discussion + - repository + - organization + - new_property_values + - old_property_values + webhook-delete: + title: delete event + type: object + properties: + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pusher_type: + "$ref": "#/components/schemas/webhooks_deploy_pusher_type" + ref: + "$ref": "#/components/schemas/webhooks_ref_0" + ref_type: + description: The type of Git ref object deleted in the repository. + type: string + enum: + - tag + - branch + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - ref + - ref_type + - pusher_type - repository - sender - webhook-discussion-labeled: - title: discussion labeled event + webhook-dependabot-alert-auto-dismissed: + title: Dependabot alert auto-dismissed event type: object properties: action: type: string enum: - - labeled - discussion: - "$ref": "#/components/schemas/discussion" + - auto_dismissed + alert: + "$ref": "#/components/schemas/dependabot-alert" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-dependabot-alert-auto-reopened: + title: Dependabot alert auto-reopened event + type: object + properties: + action: + type: string + enum: + - auto_reopened + alert: + "$ref": "#/components/schemas/dependabot-alert" installation: "$ref": "#/components/schemas/simple-installation" - label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description organization: "$ref": "#/components/schemas/organization-simple-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - discussion - - label + - alert - repository - sender - webhook-discussion-locked: - title: discussion locked event + webhook-dependabot-alert-created: + title: Dependabot alert created event type: object properties: action: type: string enum: - - locked - discussion: - "$ref": "#/components/schemas/discussion" + - created + alert: + "$ref": "#/components/schemas/dependabot-alert" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-dependabot-alert-dismissed: + title: Dependabot alert dismissed event + type: object + properties: + action: + type: string + enum: + - dismissed + alert: + "$ref": "#/components/schemas/dependabot-alert" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - discussion + - alert - repository - sender - webhook-discussion-pinned: - title: discussion pinned event + webhook-dependabot-alert-fixed: + title: Dependabot alert fixed event type: object properties: action: type: string enum: - - pinned - discussion: - "$ref": "#/components/schemas/discussion" + - fixed + alert: + "$ref": "#/components/schemas/dependabot-alert" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-dependabot-alert-reintroduced: + title: Dependabot alert reintroduced event + type: object + properties: + action: + type: string + enum: + - reintroduced + alert: + "$ref": "#/components/schemas/dependabot-alert" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - discussion + - alert - repository - sender - webhook-discussion-reopened: - title: discussion reopened event + webhook-dependabot-alert-reopened: + title: Dependabot alert reopened event type: object properties: action: type: string enum: - reopened - discussion: - "$ref": "#/components/schemas/discussion" + alert: + "$ref": "#/components/schemas/dependabot-alert" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-deploy-key-created: + title: deploy_key created event + type: object + properties: + action: + type: string + enum: + - created enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + key: + "$ref": "#/components/schemas/webhooks_deploy_key" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -99234,33 +100908,23 @@ components: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - discussion + - key - repository - sender - webhook-discussion-transferred: - title: discussion transferred event + webhook-deploy-key-deleted: + title: deploy_key deleted event type: object properties: action: type: string enum: - - transferred - changes: - type: object - properties: - new_discussion: - "$ref": "#/components/schemas/discussion" - new_repository: - "$ref": "#/components/schemas/repository-webhooks" - required: - - new_discussion - - new_repository - discussion: - "$ref": "#/components/schemas/discussion" + - deleted enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + key: + "$ref": "#/components/schemas/webhooks_deploy_key" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -99269,98 +100933,28 @@ components: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - changes - - discussion + - key - repository - sender - webhook-discussion-unanswered: - title: discussion unanswered event + webhook-deployment-created: + title: deployment created event type: object properties: action: type: string enum: - - unanswered - discussion: - "$ref": "#/components/schemas/discussion" - old_answer: + - created + deployment: + title: Deployment + description: The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). type: object properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - type: string - child_comment_count: - type: integer created_at: type: string - format: date-time - discussion_id: - type: integer - html_url: - type: string - id: - type: integer - node_id: - type: string - parent_id: - nullable: true - reactions: - title: Reactions + creator: + title: User type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - updated_at: - type: string - format: date-time - user: - title: User - type: object - nullable: true + nullable: true properties: avatar_url: type: string @@ -99424,123 +101018,409 @@ components: required: - login - id - required: - - id - - node_id - - html_url - - parent_id - - child_comment_count - - repository_url - - discussion_id - - author_association - - user - - created_at - - updated_at - - body - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - old_answer - - repository - webhook-discussion-unlabeled: - title: discussion unlabeled event - type: object - properties: - action: - type: string - enum: - - unlabeled - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean description: type: string nullable: true + environment: + type: string id: type: integer - name: - description: The name of the label. - type: string node_id: type: string + original_environment: + type: string + payload: + oneOf: + - type: object + - type: string + performed_via_github_app: + title: 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. + type: object + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + - workflow_job + - pull_request_review_thread + - merge_queue_entry + - secret_scanning_alert_location + - merge_group + external_url: + type: string + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: string + nullable: true + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + production_environment: + type: boolean + ref: + type: string + repository_url: + type: string + format: uri + sha: + type: string + statuses_url: + type: string + format: uri + task: + type: string + transient_environment: + type: boolean + updated_at: + type: string url: - description: URL for the label type: string format: uri required: + - url - id - node_id - - url - - name - - color - - default + - sha + - ref + - task + - payload + - original_environment + - environment - description - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - label - - repository - - sender - webhook-discussion-unlocked: - title: discussion unlocked event - type: object - properties: - action: - type: string - enum: - - unlocked - discussion: - "$ref": "#/components/schemas/discussion" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - repository - - sender - webhook-discussion-unpinned: - title: discussion unpinned event - type: object - properties: - action: - type: string - enum: - - unpinned - discussion: - "$ref": "#/components/schemas/discussion" + - creator + - created_at + - updated_at + - statuses_url + - repository_url enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -99551,1587 +101431,1837 @@ components: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - discussion - - repository - - sender - webhook-fork: - title: fork event - description: A user forks a repository. - type: object - properties: - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - forkee: - description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) - resource. - allOf: - - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: - type: object - description: The custom properties that were defined for the repository. - The keys are the custom property names, and the values are the corresponding - custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License + workflow: + "$ref": "#/components/schemas/webhooks_workflow" + workflow_run: + title: Deployment Workflow Run + type: object + nullable: true + properties: + actor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + artifacts_url: + type: string + cancel_url: + type: string + check_suite_id: + type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + conclusion: + type: string + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + display_title: + type: string + event: + type: string + head_branch: + type: string + head_commit: + nullable: true + head_repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + nullable: true + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: + type: string + html_url: + type: string + format: uri + id: + type: integer + jobs_url: + type: string + logs_url: + type: string + name: + type: string + node_id: + type: string + path: + type: string + previous_attempt_url: + nullable: true + pull_requests: + type: array + items: + title: Check Run Pull Request type: object - nullable: true properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo id: type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization + number: + type: integer url: type: string format: uri required: - - login + - url - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on web-based - commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - - type: object - properties: - allow_forking: - type: boolean - archive_url: - type: string - archived: - type: boolean - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - clone_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - created_at: - type: string - default_branch: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - disabled: - type: boolean - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - enum: - - true - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - git_url: - type: string - has_downloads: - type: boolean - has_issues: - type: boolean - has_pages: - type: boolean - has_projects: - type: boolean - has_wiki: - type: boolean - homepage: - type: string - nullable: true - hooks_url: - type: string - html_url: - type: string - id: - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - language: - nullable: true - languages_url: - type: string - license: - type: object - nullable: true - merges_url: - type: string - milestones_url: - type: string - mirror_url: - nullable: true - name: - type: string - node_id: - type: string - notifications_url: - type: string - open_issues: - type: integer - open_issues_count: - type: integer - owner: + - number + - head + - base + referenced_workflows: + type: array + nullable: true + items: type: object properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: + path: type: string - type: + ref: type: string - url: + sha: type: string - private: - type: boolean - public: - type: boolean - pulls_url: - type: string - pushed_at: - type: string - releases_url: - type: string - size: - type: integer - ssh_url: - type: string - stargazers_count: - type: integer - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - svn_url: - type: string - tags_url: - type: string - teams_url: - type: string - topics: - type: array - items: + required: + - path + - sha + repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: nullable: true - trees_url: - type: string - updated_at: - type: string - url: - type: string - visibility: - type: string - watchers: - type: integer - watchers_count: - type: integer - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + rerun_url: + type: string + run_attempt: + type: integer + run_number: + type: integer + run_started_at: + type: string + format: date-time + status: + type: string + enum: + - requested + - in_progress + - completed + - queued + - waiting + - pending + triggering_actor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + required: + - id + - name + - node_id + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id + - url + - html_url + - path + - pull_requests + - created_at + - updated_at + - actor + - run_attempt + - run_started_at + - display_title required: - - forkee + - action + - deployment + - workflow + - workflow_run - repository - sender - webhook-github-app-authorization-revoked: - title: github_app_authorization revoked event + webhook-deployment-protection-rule-requested: + title: deployment protection rule requested event type: object properties: action: type: string enum: - - revoked - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" + - requested + environment: + description: The name of the environment that has the deployment protection + rule. + type: string + event: + description: The event that triggered the deployment protection rule. + type: string + deployment_callback_url: + description: The URL to review the deployment protection rule. + type: string + format: uri + deployment: + "$ref": "#/components/schemas/deployment" + pull_requests: + type: array + items: + "$ref": "#/components/schemas/pull-request" repository: "$ref": "#/components/schemas/repository-webhooks" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" sender: "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - sender - webhook-gollum: - title: gollum event + webhook-deployment-review-approved: type: object properties: + action: + type: string + enum: + - approved + approver: + "$ref": "#/components/schemas/webhooks_approver" + comment: + type: string enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" - pages: - description: The pages that were updated. - type: array - items: - type: object - properties: - action: - description: The action that was performed on the page. Can be `created` - or `edited`. - type: string - enum: - - created - - edited - html_url: - description: Points to the HTML wiki page. - type: string - format: uri - page_name: - description: The name of the page. - type: string - sha: - description: The latest commit SHA of the page. - type: string - summary: - type: string - nullable: true - title: - description: The current page title. - type: string - required: - - page_name - - title - - summary - - action - - sha - - html_url repository: "$ref": "#/components/schemas/repository-webhooks" + reviewers: + "$ref": "#/components/schemas/webhooks_reviewers" sender: "$ref": "#/components/schemas/simple-user-webhooks" - required: - - pages - - repository - - sender - webhook-installation-created: - title: installation created event - type: object - properties: - action: + since: type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - description: An array of repository objects that the installation can access. + workflow_job_run: + "$ref": "#/components/schemas/webhooks_workflow_job_run" + workflow_job_runs: type: array items: type: object properties: - full_name: + conclusion: + nullable: true + created_at: + type: string + environment: + type: string + html_url: type: string id: - description: Unique identifier of the repository type: integer name: - description: The name of the repository. type: string - node_id: + nullable: true + status: type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - title: User + updated_at: + type: string + workflow_run: + title: Deployment Workflow Run type: object nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string + actor: + title: User + type: object nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + artifacts_url: type: string - html_url: + cancel_url: type: string - format: uri - id: + check_suite_id: type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: + check_suite_node_id: type: string - format: uri - received_events_url: + check_suite_url: type: string - format: uri - repos_url: + conclusion: type: string - format: uri - site_admin: - type: boolean - starred_url: + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: type: string - format: uri-template - subscriptions_url: + format: date-time + display_title: type: string - format: uri - type: + event: type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - installation - - sender - webhook-installation-deleted: - title: installation deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - description: An array of repository objects that the installation can access. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - nullable: true - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - installation - - sender - webhook-installation-new-permissions-accepted: - title: installation new_permissions_accepted event - type: object - properties: - action: - type: string - enum: - - new_permissions_accepted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - description: An array of repository objects that the installation can access. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - nullable: true - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - installation - - sender - webhook-installation-repositories-added: - title: installation_repositories added event - type: object - properties: - action: - type: string - enum: - - added - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories_added: - description: An array of repository objects, which were added to the installation. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repositories_removed: - description: An array of repository objects, which were removed from the - installation. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_selection: - description: Describe whether all repositories have been selected or there's - a selection involved - type: string - enum: - - all - - selected - requester: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + head_branch: type: string + head_commit: + type: object nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: + head_repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: string + nullable: true + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: type: string html_url: type: string format: uri id: type: integer - login: + jobs_url: + type: string + logs_url: type: string name: type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: + path: type: string - format: uri - repos_url: + previous_attempt_url: type: string - format: uri - site_admin: - type: boolean - starred_url: + nullable: true + pull_requests: + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + referenced_workflows: + type: array + nullable: true + items: + type: object + properties: + path: + type: string + ref: + type: string + sha: + type: string + required: + - path + - sha + repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: string + nullable: true + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + rerun_url: type: string - format: uri-template - subscriptions_url: + run_attempt: + type: integer + run_number: + type: integer + run_started_at: type: string - format: uri - type: + format: date-time + status: type: string enum: - - Bot - - User - - Organization + - requested + - in_progress + - completed + - queued + - waiting + - pending + triggering_actor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + updated_at: + type: string + format: date-time url: type: string format: uri + workflow_id: + type: integer + workflow_url: + type: string required: - - login - id - sender: - "$ref": "#/components/schemas/simple-user-webhooks" + - name + - node_id + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id + - url + - html_url + - path + - pull_requests + - created_at + - updated_at + - actor + - triggering_actor + - run_attempt + - run_started_at + - display_title required: - action - - installation - - repository_selection - - repositories_added - - repositories_removed - - requester + - workflow_run + - since + - repository + - organization - sender - webhook-installation-repositories-removed: - title: installation_repositories removed event + webhook-deployment-review-rejected: type: object properties: action: type: string enum: - - removed + - rejected + approver: + "$ref": "#/components/schemas/webhooks_approver" + comment: + type: string enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: - "$ref": "#/components/schemas/installation" + "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" - repositories_added: - description: An array of repository objects, which were added to the installation. + repository: + "$ref": "#/components/schemas/repository-webhooks" + reviewers: + "$ref": "#/components/schemas/webhooks_reviewers" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + since: + type: string + workflow_job_run: + "$ref": "#/components/schemas/webhooks_workflow_job_run" + workflow_job_runs: type: array items: type: object properties: - full_name: + conclusion: type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. + nullable: true + created_at: type: string - node_id: + environment: type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repositories_removed: - description: An array of repository objects, which were removed from the - installation. - type: array - items: - type: object - properties: - full_name: + html_url: type: string id: - description: Unique identifier of the repository type: integer name: - description: The name of the repository. type: string - node_id: + nullable: true + status: type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_selection: - description: Describe whether all repositories have been selected or there's - a selection involved - type: string - enum: - - all - - selected - requester: - title: User + updated_at: + type: string + workflow_run: + title: Deployment Workflow Run type: object nullable: true properties: - avatar_url: + actor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + artifacts_url: type: string - format: uri - deleted: - type: boolean - email: + cancel_url: type: string - nullable: true - events_url: + check_suite_id: + type: integer + check_suite_node_id: type: string - format: uri-template - followers_url: + check_suite_url: type: string - format: uri - following_url: + conclusion: type: string - format: uri-template - gists_url: + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: type: string - format: uri-template - gravatar_id: + format: date-time + event: + type: string + head_branch: + type: string + head_commit: + type: object + nullable: true + head_repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: string + nullable: true + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: type: string html_url: type: string format: uri id: type: integer - login: + jobs_url: + type: string + logs_url: type: string name: type: string node_id: type: string - organizations_url: + path: type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - installation - - repository_selection - - repositories_added - - repositories_removed - - requester - - sender - webhook-installation-suspend: - title: installation suspend event - type: object - properties: - action: - type: string - enum: - - suspend - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - description: An array of repository objects that the installation can access. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - nullable: true - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - installation - - sender - webhook-installation-target-renamed: - type: object - properties: - account: - type: object - properties: - archived_at: + previous_attempt_url: type: string nullable: true - avatar_url: - type: string - created_at: - type: string - description: - nullable: true - events_url: - type: string - followers: - type: integer - followers_url: - type: string - following: - type: integer - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - has_organization_projects: - type: boolean - has_repository_projects: - type: boolean - hooks_url: - type: string - html_url: - type: string - id: - type: integer - is_verified: - type: boolean - issues_url: - type: string - login: - type: string - members_url: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - public_gists: - type: integer - public_members_url: - type: string - public_repos: - type: integer - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - slug: - type: string - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - updated_at: - type: string - url: - type: string - website_url: + pull_requests: + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: + type: string + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: + type: string + required: + - ref + - sha + - repo + id: + type: integer + number: + type: integer + url: + type: string + format: uri + required: + - url + - id + - number + - head + - base + referenced_workflows: + type: array nullable: true - required: - - id - - node_id - - avatar_url - - html_url - action: - type: string - enum: - - renamed - changes: - type: object - properties: - login: + items: + type: object + properties: + path: + type: string + ref: + type: string + sha: + type: string + required: + - path + - sha + repository: type: object properties: - from: + archive_url: type: string - required: - - from - slug: - type: object - properties: - from: + assignees_url: type: string - required: - - from - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - target_type: - type: string - required: - - action - - target_type - - account - - changes - - installation - webhook-installation-unsuspend: - title: installation unsuspend event - type: object - properties: - action: - type: string - enum: - - unsuspend - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repositories: - description: An array of repository objects that the installation can access. - type: array - items: - type: object - properties: - full_name: - type: string - id: - description: Unique identifier of the repository - type: integer - name: - description: The name of the repository. - type: string - node_id: - type: string - private: - description: Whether the repository is private or public. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - repository: - "$ref": "#/components/schemas/repository-webhooks" - requester: - nullable: true - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - installation - - sender - webhook-issue-comment-created: - title: issue_comment created event - type: object - properties: - action: - type: string - enum: - - created - comment: - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue comment - type: string - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - description: Unique identifier of the issue comment - type: integer - format: int64 - issue_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - "$ref": "#/components/schemas/nullable-integration" - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: string + nullable: true + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string url: type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - updated_at: + rerun_url: + type: string + run_attempt: + type: integer + run_number: + type: integer + run_started_at: type: string format: date-time - url: - description: URL for the issue comment + status: type: string - format: uri - user: + enum: + - requested + - in_progress + - completed + - queued + - waiting + triggering_actor: title: User type: object nullable: true @@ -101198,42 +103328,74 @@ components: required: - login - id + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + display_title: + type: string required: - - url - - html_url - - issue_url - id + - name - node_id - - user + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id + - url + - html_url + - path + - pull_requests - created_at - updated_at - - author_association - - performed_via_github_app - - body - - reactions + - actor + - triggering_actor + - run_attempt + - run_started_at + - display_title + required: + - action + - workflow_run + - since + - repository + - organization + - sender + webhook-deployment-review-requested: + type: object + properties: + action: + type: string + enum: + - requested enterprise: "$ref": "#/components/schemas/enterprise-webhooks" + environment: + type: string installation: "$ref": "#/components/schemas/simple-installation" - issue: - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - the comment belongs to. - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requestor: + "$ref": "#/components/schemas/webhooks_user" + reviewers: + type: array + items: type: object properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: + reviewer: title: User type: object nullable: true @@ -101294,1156 +103456,744 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - - login - id - assignees: - type: array - items: - title: User - type: object + type: + type: string + enum: + - User + - Team + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + since: + type: string + workflow_job_run: + type: object + properties: + conclusion: + nullable: true + created_at: + type: string + environment: + type: string + html_url: + type: string + id: + type: integer + name: + type: string + nullable: true + status: + type: string + updated_at: + type: string + required: + - id + - name + - status + - conclusion + - html_url + - created_at + - updated_at + - environment + workflow_run: + title: Deployment Workflow Run + type: object + nullable: true + properties: + actor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + artifacts_url: + type: string + cancel_url: + type: string + check_suite_id: + type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + conclusion: + type: string + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + created_at: + type: string + format: date-time + event: + type: string + head_branch: + type: string + head_commit: + type: object + nullable: true + head_repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: string nullable: true + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object properties: avatar_url: type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true events_url: type: string - format: uri-template followers_url: type: string - format: uri following_url: type: string - format: uri-template gists_url: type: string - format: uri-template gravatar_id: type: string html_url: type: string - format: uri id: type: integer login: type: string - name: - type: string node_id: type: string organizations_url: type: string - format: uri received_events_url: type: string - format: uri repos_url: type: string - format: uri site_admin: type: boolean starred_url: type: string - format: uri-template subscriptions_url: type: string - format: uri type: type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string url: - description: URL for the label type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: + type: string + html_url: + type: string + format: uri + id: + type: integer + jobs_url: + type: string + logs_url: + type: string + name: + type: string + node_id: + type: string + path: + type: string + previous_attempt_url: + type: string + nullable: true + pull_requests: + type: array + items: + title: Check Run Pull Request type: object - nullable: true properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User + base: type: object - nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: + ref: type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: type: string - format: uri required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User + - ref + - sha + - repo + head: type: object - nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: + ref: type: string - enum: - - Bot - - User - - Organization - url: + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: type: string - format: uri required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: + - ref + - sha + - repo + id: type: integer - total_count: + number: type: integer url: type: string format: uri required: - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: string - nullable: true - assignee: - title: User + - number + - head + - base + referenced_workflows: + type: array + nullable: true + items: type: object - nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: + path: type: string - format: uri - type: + ref: type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: + sha: type: string - format: uri required: - - login - - id - assignees: - type: array - items: - type: object + - path + - sha + repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + type: string nullable: true - author_association: - type: string - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - title: Label + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: type: object properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + avatar_url: type: string - default: - type: boolean - description: + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: type: string - nullable: true id: type: integer - name: - description: The name of the label. + login: type: string node_id: type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string url: - description: URL for the label type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - locked: - type: boolean - milestone: - type: object - nullable: true - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: object - nullable: true - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - required: - - labels - - state - - locked - - assignee - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - comment - - repository - - sender - webhook-issue-comment-deleted: - title: issue_comment deleted event - type: object - properties: - action: - type: string - enum: - - deleted - comment: - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + rerun_url: + type: string + run_attempt: + type: integer + run_number: + type: integer + run_started_at: + type: string + format: date-time + status: type: string enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue comment + - requested + - in_progress + - completed + - queued + - waiting + - pending + triggering_actor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + updated_at: type: string - created_at: + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + display_title: + type: string + required: + - id + - name + - node_id + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id + - url + - html_url + - path + - pull_requests + - created_at + - updated_at + - actor + - triggering_actor + - run_attempt + - run_started_at + - display_title + required: + - action + - workflow_run + - since + - workflow_job_run + - environment + - reviewers + - requestor + - repository + - organization + - sender + webhook-deployment-status-created: + title: deployment_status created event + type: object + properties: + action: + type: string + enum: + - created + check_run: + type: object + nullable: true + properties: + completed_at: type: string + nullable: true format: date-time + conclusion: + description: The result of the completed check run. This value will + be `null` until the check run has completed. + type: string + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - skipped + - + details_url: + type: string + format: uri + external_id: + type: string + head_sha: + description: The SHA of the commit that is being checked. + type: string html_url: type: string format: uri id: - description: Unique identifier of the issue comment + description: The id of the check. type: integer - format: int64 - issue_url: + name: + description: The name of the check run. type: string - format: uri node_id: type: string - performed_via_github_app: - "$ref": "#/components/schemas/nullable-integration" - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - updated_at: + started_at: type: string format: date-time + status: + description: The current status of the check run. Can be `queued`, `in_progress`, + or `completed`. + type: string + enum: + - queued + - in_progress + - completed + - waiting + - pending url: - description: URL for the issue comment type: string format: uri - user: + required: + - id + - name + - node_id + - head_sha + - external_id + - url + - html_url + - details_url + - status + - conclusion + - started_at + - completed_at + deployment: + title: Deployment + description: The [deployment](https://docs.github.com/rest/deployments/deployments#list-deployments). + type: object + properties: + created_at: + type: string + creator: title: User type: object nullable: true @@ -102504,119 +104254,117 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - login - id - required: - - url - - html_url - - issue_url - - id - - node_id - - user - - created_at - - updated_at - - author_association - - performed_via_github_app - - body - - reactions - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - the comment belongs to. - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: + description: + type: string + nullable: true + environment: + type: string + id: + type: integer + node_id: + type: string + original_environment: + type: string + payload: + oneOf: + - type: string + - type: object + nullable: true + performed_via_github_app: + title: 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. + type: object + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: type: string enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: + - 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 + - merge_queue_entry + - workflow_job + - pull_request_review_thread + - secret_scanning_alert_location + - merge_group + external_url: + type: string + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: title: User type: object nullable: true @@ -102677,1094 +104425,1221 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - login - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label + permissions: + description: The set of permissions for the GitHub app type: object properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + actions: type: string - default: + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: string + nullable: true + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + production_environment: + type: boolean + ref: + type: string + repository_url: + type: string + format: uri + sha: + type: string + statuses_url: + type: string + format: uri + task: + type: string + transient_environment: + type: boolean + updated_at: + type: string + url: + type: string + format: uri + required: + - url + - id + - node_id + - sha + - ref + - task + - payload + - original_environment + - environment + - description + - creator + - created_at + - updated_at + - statuses_url + - repository_url + deployment_status: + description: The [deployment status](https://docs.github.com/rest/deployments/statuses#list-deployment-statuses). + type: object + properties: + created_at: + type: string + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + deployment_url: + type: string + format: uri + description: + description: The optional human-readable description added to the status. + type: string + environment: + type: string + environment_url: + type: string + format: uri + id: + type: integer + log_url: + type: string + format: uri + node_id: + type: string + performed_via_github_app: + title: 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. + type: object + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + - merge_queue_entry + - workflow_job + - merge_group + - secret_scanning_alert_location + external_url: + type: string + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: type: boolean - description: + email: type: string nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer + login: + type: string name: - description: The name of the label. type: string node_id: type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: - description: URL for the label type: string format: uri required: + - login - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: string + nullable: true + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + repository_url: + type: string + format: uri + state: + description: The new state. Can be `pending`, `success`, `failure`, + or `error`. + type: string + target_url: + description: The optional link added to the status. + type: string + updated_at: + type: string + url: + type: string + format: uri + required: + - url + - id + - node_id + - state + - creator + - description + - environment + - target_url + - created_at + - updated_at + - deployment_url + - repository_url + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + workflow: + "$ref": "#/components/schemas/webhooks_workflow" + workflow_run: + title: Deployment Workflow Run + type: object + nullable: true + properties: + actor: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + artifacts_url: + type: string + cancel_url: + type: string + check_suite_id: + type: integer + check_suite_node_id: + type: string + check_suite_url: + type: string + conclusion: + type: string + nullable: true + enum: + - success + - failure + - neutral + - cancelled + - timed_out + - action_required + - stale + - + - startup_failure + created_at: + type: string + format: date-time + display_title: + type: string + event: + type: string + head_branch: + type: string + head_commit: + nullable: true + head_repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: + nullable: true + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: + type: string + url: + type: string + head_sha: + type: string + html_url: + type: string + format: uri + id: + type: integer + jobs_url: + type: string + logs_url: + type: string + name: + type: string + node_id: + type: string + path: + type: string + previous_attempt_url: + nullable: true + pull_requests: + type: array + items: + title: Check Run Pull Request + type: object + properties: + base: type: object - nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: + ref: type: string - format: uri-template - subscriptions_url: + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: type: string - format: uri - type: + required: + - ref + - sha + - repo + head: + type: object + properties: + ref: type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: + repo: + title: Repo Ref + type: object + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + required: + - id + - url + - name + sha: type: string - format: uri required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri + - ref + - sha + - repo id: type: integer - labels_url: - type: string - format: uri - node_id: - type: string number: - description: The number of the milestone. - type: integer - open_issues: type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time url: type: string format: uri required: - url - - html_url - - labels_url - id - - node_id - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. + - head + - base + referenced_workflows: + type: array + nullable: true + items: type: object - nullable: true properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: + path: type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app + ref: type: string - updated_at: + sha: type: string - nullable: true - format: date-time required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: string - nullable: true - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - type: object + - path + - sha + repository: + type: object + properties: + archive_url: + type: string + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + collaborators_url: + type: string + comments_url: + type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string + deployments_url: + type: string + description: nullable: true - author_association: - type: string - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - title: Label + downloads_url: + type: string + events_url: + type: string + fork: + type: boolean + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + hooks_url: + type: string + html_url: + type: string + id: + type: integer + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string + labels_url: + type: string + languages_url: + type: string + merges_url: + type: string + milestones_url: + type: string + name: + type: string + node_id: + type: string + notifications_url: + type: string + owner: type: object properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + avatar_url: type: string - default: - type: boolean - description: + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: type: string - nullable: true id: type: integer - name: - description: The name of the label. + login: type: string node_id: type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string url: - description: URL for the label type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - locked: - type: boolean - milestone: - type: object - nullable: true - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: object - nullable: true - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - required: - - labels - - state - - locked - - assignee - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - comment - - repository - - sender - webhook-issue-comment-edited: - title: issue_comment edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: The changes to the comment. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. + private: + type: boolean + pulls_url: + type: string + releases_url: + type: string + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + tags_url: + type: string + teams_url: + type: string + trees_url: type: string - required: - - from - comment: - title: issue comment - description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) - itself. - type: object - properties: - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue comment - type: string - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - description: Unique identifier of the issue comment - type: integer - format: int64 - issue_url: - type: string - format: uri - node_id: - type: string - performed_via_github_app: - "$ref": "#/components/schemas/nullable-integration" - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer url: type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - updated_at: + rerun_url: + type: string + run_attempt: + type: integer + run_number: + type: integer + run_started_at: type: string format: date-time - url: - description: URL for the issue comment + status: type: string - format: uri - user: + enum: + - requested + - in_progress + - completed + - queued + - waiting + - pending + triggering_actor: title: User type: object nullable: true @@ -103825,870 +105700,870 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - login - id + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string required: - - url - - html_url - - issue_url - id + - name - node_id - - user + - head_branch + - head_sha + - run_number + - event + - status + - conclusion + - workflow_id + - check_suite_id + - check_suite_node_id + - url + - html_url + - path + - pull_requests - created_at - updated_at - - author_association - - performed_via_github_app - - body - - reactions + - actor + - triggering_actor + - run_attempt + - run_started_at + - display_title + required: + - action + - deployment_status + - deployment + - repository + - sender + webhook-discussion-answered: + title: discussion answered event + type: object + properties: + action: + type: string + enum: + - answered + answer: + "$ref": "#/components/schemas/webhooks_answer" + discussion: + "$ref": "#/components/schemas/discussion" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" - issue: - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - the comment belongs to. - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - answer + - repository + - sender + webhook-discussion-category-changed: + title: discussion category changed event + type: object + properties: + action: + type: string + enum: + - category_changed + changes: + type: object + properties: + category: + type: object + properties: + from: type: object - nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: + created_at: type: string - format: uri-template - gravatar_id: + format: date-time + description: type: string - html_url: + emoji: type: string - format: uri id: type: integer - login: - type: string + is_answerable: + type: boolean name: type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: + repository_id: type: integer - name: - description: The name of the label. - type: string - node_id: + slug: type: string - url: - description: URL for the label + updated_at: type: string - format: uri required: - id - - node_id - - url + - repository_id + - emoji - name - - color - - default - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. + - created_at + - updated_at + - slug + - is_answerable + required: + - from + required: + - category + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - discussion + - repository + - sender + webhook-discussion-closed: + title: discussion closed event + type: object + properties: + action: + type: string + enum: + - closed + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-comment-created: + title: discussion_comment created event + type: object + properties: + action: + type: string + enum: + - created + comment: + "$ref": "#/components/schemas/webhooks_comment" + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - comment + - discussion + - repository + - sender + webhook-discussion-comment-deleted: + title: discussion_comment deleted event + type: object + properties: + action: + type: string + enum: + - deleted + comment: + "$ref": "#/components/schemas/webhooks_comment" + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - comment + - discussion + - repository + - sender + webhook-discussion-comment-edited: + title: discussion_comment edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + type: object + properties: + body: + type: object + properties: + from: + type: string + required: + - from + required: + - body + comment: + "$ref": "#/components/schemas/webhooks_comment" + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - comment + - discussion + - repository + - sender + webhook-discussion-created: + title: discussion created event + type: object + properties: + action: + type: string + enum: + - created + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-deleted: + title: discussion deleted event + type: object + properties: + action: + type: string + enum: + - deleted + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-edited: + title: discussion edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + type: object + properties: + body: + type: object + properties: + from: + type: string + required: + - from + title: + type: object + properties: + from: + type: string + required: + - from + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-labeled: + title: discussion labeled event + type: object + properties: + action: + type: string + enum: + - labeled + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + label: + "$ref": "#/components/schemas/webhooks_label" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - label + - repository + - sender + webhook-discussion-locked: + title: discussion locked event + type: object + properties: + action: + type: string + enum: + - locked + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-pinned: + title: discussion pinned event + type: object + properties: + action: + type: string + enum: + - pinned + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-reopened: + title: discussion reopened event + type: object + properties: + action: + type: string + enum: + - reopened + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-transferred: + title: discussion transferred event + type: object + properties: + action: + type: string + enum: + - transferred + changes: + type: object + properties: + new_discussion: + "$ref": "#/components/schemas/discussion" + new_repository: + "$ref": "#/components/schemas/repository-webhooks" + required: + - new_discussion + - new_repository + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - discussion + - repository + - sender + webhook-discussion-unanswered: + title: discussion unanswered event + type: object + properties: + action: + type: string + enum: + - unanswered + discussion: + "$ref": "#/components/schemas/discussion" + old_answer: + "$ref": "#/components/schemas/webhooks_answer" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - old_answer + - repository + webhook-discussion-unlabeled: + title: discussion unlabeled event + type: object + properties: + action: + type: string + enum: + - unlabeled + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + label: + "$ref": "#/components/schemas/webhooks_label" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - label + - repository + - sender + webhook-discussion-unlocked: + title: discussion unlocked event + type: object + properties: + action: + type: string + enum: + - unlocked + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-discussion-unpinned: + title: discussion unpinned event + type: object + properties: + action: + type: string + enum: + - unpinned + discussion: + "$ref": "#/components/schemas/discussion" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - discussion + - repository + - sender + webhook-fork: + title: fork event + description: A user forks a repository. + type: object + properties: + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + forkee: + description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) + resource. + allOf: + - title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + custom_properties: + type: object + description: The custom properties that were defined for the repository. + The keys are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are + merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + homepage: + type: string + nullable: true + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: string + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: type: string - enum: - - open - - closed - title: - description: The title of the milestone. + name: type: string - updated_at: + node_id: + type: string + spdx_id: type: string - format: date-time url: type: string + nullable: true format: uri required: + - key + - name + - spdx_id - url - - html_url - - labels_url - - id - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at + master_branch: + type: string + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: string + nullable: true + format: uri + name: + description: The name of the repository. + type: string node_id: type: string - number: + notifications_url: + type: string + format: uri-template + open_issues: type: integer - performed_via_github_app: - title: 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. + open_issues_count: + type: integer + organization: + type: string + owner: + title: User type: object nullable: true properties: - created_at: + avatar_url: type: string - nullable: true - format: date-time - description: + format: uri + deleted: + type: boolean + email: type: string nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: + events_url: + type: string + format: uri-template + followers_url: type: string - nullable: true format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string html_url: type: string format: uri id: - description: Unique identifier of the GitHub app type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string + login: + type: string name: type: string node_id: @@ -104716,221 +106591,298 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - login - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: string - nullable: true - assignee: - title: User + permissions: type: object - nullable: true properties: - avatar_url: - type: string - format: uri - deleted: + admin: type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri required: - - login - - id - assignees: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + size: + type: integer + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: type: array items: - type: object - nullable: true - author_association: + type: string + trees_url: type: string - body: + format: uri-template + updated_at: type: string - nullable: true - closed_at: + format: date-time + url: type: string - nullable: true - comments: + format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based + commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + - type: object + properties: + allow_forking: + type: boolean + archive_url: + type: string + archived: + type: boolean + assignees_url: + type: string + blobs_url: + type: string + branches_url: + type: string + clone_url: + type: string + collaborators_url: + type: string comments_url: type: string + commits_url: + type: string + compare_url: + type: string + contents_url: + type: string + contributors_url: + type: string created_at: type: string + default_branch: + type: string + deployments_url: + type: string + description: + type: string + nullable: true + disabled: + type: boolean + downloads_url: + type: string events_url: type: string + fork: + type: boolean + enum: + - true + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + full_name: + type: string + git_commits_url: + type: string + git_refs_url: + type: string + git_tags_url: + type: string + git_url: + type: string + has_downloads: + type: boolean + has_issues: + type: boolean + has_pages: + type: boolean + has_projects: + type: boolean + has_wiki: + type: boolean + homepage: + type: string + nullable: true + hooks_url: + type: string html_url: type: string id: type: integer - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description + is_template: + type: boolean + issue_comment_url: + type: string + issue_events_url: + type: string + issues_url: + type: string + keys_url: + type: string labels_url: type: string - locked: - type: boolean - milestone: - type: object + language: nullable: true - node_id: + languages_url: type: string - number: - type: integer - performed_via_github_app: + license: type: object nullable: true - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - description: State of the issue; either 'open' or 'closed' + merges_url: type: string - enum: - - open - - closed - timeline_url: + milestones_url: type: string - title: + mirror_url: + nullable: true + name: type: string - updated_at: + node_id: type: string - url: + notifications_url: type: string - user: + open_issues: + type: integer + open_issues_count: + type: integer + owner: type: object properties: avatar_url: @@ -104969,11 +106921,54 @@ components: type: string url: type: string - required: - - labels - - state - - locked - - assignee + private: + type: boolean + public: + type: boolean + pulls_url: + type: string + pushed_at: + type: string + releases_url: + type: string + size: + type: integer + ssh_url: + type: string + stargazers_count: + type: integer + stargazers_url: + type: string + statuses_url: + type: string + subscribers_url: + type: string + subscription_url: + type: string + svn_url: + type: string + tags_url: + type: string + teams_url: + type: string + topics: + type: array + items: + nullable: true + trees_url: + type: string + updated_at: + type: string + url: + type: string + visibility: + type: string + watchers: + type: integer + watchers_count: + type: integer + installation: + "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -104981,245 +106976,453 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" required: + - forkee + - repository + - sender + webhook-github-app-authorization-revoked: + title: github_app_authorization revoked event + type: object + properties: + action: + type: string + enum: + - revoked + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: - action - - changes - - issue - - comment + - sender + webhook-gollum: + title: gollum event + type: object + properties: + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pages: + description: The pages that were updated. + type: array + items: + type: object + properties: + action: + description: The action that was performed on the page. Can be `created` + or `edited`. + type: string + enum: + - created + - edited + html_url: + description: Points to the HTML wiki page. + type: string + format: uri + page_name: + description: The name of the page. + type: string + sha: + description: The latest commit SHA of the page. + type: string + summary: + type: string + nullable: true + title: + description: The current page title. + type: string + required: + - page_name + - title + - summary + - action + - sha + - html_url + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - pages - repository - sender - webhook-issues-assigned: - title: issues assigned event + webhook-installation-created: + title: installation created event type: object properties: action: - description: The action that was performed. type: string enum: - - assigned - assignee: - title: User - type: object + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + "$ref": "#/components/schemas/webhooks_user" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - installation + - sender + webhook-installation-deleted: + title: installation deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + nullable: true + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - installation + - sender + webhook-installation-new-permissions-accepted: + title: installation new_permissions_accepted event + type: object + properties: + action: + type: string + enum: + - new_permissions_accepted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + nullable: true + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - installation + - sender + webhook-installation-repositories-added: + title: installation_repositories added event + type: object + properties: + action: + type: string + enum: + - added + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories_added: + "$ref": "#/components/schemas/webhooks_repositories_added" + repositories_removed: + description: An array of repository objects, which were removed from the + installation. + type: array + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_selection: + "$ref": "#/components/schemas/webhooks_repository_selection" + requester: + "$ref": "#/components/schemas/webhooks_user" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - installation + - repository_selection + - repositories_added + - repositories_removed + - requester + - sender + webhook-installation-repositories-removed: + title: installation_repositories removed event + type: object + properties: + action: + type: string + enum: + - removed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories_added: + "$ref": "#/components/schemas/webhooks_repositories_added" + repositories_removed: + description: An array of repository objects, which were removed from the + installation. + type: array + items: + type: object + properties: + full_name: + type: string + id: + description: Unique identifier of the repository + type: integer + name: + description: The name of the repository. + type: string + node_id: + type: string + private: + description: Whether the repository is private or public. + type: boolean + required: + - id + - node_id + - name + - full_name + - private + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_selection: + "$ref": "#/components/schemas/webhooks_repository_selection" + requester: + "$ref": "#/components/schemas/webhooks_user" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - installation + - repository_selection + - repositories_added + - repositories_removed + - requester + - sender + webhook-installation-suspend: + title: installation suspend event + type: object + properties: + action: + type: string + enum: + - suspend + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: nullable: true + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - installation + - sender + webhook-installation-target-renamed: + type: object + properties: + account: + type: object properties: + archived_at: + type: string + nullable: true avatar_url: type: string - format: uri - deleted: - type: boolean - email: + created_at: type: string + description: nullable: true events_url: type: string - format: uri-template + followers: + type: integer followers_url: type: string - format: uri + following: + type: integer following_url: type: string - format: uri-template gists_url: type: string - format: uri-template gravatar_id: type: string + has_organization_projects: + type: boolean + has_repository_projects: + type: boolean + hooks_url: + type: string html_url: type: string - format: uri id: type: integer + is_verified: + type: boolean + issues_url: + type: string login: type: string + members_url: + type: string name: type: string node_id: type: string organizations_url: type: string - format: uri + public_gists: + type: integer + public_members_url: + type: string + public_repos: + type: integer received_events_url: type: string - format: uri repos_url: type: string - format: uri site_admin: type: boolean + slug: + type: string starred_url: type: string - format: uri-template subscriptions_url: type: string - format: uri type: type: string - enum: - - Bot - - User - - Organization + updated_at: + type: string url: type: string - format: uri + website_url: + nullable: true required: - - login - id - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. + - node_id + - avatar_url + - html_url + action: + type: string + enum: + - renamed + changes: type: object properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User + login: type: object - nullable: true properties: - avatar_url: + from: type: string - format: uri - deleted: - type: boolean - email: + required: + - from + slug: + type: object + properties: + from: type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id + - from + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + target_type: + type: string + required: + - action + - target_type + - account + - changes + - installation + webhook-installation-unsuspend: + title: installation unsuspend event + type: object + properties: + action: + type: string + enum: + - unsuspend + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repositories: + "$ref": "#/components/schemas/webhooks_repositories" + repository: + "$ref": "#/components/schemas/repository-webhooks" + requester: + nullable: true + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - installation + - sender + webhook-issue-comment-created: + title: issue_comment created event + type: object + properties: + action: + type: string + enum: + - created + comment: + title: issue comment + description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) + itself. + type: object + properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -105234,580 +107437,25 @@ components: - NONE - OWNER body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: + description: Contents of the issue comment type: string - format: uri created_at: type: string format: date-time - draft: - type: boolean - events_url: - type: string - format: uri html_url: type: string format: uri id: + description: Unique identifier of the issue comment type: integer format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: + issue_url: type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at + format: uri node_id: type: string - number: - type: integer performed_via_github_app: - title: 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. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri + "$ref": "#/components/schemas/nullable-integration" reactions: title: Reactions type: object @@ -105844,29 +107492,11 @@ components: - hooray - eyes - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string updated_at: type: string format: date-time url: - description: URL for the issue + description: URL for the issue comment type: string format: uri user: @@ -105930,7 +107560,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -105939,53 +107568,24 @@ components: - id required: - url - - repository_url - - labels_url - - comments_url - - events_url - html_url + - issue_url - id - node_id - - number - - title - user - - assignees - - milestone - - comments - created_at - updated_at - - closed_at - author_association - - active_lock_reason + - performed_via_github_app - body - reactions - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - repository - - sender - webhook-issues-closed: - title: issues closed event - type: object - properties: - action: - description: The action that was performed. - type: string - enum: - - closed enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. + the comment belongs to. allOf: - title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -106427,7 +108027,6 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - reminder - pull_request_review_thread external_url: @@ -106648,6 +108247,7 @@ components: enum: - read - write + - admin secret_scanning_alerts: type: string enum: @@ -106886,8 +108486,73 @@ components: type: string nullable: true assignee: + title: User type: object nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id assignees: type: array items: @@ -106916,8 +108581,37 @@ components: labels: type: array items: + title: Label type: object - nullable: true + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description labels_url: type: string locked: @@ -106958,10 +108652,11 @@ components: repository_url: type: string state: + description: State of the issue; either 'open' or 'closed' type: string enum: - - closed - open + - closed timeline_url: type: string title: @@ -107010,8 +108705,10 @@ components: url: type: string required: + - labels - state - - closed_at + - locked + - assignee organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -107021,105 +108718,42 @@ components: required: - action - issue + - comment - repository - sender - webhook-issues-deleted: - title: issues deleted event + webhook-issue-comment-deleted: + title: issue_comment deleted event type: object properties: action: type: string enum: - deleted + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: - title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: title: User type: object nullable: true @@ -107180,848 +108814,7 @@ components: - Bot - User - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - repository - - sender - webhook-issues-demilestoned: - title: issues demilestoned event - type: object - properties: - action: - type: string - enum: - - demilestoned - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin + - Mannequin url: type: string format: uri @@ -108563,7 +109356,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -108842,8 +109634,73 @@ components: type: string nullable: true assignee: + title: User type: object nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id assignees: type: array items: @@ -108872,49 +109729,434 @@ components: labels: type: array items: + title: Label type: object - nullable: true + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description labels_url: type: string locked: type: boolean milestone: - title: Milestone - description: A collection of related issues and pull requests. type: object nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + reactions: + type: object properties: - closed_at: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: type: string - nullable: true - format: date-time - closed_issues: + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: type: integer - created_at: + login: type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - labels + - state + - locked + - assignee + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - comment + - repository + - sender + webhook-issue-comment-edited: + title: issue_comment edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + "$ref": "#/components/schemas/webhooks_changes" + comment: + "$ref": "#/components/schemas/webhooks_issue_comment" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + the comment belongs to. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: string + nullable: true + closed_at: + type: string + nullable: true + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template gists_url: type: string format: uri-template @@ -109020,9 +110262,376 @@ components: number: type: integer performed_via_github_app: + title: 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. type: object nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + external_url: + type: string + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: string + nullable: true + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: string + nullable: true + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri reactions: + title: Reactions type: object properties: "+1": @@ -109045,324 +110654,44 @@ components: type: integer url: type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket repository_url: type: string + format: uri state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: type: string + nullable: true timeline_url: type: string + format: uri title: + description: Title of the issue type: string updated_at: type: string + format: date-time url: + description: URL for the issue type: string + format: uri user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - required: - - milestone - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - repository - - sender - webhook-issues-edited: - title: issues edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: The changes to the issue. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from - title: - type: object - properties: - from: - description: The previous version of the title. - type: string - required: - - from - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: title: User type: object nullable: true @@ -109430,313 +110759,400 @@ components: required: - login - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: string + nullable: true + assignee: + title: User type: object + nullable: true properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + avatar_url: type: string - default: + format: uri + deleted: type: boolean - description: + email: type: string nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer + login: + type: string name: - description: The name of the label. type: string node_id: type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin url: - description: URL for the label type: string format: uri required: + - login - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User + assignees: + type: array + items: type: object nullable: true + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + title: Label + type: object properties: - avatar_url: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - format: uri - deleted: + default: type: boolean - email: + description: type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri id: type: integer - login: - type: string name: + description: The name of the label. type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin url: + description: URL for the label type: string format: uri required: - - login - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: object + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - labels + - state + - locked + - assignee + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - issue + - comment + - repository + - sender + webhook-issues-assigned: + title: issues assigned event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - assigned + assignee: + "$ref": "#/components/schemas/webhooks_user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - repository + - sender + webhook-issues-closed: + title: issues closed event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - closed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + allOf: + - title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string enum: - - 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 - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: title: User type: object nullable: true @@ -109797,411 +111213,886 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri required: - login - id - permissions: - description: The set of permissions for the GitHub app + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: string + nullable: true + closed_at: + type: string + nullable: true + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label type: object properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - enum: - - read - - write - single_file: + default: + type: boolean + description: type: string - enum: - - read - - write - statuses: + nullable: true + id: + type: integer + name: + description: The name of the label. type: string - enum: - - read - - write - team_discussions: + node_id: type: string - enum: - - read - - write - vulnerability_alerts: + url: + description: URL for the label type: string - enum: - - read - - write - workflows: + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: 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. + type: object + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: type: string enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string + - 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 + external_url: + type: string + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: string + nullable: true + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: string + nullable: true + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + - type: object + properties: + active_lock_reason: + type: string + nullable: true + assignee: + type: object + nullable: true + assignees: + type: array + items: + type: object nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string + author_association: + type: string + body: + type: string + nullable: true + closed_at: + type: string + nullable: true + comments: + type: integer + comments_url: + type: string + created_at: + type: string + events_url: + type: string + html_url: + type: string + id: + type: integer + labels: + type: array + items: + type: object nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description + labels_url: + type: string + locked: + type: boolean + milestone: + type: object + nullable: true + node_id: + type: string + number: + type: integer + performed_via_github_app: + type: object + nullable: true + reactions: + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + repository_url: + type: string + state: + type: string + enum: + - closed + - open + timeline_url: + type: string + title: + type: string + updated_at: + type: string + url: + type: string + user: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - state + - closed_at organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -110210,18 +112101,17 @@ components: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - changes - issue - repository - sender - webhook-issues-labeled: - title: issues labeled event + webhook-issues-deleted: + title: issues deleted event type: object properties: action: type: string enum: - - labeled + - deleted enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -110302,7 +112192,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -110372,7 +112261,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -110534,7 +112422,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -110666,7 +112553,6 @@ components: - watch - workflow_dispatch - workflow_run - - pull_request_review_thread - reminder external_url: type: string @@ -110845,7 +112731,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -111089,7 +112974,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -111118,38 +113002,6 @@ components: - active_lock_reason - body - reactions - label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -111161,38 +113013,132 @@ components: - issue - repository - sender - webhook-issues-locked: - title: issues locked event + webhook-issues-demilestoned: + title: issues demilestoned event type: object properties: action: type: string enum: - - locked + - demilestoned enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" issue: - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user + properties: + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + assignees: + type: array + items: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -111250,19 +113196,130 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: string + nullable: true + closed_at: + type: string + nullable: true + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + required: + - id + - node_id + - url + - name + - color + - default + - description + nullable: true + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + required: + - login + - id + properties: avatar_url: type: string format: uri @@ -111319,995 +113376,839 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: 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. + type: object + nullable: true + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + external_url: + type: string + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true required: - login - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + avatar_url: type: string - default: + format: uri + deleted: type: boolean - description: + email: type: string nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer + login: + type: string name: - description: The name of the label. type: string node_id: type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: - description: URL for the label type: string format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: string + nullable: true + format: date-time + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: string + nullable: true + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + repository_url: + type: string + format: uri + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + milestone: + "$ref": "#/components/schemas/webhooks_milestone" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - repository + - sender + webhook-issues-edited: + title: issues edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + description: The changes to the issue. + type: object + properties: + body: + type: object + properties: + from: + description: The previous version of the body. + type: string + required: + - from + title: + type: object + properties: + from: + description: The previous version of the title. + type: string + required: + - from + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: + title: User type: object nullable: true properties: - closed_at: + avatar_url: type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: + format: uri + deleted: + type: boolean + email: type: string - format: date-time - creator: - title: User - type: object nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: + events_url: type: string - nullable: true - due_on: + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: type: string - nullable: true - format: date-time html_url: type: string format: uri id: type: integer - labels_url: + login: + type: string + name: type: string - format: uri node_id: type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. + organizations_url: type: string - enum: - - open - - closed - title: - description: The title of the milestone. + format: uri + received_events_url: type: string - updated_at: + format: uri + repos_url: type: string - format: date-time + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin url: type: string format: uri required: - - url - - html_url - - labels_url + - login - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: string + nullable: true + closed_at: + type: string + nullable: true + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label type: object - nullable: true properties: - avatar_url: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - format: uri - deleted: + default: type: boolean - email: + description: type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri id: type: integer - login: - type: string name: + description: The name of the label. type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization url: + description: URL for the label type: string format: uri required: - - login - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - type: object - nullable: true - assignees: - type: array - items: - type: object - nullable: true - author_association: - type: string - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - type: object + - node_id + - url + - name + - color + - default + - description + labels_url: + type: string + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string nullable: true - labels_url: - type: string - locked: - type: boolean - enum: - - true - milestone: - type: object - nullable: true - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: object - nullable: true - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - type: string - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - required: - - locked - - active_lock_reason - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - repository - - sender - webhook-issues-milestoned: - title: issues milestoned event - type: object - properties: - action: - type: string - enum: - - milestoned - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: title: User type: object nullable: true @@ -112368,1187 +114269,865 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri required: - login - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: 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. + type: object + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + external_url: + type: string + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User type: object + nullable: true properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + avatar_url: type: string - default: + format: uri + deleted: type: boolean - description: + email: type: string nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer + login: + type: string name: - description: The name of the label. type: string node_id: type: string - url: - description: URL for the label + organizations_url: type: string format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + - admin + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: string + nullable: true + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: string + nullable: true + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + label: + "$ref": "#/components/schemas/webhooks_label" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - issue + - repository + - sender + webhook-issues-labeled: + title: issues labeled event + type: object + properties: + action: + type: string + enum: + - labeled + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + properties: + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: + title: User type: object nullable: true properties: - closed_at: + avatar_url: type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: + format: uri + deleted: + type: boolean + email: type: string - format: date-time - creator: - title: User - type: object nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: + events_url: type: string - nullable: true - due_on: + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: type: string - nullable: true - format: date-time html_url: type: string format: uri id: type: integer - labels_url: + login: + type: string + name: type: string - format: uri node_id: type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. + organizations_url: type: string - enum: - - open - - closed - title: - description: The title of the milestone. + format: uri + received_events_url: type: string - updated_at: + format: uri + repos_url: type: string - format: date-time + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin url: type: string format: uri required: - - url - - html_url - - labels_url + - login - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: string + nullable: true + closed_at: + type: string + nullable: true + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label type: object - nullable: true properties: - created_at: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - nullable: true - format: date-time + default: + type: boolean description: type: string nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri id: - description: Unique identifier of the GitHub app type: integer - nullable: true name: - description: The name of the GitHub app + description: The name of the label. type: string node_id: type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: string - nullable: true - assignee: - type: object - nullable: true - assignees: - type: array - items: - type: object - nullable: true - author_association: - type: string - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - type: object - nullable: true - labels_url: - type: string - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time url: + description: URL for the label type: string format: uri required: - - url - - html_url - - labels_url - id - node_id - - number - - title + - url + - name + - color + - default - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: object - nullable: true - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - type: string - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - required: - - milestone - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: + labels_url: type: string - format: date-time - creator: - title: User + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. type: object nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + closed_at: type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: + format: date-time + closed_issues: type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - milestone - - repository - - sender - webhook-issues-opened: - title: issues opened event - type: object - properties: - action: - type: string - enum: - - opened - changes: - type: object - properties: - old_issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - nullable: true - properties: - active_lock_reason: + created_at: type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: + format: date-time + creator: title: User type: object nullable: true @@ -113609,1336 +115188,695 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri required: - login - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue + description: type: string nullable: true - closed_at: + due_on: type: string nullable: true format: date-time - comments: + html_url: + type: string + format: uri + id: type: integer - comments_url: + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: type: string format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: 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. + type: object + nullable: true + properties: created_at: type: string + nullable: true format: date-time - draft: - type: boolean - events_url: + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + external_url: type: string + nullable: true format: uri html_url: type: string format: uri id: + description: Unique identifier of the GitHub app type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, - identifying the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: + nullable: true + name: + description: The name of the GitHub app type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. + node_id: + type: string + owner: + title: User type: object nullable: true properties: - closed_at: + avatar_url: type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: + format: uri + deleted: + type: boolean + email: type: string - format: date-time - creator: - title: User - type: object nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: + events_url: type: string - nullable: true - due_on: + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: type: string - nullable: true - format: date-time html_url: type: string format: uri id: type: integer - labels_url: + login: type: string - format: uri - node_id: + name: type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. + node_id: type: string - enum: - - open - - closed - title: - description: The title of the milestone. + organizations_url: type: string - updated_at: + format: uri + received_events_url: type: string - format: date-time - url: + format: uri + repos_url: type: string format: uri - required: - - url - - html_url - - labels_url + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. + permissions: + description: The set of permissions for the GitHub app type: object - nullable: true properties: - created_at: + actions: type: string - nullable: true - format: date-time - description: + enum: + - read + - write + administration: type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: + enum: + - read + - write + checks: type: string - nullable: true - format: uri - html_url: + enum: + - read + - write + content_references: type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app + enum: + - read + - write + contents: type: string - node_id: + enum: + - read + - write + deployments: type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app + enum: + - read + - write + discussions: type: string - updated_at: + enum: + - read + - write + emails: type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: + enum: + - read + - write + environments: type: string - format: uri - html_url: + enum: + - read + - write + issues: type: string - format: uri - merged_at: + enum: + - read + - write + keys: type: string - nullable: true - format: date-time - patch_url: + enum: + - read + - write + members: type: string - format: uri - url: + enum: + - read + - write + metadata: type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: + enum: + - read + - write + organization_administration: type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: + enum: + - read + - write + organization_hooks: type: string - format: uri - deleted: - type: boolean - email: + enum: + - read + - write + organization_packages: type: string - nullable: true - events_url: + enum: + - read + - write + organization_plan: type: string - format: uri-template - followers_url: + enum: + - read + - write + organization_projects: type: string - format: uri - following_url: + enum: + - read + - write + - admin + organization_secrets: type: string - format: uri-template - gists_url: + enum: + - read + - write + organization_self_hosted_runners: type: string - format: uri-template - gravatar_id: + enum: + - read + - write + organization_user_blocking: type: string - html_url: + enum: + - read + - write + packages: type: string - format: uri - id: - type: integer - login: + enum: + - read + - write + pages: type: string - name: + enum: + - read + - write + pull_requests: type: string - node_id: + enum: + - read + - write + repository_hooks: type: string - organizations_url: + enum: + - read + - write + repository_projects: type: string - format: uri - received_events_url: + enum: + - read + - write + secret_scanning_alerts: type: string - format: uri - repos_url: + enum: + - read + - write + secrets: type: string - format: uri - site_admin: - type: boolean - starred_url: + enum: + - read + - write + security_events: type: string - format: uri-template - subscriptions_url: + enum: + - read + - write + security_scanning_alert: type: string - format: uri - type: + enum: + - read + - write + single_file: type: string enum: - - Bot - - User - - Organization - url: + - read + - write + statuses: type: string - format: uri - required: - - login - - id + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: string + nullable: true + format: date-time required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - id - node_id - - number - - title - - user - - assignees - - milestone - - comments + - owner + - name + - description + - external_url + - html_url - created_at - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - old_repository: - title: Repository - description: A git repository + pull_request: type: object properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: + diff_url: type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: + format: uri + html_url: type: string - format: uri-template - blobs_url: + format: uri + merged_at: type: string - format: uri-template - branches_url: + nullable: true + format: date-time + patch_url: type: string - format: uri-template - clone_url: + format: uri + url: type: string format: uri - collaborators_url: + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: type: string - format: uri-template - comments_url: + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri + state: + description: State of the issue; either 'open' or 'closed' + type: string + enum: + - open + - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri + title: + description: Title of the issue + type: string + updated_at: + type: string + format: date-time + url: + description: URL for the issue + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: type: string - format: uri-template - commits_url: + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: type: string format: uri-template - compare_url: + followers_url: + type: string + format: uri + following_url: type: string format: uri-template - contents_url: + gists_url: type: string format: uri-template - contributors_url: + gravatar_id: + type: string + html_url: type: string format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: - type: object - description: The custom properties that were defined for the repository. - The keys are the custom property names, and the values are the - corresponding custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. + id: + type: integer + login: type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: + name: type: string - format: uri - description: + node_id: type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: + organizations_url: type: string format: uri - events_url: + received_events_url: type: string format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: + repos_url: type: string format: uri - full_name: - type: string - git_commits_url: + site_admin: + type: boolean + starred_url: type: string format: uri-template - git_refs_url: + subscriptions_url: type: string - format: uri-template - git_tags_url: + format: uri + type: type: string - format: uri-template - git_url: + enum: + - Bot + - User + - Organization + - Mannequin + url: type: string format: uri - has_discussions: - description: Whether the repository has discussions enabled. - type: boolean - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. + required: + - login + - id + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + label: + "$ref": "#/components/schemas/webhooks_label" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - repository + - sender + webhook-issues-locked: + title: issues locked event + type: object + properties: + action: + type: string + enum: + - locked + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - locked + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user + properties: + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: type: boolean - default: true - homepage: + email: type: string nullable: true - hooks_url: + events_url: type: string - format: uri - html_url: + format: uri-template + followers_url: type: string format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: + following_url: type: string format: uri-template - issue_events_url: + gists_url: type: string format: uri-template - issues_url: + gravatar_id: type: string - format: uri-template - keys_url: + html_url: type: string - format: uri-template - labels_url: + format: uri + id: + type: integer + login: type: string - format: uri-template - language: + name: type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require commit signoff. - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - required: - - old_issue - - old_repository - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: + node_id: + type: string + organizations_url: type: string format: uri received_events_url: @@ -114964,15 +115902,15 @@ components: url: type: string format: uri - required: - - login - - id assignees: type: array items: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -115033,9 +115971,6 @@ components: url: type: string format: uri - required: - - login - - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -115081,6 +116016,15 @@ components: items: title: Label type: object + required: + - id + - node_id + - url + - name + - color + - default + - description + nullable: true properties: color: description: '6-character hex code, without the leading #, identifying @@ -115102,24 +116046,35 @@ components: description: URL for the label type: string format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description labels_url: type: string format: uri-template locked: type: boolean + enum: + - true milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at properties: closed_at: type: string @@ -115134,6 +116089,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -115191,13 +116149,9 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri - required: - - login - - id description: type: string nullable: true @@ -115235,23 +116189,6 @@ components: url: type: string format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at node_id: type: string number: @@ -115264,6 +116201,16 @@ components: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: created_at: type: string @@ -115323,9 +116270,8 @@ components: - watch - workflow_dispatch - workflow_run - - security_and_analysis - - pull_request_review_thread - reminder + - security_and_analysis external_url: type: string nullable: true @@ -115346,6 +116292,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -115406,9 +116355,6 @@ components: url: type: string format: uri - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -115503,7 +116449,6 @@ components: enum: - read - write - - admin organization_secrets: type: string enum: @@ -115596,16 +116541,6 @@ components: type: string nullable: true format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -115628,6 +116563,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -115650,17 +116596,6 @@ components: url: type: string format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket repository_url: type: string format: uri @@ -115690,6 +116625,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -115750,31 +116688,6 @@ components: url: type: string format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -115786,14 +116699,14 @@ components: - issue - repository - sender - webhook-issues-pinned: - title: issues pinned event + webhook-issues-milestoned: + title: issues milestoned event type: object properties: action: type: string enum: - - pinned + - milestoned enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -115803,6 +116716,28 @@ components: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user properties: active_lock_reason: type: string @@ -115817,6 +116752,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -115877,15 +116815,15 @@ components: url: type: string format: uri - required: - - login - - id assignees: type: array items: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -115946,9 +116884,6 @@ components: url: type: string format: uri - required: - - login - - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -115994,6 +116929,15 @@ components: items: title: Label type: object + required: + - id + - node_id + - url + - name + - color + - default + - description + nullable: true properties: color: description: '6-character hex code, without the leading #, identifying @@ -116015,14 +116959,6 @@ components: description: URL for the label type: string format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description labels_url: type: string format: uri-template @@ -116033,6 +116969,23 @@ components: description: A collection of related issues and pull requests. type: object nullable: true + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at properties: closed_at: type: string @@ -116047,6 +117000,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -116104,12 +117060,10 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri - required: - - login - - id description: type: string nullable: true @@ -116147,23 +117101,6 @@ components: url: type: string format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at node_id: type: string number: @@ -116176,6 +117113,16 @@ components: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: created_at: type: string @@ -116235,6 +117182,7 @@ components: - watch - workflow_dispatch - workflow_run + - reminder external_url: type: string nullable: true @@ -116255,6 +117203,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -116315,9 +117266,6 @@ components: url: type: string format: uri - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -116412,6 +117360,7 @@ components: enum: - read - write + - admin organization_secrets: type: string enum: @@ -116504,16 +117453,6 @@ components: type: string nullable: true format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -116536,6 +117475,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -116558,17 +117508,6 @@ components: url: type: string format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket repository_url: type: string format: uri @@ -116598,6 +117537,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -116658,31 +117600,8 @@ components: url: type: string format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions + milestone: + "$ref": "#/components/schemas/webhooks_milestone" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -116692,106 +117611,37 @@ components: required: - action - issue + - milestone - repository - sender - webhook-issues-reopened: - title: issues reopened event + webhook-issues-opened: + title: issues opened event type: object properties: action: type: string enum: - - reopened - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: + - opened + changes: + type: object + properties: + old_issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + nullable: true + properties: + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: title: User type: object nullable: true @@ -116852,992 +117702,15 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - login - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - - admin - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - - admin - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - type: string - nullable: true - assignee: - type: object - nullable: true - assignees: - type: array - items: - type: object - nullable: true - author_association: - type: string - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - type: object - nullable: true - labels_url: - type: string - locked: - type: boolean - milestone: - type: object - nullable: true - node_id: - type: string - number: - type: integer - performed_via_github_app: - type: object - nullable: true - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - type: string - enum: - - open - - closed - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - required: - - state - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - repository - - sender - webhook-issues-transferred: - title: issues transferred event - type: object - properties: - action: - type: string - enum: - - transferred - changes: - type: object - properties: - new_issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: + assignees: + type: array + items: title: User type: object nullable: true @@ -118639,7 +118512,7 @@ components: - active_lock_reason - body - reactions - new_repository: + old_repository: title: Repository description: A git repository type: object @@ -118759,6 +118632,9 @@ components: git_url: type: string format: uri + has_discussions: + description: Whether the repository has discussions enabled. + type: boolean has_downloads: description: Whether downloads are enabled. type: boolean @@ -118777,10 +118653,6 @@ components: description: Whether the wiki is enabled. type: boolean default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false homepage: type: string nullable: true @@ -119022,8 +118894,7 @@ components: watchers_count: type: integer web_commit_signoff_required: - description: Whether to require contributors to sign off on web-based - commits + description: Whether to require commit signoff. type: boolean required: - id @@ -119089,7 +118960,6 @@ components: - has_downloads - has_wiki - has_pages - - has_discussions - forks_count - mirror_url - archived @@ -119102,8 +118972,8 @@ components: - topics - visibility required: - - new_issue - - new_repository + - old_issue + - old_repository enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -119414,6 +119284,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -119545,6 +119416,9 @@ components: - watch - workflow_dispatch - workflow_run + - security_and_analysis + - pull_request_review_thread + - reminder external_url: type: string nullable: true @@ -119722,6 +119596,7 @@ components: enum: - read - write + - admin organization_secrets: type: string enum: @@ -120001,87 +119876,42 @@ components: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - changes - issue - repository - sender - webhook-issues-unassigned: - title: issues unassigned event + webhook-issues-pinned: + title: issues pinned event type: object properties: action: - description: The action that was performed. type: string enum: - - unassigned - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id + - pinned + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue_2" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - repository + - sender + webhook-issues-reopened: + title: issues reopened event + type: object + properties: + action: + type: string + enum: + - reopened enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -120091,6 +119921,29 @@ components: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - milestone + - node_id + - number + - reactions + - repository_url + - state + - title + - updated_at + - url + - user properties: active_lock_reason: type: string @@ -120105,6 +119958,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -120162,19 +120018,18 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri - required: - - login - - id assignees: type: array items: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -120236,9 +120091,6 @@ components: url: type: string format: uri - required: - - login - - id author_association: title: AuthorAssociation description: How the author is associated with the repository. @@ -120284,6 +120136,15 @@ components: items: title: Label type: object + required: + - id + - node_id + - url + - name + - color + - default + - description + nullable: true properties: color: description: '6-character hex code, without the leading #, identifying @@ -120305,14 +120166,6 @@ components: description: URL for the label type: string format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description labels_url: type: string format: uri-template @@ -120323,6 +120176,23 @@ components: description: A collection of related issues and pull requests. type: object nullable: true + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at properties: closed_at: type: string @@ -120337,6 +120207,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -120398,9 +120271,6 @@ components: url: type: string format: uri - required: - - login - - id description: type: string nullable: true @@ -120438,23 +120308,6 @@ components: url: type: string format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at node_id: type: string number: @@ -120467,6 +120320,16 @@ components: and built-in webhooks. GitHub apps are first class actors within GitHub. type: object nullable: true + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at properties: created_at: type: string @@ -120526,8 +120389,8 @@ components: - watch - workflow_dispatch - workflow_run - - reminder - pull_request_review_thread + - reminder external_url: type: string nullable: true @@ -120548,6 +120411,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -120608,9 +120474,6 @@ components: url: type: string format: uri - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -120746,6 +120609,7 @@ components: enum: - read - write + - admin secret_scanning_alerts: type: string enum: @@ -120798,16 +120662,6 @@ components: type: string nullable: true format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -120830,6 +120684,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -120852,17 +120717,6 @@ components: url: type: string format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket repository_url: type: string format: uri @@ -120892,134 +120746,9 @@ components: title: User type: object nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri required: - login - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - repository - - sender - webhook-issues-unlabeled: - title: issues unlabeled event - type: object - properties: - action: - type: string - enum: - - unlabeled - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true properties: avatar_url: type: string @@ -121081,174 +120810,44 @@ components: url: type: string format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - repository + - sender + webhook-issues-transferred: + title: issues transferred event + type: object + properties: + action: + type: string + enum: + - transferred + changes: + type: object + properties: + new_issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. type: object - nullable: true properties: - closed_at: + active_lock_reason: type: string nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: title: User type: object nullable: true @@ -121309,157 +120908,728 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - login - id - description: + assignees: + type: array + items: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue type: string nullable: true - due_on: + closed_at: type: string nullable: true format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri html_url: type: string format: uri id: type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object + properties: + color: + description: '6-character hex code, without the leading #, + identifying the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + required: + - id + - node_id + - url + - name + - color + - default + - description labels_url: type: string - format: uri + format: uri-template + locked: + type: boolean + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at node_id: type: string number: - description: The number of the milestone. - type: integer - open_issues: type: integer + performed_via_github_app: + title: 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. + type: object + nullable: true + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: + type: string + enum: + - 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 + external_url: + type: string + nullable: true + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the GitHub app + type: integer + nullable: true + name: + description: The name of the GitHub app + type: string + node_id: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + description: The set of permissions for the GitHub app + type: object + properties: + actions: + type: string + enum: + - read + - write + administration: + type: string + enum: + - read + - write + checks: + type: string + enum: + - read + - write + content_references: + type: string + enum: + - read + - write + contents: + type: string + enum: + - read + - write + deployments: + type: string + enum: + - read + - write + discussions: + type: string + enum: + - read + - write + emails: + type: string + enum: + - read + - write + environments: + type: string + enum: + - read + - write + issues: + type: string + enum: + - read + - write + keys: + type: string + enum: + - read + - write + members: + type: string + enum: + - read + - write + metadata: + type: string + enum: + - read + - write + organization_administration: + type: string + enum: + - read + - write + organization_hooks: + type: string + enum: + - read + - write + organization_packages: + type: string + enum: + - read + - write + organization_plan: + type: string + enum: + - read + - write + organization_projects: + type: string + enum: + - read + - write + organization_secrets: + type: string + enum: + - read + - write + organization_self_hosted_runners: + type: string + enum: + - read + - write + organization_user_blocking: + type: string + enum: + - read + - write + packages: + type: string + enum: + - read + - write + pages: + type: string + enum: + - read + - write + pull_requests: + type: string + enum: + - read + - write + repository_hooks: + type: string + enum: + - read + - write + repository_projects: + type: string + enum: + - read + - write + secret_scanning_alerts: + type: string + enum: + - read + - write + secrets: + type: string + enum: + - read + - write + security_events: + type: string + enum: + - read + - write + security_scanning_alert: + type: string + enum: + - read + - write + single_file: + type: string + enum: + - read + - write + statuses: + type: string + enum: + - read + - write + team_discussions: + type: string + enum: + - read + - write + vulnerability_alerts: + type: string + enum: + - read + - write + workflows: + type: string + enum: + - read + - write + slug: + description: The slug name of the GitHub app + type: string + updated_at: + type: string + nullable: true + format: date-time + required: + - id + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + pull_request: + type: object + properties: + diff_url: + type: string + format: uri + html_url: + type: string + format: uri + merged_at: + type: string + nullable: true + format: date-time + patch_url: + type: string + format: uri + url: + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + repository_url: + type: string + format: uri state: - description: The state of the milestone. + description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed + state_reason: + type: string + nullable: true + timeline_url: + type: string + format: uri title: - description: The title of the milestone. + description: Title of the issue type: string updated_at: type: string format: date-time url: + description: URL for the issue type: string format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: + user: title: User type: object nullable: true @@ -121526,287 +121696,623 @@ components: required: - login - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: + required: + - url + - repository_url + - labels_url + - comments_url + - events_url + - html_url + - id + - node_id + - number + - title + - user + - assignees + - milestone + - comments + - created_at + - updated_at + - closed_at + - author_association + - active_lock_reason + - body + - reactions + new_repository: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + custom_properties: + type: object + description: The custom properties that were defined for the repository. + The keys are the custom property names, and the values are the + corresponding custom property values. + additionalProperties: true + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: string + nullable: true + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: string + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: type: string - enum: - - read - - write - organization_administration: + name: type: string - enum: - - read - - write - organization_hooks: + node_id: type: string - enum: - - read - - write - organization_packages: + spdx_id: type: string - enum: - - read - - write - organization_plan: + url: type: string - enum: - - read - - write - organization_projects: + nullable: true + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: string + nullable: true + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: type: string - enum: - - read - - write - - admin - organization_secrets: + format: uri + deleted: + type: boolean + email: type: string - enum: - - read - - write - organization_self_hosted_runners: + nullable: true + events_url: type: string - enum: - - read - - write - organization_user_blocking: + format: uri-template + followers_url: type: string - enum: - - read - - write - packages: + format: uri + following_url: type: string - enum: - - read - - write - pages: + format: uri-template + gists_url: type: string - enum: - - read - - write - pull_requests: + format: uri-template + gravatar_id: type: string - enum: - - read - - write - repository_hooks: + html_url: type: string - enum: - - read - - write - repository_projects: + format: uri + id: + type: integer + login: type: string - enum: - - read - - write - secret_scanning_alerts: + name: type: string - enum: - - read - - write - secrets: + node_id: type: string - enum: - - read - - write - security_events: + organizations_url: type: string - enum: - - read - - write - security_scanning_alert: + format: uri + received_events_url: type: string - enum: - - read - - write - single_file: + format: uri + repos_url: type: string - enum: - - read - - write - statuses: + format: uri + site_admin: + type: boolean + starred_url: type: string - enum: - - read - - write - team_discussions: + format: uri-template + subscriptions_url: type: string - enum: - - read - - write - vulnerability_alerts: + format: uri + type: type: string enum: - - read - - write - workflows: + - Bot + - User + - Organization + url: type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: type: string - updated_at: + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: type: string nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: + size: + type: integer + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: type: string format: uri - html_url: + statuses_url: + type: string + format: uri-template + subscribers_url: type: string format: uri - merged_at: + subscription_url: type: string - nullable: true - format: date-time - patch_url: + format: uri + svn_url: type: string format: uri - url: + tags_url: type: string format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time url: type: string format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based + commits + type: boolean required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + required: + - new_issue + - new_repository + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue_2" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - issue + - repository + - sender + webhook-issues-unassigned: + title: issues unassigned event + type: object + properties: + action: + description: The action that was performed. + type: string + enum: + - unassigned + assignee: + "$ref": "#/components/schemas/webhooks_user_mannequin" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - repository + - sender + webhook-issues-unlabeled: + title: issues unlabeled event + type: object + properties: + action: + type: string + enum: + - unlabeled + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue" + label: + "$ref": "#/components/schemas/webhooks_label" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - repository + - sender + webhook-issues-unlocked: + title: issues unlocked event + type: object + properties: + action: + type: string + enum: + - unlocked + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + title: Issue + description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) + itself. + type: object + required: + - active_lock_reason + - assignees + - author_association + - body + - closed_at + - comments + - comments_url + - created_at + - events_url + - html_url + - id + - labels_url + - locked + - milestone + - node_id + - number + - reactions + - repository_url + - title + - updated_at + - url + - user + properties: + active_lock_reason: type: string nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -121864,110 +122370,18 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - repository - - sender - webhook-issues-unlocked: - title: issues unlocked event - type: object - properties: - action: - type: string - enum: - - unlocked - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - allOf: - - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: + assignees: + type: array + items: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -122028,15 +122442,127 @@ components: url: type: string format: uri + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: Contents of the issue + type: string + nullable: true + closed_at: + type: string + nullable: true + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + created_at: + type: string + format: date-time + draft: + type: boolean + events_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + format: int64 + labels: + type: array + items: + title: Label + type: object required: - - login - id - assignees: - type: array - items: + - node_id + - url + - name + - color + - default + - description + nullable: true + properties: + color: + description: '6-character hex code, without the leading #, identifying + the color' + type: string + default: + type: boolean + description: + type: string + nullable: true + id: + type: integer + name: + description: The name of the label. + type: string + node_id: + type: string + url: + description: URL for the label + type: string + format: uri + labels_url: + type: string + format: uri-template + locked: + type: boolean + enum: + - false + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -122097,1286 +122623,77 @@ components: url: type: string format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: - type: string - enum: - - 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 - external_url: - type: string - nullable: true - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the GitHub app - type: integer - nullable: true - name: - description: The name of the GitHub app - type: string - node_id: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - description: The set of permissions for the GitHub app - type: object - properties: - actions: - type: string - enum: - - read - - write - administration: - type: string - enum: - - read - - write - checks: - type: string - enum: - - read - - write - content_references: - type: string - enum: - - read - - write - contents: - type: string - enum: - - read - - write - deployments: - type: string - enum: - - read - - write - discussions: - type: string - enum: - - read - - write - emails: - type: string - enum: - - read - - write - environments: - type: string - enum: - - read - - write - issues: - type: string - enum: - - read - - write - keys: - type: string - enum: - - read - - write - members: - type: string - enum: - - read - - write - metadata: - type: string - enum: - - read - - write - organization_administration: - type: string - enum: - - read - - write - organization_hooks: - type: string - enum: - - read - - write - organization_packages: - type: string - enum: - - read - - write - organization_plan: - type: string - enum: - - read - - write - organization_projects: - type: string - enum: - - read - - write - organization_secrets: - type: string - enum: - - read - - write - organization_self_hosted_runners: - type: string - enum: - - read - - write - organization_user_blocking: - type: string - enum: - - read - - write - packages: - type: string - enum: - - read - - write - pages: - type: string - enum: - - read - - write - pull_requests: - type: string - enum: - - read - - write - repository_hooks: - type: string - enum: - - read - - write - repository_projects: - type: string - enum: - - read - - write - secret_scanning_alerts: - type: string - enum: - - read - - write - secrets: - type: string - enum: - - read - - write - security_events: - type: string - enum: - - read - - write - security_scanning_alert: - type: string - enum: - - read - - write - single_file: - type: string - enum: - - read - - write - statuses: - type: string - enum: - - read - - write - team_discussions: - type: string - enum: - - read - - write - vulnerability_alerts: - type: string - enum: - - read - - write - workflows: - type: string - enum: - - read - - write - slug: - description: The slug name of the GitHub app - type: string - updated_at: - type: string - nullable: true - format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at - pull_request: - type: object - properties: - diff_url: - type: string - format: uri - html_url: - type: string - format: uri - merged_at: - type: string - nullable: true - format: date-time - patch_url: - type: string - format: uri - url: - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - repository_url: - type: string - format: uri - state: - description: State of the issue; either 'open' or 'closed' - type: string - enum: - - open - - closed - state_reason: - type: string - nullable: true - timeline_url: - type: string - format: uri - title: - description: Title of the issue - type: string - updated_at: - type: string - format: date-time - url: - description: URL for the issue - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions - - type: object - properties: - active_lock_reason: - nullable: true - assignee: - type: object - nullable: true - assignees: - type: array - items: - type: object - nullable: true - author_association: - type: string - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments: - type: integer - comments_url: - type: string - created_at: - type: string - events_url: - type: string - html_url: - type: string - id: - type: integer - labels: - type: array - items: - type: object - nullable: true - labels_url: - type: string - locked: - type: boolean - enum: - - false - milestone: - type: object - nullable: true - node_id: - type: string - number: - type: integer - performed_via_github_app: - nullable: true - reactions: - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - repository_url: - type: string - state: - type: string - timeline_url: - type: string - title: - type: string - updated_at: - type: string - url: - type: string - user: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - required: - - locked - - active_lock_reason - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - issue - - repository - - sender - webhook-issues-unpinned: - title: issues unpinned event - type: object - properties: - action: - type: string - enum: - - unpinned - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - issue: - title: Issue - description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) - itself. - type: object - properties: - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + description: type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: + due_on: type: string + nullable: true + format: date-time html_url: type: string format: uri id: type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: + labels_url: type: string format: uri - repos_url: + node_id: type: string - format: uri - site_admin: - type: boolean - starred_url: + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. type: string - format: uri-template - subscriptions_url: + enum: + - open + - closed + title: + description: The title of the milestone. type: string - format: uri - type: + updated_at: type: string - enum: - - Bot - - User - - Organization + format: date-time url: type: string format: uri + node_id: + type: string + number: + type: integer + performed_via_github_app: + title: 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. + type: object + nullable: true required: - - login - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: Contents of the issue - type: string - nullable: true - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - created_at: - type: string - format: date-time - draft: - type: boolean - events_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - type: integer - format: int64 - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - labels_url: - type: string - format: uri-template - locked: - type: boolean - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - performed_via_github_app: - title: 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. - type: object - nullable: true - properties: - created_at: - type: string - nullable: true - format: date-time - description: - type: string - nullable: true - events: - description: The list of events for the GitHub app - type: array - items: + - node_id + - owner + - name + - description + - external_url + - html_url + - created_at + - updated_at + properties: + created_at: + type: string + nullable: true + format: date-time + description: + type: string + nullable: true + events: + description: The list of events for the GitHub app + type: array + items: type: string enum: - branch_protection_rule @@ -123444,6 +122761,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -123504,9 +122824,6 @@ components: url: type: string format: uri - required: - - login - - id permissions: description: The set of permissions for the GitHub app type: object @@ -123693,16 +123010,6 @@ components: type: string nullable: true format: date-time - required: - - id - - node_id - - owner - - name - - description - - external_url - - html_url - - created_at - - updated_at pull_request: type: object properties: @@ -123725,6 +123032,17 @@ components: reactions: title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: "+1": type: integer @@ -123747,17 +123065,6 @@ components: url: type: string format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket repository_url: type: string format: uri @@ -123787,6 +123094,9 @@ components: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -123847,31 +123157,31 @@ components: url: type: string format: uri - required: - - login - - id - required: - - url - - repository_url - - labels_url - - comments_url - - events_url - - html_url - - id - - node_id - - number - - title - - user - - assignees - - milestone - - comments - - created_at - - updated_at - - closed_at - - author_association - - active_lock_reason - - body - - reactions + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - issue + - repository + - sender + webhook-issues-unpinned: + title: issues unpinned event + type: object + properties: + action: + type: string + enum: + - unpinned + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + issue: + "$ref": "#/components/schemas/webhooks_issue_2" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -123896,37 +123206,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description + "$ref": "#/components/schemas/webhooks_label" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -123950,37 +123230,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description + "$ref": "#/components/schemas/webhooks_label" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -124036,37 +123286,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description + "$ref": "#/components/schemas/webhooks_label" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -124093,228 +123313,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: - allOf: - - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - type: string - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan - - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - billing_cycle: - type: string - free_trial_ends_on: - type: string - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - nullable: true - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - unit_count: - type: integer - required: - - next_billing_date + "$ref": "#/components/schemas/webhooks_marketplace_purchase" organization: "$ref": "#/components/schemas/organization-simple-webhooks" previous_marketplace_purchase: - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan + "$ref": "#/components/schemas/webhooks_previous_marketplace_purchase" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -124339,146 +123342,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: - allOf: - - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - type: string - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan - - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - billing_cycle: - type: string - free_trial_ends_on: - type: string - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - nullable: true - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - unit_count: - type: integer - required: - - next_billing_date + "$ref": "#/components/schemas/webhooks_marketplace_purchase" organization: "$ref": "#/components/schemas/organization-simple-webhooks" previous_marketplace_purchase: @@ -124587,146 +123451,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: - allOf: - - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - type: string - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan - - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - billing_cycle: - type: string - free_trial_ends_on: - type: string - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - nullable: true - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - unit_count: - type: integer - required: - - next_billing_date + "$ref": "#/components/schemas/webhooks_marketplace_purchase" organization: "$ref": "#/components/schemas/organization-simple-webhooks" previous_marketplace_purchase: @@ -124834,100 +123559,25 @@ components: installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: - allOf: - - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan - - type: object - properties: - next_billing_date: - type: string - required: - - next_billing_date - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - previous_marketplace_purchase: title: Marketplace Purchase type: object + required: + - account + - billing_cycle + - free_trial_ends_on + - next_billing_date + - on_free_trial + - plan + - unit_count properties: account: type: object + required: + - type + - id + - node_id + - login + - organization_billing_email properties: id: type: integer @@ -124940,12 +123590,6 @@ components: nullable: true type: type: string - required: - - type - - id - - node_id - - login - - organization_billing_email billing_cycle: type: string free_trial_ends_on: @@ -124957,6 +123601,16 @@ components: type: boolean plan: type: object + required: + - id + - name + - description + - monthly_price_in_cents + - yearly_price_in_cents + - price_model + - has_free_trial + - unit_name + - bullets properties: bullets: type: array @@ -124983,25 +123637,12 @@ components: nullable: true yearly_price_in_cents: type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets unit_count: type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + previous_marketplace_purchase: + "$ref": "#/components/schemas/webhooks_previous_marketplace_purchase" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -125026,330 +123667,61 @@ components: installation: "$ref": "#/components/schemas/simple-installation" marketplace_purchase: - allOf: - - title: Marketplace Purchase - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - type: string - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan - - type: object - properties: - account: - type: object - properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: - type: string - nullable: true - type: - type: string - billing_cycle: - type: string - free_trial_ends_on: - type: string - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - nullable: true - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - unit_count: - type: integer - required: - - next_billing_date + "$ref": "#/components/schemas/webhooks_marketplace_purchase" organization: "$ref": "#/components/schemas/organization-simple-webhooks" previous_marketplace_purchase: - title: Marketplace Purchase + "$ref": "#/components/schemas/webhooks_previous_marketplace_purchase" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - effective_date + - sender + - marketplace_purchase + webhook-member-added: + title: member added event + type: object + properties: + action: + type: string + enum: + - added + changes: type: object properties: - account: + permission: + description: |- + This field is included for legacy purposes; use the `role_name` field instead. The `maintain` + role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role + assigned to the collaborator, use the `role_name` field instead, which will provide the full + role name, including custom roles. type: object properties: - id: - type: integer - login: - type: string - node_id: - type: string - organization_billing_email: + to: type: string - nullable: true - type: + enum: + - write + - admin + - read + required: + - to + role_name: + description: The role assigned to the collaborator. + type: object + properties: + to: type: string required: - - type - - id - - node_id - - login - - organization_billing_email - billing_cycle: - type: string - free_trial_ends_on: - nullable: true - next_billing_date: - type: string - nullable: true - on_free_trial: - type: boolean - plan: - type: object - properties: - bullets: - type: array - items: - type: string - description: - type: string - has_free_trial: - type: boolean - id: - type: integer - monthly_price_in_cents: - type: integer - name: - type: string - price_model: - type: string - enum: - - FREE - - FLAT_RATE - - PER_UNIT - unit_name: - type: string - nullable: true - yearly_price_in_cents: - type: integer - required: - - id - - name - - description - - monthly_price_in_cents - - yearly_price_in_cents - - price_model - - has_free_trial - - unit_name - - bullets - unit_count: - type: integer - required: - - account - - billing_cycle - - unit_count - - on_free_trial - - free_trial_ends_on - - plan - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - effective_date - - sender - - marketplace_purchase - webhook-member-added: - title: member added event - type: object - properties: - action: - type: string - enum: - - added - changes: - type: object - properties: - permission: - type: object - properties: - to: - type: string - enum: - - write - - admin - - read - required: - to enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" member: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id + "$ref": "#/components/schemas/webhooks_user" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -125396,72 +123768,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" member: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id + "$ref": "#/components/schemas/webhooks_user" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -125487,72 +123794,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" member: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id + "$ref": "#/components/schemas/webhooks_user" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -125577,72 +123819,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" member: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id + "$ref": "#/components/schemas/webhooks_user" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -125720,117 +123897,7 @@ components: - login - id team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team" required: - action - scope @@ -125851,72 +123918,7 @@ components: installation: "$ref": "#/components/schemas/simple-installation" member: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id + "$ref": "#/components/schemas/webhooks_user" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -125995,117 +123997,7 @@ components: - login - id team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team" required: - action - scope @@ -126304,141 +124196,113 @@ components: installation: "$ref": "#/components/schemas/simple-installation" milestone: - title: Milestone - description: A collection of related issues and pull requests. + "$ref": "#/components/schemas/webhooks_milestone" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - milestone + - repository + - sender + webhook-milestone-created: + title: milestone created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + milestone: + "$ref": "#/components/schemas/webhooks_milestone_3" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - milestone + - repository + - sender + webhook-milestone-deleted: + title: milestone deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + milestone: + "$ref": "#/components/schemas/webhooks_milestone" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - milestone + - repository + - sender + webhook-milestone-edited: + title: milestone edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + description: The changes to the milestone if the action was `edited`. type: object properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User + description: type: object - nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: + from: + description: The previous version of the description if the action + was `edited`. type: string - format: uri required: - - login - - id - description: - type: string - nullable: true + - from due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed + type: object + properties: + from: + description: The previous version of the due date if the action + was `edited`. + type: string + required: + - from title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at + type: object + properties: + from: + description: The previous version of the title if the action was + `edited`. + type: string + required: + - from + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + milestone: + "$ref": "#/components/schemas/webhooks_milestone" organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: @@ -126447,36 +124311,169 @@ components: "$ref": "#/components/schemas/simple-user-webhooks" required: - action + - changes - milestone - repository - sender - webhook-milestone-created: - title: milestone created event + webhook-milestone-opened: + title: milestone opened event type: object properties: action: type: string enum: - - created + - opened enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" milestone: - title: Milestone - description: A collection of related issues and pull requests. + "$ref": "#/components/schemas/webhooks_milestone_3" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - milestone + - repository + - sender + webhook-org-block-blocked: + title: org_block blocked event + type: object + properties: + action: + type: string + enum: + - blocked + blocked_user: + "$ref": "#/components/schemas/webhooks_user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - blocked_user + - organization + - sender + webhook-org-block-unblocked: + title: org_block unblocked event + type: object + properties: + action: + type: string + enum: + - unblocked + blocked_user: + "$ref": "#/components/schemas/webhooks_user" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - blocked_user + - organization + - sender + webhook-organization-deleted: + title: organization deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + membership: + "$ref": "#/components/schemas/webhooks_membership" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - organization + - sender + webhook-organization-member-added: + title: organization member_added event + type: object + properties: + action: + type: string + enum: + - member_added + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + membership: + "$ref": "#/components/schemas/webhooks_membership" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - membership + - organization + - sender + webhook-organization-member-invited: + title: organization member_invited event + type: object + properties: + action: + type: string + enum: + - member_invited + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + invitation: + description: The invitation for the user or email if the action is `member_invited`. type: object properties: - closed_at: + created_at: type: string - nullable: true format: date-time - closed_issues: - type: integer - created_at: + email: + type: string + nullable: true + failed_at: type: string + nullable: true format: date-time - creator: + failed_reason: + type: string + nullable: true + id: + type: number + invitation_teams_url: + type: string + format: uri + inviter: title: User type: object nullable: true @@ -126543,98 +124540,168 @@ components: required: - login - id - description: - type: string - nullable: true - due_on: + login: type: string nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri node_id: type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: + role: type: string - format: date-time - url: + team_count: + type: number + invitation_source: type: string - format: uri required: - - url - - html_url - - labels_url - id - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state + - login + - email + - role - created_at - - updated_at - - due_on - - closed_at + - failed_at + - failed_reason + - inviter + - team_count + - invitation_teams_url organization: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" + user: + "$ref": "#/components/schemas/webhooks_user" required: - action - - milestone - - repository + - invitation + - organization - sender - webhook-milestone-deleted: - title: milestone deleted event + webhook-organization-member-removed: + title: organization member_removed event type: object properties: action: type: string enum: - - deleted + - member_removed enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" - milestone: - title: Milestone - description: A collection of related issues and pull requests. + membership: + "$ref": "#/components/schemas/webhooks_membership" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - membership + - organization + - sender + webhook-organization-renamed: + title: organization renamed event + type: object + properties: + action: + type: string + enum: + - renamed + changes: type: object properties: - closed_at: + login: + type: object + properties: + from: + type: string + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + membership: + "$ref": "#/components/schemas/webhooks_membership" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - organization + - sender + webhook-rubygems-metadata: + title: Ruby Gems metadata + type: object + properties: + name: + type: string + description: + type: string + readme: + type: string + homepage: + type: string + version_info: + type: object + properties: + version: + type: string + platform: + type: string + metadata: + type: object + additionalProperties: + type: string + repo: + type: string + dependencies: + type: array + items: + type: object + additionalProperties: + type: string + commit_oid: + type: string + webhook-package-published: + title: package published event + type: object + properties: + action: + type: string + enum: + - published + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + package: + description: Information about the package. + type: object + properties: + created_at: type: string nullable: true - format: date-time - closed_issues: + description: + type: string + nullable: true + ecosystem: + type: string + html_url: + type: string + format: uri + id: type: integer - created_at: + name: type: string - format: date-time - creator: + namespace: + type: string + owner: title: User type: object nullable: true @@ -126695,296 +124762,523 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - login - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - milestone - - repository - - sender - webhook-milestone-edited: - title: milestone edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: The changes to the milestone if the action was `edited`. - type: object - properties: - description: - type: object - properties: - from: - description: The previous version of the description if the action - was `edited`. - type: string - required: - - from - due_on: - type: object - properties: - from: - description: The previous version of the due date if the action - was `edited`. - type: string - required: - - from - title: - type: object - properties: - from: - description: The previous version of the title if the action was - `edited`. - type: string - required: - - from - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: + package_type: type: string - format: date-time - creator: - title: User + package_version: type: object nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string + author: + title: User + type: object nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + body: + oneOf: + - type: string + - type: object + body_html: type: string - format: uri-template - gists_url: + container_metadata: + type: object + nullable: true + properties: + labels: + type: object + nullable: true + manifest: + type: object + nullable: true + tag: + type: object + properties: + digest: + type: string + name: + type: string + created_at: type: string - format: uri-template - gravatar_id: + description: type: string + docker_metadata: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: string + draft: + type: boolean html_url: type: string format: uri id: type: integer - login: + installation_command: + type: string + manifest: type: string + metadata: + type: array + items: + type: object + additionalProperties: true name: type: string - node_id: + npm_metadata: + type: object + nullable: true + properties: + name: + type: string + version: + type: string + npm_user: + type: string + author: + type: object + nullable: true + bugs: + type: object + nullable: true + dependencies: + type: object + dev_dependencies: + type: object + peer_dependencies: + type: object + optional_dependencies: + type: object + description: + type: string + dist: + type: object + nullable: true + git_head: + type: string + homepage: + type: string + license: + type: string + main: + type: string + repository: + type: object + nullable: true + scripts: + type: object + id: + type: string + node_version: + type: string + npm_version: + type: string + has_shrinkwrap: + type: boolean + maintainers: + type: array + items: + type: object + contributors: + type: array + items: + type: object + engines: + type: object + keywords: + type: array + items: + type: string + files: + type: array + items: + type: string + bin: + type: object + man: + type: object + directories: + type: object + nullable: true + os: + type: array + items: + type: string + cpu: + type: array + items: + type: string + readme: + type: string + installation_command: + type: string + release_id: + type: integer + commit_oid: + type: string + published_via_actions: + type: boolean + deleted_by_id: + type: integer + nuget_metadata: + type: array + nullable: true + items: + type: object + properties: + id: + oneOf: + - type: integer + - type: string + name: + type: string + value: + oneOf: + - type: boolean + - type: string + - type: integer + - type: object + properties: + url: + type: string + branch: + type: string + commit: + type: string + type: + type: string + package_files: + type: array + items: + type: object + properties: + content_type: + type: string + created_at: + type: string + download_url: + type: string + format: uri + id: + type: integer + md5: + type: string + nullable: true + name: + type: string + sha1: + type: string + nullable: true + sha256: + type: string + nullable: true + size: + type: integer + state: + type: string + nullable: true + updated_at: + type: string + required: + - download_url + - id + - name + - sha256 + - sha1 + - md5 + - content_type + - state + - size + - created_at + - updated_at + package_url: type: string - organizations_url: + prerelease: + type: boolean + release: + type: object + properties: + author: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + created_at: + type: string + draft: + type: boolean + html_url: + type: string + format: uri + id: + type: integer + name: + type: string + nullable: true + prerelease: + type: boolean + published_at: + type: string + tag_name: + type: string + target_commitish: + type: string + url: + type: string + format: uri + required: + - url + - html_url + - id + - tag_name + - target_commitish + - name + - draft + - author + - prerelease + - created_at + - published_at + rubygems_metadata: + type: array + items: + "$ref": "#/components/schemas/webhook-rubygems-metadata" + source_url: type: string - format: uri - received_events_url: + summary: type: string - format: uri - repos_url: + tag_name: type: string - format: uri - site_admin: - type: boolean - starred_url: + target_commitish: type: string - format: uri-template - subscriptions_url: + target_oid: + type: string + updated_at: + type: string + version: + type: string + required: + - id + - version + - summary + - name + - description + - html_url + - metadata + - package_files + - installation_command + registry: + type: object + nullable: true + properties: + about_url: type: string format: uri + name: + type: string type: type: string - enum: - - Bot - - User - - Organization - - Mannequin url: type: string format: uri + vendor: + type: string required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string + - about_url + - name + - type + - url + - vendor updated_at: type: string - format: date-time - url: - type: string - format: uri + nullable: true required: - - url - - html_url - - labels_url - id - - node_id - - number - - title + - name + - namespace - description - - creator - - open_issues - - closed_issues - - state + - ecosystem + - package_type + - html_url - created_at - updated_at - - due_on - - closed_at - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" + - owner + - package_version + - registry repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - changes - - milestone - - repository + - package - sender - webhook-milestone-opened: - title: milestone opened event + webhook-package-updated: + title: package updated event type: object properties: action: type: string enum: - - opened + - updated enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" - milestone: - title: Milestone - description: A collection of related issues and pull requests. + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + package: + description: Information about the package. type: object properties: - closed_at: + created_at: + type: string + description: type: string nullable: true - format: date-time - closed_issues: + ecosystem: + type: string + html_url: + type: string + format: uri + id: type: integer - created_at: + name: type: string - format: date-time - creator: + namespace: + type: string + owner: title: User type: object nullable: true @@ -127051,1047 +125345,10 @@ components: required: - login - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - milestone - - repository - - sender - webhook-org-block-blocked: - title: org_block blocked event - type: object - properties: - action: - type: string - enum: - - blocked - blocked_user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - blocked_user - - organization - - sender - webhook-org-block-unblocked: - title: org_block unblocked event - type: object - properties: - action: - type: string - enum: - - unblocked - blocked_user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - blocked_user - - organization - - sender - webhook-organization-deleted: - title: organization deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - membership: - title: Membership - description: The membership between the user and the organization. Not present - when the action is `member_invited`. - type: object - properties: - organization_url: - type: string - format: uri - role: - type: string - state: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - state - - role - - organization_url - - user - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - organization - - sender - webhook-organization-member-added: - title: organization member_added event - type: object - properties: - action: - type: string - enum: - - member_added - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - membership: - title: Membership - description: The membership between the user and the organization. Not present - when the action is `member_invited`. - type: object - properties: - organization_url: - type: string - format: uri - role: - type: string - state: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - state - - role - - organization_url - - user - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - membership - - organization - - sender - webhook-organization-member-invited: - title: organization member_invited event - type: object - properties: - action: - type: string - enum: - - member_invited - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - invitation: - description: The invitation for the user or email if the action is `member_invited`. - type: object - properties: - created_at: - type: string - format: date-time - email: - type: string - nullable: true - failed_at: - type: string - nullable: true - format: date-time - failed_reason: - type: string - nullable: true - id: - type: number - invitation_teams_url: - type: string - format: uri - inviter: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - login: - type: string - nullable: true - node_id: - type: string - role: - type: string - team_count: - type: number - invitation_source: - type: string - required: - - id - - node_id - - login - - email - - role - - created_at - - failed_at - - failed_reason - - inviter - - team_count - - invitation_teams_url - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - action - - invitation - - organization - - sender - webhook-organization-member-removed: - title: organization member_removed event - type: object - properties: - action: - type: string - enum: - - member_removed - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - membership: - title: Membership - description: The membership between the user and the organization. Not present - when the action is `member_invited`. - type: object - properties: - organization_url: - type: string - format: uri - role: - type: string - state: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - state - - role - - organization_url - - user - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - membership - - organization - - sender - webhook-organization-renamed: - title: organization renamed event - type: object - properties: - action: - type: string - enum: - - renamed - changes: - type: object - properties: - login: - type: object - properties: - from: - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - membership: - title: Membership - description: The membership between the user and the organization. Not present - when the action is `member_invited`. - type: object - properties: - organization_url: - type: string - format: uri - role: - type: string - state: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - state - - role - - organization_url - - user - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - organization - - sender - webhook-rubygems-metadata: - title: Ruby Gems metadata - type: object - properties: - name: - type: string - description: - type: string - readme: - type: string - homepage: - type: string - version_info: - type: object - properties: - version: - type: string - platform: - type: string - metadata: - type: object - additionalProperties: - type: string - repo: - type: string - dependencies: - type: array - items: - type: object - additionalProperties: - type: string - commit_oid: - type: string - webhook-package-published: - title: package published event - type: object - properties: - action: - type: string - enum: - - published - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - package: - description: Information about the package. - type: object - properties: - created_at: - type: string - nullable: true - description: - type: string - nullable: true - ecosystem: - type: string - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - namespace: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - package_type: + package_type: type: string package_version: type: object - nullable: true properties: author: title: User @@ -128161,28 +125418,9 @@ components: - login - id body: - oneOf: - - type: string - - type: object + type: string body_html: type: string - container_metadata: - type: object - nullable: true - properties: - labels: - type: object - nullable: true - manifest: - type: object - nullable: true - tag: - type: object - properties: - digest: - type: string - name: - type: string created_at: type: string description: @@ -128214,128 +125452,6 @@ components: additionalProperties: true name: type: string - npm_metadata: - type: object - nullable: true - properties: - name: - type: string - version: - type: string - npm_user: - type: string - author: - type: object - nullable: true - bugs: - type: object - nullable: true - dependencies: - type: object - dev_dependencies: - type: object - peer_dependencies: - type: object - optional_dependencies: - type: object - description: - type: string - dist: - type: object - nullable: true - git_head: - type: string - homepage: - type: string - license: - type: string - main: - type: string - repository: - type: object - nullable: true - scripts: - type: object - id: - type: string - node_version: - type: string - npm_version: - type: string - has_shrinkwrap: - type: boolean - maintainers: - type: array - items: - type: object - contributors: - type: array - items: - type: object - engines: - type: object - keywords: - type: array - items: - type: string - files: - type: array - items: - type: string - bin: - type: object - man: - type: object - directories: - type: object - nullable: true - os: - type: array - items: - type: string - cpu: - type: array - items: - type: string - readme: - type: string - installation_command: - type: string - release_id: - type: integer - commit_oid: - type: string - published_via_actions: - type: boolean - deleted_by_id: - type: integer - nuget_metadata: - type: array - nullable: true - items: - type: object - properties: - id: - oneOf: - - type: integer - - type: string - name: - type: string - value: - oneOf: - - type: boolean - - type: string - - type: integer - - type: object - properties: - url: - type: string - branch: - type: string - commit: - type: string - type: - type: string package_files: type: array items: @@ -128360,12 +125476,10 @@ components: nullable: true sha256: type: string - nullable: true size: type: integer state: type: string - nullable: true updated_at: type: string required: @@ -128465,7 +125579,6 @@ components: type: integer name: type: string - nullable: true prerelease: type: boolean published_at: @@ -128495,6 +125608,7 @@ components: "$ref": "#/components/schemas/webhook-rubygems-metadata" source_url: type: string + format: uri summary: type: string tag_name: @@ -128513,9 +125627,16 @@ components: - summary - name - description + - body + - body_html - html_url + - target_commitish + - target_oid + - created_at + - updated_at - metadata - package_files + - author - installation_command registry: type: object @@ -128541,7 +125662,6 @@ components: - vendor updated_at: type: string - nullable: true required: - id - name @@ -128562,42 +125682,33 @@ components: required: - action - package + - repository - sender - webhook-package-updated: - title: package updated event + webhook-page-build: + title: page_build event type: object properties: - action: - type: string - enum: - - updated - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - package: - description: Information about the package. + build: + description: The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) + itself. type: object properties: - created_at: - type: string - description: + commit: type: string nullable: true - ecosystem: - type: string - html_url: + created_at: type: string - format: uri - id: + duration: type: integer - name: - type: string - namespace: - type: string - owner: + error: + type: object + properties: + message: + type: string + nullable: true + required: + - message + pusher: title: User type: object nullable: true @@ -128664,437 +125775,7 @@ components: required: - login - id - package_type: - type: string - package_version: - type: object - properties: - author: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - body: - type: string - body_html: - type: string - created_at: - type: string - description: - type: string - docker_metadata: - type: array - items: - type: object - properties: - tags: - type: array - items: - type: string - draft: - type: boolean - html_url: - type: string - format: uri - id: - type: integer - installation_command: - type: string - manifest: - type: string - metadata: - type: array - items: - type: object - additionalProperties: true - name: - type: string - package_files: - type: array - items: - type: object - properties: - content_type: - type: string - created_at: - type: string - download_url: - type: string - format: uri - id: - type: integer - md5: - type: string - nullable: true - name: - type: string - sha1: - type: string - nullable: true - sha256: - type: string - size: - type: integer - state: - type: string - updated_at: - type: string - required: - - download_url - - id - - name - - sha256 - - sha1 - - md5 - - content_type - - state - - size - - created_at - - updated_at - package_url: - type: string - prerelease: - type: boolean - release: - type: object - properties: - author: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - created_at: - type: string - draft: - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - prerelease: - type: boolean - published_at: - type: string - tag_name: - type: string - target_commitish: - type: string - url: - type: string - format: uri - required: - - url - - html_url - - id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - rubygems_metadata: - type: array - items: - "$ref": "#/components/schemas/webhook-rubygems-metadata" - source_url: - type: string - format: uri - summary: - type: string - tag_name: - type: string - target_commitish: - type: string - target_oid: - type: string - updated_at: - type: string - version: - type: string - required: - - id - - version - - summary - - name - - description - - body - - body_html - - html_url - - target_commitish - - target_oid - - created_at - - updated_at - - metadata - - package_files - - author - - installation_command - registry: - type: object - nullable: true - properties: - about_url: - type: string - format: uri - name: - type: string - type: - type: string - url: - type: string - format: uri - vendor: - type: string - required: - - about_url - - name - - type - - url - - vendor - updated_at: - type: string - required: - - id - - name - - namespace - - description - - ecosystem - - package_type - - html_url - - created_at - - updated_at - - owner - - package_version - - registry - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - package - - repository - - sender - webhook-page-build: - title: page_build event - type: object - properties: - build: - description: The [List GitHub Pages builds](https://docs.github.com/rest/pages/pages#list-github-pages-builds) - itself. - type: object - properties: - commit: - type: string - nullable: true - created_at: - type: string - duration: - type: integer - error: - type: object - properties: - message: - type: string - nullable: true - required: - - message - pusher: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - status: + status: type: string updated_at: type: string @@ -129338,122 +126019,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project_card: - title: Project Card - type: object - properties: - after_id: - type: integer - nullable: true - archived: - description: Whether or not the card is archived - type: boolean - column_id: - type: integer - column_url: - type: string - format: uri - content_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - id: - description: The project card's ID - type: integer - node_id: - type: string - note: - type: string - nullable: true - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - column_url - - column_id - - id - - node_id - - note - - archived - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project_card" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -129478,122 +126044,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project_card: - title: Project Card - type: object - properties: - after_id: - type: integer - nullable: true - archived: - description: Whether or not the card is archived - type: boolean - column_id: - type: integer - column_url: - type: string - format: uri - content_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - id: - description: The project card's ID - type: integer - node_id: - type: string - note: - type: string - nullable: true - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - column_url - - column_id - - id - - node_id - - note - - archived - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project_card" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -129771,122 +126222,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project_card: - title: Project Card - type: object - properties: - after_id: - type: integer - nullable: true - archived: - description: Whether or not the card is archived - type: boolean - column_id: - type: integer - column_url: - type: string - format: uri - content_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - id: - description: The project card's ID - type: integer - node_id: - type: string - note: - type: string - nullable: true - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - column_url - - column_id - - id - - node_id - - note - - archived - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project_card" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -130132,127 +126468,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project: - title: Project - type: object - properties: - body: - description: Body of the project - type: string - nullable: true - columns_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - html_url: - type: string - format: uri - id: - type: integer - name: - description: Name of the project - type: string - node_id: - type: string - number: - type: integer - owner_url: - type: string - format: uri - state: - description: State of the project; either 'open' or 'closed' - type: string - enum: - - open - - closed - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -130276,44 +126492,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project_column: - title: Project Column - type: object - properties: - after_id: - type: integer - nullable: true - cards_url: - type: string - format: uri - created_at: - type: string - format: date-time - id: - description: The unique identifier of the project column - type: integer - name: - description: Name of the project column - type: string - node_id: - type: string - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - cards_url - - id - - node_id - - name - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project_column" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -130336,44 +126515,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project_column: - title: Project Column - type: object - properties: - after_id: - type: integer - nullable: true - cards_url: - type: string - format: uri - created_at: - type: string - format: date-time - id: - description: The unique identifier of the project column - type: integer - name: - description: Name of the project column - type: string - node_id: - type: string - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - cards_url - - id - - node_id - - name - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project_column" repository: "$ref": "#/components/schemas/nullable-repository-webhooks" sender: @@ -130406,44 +126548,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project_column: - title: Project Column - type: object - properties: - after_id: - type: integer - nullable: true - cards_url: - type: string - format: uri - created_at: - type: string - format: date-time - id: - description: The unique identifier of the project column - type: integer - name: - description: Name of the project column - type: string - node_id: - type: string - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - cards_url - - id - - node_id - - name - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project_column" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -130467,44 +126572,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project_column: - title: Project Column - type: object - properties: - after_id: - type: integer - nullable: true - cards_url: - type: string - format: uri - created_at: - type: string - format: date-time - id: - description: The unique identifier of the project column - type: integer - name: - description: Name of the project column - type: string - node_id: - type: string - project_url: - type: string - format: uri - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - project_url - - cards_url - - id - - node_id - - name - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project_column" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -130528,127 +126596,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project: - title: Project - type: object - properties: - body: - description: Body of the project - type: string - nullable: true - columns_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - html_url: - type: string - format: uri - id: - type: integer - name: - description: Name of the project - type: string - node_id: - type: string - number: - type: integer - owner_url: - type: string - format: uri - state: - description: State of the project; either 'open' or 'closed' - type: string - enum: - - open - - closed - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -130672,127 +126620,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project: - title: Project - type: object - properties: - body: - description: Body of the project - type: string - nullable: true - columns_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - html_url: - type: string - format: uri - id: - type: integer - name: - description: Name of the project - type: string - node_id: - type: string - number: - type: integer - owner_url: - type: string - format: uri - state: - description: State of the project; either 'open' or 'closed' - type: string - enum: - - open - - closed - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project" repository: "$ref": "#/components/schemas/nullable-repository-webhooks" sender: @@ -130836,127 +126664,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project: - title: Project - type: object - properties: - body: - description: Body of the project - type: string - nullable: true - columns_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - html_url: - type: string - format: uri - id: - type: integer - name: - description: Name of the project - type: string - node_id: - type: string - number: - type: integer - owner_url: - type: string - format: uri - state: - description: State of the project; either 'open' or 'closed' - type: string - enum: - - open - - closed - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -130979,127 +126687,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" project: - title: Project - type: object - properties: - body: - description: Body of the project - type: string - nullable: true - columns_url: - type: string - format: uri - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - html_url: - type: string - format: uri - id: - type: integer - name: - description: Name of the project - type: string - node_id: - type: string - number: - type: integer - owner_url: - type: string - format: uri - state: - description: State of the project; either 'open' or 'closed' - type: string - enum: - - open - - closed - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - owner_url - - url - - html_url - - columns_url - - id - - node_id - - name - - body - - number - - state - - creator - - created_at - - updated_at + "$ref": "#/components/schemas/webhooks_project" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -131237,19 +126825,7 @@ components: enum: - archived changes: - type: object - properties: - archived_at: - type: object - properties: - from: - type: string - nullable: true - format: date-time - to: - type: string - nullable: true - format: date-time + "$ref": "#/components/schemas/webhooks_project_changes" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -131429,19 +127005,7 @@ components: enum: - restored changes: - type: object - properties: - archived_at: - type: object - properties: - from: - type: string - nullable: true - format: date-time - to: - type: string - nullable: true - format: date-time + "$ref": "#/components/schemas/webhooks_project_changes" installation: "$ref": "#/components/schemas/simple-installation" organization: @@ -131503,79 +127067,13 @@ components: enum: - assigned assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id + "$ref": "#/components/schemas/webhooks_user" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: - description: The pull request number. - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: @@ -138370,73 +133868,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" number: - description: The pull request number. - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - allOf: - - "$ref": "#/components/schemas/pull-request" - - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_update_branch: - description: Whether to allow updating the pull request's branch. - type: boolean - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged. - type: boolean - default: false - merge_commit_message: - description: |- - The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull request - title as default. **This property has been deprecated. Please use - `squash_merge_commit_title` instead.** - type: boolean - default: false + "$ref": "#/components/schemas/pull-request-webhook" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -138460,73 +133896,11 @@ components: installation: "$ref": "#/components/schemas/simple-installation" number: - description: The pull request number. - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - allOf: - - "$ref": "#/components/schemas/pull-request" - - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_update_branch: - description: Whether to allow updating the pull request's branch. - type: boolean - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged. - type: boolean - default: false - merge_commit_message: - description: |- - The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull request - title as default. **This property has been deprecated. Please use - `squash_merge_commit_title` instead.** - type: boolean - default: false + "$ref": "#/components/schemas/pull-request-webhook" repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -138550,7 +133924,33 @@ components: milestone: "$ref": "#/components/schemas/milestone" number: - description: The pull request number. + "$ref": "#/components/schemas/webhooks_number" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + "$ref": "#/components/schemas/webhooks_pull_request_5" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - number + - pull_request + - repository + webhook-pull-request-dequeued: + title: pull_request dequeued event + type: object + properties: + action: + type: string + enum: + - dequeued + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: type: integer organization: "$ref": "#/components/schemas/organization-simple-webhooks" @@ -138714,7 +134114,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -138784,7 +134183,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -139316,7 +134714,8 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. type: boolean default: false visibility: @@ -139933,7 +135332,8 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. type: boolean default: false visibility: @@ -140224,7 +135624,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -140781,6 +136180,8 @@ components: - auto_merge - active_lock_reason - draft + reason: + type: string repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -140790,14 +136191,86 @@ components: - number - pull_request - repository - webhook-pull-request-dequeued: - title: pull_request dequeued event + - sender + - reason + webhook-pull-request-edited: + title: pull_request edited event type: object properties: action: type: string enum: - - dequeued + - edited + changes: + description: The changes to the comment if the action was `edited`. + type: object + properties: + base: + type: object + properties: + ref: + type: object + properties: + from: + type: string + required: + - from + sha: + type: object + properties: + from: + type: string + required: + - from + required: + - ref + - sha + body: + type: object + properties: + from: + description: The previous version of the body if the action was + `edited`. + type: string + required: + - from + title: + type: object + properties: + from: + description: The previous version of the title if the action was + `edited`. + type: string + required: + - from + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: + "$ref": "#/components/schemas/webhooks_number" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + "$ref": "#/components/schemas/pull-request-webhook" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - number + - pull_request + - repository + webhook-pull-request-enqueued: + title: pull_request enqueued event + type: object + properties: + action: + type: string + enum: + - enqueued enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -141647,8 +137120,8 @@ components: - has_projects - has_downloads - has_wiki - - has_pages - has_discussions + - has_pages - forks_count - mirror_url - archived @@ -143032,8 +138505,6 @@ components: - auto_merge - active_lock_reason - draft - reason: - type: string repository: "$ref": "#/components/schemas/repository-webhooks" sender: @@ -143044,153 +138515,22 @@ components: - pull_request - repository - sender - - reason - webhook-pull-request-edited: - title: pull_request edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: The changes to the comment if the action was `edited`. - type: object - properties: - base: - type: object - properties: - ref: - type: object - properties: - from: - type: string - required: - - from - sha: - type: object - properties: - from: - type: string - required: - - from - required: - - ref - - sha - body: - type: object - properties: - from: - description: The previous version of the body if the action was - `edited`. - type: string - required: - - from - title: - type: object - properties: - from: - description: The previous version of the title if the action was - `edited`. - type: string - required: - - from - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - allOf: - - "$ref": "#/components/schemas/pull-request" - - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_update_branch: - description: Whether to allow updating the pull request's branch. - type: boolean - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged. - type: boolean - default: false - merge_commit_message: - description: |- - The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull request - title as default. **This property has been deprecated. Please use - `squash_merge_commit_title` instead. - type: boolean - default: false - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - changes - - number - - pull_request - - repository - webhook-pull-request-enqueued: - title: pull_request enqueued event + webhook-pull-request-labeled: + title: pull_request labeled event type: object properties: action: type: string enum: - - enqueued + - labeled enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + label: + "$ref": "#/components/schemas/webhooks_label" number: - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: @@ -143353,6 +138693,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -143422,6 +138763,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -144034,8 +139376,8 @@ components: - has_projects - has_downloads - has_wiki - - has_discussions - has_pages + - has_discussions - forks_count - mirror_url - archived @@ -144157,12 +139499,14 @@ components: properties: label: type: string + nullable: true ref: type: string repo: title: Repository description: A git repository type: object + nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -144863,6 +140207,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -145082,6 +140427,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -145187,6 +140533,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -145429,53 +140784,20 @@ components: - pull_request - repository - sender - webhook-pull-request-labeled: - title: pull_request labeled event + webhook-pull-request-locked: + title: pull_request locked event type: object properties: action: type: string enum: - - labeled + - locked enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" - label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description number: - description: The pull request number. - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: @@ -145638,7 +140960,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -147235,7 +142556,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -147729,48 +143049,134 @@ components: - pull_request - repository - sender - webhook-pull-request-locked: - title: pull_request locked event + webhook-pull-request-milestoned: + title: pull_request milestoned event type: object properties: action: type: string enum: - - locked + - milestoned + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + milestone: + "$ref": "#/components/schemas/milestone" + number: + "$ref": "#/components/schemas/webhooks_number" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + "$ref": "#/components/schemas/webhooks_pull_request_5" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - number + - pull_request + - repository + webhook-pull-request-opened: + title: pull_request opened event + type: object + properties: + action: + type: string + enum: + - opened enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: - description: The pull request number. - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - title: Pull Request + "$ref": "#/components/schemas/pull-request-webhook" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - number + - pull_request + - repository + - sender + webhook-pull-request-ready-for-review: + title: pull_request ready_for_review event + type: object + properties: + action: + type: string + enum: + - ready_for_review + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: + "$ref": "#/components/schemas/webhooks_number" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + "$ref": "#/components/schemas/pull-request-webhook" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - number + - pull_request + - repository + - sender + webhook-pull-request-reopened: + title: pull_request reopened event + type: object + properties: + action: + type: string + enum: + - reopened + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: + "$ref": "#/components/schemas/webhooks_number" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + "$ref": "#/components/schemas/pull-request-webhook" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - number + - pull_request + - repository + - sender + webhook-pull-request-review-comment-created: + title: pull_request_review_comment created event + type: object + properties: + action: + type: string + enum: + - created + comment: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. type: object properties: _links: type: object properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href html: title: Link type: object @@ -147780,25 +143186,7 @@ components: format: uri-template required: - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: + pull_request: title: Link type: object properties: @@ -147816,36 +143204,158 @@ components: format: uri-template required: - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href required: - self - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment applies. The + last line of the range for a multi-line comment + type: integer + nullable: true + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the comment applies. type: string + original_line: + description: The line of the blob to which the comment applies. The + last line of the range for a multi-line comment + type: integer nullable: true + original_position: + description: The index of the original line in the diff to which the + comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line comment. + type: integer + nullable: true + path: + description: The relative path of the file to which the comment applies. + type: string + position: + description: The line index in the diff to which the comment applies. + type: integer + nullable: true + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: integer + nullable: true + pull_request_url: + description: URL for the pull request that the review comment belongs + to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for a multi-line + comment. + type: string enum: - - resolved - - off-topic - - too heated - - spam - - - additions: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line comment. type: integer - assignee: + nullable: true + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: string + nullable: true + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, can be a diff + line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: title: User type: object nullable: true @@ -147912,6 +143422,202 @@ components: required: - login - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id assignees: type: array items: @@ -148679,39 +144385,27 @@ components: body: type: string nullable: true - changed_files: - type: integer closed_at: type: string nullable: true - format: date-time - comments: - type: integer comments_url: type: string format: uri - commits: - type: integer commits_url: type: string format: uri created_at: type: string - format: date-time - deletions: - type: integer diff_url: type: string format: uri draft: - description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string - nullable: true ref: type: string repo: @@ -149209,7 +144903,6 @@ components: - has_downloads - has_wiki - has_pages - - has_discussions - forks_count - mirror_url - archived @@ -149340,92 +145033,12 @@ components: - description locked: type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull request. - type: boolean merge_commit_sha: type: string nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true merged_at: type: string nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -149502,6 +145115,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -149565,15 +145179,10 @@ components: node_id: type: string number: - description: Number uniquely identifying the pull request within its - repository. type: integer patch_url: type: string format: uri - rebaseable: - type: boolean - nullable: true requested_reviewers: type: array items: @@ -149857,13 +145466,10 @@ components: review_comment_url: type: string format: uri-template - review_comments: - type: integer review_comments_url: type: string format: uri state: - description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -149872,11 +145478,9 @@ components: type: string format: uri title: - description: The title of the pull request. type: string updated_at: type: string - format: date-time url: type: string format: uri @@ -149982,38 +145586,34 @@ components: - base - _links - author_association - - auto_merge - active_lock_reason - - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - number + - comment - pull_request - repository - sender - webhook-pull-request-milestoned: - title: pull_request milestoned event + webhook-pull-request-review-comment-deleted: + title: pull_request_review_comment deleted event type: object properties: action: type: string enum: - - milestoned + - deleted + comment: + "$ref": "#/components/schemas/webhooks_review_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" - milestone: - "$ref": "#/components/schemas/milestone" - number: - description: The pull request number. - type: integer + installation: + "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - title: Pull Request type: object properties: _links: @@ -150109,8 +145709,6 @@ components: - too heated - spam - - additions: - type: integer assignee: title: User type: object @@ -150172,7 +145770,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -150242,7 +145839,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -150774,7 +146370,8 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. type: boolean default: false visibility: @@ -150945,32 +146542,21 @@ components: body: type: string nullable: true - changed_files: - type: integer closed_at: type: string nullable: true - format: date-time - comments: - type: integer comments_url: type: string format: uri - commits: - type: integer commits_url: type: string format: uri created_at: type: string - format: date-time - deletions: - type: integer diff_url: type: string format: uri draft: - description: Indicates whether or not the pull request is a draft. type: boolean head: type: object @@ -150983,6 +146569,7 @@ components: title: Repository description: A git repository type: object + nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -151391,7 +146978,8 @@ components: format: uri use_squash_pr_title_as_default: description: Whether a squash merge commit can use the pull - request title as default. + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. type: boolean default: false visibility: @@ -151603,538 +147191,447 @@ components: - description locked: type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull request. - type: boolean merge_commit_sha: type: string nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true merged_at: type: string nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within its - repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + type: integer + patch_url: + type: string + format: uri + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: object + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: object + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: + type: string + format: uri-template + review_comments_url: + type: string + format: uri + state: + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + type: string + updated_at: + type: string + url: + type: string + format: uri + user: title: User type: object nullable: true @@ -152236,576 +147733,29 @@ components: - base - _links - author_association - - auto_merge - active_lock_reason - - draft - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - number - - pull_request - - repository - webhook-pull-request-opened: - title: pull_request opened event - type: object - properties: - action: - type: string - enum: - - opened - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - allOf: - - "$ref": "#/components/schemas/pull-request" - - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_update_branch: - description: Whether to allow updating the pull request's branch. - type: boolean - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged. - type: boolean - default: false - merge_commit_message: - description: |- - The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull request - title as default. **This property has been deprecated. Please use - `squash_merge_commit_title` instead.** - type: boolean - default: false repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - number - - pull_request - - repository - - sender - webhook-pull-request-ready-for-review: - title: pull_request ready_for_review event - type: object - properties: - action: - type: string - enum: - - ready_for_review - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - allOf: - - "$ref": "#/components/schemas/pull-request" - - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_update_branch: - description: Whether to allow updating the pull request's branch. - type: boolean - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged. - type: boolean - default: false - merge_commit_message: - description: |- - The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull request - title as default. **This property has been deprecated. Please use - `squash_merge_commit_title` instead.** - type: boolean - default: false - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - number - - pull_request - - repository - - sender - webhook-pull-request-reopened: - title: pull_request reopened event - type: object - properties: - action: - type: string - enum: - - reopened - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - allOf: - - "$ref": "#/components/schemas/pull-request" - - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_update_branch: - description: Whether to allow updating the pull request's branch. - type: boolean - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged. - type: boolean - default: false - merge_commit_message: - description: |- - The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., "Merge pull request #123 from branch-name"). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull request - title as default. **This property has been deprecated. Please use - `squash_merge_commit_title` instead.** - type: boolean - default: false - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - number + - comment - pull_request - repository - sender - webhook-pull-request-review-comment-created: - title: pull_request_review_comment created event + webhook-pull-request-review-comment-edited: + title: pull_request_review_comment edited event type: object properties: action: type: string enum: - - created + - edited + changes: + "$ref": "#/components/schemas/webhooks_changes" comment: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment - type: integer - nullable: true - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment applies. - type: string - original_line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment - type: integer - nullable: true - original_position: - description: The index of the original line in the diff to which the - comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: integer - nullable: true - path: - description: The relative path of the file to which the comment applies. - type: string - position: - description: The line index in the diff to which the comment applies. - type: integer - nullable: true - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: integer - nullable: true - pull_request_url: - description: URL for the pull request that the review comment belongs - to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: integer - nullable: true - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: string - nullable: true - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be a diff - line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions + "$ref": "#/components/schemas/webhooks_review_comment" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -152969,7 +147919,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -153039,7 +147988,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -154261,6 +149209,7 @@ components: - has_downloads - has_wiki - has_pages + - has_discussions - forks_count - mirror_url - archived @@ -154605,7 +149554,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -154711,15 +149659,6 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -154951,297 +149890,19 @@ components: "$ref": "#/components/schemas/simple-user-webhooks" required: - action + - changes - comment - pull_request - repository - sender - webhook-pull-request-review-comment-deleted: - title: pull_request_review_comment deleted event + webhook-pull-request-review-dismissed: + title: pull_request_review dismissed event type: object properties: action: type: string enum: - - deleted - comment: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment - type: integer - nullable: true - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment applies. - type: string - original_line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment - type: integer - original_position: - description: The index of the original line in the diff to which the - comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: integer - nullable: true - path: - description: The relative path of the file to which the comment applies. - type: string - position: - description: The line index in the diff to which the comment applies. - type: integer - nullable: true - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: integer - nullable: true - pull_request_url: - description: URL for the pull request that the review comment belongs - to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: integer - nullable: true - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: string - nullable: true - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be a diff - line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions + - dismissed enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -155249,6 +149910,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: + title: Simple Pull Request type: object properties: _links: @@ -155405,6 +150067,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -155474,6 +150137,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -157039,6 +151703,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -157144,6 +151809,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -157359,6 +152033,7 @@ components: - requested_teams - labels - milestone + - draft - commits_url - review_comments_url - review_comment_url @@ -157368,41 +152043,12 @@ components: - base - _links - author_association + - auto_merge - active_lock_reason repository: "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - comment - - pull_request - - repository - - sender - webhook-pull-request-review-comment-edited: - title: pull_request_review_comment edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - description: The changes to the comment. - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body. - type: string - required: - - from - comment: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. + review: + description: The review that was affected. type: object properties: _links: @@ -157426,17 +152072,7 @@ components: format: uri-template required: - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href required: - - self - html - pull_request author_association: @@ -157453,138 +152089,32 @@ components: - NONE - OWNER body: - description: The text of the comment. + description: The text of the review. type: string + nullable: true commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. + description: A commit SHA for the review. type: string html_url: - description: HTML URL for the pull request review comment. type: string format: uri id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment + description: Unique identifier of the review type: integer - nullable: true node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment applies. type: string - original_line: - description: The line of the blob to which the comment applies. The - last line of the range for a multi-line comment - type: integer - original_position: - description: The index of the original line in the diff to which the - comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: integer - nullable: true - path: - description: The relative path of the file to which the comment applies. - type: string - position: - description: The line index in the diff to which the comment applies. - type: integer - nullable: true - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: integer - nullable: true pull_request_url: - description: URL for the pull request that the review comment belongs - to. type: string format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: integer - nullable: true - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: string - nullable: true - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be a diff - line or a file. + state: type: string enum: - - line - - file - updated_at: + - dismissed + - approved + - changes_requested + submitted_at: type: string format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri user: title: User type: object @@ -157646,6 +152176,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -157653,31 +152184,45 @@ components: - login - id required: - - url - - pull_request_review_id - id - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - user - body - - created_at - - updated_at + - commit_id + - submitted_at + - state - html_url - pull_request_url - author_association - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - review + - pull_request + - repository + - sender + webhook-pull-request-review-edited: + title: pull_request_review edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + type: object + properties: + body: + type: object + properties: + from: + description: The previous version of the body if the action was + `edited`. + type: string + required: + - from enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -157685,6 +152230,7 @@ components: organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: + title: Simple Pull Request type: object properties: _links: @@ -157841,6 +152387,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -157910,6 +152457,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -158161,10 +152709,6 @@ components: description: Whether the wiki is enabled. type: boolean default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false homepage: type: string nullable: true @@ -158225,28 +152769,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -158377,28 +152899,6 @@ components: nullable: true size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -158439,12 +152939,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -158455,10 +152949,6 @@ components: type: integer watchers_count: type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean required: - id - node_id @@ -158523,7 +153013,6 @@ components: - has_downloads - has_wiki - has_pages - - has_discussions - forks_count - mirror_url - archived @@ -158769,10 +153258,6 @@ components: description: Whether the wiki is enabled. type: boolean default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false homepage: type: string nullable: true @@ -158833,28 +153318,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -158985,28 +153448,6 @@ components: nullable: true size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -159047,12 +153488,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -159063,10 +153498,6 @@ components: type: integer watchers_count: type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean required: - id - node_id @@ -159131,7 +153562,6 @@ components: - has_downloads - has_wiki - has_pages - - has_discussions - forks_count - mirror_url - archived @@ -159476,6 +153906,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -159581,6 +154012,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -159796,6 +154236,7 @@ components: - requested_teams - labels - milestone + - draft - commits_url - review_comments_url - review_comment_url @@ -159805,200 +154246,139 @@ components: - base - _links - author_association + - auto_merge - active_lock_reason repository: "$ref": "#/components/schemas/repository-webhooks" + review: + "$ref": "#/components/schemas/webhooks_review" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - changes - - comment + - review - pull_request - repository - sender - webhook-pull-request-review-dismissed: - title: pull_request_review dismissed event - type: object - properties: - action: - type: string - enum: - - dismissed - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Simple Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: + webhook-pull-request-review-request-removed: + title: pull_request review_request_removed event + oneOf: + - type: object + properties: + action: + type: string + enum: + - review_request_removed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: + description: The pull request number. + type: integer + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: title: User type: object nullable: true @@ -160059,41 +154439,15 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri required: - login - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: + assignees: + type: array + items: title: User type: object nullable: true @@ -160160,1280 +154514,2267 @@ components: required: - login - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: object + nullable: true + properties: + commit_message: + description: Commit message for the merge commit. + type: string + nullable: true + commit_title: + description: Title for the merge commit message. + type: string + nullable: true + enabled_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: string + nullable: true + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: string + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: string + nullable: true + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + size: + type: integer + squash_merge_commit_message: + description: The default value for a squash merge commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: The default value for a squash merge commit title. + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: + url: type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: string + nullable: true + changed_files: + type: integer + closed_at: + type: string + nullable: true + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + commits: + type: integer + commits_url: + type: string + format: uri + created_at: + type: string + format: date-time + deletions: + type: integer + diff_url: + type: string + format: uri + draft: + description: Indicates whether or not the pull request is a draft. + type: boolean + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: string + nullable: true + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: string + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: string + nullable: true + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label type: object - nullable: true properties: - avatar_url: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - format: uri - deleted: + default: type: boolean - email: + description: type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri id: type: integer - login: - type: string name: + description: The name of the label. type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization url: + description: URL for the label type: string format: uri required: - - login - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + merge_commit_sha: + type: string + nullable: true + mergeable: + type: boolean + nullable: true + mergeable_state: + type: string + merged: + type: boolean + nullable: true + merged_at: + type: string + nullable: true + format: date-time + merged_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within its + repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: boolean + nullable: true + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: object + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: type: boolean - default: false - homepage: + description: + description: Description of the team type: string nullable: true - hooks_url: - type: string - format: uri html_url: type: string format: uri id: - description: Unique identifier of the repository + description: Unique identifier of the team type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: + members_url: type: string format: uri-template - mirror_url: - type: string - nullable: true - format: uri name: - description: The name of the repository. + description: Name of the team type: string node_id: type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User + parent: type: object nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + description: + description: Description of the team type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string html_url: type: string format: uri id: + description: Unique identifier of the team type: integer - login: + members_url: type: string + format: uri-template name: + description: Name of the team type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: + permission: + description: Permission that the team will have for its + repositories type: string - format: uri - site_admin: - type: boolean - starred_url: + privacy: type: string - format: uri-template - subscriptions_url: + enum: + - open + - closed + - secret + repositories_url: type: string format: uri - type: + slug: type: string - enum: - - Bot - - User - - Organization url: + description: URL for the team type: string format: uri required: - - login + - name - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + privacy: type: string enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: + - open + - closed + - secret + repositories_url: type: string format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: + slug: type: string - format: date-time url: + description: URL for the team type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean required: + - name - id - node_id - - name - - full_name - - private - - owner - - html_url + - slug - description - - fork + - privacy - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label + - html_url + - members_url + - repositories_url + - permission + review_comment_url: + type: string + format: uri-template + review_comments: + type: integer + review_comments_url: + type: string + format: uri + state: + description: State of this Pull Request. Either `open` or `closed`. + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: + title: User type: object + nullable: true properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + avatar_url: type: string - default: + format: uri + deleted: type: boolean - description: + email: type: string nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer + login: + type: string name: - description: The name of the label. type: string node_id: type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: - description: URL for the label type: string format: uri required: + - login - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: string - nullable: true - merged_at: - type: string - nullable: true - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft + repository: + "$ref": "#/components/schemas/repository-webhooks" + requested_reviewer: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - requested_reviewer + - action + - number + - pull_request + - repository + - sender + - type: object + properties: + action: + type: string + enum: + - review_request_removed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: + description: The pull request number. + type: integer + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: title: User type: object nullable: true @@ -161500,10237 +156841,118 @@ components: required: - login - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. type: object + nullable: true properties: - deleted: - type: boolean - description: - description: Description of the team + commit_message: + description: Commit message for the merge commit. type: string nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: + commit_title: + description: Title for the merge commit message. type: string - parent: + nullable: true + enabled_by: + title: User type: object nullable: true properties: - description: - description: Description of the team + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: type: string nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string html_url: type: string format: uri id: - description: Unique identifier of the team type: integer - members_url: + login: type: string - format: uri-template name: - description: Name of the team type: string node_id: type: string - permission: - description: Permission that the team will have for its repositories + organizations_url: type: string - privacy: + format: uri + received_events_url: type: string - enum: - - open - - closed - - secret - repositories_url: + format: uri + repos_url: type: string format: uri - slug: + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string + enum: + - Bot + - User + - Organization url: - description: URL for the team type: string format: uri required: - - name + - login - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: + merge_method: + description: The merge method to use. type: string enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: - "$ref": "#/components/schemas/repository-webhooks" - review: - description: The review that was affected. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the review. - type: string - nullable: true - commit_id: - description: A commit SHA for the review. - type: string - html_url: - type: string - format: uri - id: - description: Unique identifier of the review - type: integer - node_id: - type: string - pull_request_url: - type: string - format: uri - state: - type: string - enum: - - dismissed - - approved - - changes_requested - submitted_at: - type: string - format: date-time - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - id - - node_id - - user - - body - - commit_id - - submitted_at - - state - - html_url - - pull_request_url - - author_association - - _links - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - review - - pull_request - - repository - - sender - webhook-pull-request-review-edited: - title: pull_request_review edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body if the action was - `edited`. - type: string - required: - - from - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Simple Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: string - nullable: true - merged_at: - type: string - nullable: true - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: - "$ref": "#/components/schemas/repository-webhooks" - review: - description: The review that was affected. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the review. - type: string - nullable: true - commit_id: - description: A commit SHA for the review. - type: string - html_url: - type: string - format: uri - id: - description: Unique identifier of the review - type: integer - node_id: - type: string - pull_request_url: - type: string - format: uri - state: - type: string - submitted_at: - type: string - nullable: true - format: date-time - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - id - - node_id - - user - - body - - commit_id - - submitted_at - - state - - html_url - - pull_request_url - - author_association - - _links - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - changes - - review - - pull_request - - repository - - sender - webhook-pull-request-review-request-removed: - title: pull_request review_request_removed event - oneOf: - - type: object - properties: - action: - type: string - enum: - - review_request_removed - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: The default value for a squash merge commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: The default value for a squash merge commit title. - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within its - repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: - "$ref": "#/components/schemas/repository-webhooks" - requested_reviewer: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - requested_reviewer - - action - - number - - pull_request - - repository - - sender - - type: object - properties: - action: - type: string - enum: - - review_request_removed - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within its - repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: - "$ref": "#/components/schemas/repository-webhooks" - requested_team: - title: Team - description: Groups of organization members that gives permissions on - specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - requested_team - - action - - number - - pull_request - - repository - - sender - webhook-pull-request-review-requested: - title: pull_request review_requested event - oneOf: - - type: object - properties: - action: - type: string - enum: - - review_requested - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - changed_files: - type: integer - closed_at: - type: string - nullable: true - format: date-time - comments: - type: integer - comments_url: - type: string - format: uri - commits: - type: integer - commits_url: - type: string - format: uri - created_at: - type: string - format: date-time - deletions: - type: integer - diff_url: - type: string - format: uri - draft: - description: Indicates whether or not the pull request is a draft. - type: boolean - head: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull request. - type: boolean - merge_commit_sha: - type: string - nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true - merged_at: - type: string - nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - description: Number uniquely identifying the pull request within its - repository. - type: integer - patch_url: - type: string - format: uri - rebaseable: - type: boolean - nullable: true - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its - repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: - "$ref": "#/components/schemas/repository-webhooks" - requested_reviewer: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - requested_reviewer - - action - - number - - pull_request - - repository - - sender - - type: object - properties: - action: - type: string - enum: - - review_requested - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - additions: - type: integer - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: + ref: type: string repo: title: Repository @@ -173136,7 +158358,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -173378,6 +158599,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -173480,6 +158710,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission review_comment_url: type: string format: uri-template @@ -173567,7 +158806,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -173708,201 +158946,146 @@ components: url: description: URL for the team type: string - format: uri - required: - - name - - id - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - requested_team - - action - - number - - pull_request - - repository - - sender - webhook-pull-request-review-submitted: - title: pull_request_review submitted event - type: object - properties: - action: - type: string - enum: - - submitted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Simple Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + webhook-pull-request-review-requested: + title: pull_request review_requested event + oneOf: + - type: object + properties: + action: + type: string + enum: + - review_requested + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: + description: The pull request number. + type: integer + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: title: User type: object nullable: true @@ -173970,628 +159153,9 @@ components: required: - login - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: + assignees: + type: array + items: title: User type: object nullable: true @@ -174601,944 +159165,1836 @@ components: format: uri deleted: type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: string - nullable: true - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - nullable: true - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: + email: type: string - git_commits_url: + nullable: true + events_url: type: string format: uri-template - git_refs_url: + followers_url: type: string - format: uri-template - git_tags_url: + format: uri + following_url: type: string format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: + gists_url: type: string - nullable: true - hooks_url: + format: uri-template + gravatar_id: type: string - format: uri html_url: type: string format: uri id: - description: Unique identifier of the repository type: integer - is_template: - type: boolean - issue_comment_url: + login: type: string - format: uri-template - issue_events_url: + name: type: string - format: uri-template - issues_url: + node_id: type: string - format: uri-template - keys_url: + organizations_url: type: string - format: uri-template - labels_url: + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: type: string format: uri-template - language: + subscriptions_url: type: string - nullable: true - languages_url: + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: type: string format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: object + nullable: true + properties: + commit_message: + description: Commit message for the merge commit. + type: string + nullable: true + commit_title: + description: Title for the merge commit message. + type: string + nullable: true + enabled_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: string + nullable: true + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: string + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: string + nullable: true + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merge_commit_message: - description: |- - The default value for a merge commit message. + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: string + nullable: true + changed_files: + type: integer + closed_at: + type: string + nullable: true + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + commits: + type: integer + commits_url: + type: string + format: uri + created_at: + type: string + format: date-time + deletions: + type: integer + diff_url: + type: string + format: uri + draft: + description: Indicates whether or not the pull request is a draft. + type: boolean + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: string + nullable: true + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: string + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: string + nullable: true + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label type: object - nullable: true properties: - avatar_url: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - format: uri - deleted: + default: type: boolean - email: + description: type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri id: type: integer - login: - type: string name: + description: The name of the label. type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization url: + description: URL for the label type: string format: uri required: - - login - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label + - node_id + - url + - name + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + merge_commit_sha: + type: string + nullable: true + mergeable: + type: boolean + nullable: true + mergeable_state: + type: string + merged: + type: boolean + nullable: true + merged_at: + type: string + nullable: true + format: date-time + merged_by: + title: User type: object + nullable: true properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + avatar_url: type: string - default: + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id description: type: string nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: string - nullable: true - merged_at: - type: string - nullable: true - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - - title: Team + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within its + repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: boolean + nullable: true + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: object + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: + type: array + items: + title: Team description: Groups of organization members that gives permissions on specified repositories. type: object @@ -175637,577 +161093,331 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. + review_comment_url: + type: string + format: uri-template + review_comments: + type: integer + review_comments_url: + type: string + format: uri + state: + description: State of this Pull Request. Either `open` or `closed`. + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: + title: User type: object + nullable: true properties: + avatar_url: + type: string + format: uri deleted: type: boolean - description: - description: Description of the team + email: type: string nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: + events_url: type: string format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories + followers_url: type: string - privacy: + format: uri + following_url: type: string - enum: - - open - - closed - - secret - repositories_url: + format: uri-template + gists_url: type: string - format: uri - slug: + format: uri-template + gravatar_id: type: string - url: - description: URL for the team + html_url: type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: - "$ref": "#/components/schemas/repository-webhooks" - review: - description: The review that was affected. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the review. - type: string - nullable: true - commit_id: - description: A commit SHA for the review. - type: string - html_url: - type: string - format: uri - id: - description: Unique identifier of the review - type: integer - node_id: - type: string - pull_request_url: - type: string - format: uri - state: - type: string - submitted_at: - type: string - nullable: true - format: date-time - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - id - - node_id - - user - - body - - commit_id - - submitted_at - - state - - html_url - - pull_request_url - - author_association - - _links - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - review - - pull_request - - repository - - sender - webhook-pull-request-review-thread-resolved: - title: pull_request_review_thread resolved event - type: object - properties: - action: - type: string - enum: - - resolved - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Simple Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - assignees: - type: array - items: + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft + repository: + "$ref": "#/components/schemas/repository-webhooks" + requested_reviewer: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - requested_reviewer + - action + - number + - pull_request + - repository + - sender + - type: object + properties: + action: + type: string + enum: + - review_requested + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + number: + description: The pull request number. + type: integer + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: title: User type: object nullable: true @@ -176268,40 +161478,16 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri required: - login - id - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - auto_merge: - title: PullRequestAutoMerge - description: The status of auto merging a pull request. - type: object - nullable: true - properties: - commit_message: - description: Commit message for the merge commit. - type: string - nullable: true - commit_title: - description: Title for the merge commit message. - type: string - nullable: true - enabled_by: + assignees: + type: array + items: title: User type: object nullable: true @@ -176362,1386 +161548,1776 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri required: - login - id - merge_method: - description: The merge method to use. - type: string - enum: - - merge - - squash - - rebase - required: - - enabled_by - - merge_method - - commit_title - - commit_message - base: - type: object - properties: - label: - type: string - ref: - type: string - repo: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: object + nullable: true + properties: + commit_message: + description: Commit message for the merge commit. + type: string + nullable: true + commit_title: + description: Title for the merge commit message. + type: string + nullable: true + enabled_by: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: string + nullable: true + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: string + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: string + nullable: true + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: type: string - enum: - - Bot - - User - - Organization - url: + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + body: + type: string + nullable: true + changed_files: + type: integer + closed_at: + type: string + nullable: true + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + commits: + type: integer + commits_url: + type: string + format: uri + created_at: + type: string + format: date-time + deletions: + type: integer + diff_url: + type: string + format: uri + draft: + description: Indicates whether or not the pull request is a draft. + type: boolean + head: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository + type: object + properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: string + nullable: true + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: string + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: string + nullable: true + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: + url: type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean - required: - - id - - node_id - - name - - full_name - - private - - owner - - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - body: - type: string - nullable: true - closed_at: - type: string - nullable: true - comments_url: - type: string - format: uri - commits_url: - type: string - format: uri - created_at: - type: string - diff_url: - type: string - format: uri - draft: - type: boolean - head: - type: object - properties: - label: - type: string - nullable: true - ref: - type: string - repo: - title: Repository - description: A git repository + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label type: object - nullable: true properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - default_branch: - description: The default branch of the repository. + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests - are merged + default: type: boolean - default: false - deployments_url: - type: string - format: uri description: type: string nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri id: - description: Unique identifier of the repository type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - mirror_url: - type: string - nullable: true - format: uri name: - description: The name of the repository. + description: The name of the label. type: string node_id: type: string - notifications_url: - type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: - type: string - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time url: + description: URL for the label type: string format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on - web-based commits - type: boolean required: - id - node_id + - url - name - - full_name - - private - - owner - - html_url + - color + - default - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url - - created_at - - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility - sha: - type: string - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - label - - ref - - sha - - user - - repo - html_url: - type: string - format: uri - id: - type: integer - issue_url: - type: string - format: uri - labels: - type: array - items: - title: Label + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + merge_commit_sha: + type: string + nullable: true + mergeable: + type: boolean + nullable: true + mergeable_state: + type: string + merged: + type: boolean + nullable: true + merged_at: + type: string + nullable: true + format: date-time + merged_by: + title: User type: object + nullable: true properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' + avatar_url: type: string - default: + format: uri + deleted: type: boolean - description: + email: type: string nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri id: type: integer + login: + type: string name: - description: The name of the label. type: string node_id: type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization url: - description: URL for the label type: string format: uri required: + - login - id - - node_id - - url - - name - - color - - default - - description - locked: - type: boolean - merge_commit_sha: - type: string - nullable: true - merged_at: - type: string - nullable: true - milestone: - title: Milestone - description: A collection of related issues and pull requests. - type: object - nullable: true - properties: - closed_at: - type: string - nullable: true - format: date-time - closed_issues: - type: integer - created_at: - type: string - format: date-time - creator: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - description: - type: string - nullable: true - due_on: - type: string - nullable: true - format: date-time - html_url: - type: string - format: uri - id: - type: integer - labels_url: - type: string - format: uri - node_id: - type: string - number: - description: The number of the milestone. - type: integer - open_issues: - type: integer - state: - description: The state of the milestone. - type: string - enum: - - open - - closed - title: - description: The title of the milestone. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - url - - html_url - - labels_url - - id - - node_id - - number - - title - - description - - creator - - open_issues - - closed_issues - - state - - created_at - - updated_at - - due_on - - closed_at - node_id: - type: string - number: - type: integer - patch_url: - type: string - format: uri - requested_reviewers: - type: array - items: - oneOf: - - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - - title: Team + milestone: + title: Milestone + description: A collection of related issues and pull requests. + type: object + nullable: true + properties: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + description: + type: string + nullable: true + due_on: + type: string + nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + required: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within its + repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: boolean + nullable: true + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: object + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + requested_teams: + type: array + items: + title: Team description: Groups of organization members that gives permissions on specified repositories. type: object @@ -177840,552 +163416,255 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - requested_teams: - type: array - items: - title: Team - description: Groups of organization members that gives permissions - on specified repositories. + review_comment_url: + type: string + format: uri-template + review_comments: + type: integer + review_comments_url: + type: string + format: uri + state: + description: State of this Pull Request. Either `open` or `closed`. + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: + title: User type: object + nullable: true properties: + avatar_url: + type: string + format: uri deleted: type: boolean - description: - description: Description of the team + email: type: string nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string html_url: type: string format: uri id: - description: Unique identifier of the team type: integer - members_url: + login: type: string - format: uri-template name: - description: Name of the team type: string node_id: type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories + organizations_url: type: string - privacy: + format: uri + received_events_url: type: string - enum: - - open - - closed - - secret - repositories_url: + format: uri + repos_url: type: string format: uri - slug: + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: type: string + enum: + - Bot + - User + - Organization + - Mannequin url: - description: URL for the team type: string format: uri required: - - name + - login - id - review_comment_url: - type: string - format: uri-template - review_comments_url: - type: string - format: uri - state: - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - type: string - updated_at: - type: string - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft + repository: + "$ref": "#/components/schemas/repository-webhooks" + requested_team: + title: Team + description: Groups of organization members that gives permissions on + specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: type: object + nullable: true properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. + description: + description: Description of the team type: string + nullable: true html_url: - description: HTML URL for the pull request review comment. type: string format: uri id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment + description: Unique identifier of the team type: integer - nullable: true - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment - applies. + members_url: type: string - original_line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - nullable: true - original_position: - description: The index of the original line in the diff to which - the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: integer - nullable: true - path: - description: The relative path of the file to which the comment - applies. + format: uri-template + name: + description: Name of the team type: string - position: - description: The line index in the diff to which the comment applies. - type: integer - nullable: true - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: integer - nullable: true - pull_request_url: - description: URL for the pull request that the review comment - belongs to. + node_id: type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. + permission: + description: Permission that the team will have for its repositories type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: integer - nullable: true - start_side: - description: The side of the first line of the range for a multi-line - comment. + privacy: type: string - nullable: true enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be - a diff line or a file. + - open + - closed + - secret + repositories_url: type: string - enum: - - line - - file - updated_at: + format: uri + slug: type: string - format: date-time url: - description: URL for the pull request review comment + description: URL for the team type: string format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id required: - - url - - pull_request_review_id + - name - id - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at + - slug + - description + - privacy + - url - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - required: - - action - - thread - - pull_request - - repository - webhook-pull-request-review-thread-unresolved: - title: pull_request_review_thread unresolved event + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - requested_team + - action + - number + - pull_request + - repository + - sender + webhook-pull-request-review-submitted: + title: pull_request_review submitted event type: object properties: action: type: string enum: - - unresolved + - submitted enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -178550,6 +163829,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -178619,6 +163899,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -178651,6 +163932,7 @@ components: commit_title: description: Title for the merge commit message. type: string + nullable: true enabled_by: title: User type: object @@ -178933,6 +164215,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -179063,6 +164367,28 @@ components: nullable: true size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -179103,6 +164429,12 @@ components: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false visibility: type: string enum: @@ -179292,12 +164624,14 @@ components: properties: label: type: string + nullable: true ref: type: string repo: title: Repository description: A git repository type: object + nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -179490,6 +164824,28 @@ components: - node_id master_branch: type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE merges_url: type: string format: uri @@ -179620,6 +164976,28 @@ components: nullable: true size: type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -179660,6 +165038,12 @@ components: url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false visibility: type: string enum: @@ -179951,6 +165335,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -180082,6 +165467,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -180187,6 +165573,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -180310,530 +165705,6 @@ components: type: string format: uri user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - draft - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - thread: - type: object - properties: - comments: - type: array - items: - title: Pull Request Review Comment - description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) - itself. - type: object - properties: - _links: - type: object - properties: - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - pull_request: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - pull_request - author_association: - title: AuthorAssociation - description: How the author is associated with the repository. - type: string - enum: - - COLLABORATOR - - CONTRIBUTOR - - FIRST_TIMER - - FIRST_TIME_CONTRIBUTOR - - MANNEQUIN - - MEMBER - - NONE - - OWNER - body: - description: The text of the comment. - type: string - commit_id: - description: The SHA of the commit to which the comment applies. - type: string - created_at: - type: string - format: date-time - diff_hunk: - description: The diff of the line that the comment refers to. - type: string - html_url: - description: HTML URL for the pull request review comment. - type: string - format: uri - id: - description: The ID of the pull request review comment. - type: integer - in_reply_to_id: - description: The comment ID to reply to. - type: integer - line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - nullable: true - node_id: - description: The node ID of the pull request review comment. - type: string - original_commit_id: - description: The SHA of the original commit to which the comment - applies. - type: string - original_line: - description: The line of the blob to which the comment applies. - The last line of the range for a multi-line comment - type: integer - original_position: - description: The index of the original line in the diff to which - the comment applies. - type: integer - original_start_line: - description: The first line of the range for a multi-line comment. - type: integer - nullable: true - path: - description: The relative path of the file to which the comment - applies. - type: string - position: - description: The line index in the diff to which the comment applies. - type: integer - nullable: true - pull_request_review_id: - description: The ID of the pull request review to which the comment - belongs. - type: integer - nullable: true - pull_request_url: - description: URL for the pull request that the review comment - belongs to. - type: string - format: uri - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - side: - description: The side of the first line of the range for a multi-line - comment. - type: string - enum: - - LEFT - - RIGHT - start_line: - description: The first line of the range for a multi-line comment. - type: integer - nullable: true - start_side: - description: The side of the first line of the range for a multi-line - comment. - type: string - nullable: true - enum: - - LEFT - - RIGHT - - - default: RIGHT - subject_type: - description: The level at which the comment is targeted, can be - a diff line or a file. - type: string - enum: - - line - - file - updated_at: - type: string - format: date-time - url: - description: URL for the pull request review comment - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - pull_request_review_id - - id - - node_id - - diff_hunk - - path - - position - - original_position - - commit_id - - original_commit_id - - user - - body - - created_at - - updated_at - - html_url - - pull_request_url - - author_association - - _links - - start_line - - original_start_line - - original_line - - line - - start_side - - side - - reactions - node_id: - type: string - required: - - node_id - - comments - required: - - action - - thread - - pull_request - - repository - webhook-pull-request-synchronize: - title: pull_request synchronize event - type: object - properties: - action: - type: string - enum: - - synchronize - after: - type: string - before: - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pull_request: - title: Pull Request - type: object - properties: - _links: - type: object - properties: - comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - commits: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - html: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - issue: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comment: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - review_comments: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - self: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - statuses: - title: Link - type: object - properties: - href: - type: string - format: uri-template - required: - - href - required: - - self - - html - - issue - - comments - - review_comments - - review_comment - - commits - - statuses - active_lock_reason: - type: string - nullable: true - enum: - - resolved - - off-topic - - too heated - - spam - - - additions: - type: integer - assignee: title: User type: object nullable: true @@ -180901,6 +165772,233 @@ components: required: - login - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - draft + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + repository: + "$ref": "#/components/schemas/repository-webhooks" + review: + "$ref": "#/components/schemas/webhooks_review" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - review + - pull_request + - repository + - sender + webhook-pull-request-review-thread-resolved: + title: pull_request_review_thread resolved event + type: object + properties: + action: + type: string + enum: + - resolved + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + pull_request: + title: Simple Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id assignees: type: array items: @@ -180964,7 +166062,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -181280,28 +166377,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -181432,28 +166507,6 @@ components: nullable: true size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -181494,12 +166547,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -181668,44 +166715,35 @@ components: body: type: string nullable: true - changed_files: - type: integer closed_at: type: string nullable: true - format: date-time - comments: - type: integer comments_url: type: string format: uri - commits: - type: integer commits_url: type: string format: uri created_at: type: string - format: date-time - deletions: - type: integer diff_url: type: string format: uri draft: - description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string + nullable: true ref: type: string repo: title: Repository description: A git repository type: object + nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -181898,19 +166936,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: The default value for a merge commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: The default value for a merge commit message title. - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -182041,28 +167066,6 @@ components: nullable: true size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -182103,12 +167106,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -182318,91 +167315,12 @@ components: - description locked: type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull request. - type: boolean merge_commit_sha: type: string nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true merged_at: type: string nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -182479,7 +167397,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -182543,15 +167460,10 @@ components: node_id: type: string number: - description: Number uniquely identifying the pull request within its - repository. type: integer patch_url: type: string format: uri - rebaseable: - type: boolean - nullable: true requested_reviewers: type: array items: @@ -182835,13 +167747,10 @@ components: review_comment_url: type: string format: uri-template - review_comments: - type: integer review_comments_url: type: string format: uri state: - description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -182850,11 +167759,9 @@ components: type: string format: uri title: - description: The title of the pull request. type: string updated_at: type: string - format: date-time url: type: string format: uri @@ -182951,6 +167858,7 @@ components: - requested_teams - labels - milestone + - draft - commits_url - review_comments_url - review_comment_url @@ -182962,106 +167870,324 @@ components: - author_association - auto_merge - active_lock_reason - - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" + thread: + type: object + properties: + comments: + type: array + items: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: integer + nullable: true + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the comment + applies. + type: string + original_line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: integer + nullable: true + original_position: + description: The index of the original line in the diff to which + the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line comment. + type: integer + nullable: true + path: + description: The relative path of the file to which the comment + applies. + type: string + position: + description: The line index in the diff to which the comment applies. + type: integer + nullable: true + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: integer + nullable: true + pull_request_url: + description: URL for the pull request that the review comment + belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for a multi-line + comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line comment. + type: integer + nullable: true + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: string + nullable: true + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, can be + a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments required: - action - - number - - before - - after + - thread - pull_request - repository - - sender - webhook-pull-request-unassigned: - title: pull_request unassigned event + webhook-pull-request-review-thread-unresolved: + title: pull_request_review_thread unresolved event type: object properties: action: type: string enum: - - unassigned - assignee: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id + - unresolved enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" - number: - description: The pull request number. - type: integer organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: - title: Pull Request + title: Simple Pull Request type: object properties: _links: @@ -183157,8 +168283,6 @@ components: - too heated - spam - - additions: - type: integer assignee: title: User type: object @@ -183220,7 +168344,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -183290,7 +168413,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -183323,7 +168445,6 @@ components: commit_title: description: Title for the merge commit message. type: string - nullable: true enabled_by: title: User type: object @@ -183408,7 +168529,6 @@ components: properties: label: type: string - nullable: true ref: type: string repo: @@ -183607,28 +168727,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -183759,28 +168857,6 @@ components: nullable: true size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -183821,12 +168897,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -183995,46 +169065,33 @@ components: body: type: string nullable: true - changed_files: - type: integer closed_at: type: string nullable: true - format: date-time - comments: - type: integer comments_url: type: string format: uri - commits: - type: integer commits_url: type: string format: uri created_at: type: string - format: date-time - deletions: - type: integer diff_url: type: string format: uri draft: - description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string - nullable: true ref: type: string repo: title: Repository description: A git repository type: object - nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -184227,28 +169284,6 @@ components: - node_id master_branch: type: string - merge_commit_message: - description: |- - The default value for a merge commit message. - - - `PR_TITLE` - default to the pull request's title. - - `PR_BODY` - default to the pull request's body. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - PR_TITLE - - BLANK - merge_commit_title: - description: |- - The default value for a merge commit title. - - - `PR_TITLE` - default to the pull request's title. - - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - type: string - enum: - - PR_TITLE - - MERGE_MESSAGE merges_url: type: string format: uri @@ -184379,28 +169414,6 @@ components: nullable: true size: type: integer - squash_merge_commit_message: - description: |- - The default value for a squash merge commit message: - - - `PR_BODY` - default to the pull request's body. - - `COMMIT_MESSAGES` - default to the branch's commit messages. - - `BLANK` - default to a blank commit message. - type: string - enum: - - PR_BODY - - COMMIT_MESSAGES - - BLANK - squash_merge_commit_title: - description: |- - The default value for a squash merge commit title: - - - `PR_TITLE` - default to the pull request's title. - - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - type: string - enum: - - PR_TITLE - - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: @@ -184441,12 +169454,6 @@ components: url: type: string format: uri - use_squash_pr_title_as_default: - description: Whether a squash merge commit can use the pull - request title as default. **This property has been deprecated. - Please use `squash_merge_commit_title` instead. - type: boolean - default: false visibility: type: string enum: @@ -184656,92 +169663,12 @@ components: - description locked: type: boolean - maintainer_can_modify: - description: Indicates whether maintainers can modify the pull request. - type: boolean merge_commit_sha: type: string nullable: true - mergeable: - type: boolean - nullable: true - mergeable_state: - type: string - merged: - type: boolean - nullable: true merged_at: type: string nullable: true - format: date-time - merged_by: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - - Mannequin - url: - type: string - format: uri - required: - - login - - id milestone: title: Milestone description: A collection of related issues and pull requests. @@ -184818,7 +169745,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -184882,15 +169808,10 @@ components: node_id: type: string number: - description: Number uniquely identifying the pull request within its - repository. type: integer patch_url: type: string format: uri - rebaseable: - type: boolean - nullable: true requested_reviewers: type: array items: @@ -184955,7 +169876,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -185061,15 +169981,6 @@ components: required: - name - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission requested_teams: type: array items: @@ -185174,13 +170085,10 @@ components: review_comment_url: type: string format: uri-template - review_comments: - type: integer review_comments_url: type: string format: uri state: - description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open @@ -185189,11 +170097,9 @@ components: type: string format: uri title: - description: The title of the pull request. type: string updated_at: type: string - format: date-time url: type: string format: uri @@ -185258,7 +170164,6 @@ components: - Bot - User - Organization - - Mannequin url: type: string format: uri @@ -185290,6 +170195,7 @@ components: - requested_teams - labels - milestone + - draft - commits_url - review_comments_url - review_comment_url @@ -185301,63 +170207,324 @@ components: - author_association - auto_merge - active_lock_reason - - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" + thread: + type: object + properties: + comments: + type: array + items: + title: Pull Request Review Comment + description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) + itself. + type: object + properties: + _links: + type: object + properties: + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + pull_request: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - pull_request + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + body: + description: The text of the comment. + type: string + commit_id: + description: The SHA of the commit to which the comment applies. + type: string + created_at: + type: string + format: date-time + diff_hunk: + description: The diff of the line that the comment refers to. + type: string + html_url: + description: HTML URL for the pull request review comment. + type: string + format: uri + id: + description: The ID of the pull request review comment. + type: integer + in_reply_to_id: + description: The comment ID to reply to. + type: integer + line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: integer + nullable: true + node_id: + description: The node ID of the pull request review comment. + type: string + original_commit_id: + description: The SHA of the original commit to which the comment + applies. + type: string + original_line: + description: The line of the blob to which the comment applies. + The last line of the range for a multi-line comment + type: integer + original_position: + description: The index of the original line in the diff to which + the comment applies. + type: integer + original_start_line: + description: The first line of the range for a multi-line comment. + type: integer + nullable: true + path: + description: The relative path of the file to which the comment + applies. + type: string + position: + description: The line index in the diff to which the comment applies. + type: integer + nullable: true + pull_request_review_id: + description: The ID of the pull request review to which the comment + belongs. + type: integer + nullable: true + pull_request_url: + description: URL for the pull request that the review comment + belongs to. + type: string + format: uri + reactions: + title: Reactions + type: object + properties: + "+1": + type: integer + "-1": + type: integer + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: + type: string + format: uri + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket + side: + description: The side of the first line of the range for a multi-line + comment. + type: string + enum: + - LEFT + - RIGHT + start_line: + description: The first line of the range for a multi-line comment. + type: integer + nullable: true + start_side: + description: The side of the first line of the range for a multi-line + comment. + type: string + nullable: true + enum: + - LEFT + - RIGHT + - + default: RIGHT + subject_type: + description: The level at which the comment is targeted, can be + a diff line or a file. + type: string + enum: + - line + - file + updated_at: + type: string + format: date-time + url: + description: URL for the pull request review comment + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - url + - pull_request_review_id + - id + - node_id + - diff_hunk + - path + - position + - original_position + - commit_id + - original_commit_id + - user + - body + - created_at + - updated_at + - html_url + - pull_request_url + - author_association + - _links + - start_line + - original_start_line + - original_line + - line + - start_side + - side + - reactions + node_id: + type: string + required: + - node_id + - comments required: - action - - number + - thread - pull_request - repository - webhook-pull-request-unlabeled: - title: pull_request unlabeled event + webhook-pull-request-synchronize: + title: pull_request synchronize event type: object properties: action: type: string enum: - - unlabeled + - synchronize + after: + type: string + before: + type: string enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" - label: - title: Label - type: object - properties: - color: - description: '6-character hex code, without the leading #, identifying - the color' - type: string - default: - type: boolean - description: - type: string - nullable: true - id: - type: integer - name: - description: The name of the label. - type: string - node_id: - type: string - url: - description: URL for the label - type: string - format: uri - required: - - id - - node_id - - url - - name - - color - - default - - description number: - description: The pull request number. - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: @@ -186326,14 +171493,12 @@ components: properties: label: type: string - nullable: true ref: type: string repo: title: Repository description: A git repository type: object - nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. @@ -187598,24 +172763,27 @@ components: required: - action - number + - before + - after - pull_request - repository - sender - webhook-pull-request-unlocked: - title: pull_request unlocked event + webhook-pull-request-unassigned: + title: pull_request unassigned event type: object properties: action: type: string enum: - - unlocked + - unassigned + assignee: + "$ref": "#/components/schemas/webhooks_user_mannequin" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" number: - description: The pull request number. - type: integer + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" pull_request: @@ -187778,6 +172946,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -187847,6 +173016,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -187879,6 +173049,7 @@ components: commit_title: description: Title for the merge commit message. type: string + nullable: true enabled_by: title: User type: object @@ -187963,6 +173134,7 @@ components: properties: label: type: string + nullable: true ref: type: string repo: @@ -188581,6 +173753,7 @@ components: properties: label: type: string + nullable: true ref: type: string repo: @@ -189288,6 +174461,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -189370,6 +174544,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -189506,6 +174681,7 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri @@ -189611,6 +174787,15 @@ components: required: - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission requested_teams: type: array items: @@ -189663,663 +174848,82 @@ components: type: string permission: description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - review_comment_url: - type: string - format: uri-template - review_comments: - type: integer - review_comments_url: - type: string - format: uri - state: - description: State of this Pull Request. Either `open` or `closed`. - type: string - enum: - - open - - closed - statuses_url: - type: string - format: uri - title: - description: The title of the pull request. - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - required: - - url - - id - - node_id - - html_url - - diff_url - - patch_url - - issue_url - - number - - state - - locked - - title - - user - - body - - created_at - - updated_at - - closed_at - - merged_at - - merge_commit_sha - - assignee - - assignees - - requested_reviewers - - requested_teams - - labels - - milestone - - commits_url - - review_comments_url - - review_comment_url - - comments_url - - statuses_url - - head - - base - - _links - - author_association - - auto_merge - - active_lock_reason - - draft - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - number - - pull_request - - repository - - sender - webhook-push: - title: push event - type: object - properties: - after: - description: The SHA of the most recent commit on `ref` after the push. - type: string - base_ref: - type: string - nullable: true - before: - description: The SHA of the most recent commit on `ref` before the push. - type: string - commits: - description: An array of commit objects describing the pushed commits. (Pushed - commits are all commits that are included in the `compare` between the - `before` commit and the `after` commit.) The array includes a maximum - of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) - to fetch additional commits. This limit is applied to timeline events - only and isn't applied to webhook deliveries. - type: array - items: - title: Commit - type: object - properties: - added: - description: An array of files added in the commit. - type: array - items: - type: string - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - distinct: - description: Whether this commit is distinct from any that have been - pushed before. - type: boolean - id: - type: string - message: - description: The commit message. - type: string - modified: - description: An array of files modified by the commit. - type: array - items: - type: string - removed: - description: An array of files removed in the commit. - type: array - items: - type: string - timestamp: - description: The ISO 8601 timestamp of the commit. - type: string - format: date-time - tree_id: - type: string - url: - description: URL that points to the commit API resource. - type: string - format: uri - required: - - id - - tree_id - - distinct - - message - - timestamp - - url - - author - - committer - compare: - description: URL that shows the changes in this `ref` update, from the `before` - commit to the `after` commit. For a newly created `ref` that is directly - based on the default branch, this is the comparison between the head of - the default branch and the `after` commit. Otherwise, this shows all commits - until the `after` commit. - type: string - created: - description: Whether this push created the `ref`. - type: boolean - deleted: - description: Whether this push deleted the `ref`. - type: boolean - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - forced: - description: Whether this push was a force push of the `ref`. - type: boolean - head_commit: - title: Commit - type: object - nullable: true - properties: - added: - description: An array of files added in the commit. - type: array - items: - type: string - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - distinct: - description: Whether this commit is distinct from any that have been - pushed before. - type: boolean - id: - type: string - message: - description: The commit message. - type: string - modified: - description: An array of files modified by the commit. - type: array - items: - type: string - removed: - description: An array of files removed in the commit. - type: array - items: - type: string - timestamp: - description: The ISO 8601 timestamp of the commit. - type: string - format: date-time - tree_id: - type: string - url: - description: URL that points to the commit API resource. - type: string - format: uri - required: - - id - - tree_id - - distinct - - message - - timestamp - - url - - author - - committer - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - pusher: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - name - ref: - description: 'The full git ref that was pushed. Example: `refs/heads/main` - or `refs/tags/v3.14.1`.' - type: string - repository: - title: Repository - description: A git repository - type: object - properties: - allow_auto_merge: - description: Whether to allow auto-merge for pull requests. - type: boolean - default: false - allow_forking: - description: Whether to allow private forks - type: boolean - allow_merge_commit: - description: Whether to allow merge commits for pull requests. - type: boolean - default: true - allow_rebase_merge: - description: Whether to allow rebase merges for pull requests. - type: boolean - default: true - allow_squash_merge: - description: Whether to allow squash merges for pull requests. - type: boolean - default: true - allow_update_branch: - type: boolean - archive_url: - type: string - format: uri-template - archived: - description: Whether the repository is archived. - type: boolean - default: false - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - clone_url: - type: string - format: uri - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - created_at: - oneOf: - - type: integer - - type: string - format: date-time - custom_properties: - type: object - description: The custom properties that were defined for the repository. - The keys are the custom property names, and the values are the corresponding - custom property values. - additionalProperties: true - default_branch: - description: The default branch of the repository. - type: string - delete_branch_on_merge: - description: Whether to delete head branches when pull requests are - merged - type: boolean - default: false - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - disabled: - description: Returns whether or not this repository is disabled. - type: boolean - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks: - type: integer - forks_count: - type: integer - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - git_url: - type: string - format: uri - has_downloads: - description: Whether downloads are enabled. - type: boolean - default: true - has_issues: - description: Whether issues are enabled. - type: boolean - default: true - has_pages: - type: boolean - has_projects: - description: Whether projects are enabled. - type: boolean - default: true - has_wiki: - description: Whether the wiki is enabled. - type: boolean - default: true - has_discussions: - description: Whether discussions are enabled. - type: boolean - default: false - homepage: - type: string - nullable: true - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - is_template: - type: boolean - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + review_comment_url: type: string format: uri-template - language: - type: string - nullable: true - languages_url: - type: string - format: uri - license: - title: License - type: object - nullable: true - properties: - key: - type: string - name: - type: string - node_id: - type: string - spdx_id: - type: string - url: - type: string - nullable: true - format: uri - required: - - key - - name - - spdx_id - - url - - node_id - master_branch: - type: string - merges_url: + review_comments: + type: integer + review_comments_url: type: string format: uri - milestones_url: + state: + description: State of this Pull Request. Either `open` or `closed`. type: string - format: uri-template - mirror_url: + enum: + - open + - closed + statuses_url: type: string - nullable: true format: uri - name: - description: The name of the repository. - type: string - node_id: + title: + description: The title of the pull request. type: string - notifications_url: + updated_at: type: string - format: uri-template - open_issues: - type: integer - open_issues_count: - type: integer - organization: + format: date-time + url: type: string - owner: + format: uri + user: title: User type: object nullable: true @@ -190380,1227 +174984,1682 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri required: - login - id - permissions: - type: object - properties: - admin: - type: boolean - maintain: - type: boolean - pull: - type: boolean - push: - type: boolean - triage: - type: boolean - required: - - pull - - push - - admin - private: - description: Whether the repository is private or public. - type: boolean - public: - type: boolean - pulls_url: - type: string - format: uri-template - pushed_at: - nullable: true - oneOf: - - type: integer - - type: string - format: date-time - releases_url: - type: string - format: uri-template - role_name: - type: string - nullable: true - size: - type: integer - ssh_url: - type: string - stargazers: - type: integer - stargazers_count: - type: integer - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - svn_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - topics: - type: array - items: - type: string - trees_url: - type: string - format: uri-template - updated_at: - type: string - format: date-time - url: - type: string - format: uri - visibility: - type: string - enum: - - public - - private - - internal - watchers: - type: integer - watchers_count: - type: integer - web_commit_signoff_required: - description: Whether to require contributors to sign off on web-based - commits - type: boolean required: + - url - id - node_id - - name - - full_name - - private - - owner - html_url - - description - - fork - - url - - forks_url - - keys_url - - collaborators_url - - teams_url - - hooks_url - - issue_events_url - - events_url - - assignees_url - - branches_url - - tags_url - - blobs_url - - git_tags_url - - git_refs_url - - trees_url - - statuses_url - - languages_url - - stargazers_url - - contributors_url - - subscribers_url - - subscription_url - - commits_url - - git_commits_url - - comments_url - - issue_comment_url - - contents_url - - compare_url - - merges_url - - archive_url - - downloads_url - - issues_url - - pulls_url - - milestones_url - - notifications_url - - labels_url - - releases_url - - deployments_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body - created_at - updated_at - - pushed_at - - git_url - - ssh_url - - clone_url - - svn_url - - homepage - - size - - stargazers_count - - watchers_count - - language - - has_issues - - has_projects - - has_downloads - - has_wiki - - has_pages - - has_discussions - - forks_count - - mirror_url - - archived - - open_issues_count - - license - - forks - - open_issues - - watchers - - default_branch - - topics - - visibility + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft + repository: + "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - - ref - - before - - after - - created - - deleted - - forced - - base_ref - - compare - - commits - - head_commit + - action + - number + - pull_request - repository - - pusher - webhook-registry-package-published: + webhook-pull-request-unlabeled: + title: pull_request unlabeled event type: object properties: action: type: string enum: - - published + - unlabeled enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + label: + "$ref": "#/components/schemas/webhooks_label" + number: + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" - registry_package: + pull_request: + title: Pull Request type: object properties: - created_at: - type: string - nullable: true - description: + _links: + type: object + properties: + comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: + type: string + format: uri-template + required: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: type: string nullable: true - ecosystem: - type: string - html_url: - type: string - id: + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: type: integer - name: - type: string - namespace: - type: string - owner: + assignee: + title: User type: object + nullable: true properties: avatar_url: type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string + format: uri-template gravatar_id: type: string html_url: type: string + format: uri id: type: integer login: type: string + name: + type: string node_id: type: string organizations_url: type: string + format: uri received_events_url: type: string + format: uri repos_url: type: string + format: uri site_admin: type: boolean starred_url: type: string + format: uri-template subscriptions_url: type: string + format: uri type: type: string + enum: + - Bot + - User + - Organization + - Mannequin url: type: string + format: uri required: - login - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - package_type: + assignees: + type: array + items: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. type: string - package_version: + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. type: object nullable: true properties: - author: + commit_message: + description: Commit message for the merge commit. + type: string + nullable: true + commit_title: + description: Title for the merge commit message. + type: string + nullable: true + enabled_by: + title: User type: object + nullable: true properties: avatar_url: type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string + format: uri-template gravatar_id: type: string html_url: type: string + format: uri id: type: integer login: type: string + name: + type: string node_id: type: string organizations_url: type: string + format: uri received_events_url: type: string + format: uri repos_url: type: string + format: uri site_admin: type: boolean starred_url: type: string + format: uri-template subscriptions_url: type: string + format: uri type: type: string + enum: + - Bot + - User + - Organization url: type: string + format: uri required: - login - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - body: - oneOf: - - type: string - - type: object - body_html: - type: string - container_metadata: - type: object - properties: - labels: - type: object - nullable: true - manifest: - type: object - nullable: true - tag: - type: object - properties: - digest: - type: string - name: - type: string - created_at: - type: string - description: - type: string - docker_metadata: - type: array - items: - type: object - properties: - tags: - type: array - items: - type: string - draft: - type: boolean - html_url: - type: string - id: - type: integer - installation_command: + merge_method: + description: The merge method to use. type: string - manifest: + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: type: string - metadata: - type: array - items: - type: object - additionalProperties: true - name: + ref: type: string - npm_metadata: + repo: + title: Repository + description: A git repository type: object - nullable: true properties: - name: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: type: string - version: + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: type: string - npm_user: + format: uri-template + blobs_url: type: string - author: - oneOf: - - type: string - - type: object - nullable: true - bugs: + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: oneOf: + - type: integer - type: string - - type: object - nullable: true - dependencies: - type: object - dev_dependencies: - type: object - peer_dependencies: - type: object - optional_dependencies: - type: object + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri description: type: string - dist: - oneOf: - - type: string - - type: object nullable: true - git_head: + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: type: string - homepage: + format: uri + events_url: type: string - license: + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: type: string - main: + format: uri + full_name: type: string - repository: - oneOf: - - type: string - - type: object - nullable: true - scripts: - type: object - id: + git_commits_url: type: string - node_version: + format: uri-template + git_refs_url: type: string - npm_version: + format: uri-template + git_tags_url: type: string - has_shrinkwrap: + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. type: boolean - maintainers: - type: array - items: - type: string - contributors: - type: array - items: - type: string - engines: - type: object - keywords: - type: array - items: - type: string - files: - type: array - items: - type: string - bin: - type: object - man: - type: object - directories: - oneOf: - - type: string - - type: object + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: string nullable: true - os: - type: array - items: - type: string - cpu: - type: array - items: - type: string - readme: + hooks_url: type: string - installation_command: + format: uri + html_url: type: string - release_id: + format: uri + id: + description: Unique identifier of the repository type: integer - commit_oid: - type: string - published_via_actions: + is_template: type: boolean - deleted_by_id: - type: integer - nuget_metadata: - type: array - nullable: true - items: - type: object - properties: - id: - oneOf: - - type: string - - type: object - - type: integer - nullable: true - name: - type: string - value: - oneOf: - - type: boolean - - type: string - - type: integer - - type: object - properties: - url: - type: string - branch: - type: string - commit: - type: string - type: - type: string - package_files: - type: array - items: - type: object - properties: - content_type: - type: string - created_at: - type: string - download_url: - type: string - id: - type: integer - md5: - type: string - nullable: true - name: - type: string - sha1: - type: string - nullable: true - sha256: - type: string - nullable: true - size: - type: integer - state: - type: string - nullable: true - updated_at: - type: string - required: - - download_url - - id - - name - - sha256 - - sha1 - - md5 - - content_type - - state - - size - - created_at - - updated_at - package_url: - type: string - prerelease: - type: boolean - release: - type: object - properties: - author: + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: string + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: string + nullable: true + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User type: object + nullable: true properties: avatar_url: type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string + format: uri-template gravatar_id: type: string html_url: type: string + format: uri id: type: integer login: type: string + name: + type: string node_id: type: string organizations_url: type: string + format: uri received_events_url: type: string + format: uri repos_url: type: string + format: uri site_admin: type: boolean starred_url: type: string + format: uri-template subscriptions_url: type: string + format: uri type: type: string + enum: + - Bot + - User + - Organization url: type: string - created_at: - type: string - draft: + format: uri + required: + - login + - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. type: boolean - html_url: + public: + type: boolean + pulls_url: type: string - id: - type: integer - name: + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: type: string nullable: true - prerelease: - type: boolean - published_at: + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. type: string - tag_name: + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). type: string - target_commitish: + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: type: string + format: uri-template + updated_at: + type: string + format: date-time url: type: string - rubygems_metadata: - type: array - items: - "$ref": "#/components/schemas/webhook-rubygems-metadata" - summary: - type: string - tag_name: - type: string - target_commitish: - type: string - target_oid: - type: string - updated_at: - type: string - version: - type: string - required: - - id - - version - - name - - description - - summary - - html_url - - metadata - - package_files - - installation_command - - package_url - registry: - type: object - nullable: true - properties: - about_url: - type: string - name: - type: string - type: - type: string - url: - type: string - vendor: - type: string - updated_at: - type: string - nullable: true - required: - - id - - name - - namespace - - description - - ecosystem - - package_type - - html_url - - created_at - - updated_at - - owner - - package_version - - registry - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - registry_package - - sender - webhook-registry-package-updated: - type: object - properties: - action: - type: string - enum: - - updated - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - registry_package: - type: object - properties: - created_at: - type: string - description: - nullable: true - ecosystem: - type: string - html_url: - type: string - id: - type: integer - name: - type: string - namespace: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: type: string - required: - - login - - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - package_type: - type: string - package_version: - type: object - properties: - author: + user: + title: User type: object + nullable: true properties: avatar_url: type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string + format: uri-template gravatar_id: type: string html_url: type: string + format: uri id: type: integer login: type: string + name: + type: string node_id: type: string organizations_url: type: string + format: uri received_events_url: type: string + format: uri repos_url: type: string + format: uri site_admin: type: boolean starred_url: type: string + format: uri-template subscriptions_url: type: string + format: uri type: type: string + enum: + - Bot + - User + - Organization url: type: string + format: uri required: - login - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - body: - type: string - body_html: - type: string - created_at: - type: string - description: - type: string - docker_metadata: - type: array - items: - type: object - nullable: true - properties: - tags: - type: array - items: - type: string - draft: - type: boolean - html_url: - type: string - id: - type: integer - installation_command: - type: string - manifest: - type: string - metadata: - type: array - items: - type: object - additionalProperties: true - name: + required: + - label + - ref + - sha + - user + - repo + body: + type: string + nullable: true + changed_files: + type: integer + closed_at: + type: string + nullable: true + format: date-time + comments: + type: integer + comments_url: + type: string + format: uri + commits: + type: integer + commits_url: + type: string + format: uri + created_at: + type: string + format: date-time + deletions: + type: integer + diff_url: + type: string + format: uri + draft: + description: Indicates whether or not the pull request is a draft. + type: boolean + head: + type: object + properties: + label: type: string - package_files: - type: array - items: - type: object - properties: - content_type: - type: string - created_at: - type: string - download_url: - type: string - id: - type: integer - md5: - type: string - nullable: true - name: - type: string - sha1: - type: string - nullable: true - sha256: - type: string - size: - type: integer - state: - type: string - updated_at: - type: string - package_url: + nullable: true + ref: type: string - prerelease: - type: boolean - release: + repo: + title: Repository + description: A git repository type: object + nullable: true properties: - author: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: string + nullable: true + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: string + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: The default value for a merge commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: The default value for a merge commit message title. + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: string + nullable: true + format: uri + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: + type: string + owner: + title: User type: object + nullable: true properties: avatar_url: type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true events_url: type: string + format: uri-template followers_url: type: string + format: uri following_url: type: string + format: uri-template gists_url: type: string + format: uri-template gravatar_id: type: string html_url: type: string + format: uri id: type: integer login: type: string + name: + type: string node_id: type: string organizations_url: type: string + format: uri received_events_url: type: string + format: uri repos_url: type: string + format: uri site_admin: type: boolean starred_url: type: string + format: uri-template subscriptions_url: type: string + format: uri type: type: string + enum: + - Bot + - User + - Organization url: type: string + format: uri required: - login - id - - node_id - - avatar_url - - gravatar_id - - url - - html_url - - followers_url - - following_url - - gists_url - - starred_url - - subscriptions_url - - organizations_url - - repos_url - - events_url - - received_events_url - - type - - site_admin - created_at: + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: object + nullable: true + properties: + avatar_url: type: string - draft: + format: uri + deleted: type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string html_url: type: string + format: uri id: type: integer + login: + type: string name: type: string - prerelease: + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: type: boolean - published_at: + starred_url: type: string - tag_name: + format: uri-template + subscriptions_url: type: string - target_commitish: + format: uri + type: type: string + enum: + - Bot + - User + - Organization url: type: string + format: uri required: - - url - - html_url + - login - id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - rubygems_metadata: - type: array - items: - "$ref": "#/components/schemas/webhook-rubygems-metadata" - summary: - type: string - tag_name: - type: string - target_commitish: - type: string - target_oid: - type: string - updated_at: - type: string - version: - type: string required: - - id - - version - - name - - description - - summary - - body - - body_html - - html_url - - target_commitish - - target_oid - - created_at - - updated_at - - metadata - - package_files - - author - - installation_command - - package_url - registry: - type: object - nullable: true - updated_at: + - label + - ref + - sha + - user + - repo + html_url: type: string - required: - - id - - name - - namespace - - description - - ecosystem - - package_type - - html_url - - created_at - - updated_at - - owner - - package_version - - registry - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - registry_package - - sender - webhook-release-created: - title: release created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - release: - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: type: array items: - title: Release Asset - description: Data related to a release. + title: Label type: object properties: - browser_download_url: - type: string - format: uri - content_type: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - created_at: + default: + type: boolean + description: type: string - format: date-time - download_count: - type: integer + nullable: true id: type: integer - label: - type: string - nullable: true name: - description: The file name of the asset. + description: The name of the label. type: string node_id: type: string - size: - type: integer - state: - description: State of the release asset. - type: string - enum: - - uploaded - updated_at: - type: string - format: date-time - uploader: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id url: + description: URL for the label type: string format: uri required: - - url - - browser_download_url - id - node_id + - url - name - - label - - state - - content_type - - size - - download_count - - created_at - - updated_at - assets_url: + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + merge_commit_sha: type: string - format: uri - author: + nullable: true + mergeable: + type: boolean + nullable: true + mergeable_state: + type: string + merged: + type: boolean + nullable: true + merged_at: + type: string + nullable: true + format: date-time + merged_by: title: User type: object nullable: true @@ -191667,622 +176726,462 @@ components: required: - login - id - body: - type: string - nullable: true - created_at: - type: string - nullable: true - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - nullable: true - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease or a - full release. - type: boolean - published_at: - type: string - nullable: true - format: date-time - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: string - nullable: true - format: uri - target_commitish: - description: Specifies the commitish value that determines where the - Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - url: - type: string - format: uri - zipball_url: - type: string - nullable: true - format: uri - required: - - url - - assets_url - - upload_url - - html_url - - id - - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - - assets - - tarball_url - - zipball_url - - body - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - release - - repository - - sender - webhook-release-deleted: - title: release deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - release: - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: - type: array - items: - title: Release Asset - description: Data related to a release. - type: object - properties: - browser_download_url: - type: string - format: uri - content_type: - type: string - created_at: - type: string - format: date-time - download_count: - type: integer - id: - type: integer - label: - type: string - nullable: true - name: - description: The file name of the asset. - type: string - node_id: - type: string - size: - type: integer - state: - description: State of the release asset. - type: string - enum: - - uploaded - updated_at: - type: string - format: date-time - uploader: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - url: - type: string - format: uri - required: - - url - - browser_download_url - - id - - node_id - - name - - label - - state - - content_type - - size - - download_count - - created_at - - updated_at - assets_url: - type: string - format: uri - author: - title: User + milestone: + title: Milestone + description: A collection of related issues and pull requests. type: object nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + closed_at: type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: + format: date-time + closed_issues: + type: integer + created_at: type: string - format: uri-template - gists_url: + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + description: type: string - format: uri-template - gravatar_id: + nullable: true + due_on: type: string + nullable: true + format: date-time html_url: type: string format: uri id: type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: + labels_url: type: string format: uri - repos_url: + node_id: type: string - format: uri - site_admin: - type: boolean - starred_url: + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. type: string - format: uri-template - subscriptions_url: + enum: + - open + - closed + title: + description: The title of the milestone. type: string - format: uri - type: + updated_at: type: string - enum: - - Bot - - User - - Organization + format: date-time url: type: string format: uri required: - - login + - url + - html_url + - labels_url - id - body: - type: string - nullable: true - created_at: - type: string - nullable: true - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - nullable: true + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at node_id: type: string - prerelease: - description: Whether the release is identified as a prerelease or a - full release. - type: boolean - published_at: - type: string - nullable: true - format: date-time - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: string - nullable: true - format: uri - target_commitish: - description: Specifies the commitish value that determines where the - Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - url: + number: + description: Number uniquely identifying the pull request within its + repository. + type: integer + patch_url: type: string format: uri - zipball_url: - type: string + rebaseable: + type: boolean nullable: true - format: uri - required: - - url - - assets_url - - upload_url - - html_url - - id - - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - - assets - - tarball_url - - zipball_url - - body - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - release - - repository - - sender - webhook-release-edited: - title: release edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - body: - type: object - properties: - from: - description: The previous version of the body if the action was - `edited`. - type: string - required: - - from - name: - type: object - properties: - from: - description: The previous version of the name if the action was - `edited`. - type: string - required: - - from - make_latest: - type: object - properties: - to: - description: Whether this release was explicitly `edited` to be - the latest. - type: boolean - required: - - to - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - release: - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: + requested_reviewers: + type: array + items: + oneOf: + - title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + - Mannequin + url: + type: string + format: uri + required: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. + type: object + properties: + deleted: + type: boolean + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: + type: object + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its + repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + requested_teams: type: array items: - title: Release Asset - description: Data related to a release. + title: Team + description: Groups of organization members that gives permissions + on specified repositories. type: object properties: - browser_download_url: - type: string - format: uri - content_type: + deleted: + type: boolean + description: + description: Description of the team type: string - created_at: + nullable: true + html_url: type: string - format: date-time - download_count: - type: integer + format: uri id: + description: Unique identifier of the team type: integer - label: + members_url: type: string - nullable: true + format: uri-template name: - description: The file name of the asset. + description: Name of the team type: string node_id: type: string - size: - type: integer - state: - description: State of the release asset. - type: string - enum: - - uploaded - updated_at: - type: string - format: date-time - uploader: - title: User + parent: type: object nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + description: + description: Description of the team type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string html_url: type: string format: uri id: + description: Unique identifier of the team type: integer - login: + members_url: type: string + format: uri-template name: + description: Name of the team type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: + permission: + description: Permission that the team will have for its repositories type: string - format: uri - site_admin: - type: boolean - starred_url: + privacy: type: string - format: uri-template - subscriptions_url: + enum: + - open + - closed + - secret + repositories_url: type: string format: uri - type: + slug: type: string - enum: - - Bot - - User - - Organization url: + description: URL for the team type: string format: uri required: - - login + - name - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string url: + description: URL for the team type: string format: uri required: - - url - - browser_download_url - - id - - node_id - name - - label - - state - - content_type - - size - - download_count - - created_at - - updated_at - assets_url: + - id + review_comment_url: + type: string + format: uri-template + review_comments: + type: integer + review_comments_url: type: string format: uri - author: + state: + description: State of this Pull Request. Either `open` or `closed`. + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: title: User type: object nullable: true @@ -192343,273 +177242,245 @@ components: - Bot - User - Organization + - Mannequin url: type: string format: uri required: - login - id - body: - type: string - nullable: true - created_at: - type: string - nullable: true - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - nullable: true - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease or a - full release. - type: boolean - published_at: - type: string - nullable: true - format: date-time - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: string - nullable: true - format: uri - target_commitish: - description: Specifies the commitish value that determines where the - Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - url: - type: string - format: uri - zipball_url: - type: string - nullable: true - format: uri required: - url - - assets_url - - upload_url - - html_url - id - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - - assets - - tarball_url - - zipball_url + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - changes - - release + - number + - pull_request - repository - webhook-release-prereleased: - title: release prereleased event + - sender + webhook-pull-request-unlocked: + title: pull_request unlocked event type: object properties: action: type: string enum: - - prereleased + - unlocked enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" + number: + "$ref": "#/components/schemas/webhooks_number" organization: "$ref": "#/components/schemas/organization-simple-webhooks" - release: - allOf: - - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: - type: array - items: - title: Release Asset - description: Data related to a release. + pull_request: + title: Pull Request + type: object + properties: + _links: + type: object + properties: + comments: + title: Link type: object properties: - browser_download_url: - type: string - format: uri - content_type: + href: type: string - created_at: + format: uri-template + required: + - href + commits: + title: Link + type: object + properties: + href: type: string - format: date-time - download_count: - type: integer - id: - type: integer - label: + format: uri-template + required: + - href + html: + title: Link + type: object + properties: + href: type: string - nullable: true - name: - description: The file name of the asset. + format: uri-template + required: + - href + issue: + title: Link + type: object + properties: + href: type: string - node_id: + format: uri-template + required: + - href + review_comment: + title: Link + type: object + properties: + href: type: string - size: - type: integer - state: - description: State of the release asset. + format: uri-template + required: + - href + review_comments: + title: Link + type: object + properties: + href: type: string - enum: - - uploaded - updated_at: + format: uri-template + required: + - href + self: + title: Link + type: object + properties: + href: type: string - format: date-time - uploader: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - url: + format: uri-template + required: + - href + statuses: + title: Link + type: object + properties: + href: type: string - format: uri + format: uri-template required: - - url - - browser_download_url - - id - - node_id - - name - - label - - state - - content_type - - size - - download_count - - created_at - - updated_at - assets_url: - type: string - format: uri - author: + - href + required: + - self + - html + - issue + - comments + - review_comments + - review_comment + - commits + - statuses + active_lock_reason: + type: string + nullable: true + enum: + - resolved + - off-topic + - too heated + - spam + - + additions: + type: integer + assignee: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + assignees: + type: array + items: title: User type: object nullable: true @@ -192676,269 +177547,361 @@ components: required: - login - id - body: - type: string - nullable: true - created_at: - type: string - nullable: true - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - nullable: true - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease or - a full release. - type: boolean - published_at: - type: string - nullable: true - format: date-time - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: string - nullable: true - format: uri - target_commitish: - description: Specifies the commitish value that determines where the - Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - url: - type: string - format: uri - zipball_url: - type: string - nullable: true - format: uri - required: - - url - - assets_url - - upload_url - - html_url - - id - - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - - assets - - tarball_url - - zipball_url - - body - - type: object - properties: - assets: - type: array - items: + author_association: + title: AuthorAssociation + description: How the author is associated with the repository. + type: string + enum: + - COLLABORATOR + - CONTRIBUTOR + - FIRST_TIMER + - FIRST_TIME_CONTRIBUTOR + - MANNEQUIN + - MEMBER + - NONE + - OWNER + auto_merge: + title: PullRequestAutoMerge + description: The status of auto merging a pull request. + type: object + nullable: true + properties: + commit_message: + description: Commit message for the merge commit. + type: string + nullable: true + commit_title: + description: Title for the merge commit message. + type: string + enabled_by: + title: User type: object nullable: true - assets_url: - type: string - author: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - body: - type: string - nullable: true - created_at: - type: string - draft: - type: boolean - html_url: - type: string - id: - type: integer - name: - type: string - nullable: true - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease or - a full release. - type: boolean - enum: - - true - published_at: - type: string - nullable: true - tag_name: - type: string - tarball_url: - type: string - nullable: true - target_commitish: - type: string - upload_url: - type: string - url: - type: string - zipball_url: - type: string - nullable: true - required: - - prerelease - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - release - - repository - webhook-release-published: - title: release published event - type: object - properties: - action: - type: string - enum: - - published - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - release: - allOf: - - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: - type: array - items: - title: Release Asset - description: Data related to a release. + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + merge_method: + description: The merge method to use. + type: string + enum: + - merge + - squash + - rebase + required: + - enabled_by + - merge_method + - commit_title + - commit_message + base: + type: object + properties: + label: + type: string + ref: + type: string + repo: + title: Repository + description: A git repository type: object properties: - browser_download_url: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: type: string format: uri - content_type: + full_name: type: string - created_at: + git_commits_url: type: string - format: date-time - download_count: - type: integer + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: string + nullable: true + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri id: + description: Unique identifier of the repository type: integer - label: + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: string + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: type: string nullable: true + format: uri name: - description: The file name of the asset. + description: The name of the repository. type: string node_id: type: string - size: - type: integer - state: - description: State of the release asset. + notifications_url: type: string - enum: - - uploaded - updated_at: + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: type: string - format: date-time - uploader: + owner: title: User type: object nullable: true @@ -193005,677 +177968,559 @@ components: required: - login - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean required: - - url - - browser_download_url - id - node_id - name - - label - - state - - content_type - - size - - download_count + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url - created_at - updated_at - assets_url: - type: string - format: uri - author: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - body: - type: string - nullable: true - created_at: - type: string - nullable: true - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - nullable: true - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease or - a full release. - type: boolean - published_at: - type: string - nullable: true - format: date-time - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: string - nullable: true - format: uri - target_commitish: - description: Specifies the commitish value that determines where the - Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - url: - type: string - format: uri - zipball_url: - type: string - nullable: true - format: uri - required: - - url - - assets_url - - upload_url - - html_url - - id - - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - - assets - - tarball_url - - zipball_url - - body - - type: object - properties: - assets: - type: array - items: - type: object - nullable: true - assets_url: - type: string - author: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - body: - type: string - nullable: true - created_at: - type: string - draft: - type: boolean - html_url: - type: string - id: - type: integer - name: - type: string - nullable: true - node_id: - type: string - prerelease: - type: boolean - published_at: - type: string - nullable: true - format: date-time - tag_name: - type: string - tarball_url: - type: string - nullable: true - target_commitish: - type: string - upload_url: - type: string - url: - type: string - zipball_url: - type: string - nullable: true - required: - - published_at - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - release - - repository - webhook-release-released: - title: release released event - type: object - properties: - action: - type: string - enum: - - released - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - release: - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: - type: array - items: - title: Release Asset - description: Data related to a release. - type: object - properties: - browser_download_url: - type: string - format: uri - content_type: - type: string - created_at: - type: string - format: date-time - download_count: - type: integer - id: - type: integer - label: - type: string - nullable: true - name: - description: The file name of the asset. - type: string - node_id: - type: string - size: - type: integer - state: - description: State of the release asset. - type: string - enum: - - uploaded - updated_at: - type: string - format: date-time - uploader: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - url: - type: string - format: uri - required: - - url - - browser_download_url - - id - - node_id - - name - - label - - state - - content_type - - size - - download_count - - created_at - - updated_at - assets_url: - type: string - format: uri - author: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: type: string + user: + title: User + type: object nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id required: - - login - - id + - label + - ref + - sha + - user + - repo body: type: string nullable: true - created_at: + changed_files: + type: integer + closed_at: type: string nullable: true format: date-time - discussion_url: + comments: + type: integer + comments_url: type: string format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: + commits: + type: integer + commits_url: type: string format: uri - id: - type: integer - name: + created_at: type: string - nullable: true - node_id: + format: date-time + deletions: + type: integer + diff_url: type: string - prerelease: - description: Whether the release is identified as a prerelease or a - full release. + format: uri + draft: + description: Indicates whether or not the pull request is a draft. type: boolean - published_at: - type: string - nullable: true - format: date-time - reactions: - title: Reactions + head: type: object properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: + label: type: string - format: uri - required: - - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: string - nullable: true - format: uri - target_commitish: - description: Specifies the commitish value that determines where the - Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - url: - type: string - format: uri - zipball_url: - type: string - nullable: true - format: uri - required: - - url - - assets_url - - upload_url - - html_url - - id - - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - - assets - - tarball_url - - zipball_url - - body - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - release - - repository - webhook-release-unpublished: - title: release unpublished event - type: object - properties: - action: - type: string - enum: - - unpublished - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - release: - allOf: - - title: Release - description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) - object. - type: object - properties: - assets: - type: array - items: - title: Release Asset - description: Data related to a release. + ref: + type: string + repo: + title: Repository + description: A git repository type: object + nullable: true properties: - browser_download_url: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: type: string format: uri - content_type: + collaborators_url: type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri created_at: + oneOf: + - type: integer + - type: string + format: date-time + default_branch: + description: The default branch of the repository. type: string - format: date-time - download_count: + delete_branch_on_merge: + description: Whether to delete head branches when pull requests + are merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: string + nullable: true + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri id: + description: Unique identifier of the repository type: integer - label: + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: string + nullable: true + languages_url: + type: string + format: uri + license: + title: License + type: object + nullable: true + properties: + key: + type: string + name: + type: string + node_id: + type: string + spdx_id: + type: string + url: + type: string + nullable: true + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merge_commit_message: + description: |- + The default value for a merge commit message. + + - `PR_TITLE` - default to the pull request's title. + - `PR_BODY` - default to the pull request's body. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - PR_TITLE + - BLANK + merge_commit_title: + description: |- + The default value for a merge commit title. + + - `PR_TITLE` - default to the pull request's title. + - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). + type: string + enum: + - PR_TITLE + - MERGE_MESSAGE + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: type: string nullable: true + format: uri name: - description: The file name of the asset. + description: The name of the repository. type: string node_id: type: string - size: - type: integer - state: - description: State of the release asset. + notifications_url: type: string - enum: - - uploaded - updated_at: + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: type: string - format: date-time - uploader: + owner: title: User type: object nullable: true @@ -193742,2359 +178587,1434 @@ components: required: - login - id + permissions: + type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + size: + type: integer + squash_merge_commit_message: + description: |- + The default value for a squash merge commit message: + + - `PR_BODY` - default to the pull request's body. + - `COMMIT_MESSAGES` - default to the branch's commit messages. + - `BLANK` - default to a blank commit message. + type: string + enum: + - PR_BODY + - COMMIT_MESSAGES + - BLANK + squash_merge_commit_title: + description: |- + The default value for a squash merge commit title: + + - `PR_TITLE` - default to the pull request's title. + - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). + type: string + enum: + - PR_TITLE + - COMMIT_OR_PR_TITLE + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time url: type: string format: uri + use_squash_pr_title_as_default: + description: Whether a squash merge commit can use the pull + request title as default. **This property has been deprecated. + Please use `squash_merge_commit_title` instead. + type: boolean + default: false + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on + web-based commits + type: boolean required: - - url - - browser_download_url - id - node_id - name - - label - - state - - content_type - - size - - download_count + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url - created_at - updated_at - assets_url: - type: string - format: uri - author: - title: User + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sha: + type: string + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - label + - ref + - sha + - user + - repo + html_url: + type: string + format: uri + id: + type: integer + issue_url: + type: string + format: uri + labels: + type: array + items: + title: Label type: object - nullable: true properties: - avatar_url: + color: + description: '6-character hex code, without the leading #, identifying + the color' type: string - format: uri - deleted: + default: type: boolean - email: + description: type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri id: type: integer - login: - type: string name: + description: The name of the label. type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization url: + description: URL for the label type: string format: uri required: - - login - id - body: - type: string - nullable: true - created_at: - type: string - nullable: true - format: date-time - discussion_url: - type: string - format: uri - draft: - description: Whether the release is a draft or published - type: boolean - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - nullable: true - node_id: - type: string - prerelease: - description: Whether the release is identified as a prerelease or - a full release. - type: boolean - published_at: - type: string - nullable: true - format: date-time - reactions: - title: Reactions - type: object - properties: - "+1": - type: integer - "-1": - type: integer - confused: - type: integer - eyes: - type: integer - heart: - type: integer - hooray: - type: integer - laugh: - type: integer - rocket: - type: integer - total_count: - type: integer - url: - type: string - format: uri - required: + - node_id - url - - total_count - - "+1" - - "-1" - - laugh - - confused - - heart - - hooray - - eyes - - rocket - tag_name: - description: The name of the tag. - type: string - tarball_url: - type: string - nullable: true - format: uri - target_commitish: - description: Specifies the commitish value that determines where the - Git tag is created from. - type: string - upload_url: - type: string - format: uri-template - url: - type: string - format: uri - zipball_url: - type: string - nullable: true - format: uri - required: - - url - - assets_url - - upload_url - - html_url - - id - - node_id - - tag_name - - target_commitish - - name - - draft - - author - - prerelease - - created_at - - published_at - - assets - - tarball_url - - zipball_url - - body - - type: object - properties: - assets: - type: array - items: - type: object - nullable: true - assets_url: - type: string - author: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - body: - type: string - nullable: true - created_at: - type: string - draft: - type: boolean - html_url: - type: string - id: - type: integer - name: - type: string - nullable: true - node_id: - type: string - prerelease: - type: boolean - published_at: - type: string - nullable: true - tag_name: - type: string - tarball_url: - type: string - nullable: true - target_commitish: - type: string - upload_url: - type: string - url: - type: string - zipball_url: - type: string - nullable: true - required: - - published_at - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - release - - repository - webhook-repository-advisory-published: - title: Repository advisory published event - type: object - properties: - action: - type: string - enum: - - published - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_advisory: - "$ref": "#/components/schemas/repository-advisory" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - repository_advisory - webhook-repository-advisory-reported: - title: Repository advisory reported event - type: object - properties: - action: - type: string - enum: - - reported - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_advisory: - "$ref": "#/components/schemas/repository-advisory" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - repository_advisory - webhook-repository-archived: - title: repository archived event - type: object - properties: - action: - type: string - enum: - - archived - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-repository-created: - title: repository created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-repository-deleted: - title: repository deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-repository-dispatch-sample: - title: repository_dispatch event - type: object - properties: - action: - type: string - enum: - - sample.collected - branch: - type: string - client_payload: - type: object - nullable: true - additionalProperties: true - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - branch - - client_payload - - repository - - sender - - installation - webhook-repository-edited: - title: repository edited event - type: object - properties: - action: - type: string - enum: - - edited - changes: - type: object - properties: - default_branch: + - name + - color + - default + - description + locked: + type: boolean + maintainer_can_modify: + description: Indicates whether maintainers can modify the pull request. + type: boolean + merge_commit_sha: + type: string + nullable: true + mergeable: + type: boolean + nullable: true + mergeable_state: + type: string + merged: + type: boolean + nullable: true + merged_at: + type: string + nullable: true + format: date-time + merged_by: + title: User type: object + nullable: true properties: - from: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri required: - - from - description: + - login + - id + milestone: + title: Milestone + description: A collection of related issues and pull requests. type: object + nullable: true properties: - from: + closed_at: + type: string + nullable: true + format: date-time + closed_issues: + type: integer + created_at: + type: string + format: date-time + creator: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + description: type: string nullable: true - required: - - from - homepage: - type: object - properties: - from: + due_on: type: string nullable: true + format: date-time + html_url: + type: string + format: uri + id: + type: integer + labels_url: + type: string + format: uri + node_id: + type: string + number: + description: The number of the milestone. + type: integer + open_issues: + type: integer + state: + description: The state of the milestone. + type: string + enum: + - open + - closed + title: + description: The title of the milestone. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri required: - - from - topics: - type: object - properties: - from: - type: array - nullable: true - items: - type: string - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - changes - - repository - - sender - webhook-repository-import: - title: repository_import event - type: object - properties: - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - status: - type: string - enum: - - success - - cancelled - - failure - required: - - status - - repository - - sender - webhook-repository-privatized: - title: repository privatized event - type: object - properties: - action: - type: string - enum: - - privatized - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-repository-publicized: - title: repository publicized event - type: object - properties: - action: - type: string - enum: - - publicized - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-repository-renamed: - title: repository renamed event - type: object - properties: - action: - type: string - enum: - - renamed - changes: - type: object - properties: - repository: - type: object - properties: - name: + - url + - html_url + - labels_url + - id + - node_id + - number + - title + - description + - creator + - open_issues + - closed_issues + - state + - created_at + - updated_at + - due_on + - closed_at + node_id: + type: string + number: + description: Number uniquely identifying the pull request within its + repository. + type: integer + patch_url: + type: string + format: uri + rebaseable: + type: boolean + nullable: true + requested_reviewers: + type: array + items: + oneOf: + - title: User type: object + nullable: true properties: - from: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri required: - - from - required: - - name - required: - - repository - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - changes - - repository - - sender - webhook-repository-ruleset-created: - title: repository ruleset created event - type: object - properties: - action: - type: string - enum: - - created - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_ruleset: - "$ref": "#/components/schemas/repository-ruleset" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository_ruleset - - sender - webhook-repository-ruleset-deleted: - title: repository ruleset deleted event - type: object - properties: - action: - type: string - enum: - - deleted - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_ruleset: - "$ref": "#/components/schemas/repository-ruleset" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository_ruleset - - sender - webhook-repository-ruleset-edited: - title: repository ruleset edited event - type: object - properties: - action: - type: string - enum: - - edited - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - repository_ruleset: - "$ref": "#/components/schemas/repository-ruleset" - changes: - type: object - properties: - name: - type: object - properties: - from: - type: string - enforcement: - type: object - properties: - from: - type: string - conditions: - type: object - properties: - added: - type: array - items: - "$ref": "#/components/schemas/repository-ruleset-conditions" - deleted: - type: array - items: - "$ref": "#/components/schemas/repository-ruleset-conditions" - updated: - type: array - items: - type: object - properties: - condition: - "$ref": "#/components/schemas/repository-ruleset-conditions" - changes: - type: object - properties: - condition_type: - type: object - properties: - from: - type: string - target: - type: object - properties: - from: - type: string - include: - type: object - properties: - from: - type: array - items: - type: string - exclude: - type: object - properties: - from: - type: array - items: - type: string - rules: - type: object - properties: - added: - type: array - items: - "$ref": "#/components/schemas/repository-rule" - deleted: - type: array - items: - "$ref": "#/components/schemas/repository-rule" - updated: - type: array - items: - type: object - properties: - rule: - "$ref": "#/components/schemas/repository-rule" - changes: - type: object - properties: - configuration: - type: object - properties: - from: - type: string - rule_type: - type: object - properties: - from: - type: string - pattern: - type: object - properties: - from: - type: string - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository_ruleset - - sender - webhook-repository-transferred: - title: repository transferred event - type: object - properties: - action: - type: string - enum: - - transferred - changes: - type: object - properties: - owner: - type: object - properties: - from: + - login + - id + - title: Team + description: Groups of organization members that gives permissions + on specified repositories. type: object properties: - organization: - title: Organization + deleted: + type: boolean + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + parent: type: object + nullable: true properties: - avatar_url: - type: string - format: uri description: + description: Description of the team type: string nullable: true - events_url: - type: string - format: uri - hooks_url: - type: string - format: uri html_url: type: string format: uri id: + description: Unique identifier of the team type: integer - issues_url: - type: string - format: uri - login: - type: string members_url: type: string format: uri-template - node_id: - type: string - public_members_url: - type: string - format: uri-template - repos_url: - type: string - format: uri - url: - type: string - format: uri - required: - - login - - id - - node_id - - url - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - user: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string name: + description: Name of the team type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: + permission: + description: Permission that the team will have for its + repositories type: string - format: uri - type: + privacy: type: string enum: - - Bot - - User - - Organization - url: + - open + - closed + - secret + repositories_url: type: string format: uri - required: - - login - - id - required: - - from - required: - - owner - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - changes - - repository - - sender - webhook-repository-unarchived: - title: repository unarchived event - type: object - properties: - action: - type: string - enum: - - unarchived - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - repository - - sender - webhook-repository-vulnerability-alert-create: - title: repository_vulnerability_alert create event - type: object - properties: - action: - type: string - enum: - - create - alert: - allOf: - - title: Repository Vulnerability Alert Alert - description: The security alert of the vulnerable dependency. - type: object - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - dismiss_reason: - type: string - dismissed_at: - type: string - dismisser: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - external_identifier: - type: string - external_reference: - type: string - nullable: true - format: uri - fix_reason: - type: string - fixed_at: - type: string - format: date-time - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - open - - dismissed - - fixed - required: - - id - - number - - node_id - - state - - affected_range - - affected_package_name - - ghsa_id - - severity - - external_reference - - external_identifier - - created_at - - type: object - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - external_identifier: - type: string - external_reference: - type: string - nullable: true - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - open - required: - - state - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-repository-vulnerability-alert-dismiss: - title: repository_vulnerability_alert dismiss event - type: object - properties: - action: - type: string - enum: - - dismiss - alert: - allOf: - - title: Repository Vulnerability Alert Alert - description: The security alert of the vulnerable dependency. - type: object - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - dismiss_comment: - type: string - nullable: true - dismiss_reason: - type: string - dismissed_at: - type: string - dismisser: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - external_identifier: - type: string - external_reference: - type: string - nullable: true - format: uri - fix_reason: - type: string - fixed_at: - type: string - format: date-time - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - open - - dismissed - - fixed - required: - - id - - number - - node_id - - state - - affected_range - - affected_package_name - - ghsa_id - - severity - - external_reference - - external_identifier - - created_at - - type: object - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - dismiss_comment: - type: string - nullable: true - dismiss_reason: - type: string - dismissed_at: - type: string - dismisser: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - external_identifier: - type: string - external_reference: - type: string - nullable: true - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - dismissed - required: - - dismisser - - dismiss_reason - - dismissed_at - - state - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-repository-vulnerability-alert-reopen: - title: repository_vulnerability_alert reopen event - type: object - properties: - action: - type: string - enum: - - reopen - alert: - allOf: - - title: Repository Vulnerability Alert Alert - description: The security alert of the vulnerable dependency. - type: object - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - dismiss_reason: - type: string - dismissed_at: - type: string - dismisser: - title: User + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + requested_teams: + type: array + items: + title: Team + description: Groups of organization members that gives permissions + on specified repositories. type: object - nullable: true properties: - avatar_url: - type: string - format: uri deleted: type: boolean - email: + description: + description: Description of the team type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string html_url: type: string format: uri id: + description: Unique identifier of the team type: integer - login: + members_url: type: string + format: uri-template name: + description: Name of the team type: string node_id: type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: + parent: + type: object + nullable: true + properties: + description: + description: Description of the team + type: string + nullable: true + html_url: + type: string + format: uri + id: + description: Unique identifier of the team + type: integer + members_url: + type: string + format: uri-template + name: + description: Name of the team + type: string + node_id: + type: string + permission: + description: Permission that the team will have for its repositories + type: string + privacy: + type: string + enum: + - open + - closed + - secret + repositories_url: + type: string + format: uri + slug: + type: string + url: + description: URL for the team + type: string + format: uri + required: + - name + - id + - node_id + - slug + - description + - privacy + - url + - html_url + - members_url + - repositories_url + - permission + permission: + description: Permission that the team will have for its repositories type: string - format: uri - site_admin: - type: boolean - starred_url: + privacy: type: string - format: uri-template - subscriptions_url: + enum: + - open + - closed + - secret + repositories_url: type: string format: uri - type: + slug: type: string - enum: - - Bot - - User - - Organization url: + description: URL for the team type: string format: uri required: - - login + - name - id - external_identifier: - type: string - external_reference: - type: string - nullable: true - format: uri - fix_reason: - type: string - fixed_at: - type: string - format: date-time - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - open - - dismissed - - fixed - required: - - id - - number - - node_id - - state - - affected_range - - affected_package_name - - ghsa_id - - severity - - external_reference - - external_identifier - - created_at - - type: object - properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - external_identifier: - type: string - external_reference: - type: string - nullable: true - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - open - required: - - state - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" + review_comment_url: + type: string + format: uri-template + review_comments: + type: integer + review_comments_url: + type: string + format: uri + state: + description: State of this Pull Request. Either `open` or `closed`. + type: string + enum: + - open + - closed + statuses_url: + type: string + format: uri + title: + description: The title of the pull request. + type: string + updated_at: + type: string + format: date-time + url: + type: string + format: uri + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id + required: + - url + - id + - node_id + - html_url + - diff_url + - patch_url + - issue_url + - number + - state + - locked + - title + - user + - body + - created_at + - updated_at + - closed_at + - merged_at + - merge_commit_sha + - assignee + - assignees + - requested_reviewers + - requested_teams + - labels + - milestone + - commits_url + - review_comments_url + - review_comment_url + - comments_url + - statuses_url + - head + - base + - _links + - author_association + - auto_merge + - active_lock_reason + - draft repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - alert + - number + - pull_request - repository - sender - webhook-repository-vulnerability-alert-resolve: - title: repository_vulnerability_alert resolve event + webhook-push: + title: push event type: object properties: - action: + after: + description: The SHA of the most recent commit on `ref` after the push. type: string - enum: - - resolve - alert: - allOf: - - title: Repository Vulnerability Alert Alert - description: The security alert of the vulnerable dependency. + base_ref: + "$ref": "#/components/schemas/webhooks_nullable_string" + before: + description: The SHA of the most recent commit on `ref` before the push. + type: string + commits: + description: An array of commit objects describing the pushed commits. (Pushed + commits are all commits that are included in the `compare` between the + `before` commit and the `after` commit.) The array includes a maximum + of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) + to fetch additional commits. + type: array + items: + title: Commit type: object properties: - affected_package_name: - type: string - affected_range: - type: string - created_at: - type: string - dismiss_reason: - type: string - dismissed_at: - type: string - dismisser: - title: User + added: + description: An array of files added in the commit. A maximum of 3000 + changed files will be reported per commit. + type: array + items: + type: string + author: + title: Committer + description: Metaproperties for Git author/committer information. type: object - nullable: true properties: - avatar_url: + date: type: string - format: uri - deleted: - type: boolean + format: date-time email: type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string + format: email name: + description: The git author's name. type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: + username: type: string - format: uri - site_admin: - type: boolean - starred_url: + required: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: type: string - format: uri-template - subscriptions_url: + format: date-time + email: type: string - format: uri - type: + nullable: true + format: email + name: + description: The git author's name. type: string - enum: - - Bot - - User - - Organization - url: + username: type: string - format: uri required: - - login - - id - external_identifier: - type: string - external_reference: - type: string - nullable: true - format: uri - fix_reason: - type: string - fixed_at: - type: string - format: date-time - fixed_in: - type: string - ghsa_id: - type: string + - email + - name + distinct: + description: Whether this commit is distinct from any that have been + pushed before. + type: boolean id: - type: integer - node_id: - type: string - number: - type: integer - severity: - type: string - state: - type: string - enum: - - open - - dismissed - - fixed - required: - - id - - number - - node_id - - state - - affected_range - - affected_package_name - - ghsa_id - - severity - - external_reference - - external_identifier - - created_at - - type: object - properties: - affected_package_name: type: string - affected_range: - type: string - created_at: - type: string - external_identifier: - type: string - external_reference: - type: string - nullable: true - fix_reason: + message: + description: The commit message. type: string - fixed_at: + modified: + description: An array of files modified by the commit. A maximum of + 3000 changed files will be reported per commit. + type: array + items: + type: string + removed: + description: An array of files removed in the commit. A maximum of + 3000 changed files will be reported per commit. + type: array + items: + type: string + timestamp: + description: The ISO 8601 timestamp of the commit. type: string format: date-time - fixed_in: - type: string - ghsa_id: - type: string - id: - type: integer - node_id: - type: string - number: - type: integer - severity: + tree_id: type: string - state: + url: + description: URL that points to the commit API resource. type: string - enum: - - fixed - - open + format: uri required: - - state - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - - sender - webhook-secret-scanning-alert-created: - title: secret_scanning_alert created event - type: object - properties: - action: - type: string - enum: - - created - alert: - "$ref": "#/components/schemas/secret-scanning-alert-webhook" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - webhook-secret-scanning-alert-location-created: - title: Secret Scanning Alert Location Created Event - type: object - properties: - action: - type: string - enum: - - created - alert: - "$ref": "#/components/schemas/secret-scanning-alert-webhook" - installation: - "$ref": "#/components/schemas/simple-installation" - location: - "$ref": "#/components/schemas/secret-scanning-location" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - location - - alert - - repository - - sender - webhook-secret-scanning-alert-location-created-form-encoded: - title: Secret Scanning Alert Location Created Event - type: object - properties: - payload: - description: A URL-encoded string of the secret_scanning_alert_location.created - JSON payload. The decoded payload is a JSON object. - type: string - required: - - payload - webhook-secret-scanning-alert-reopened: - title: secret_scanning_alert reopened event - type: object - properties: - action: - type: string - enum: - - reopened - alert: - "$ref": "#/components/schemas/secret-scanning-alert-webhook" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - webhook-secret-scanning-alert-resolved: - title: secret_scanning_alert resolved event - type: object - properties: - action: - type: string - enum: - - resolved - alert: - "$ref": "#/components/schemas/secret-scanning-alert-webhook" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - webhook-secret-scanning-alert-revoked: - title: secret_scanning_alert revoked event - type: object - properties: - action: - type: string - enum: - - revoked - alert: - "$ref": "#/components/schemas/secret-scanning-alert-webhook" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - alert - - repository - webhook-security-advisory-published: - title: security_advisory published event - type: object - properties: - action: + - id + - tree_id + - distinct + - message + - timestamp + - url + - author + - committer + compare: + description: URL that shows the changes in this `ref` update, from the `before` + commit to the `after` commit. For a newly created `ref` that is directly + based on the default branch, this is the comparison between the head of + the default branch and the `after` commit. Otherwise, this shows all commits + until the `after` commit. type: string - enum: - - published + created: + description: Whether this push created the `ref`. + type: boolean + deleted: + description: Whether this push deleted the `ref`. + type: boolean enterprise: "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - security_advisory: - description: The details of the security advisory, including summary, description, - and severity. + forced: + description: Whether this push was a force push of the `ref`. + type: boolean + head_commit: + title: Commit type: object + nullable: true properties: - cvss: - type: object - properties: - score: - type: number - vector_string: - type: string - nullable: true - required: - - vector_string - - score - cwes: - type: array - items: - type: object - properties: - cwe_id: - type: string - name: - type: string - required: - - cwe_id - - name - description: - type: string - ghsa_id: - type: string - identifiers: - type: array - items: - type: object - properties: - type: - type: string - value: - type: string - required: - - value - - type - published_at: - type: string - references: - type: array - items: - type: object - properties: - url: - type: string - format: uri - required: - - url - severity: - type: string - summary: - type: string - updated_at: - type: string - vulnerabilities: + added: + description: An array of files added in the commit. type: array items: - type: object - properties: - first_patched_version: - type: object - nullable: true - properties: - identifier: - type: string - required: - - identifier - package: - type: object - properties: - ecosystem: - type: string - name: - type: string - required: - - ecosystem - - name - severity: - type: string - vulnerable_version_range: - type: string - required: - - package - - severity - - vulnerable_version_range - - first_patched_version - withdrawn_at: - type: string - nullable: true - required: - - cvss - - cwes - - ghsa_id - - summary - - description - - severity - - identifiers - - references - - published_at - - updated_at - - withdrawn_at - - vulnerabilities - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - security_advisory - webhook-security-advisory-updated: - title: security_advisory updated event - type: object - properties: - action: - type: string - enum: - - updated - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - security_advisory: - description: The details of the security advisory, including summary, description, - and severity. - type: object - properties: - cvss: + type: string + author: + title: Committer + description: Metaproperties for Git author/committer information. type: object properties: - score: - type: number - vector_string: + date: + type: string + format: date-time + email: type: string nullable: true + format: email + name: + description: The git author's name. + type: string + username: + type: string required: - - vector_string - - score - cwes: - type: array - items: - type: object - properties: - cwe_id: - type: string - name: - type: string - required: - - cwe_id - - name - description: - type: string - ghsa_id: - type: string - identifiers: - type: array - items: - type: object - properties: - type: - type: string - value: - type: string - required: - - value - - type - published_at: - type: string - references: - type: array - items: - type: object - properties: - url: - type: string - format: uri - required: - - url - severity: - type: string - summary: - type: string - updated_at: - type: string - vulnerabilities: - type: array - items: - type: object - properties: - first_patched_version: - type: object - nullable: true - properties: - identifier: - type: string - required: - - identifier - package: - type: object - properties: - ecosystem: - type: string - name: - type: string - required: - - ecosystem - - name - severity: - type: string - vulnerable_version_range: - type: string - required: - - package - - severity - - vulnerable_version_range - - first_patched_version - withdrawn_at: - type: string - nullable: true - required: - - cvss - - cwes - - ghsa_id - - summary - - description - - severity - - identifiers - - references - - published_at - - updated_at - - withdrawn_at - - vulnerabilities - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - security_advisory - webhook-security-advisory-withdrawn: - title: security_advisory withdrawn event - type: object - properties: - action: - type: string - enum: - - withdrawn - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - security_advisory: - description: The details of the security advisory, including summary, description, - and severity. - type: object - properties: - cvss: + - email + - name + committer: + title: Committer + description: Metaproperties for Git author/committer information. type: object properties: - score: - type: number - vector_string: + date: + type: string + format: date-time + email: type: string nullable: true + format: email + name: + description: The git author's name. + type: string + username: + type: string required: - - vector_string - - score - cwes: - type: array - items: - type: object - properties: - cwe_id: - type: string - name: - type: string - required: - - cwe_id - - name - description: + - email + - name + distinct: + description: Whether this commit is distinct from any that have been + pushed before. + type: boolean + id: type: string - ghsa_id: + message: + description: The commit message. type: string - identifiers: + modified: + description: An array of files modified by the commit. type: array items: - type: object - properties: - type: - type: string - value: - type: string - required: - - value - - type - published_at: - type: string - references: + type: string + removed: + description: An array of files removed in the commit. type: array items: - type: object - properties: - url: - type: string - format: uri - required: - - url - severity: - type: string - summary: + type: string + timestamp: + description: The ISO 8601 timestamp of the commit. type: string - updated_at: + format: date-time + tree_id: type: string - vulnerabilities: - type: array - items: - type: object - properties: - first_patched_version: - type: object - nullable: true - properties: - identifier: - type: string - required: - - identifier - package: - type: object - properties: - ecosystem: - type: string - name: - type: string - required: - - ecosystem - - name - severity: - type: string - vulnerable_version_range: - type: string - required: - - package - - severity - - vulnerable_version_range - - first_patched_version - withdrawn_at: + url: + description: URL that points to the commit API resource. type: string + format: uri required: - - cvss - - cwes - - ghsa_id - - summary - - description - - severity - - identifiers - - references - - published_at - - updated_at - - withdrawn_at - - vulnerabilities - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - action - - security_advisory - webhook-security-and-analysis: - title: security_and_analysis event - type: object - properties: - changes: - type: object - properties: - from: - type: object - properties: - security_and_analysis: - "$ref": "#/components/schemas/security-and-analysis" - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" + - id + - tree_id + - distinct + - message + - timestamp + - url + - author + - committer installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/full-repository" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - required: - - changes - - repository - webhook-sponsorship-cancelled: - title: sponsorship cancelled event - type: object - properties: - action: + pusher: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + properties: + date: + type: string + format: date-time + email: + type: string + nullable: true + format: email + name: + description: The git author's name. + type: string + username: + type: string + required: + - name + ref: + description: 'The full git ref that was pushed. Example: `refs/heads/main` + or `refs/tags/v3.14.1`.' type: string - enum: - - cancelled - enterprise: - "$ref": "#/components/schemas/enterprise-webhooks" - installation: - "$ref": "#/components/schemas/simple-installation" - organization: - "$ref": "#/components/schemas/organization-simple-webhooks" repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - sponsorship: + title: Repository + description: A git repository type: object properties: + allow_auto_merge: + description: Whether to allow auto-merge for pull requests. + type: boolean + default: false + allow_forking: + description: Whether to allow private forks + type: boolean + allow_merge_commit: + description: Whether to allow merge commits for pull requests. + type: boolean + default: true + allow_rebase_merge: + description: Whether to allow rebase merges for pull requests. + type: boolean + default: true + allow_squash_merge: + description: Whether to allow squash merges for pull requests. + type: boolean + default: true + allow_update_branch: + type: boolean + archive_url: + type: string + format: uri-template + archived: + description: Whether the repository is archived. + type: boolean + default: false + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + clone_url: + type: string + format: uri + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri created_at: + oneOf: + - type: integer + - type: string + format: date-time + custom_properties: + type: object + description: The custom properties that were defined for the repository. + The keys are the custom property names, and the values are the corresponding + custom property values. + additionalProperties: true + default_branch: + description: The default branch of the repository. + type: string + delete_branch_on_merge: + description: Whether to delete head branches when pull requests are + merged + type: boolean + default: false + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + disabled: + description: Returns whether or not this repository is disabled. + type: boolean + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks: + type: integer + forks_count: + type: integer + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + git_url: + type: string + format: uri + has_downloads: + description: Whether downloads are enabled. + type: boolean + default: true + has_issues: + description: Whether issues are enabled. + type: boolean + default: true + has_pages: + type: boolean + has_projects: + description: Whether projects are enabled. + type: boolean + default: true + has_wiki: + description: Whether the wiki is enabled. + type: boolean + default: true + has_discussions: + description: Whether discussions are enabled. + type: boolean + default: false + homepage: + type: string + nullable: true + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + is_template: + type: boolean + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + language: + type: string + nullable: true + languages_url: type: string - maintainer: + format: uri + license: + title: License type: object + nullable: true properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: + key: type: string - id: - type: integer - login: + name: type: string node_id: type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: + spdx_id: type: string url: type: string + nullable: true + format: uri + required: + - key + - name + - spdx_id + - url + - node_id + master_branch: + type: string + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + mirror_url: + type: string + nullable: true + format: uri + name: + description: The name of the repository. + type: string node_id: type: string - privacy_level: + notifications_url: + type: string + format: uri-template + open_issues: + type: integer + open_issues_count: + type: integer + organization: type: string - sponsor: + owner: title: User type: object nullable: true @@ -196161,760 +180081,1352 @@ components: required: - login - id - sponsorable: - title: User + permissions: type: object + properties: + admin: + type: boolean + maintain: + type: boolean + pull: + type: boolean + push: + type: boolean + triage: + type: boolean + required: + - pull + - push + - admin + private: + description: Whether the repository is private or public. + type: boolean + public: + type: boolean + pulls_url: + type: string + format: uri-template + pushed_at: + nullable: true + oneOf: + - type: integer + - type: string + format: date-time + releases_url: + type: string + format: uri-template + role_name: + type: string + nullable: true + size: + type: integer + ssh_url: + type: string + stargazers: + type: integer + stargazers_count: + type: integer + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + svn_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + topics: + type: array + items: + type: string + trees_url: + type: string + format: uri-template + updated_at: + type: string + format: date-time + url: + type: string + format: uri + visibility: + type: string + enum: + - public + - private + - internal + watchers: + type: integer + watchers_count: + type: integer + web_commit_signoff_required: + description: Whether to require contributors to sign off on web-based + commits + type: boolean + required: + - id + - node_id + - name + - full_name + - private + - owner + - html_url + - description + - fork + - url + - forks_url + - keys_url + - collaborators_url + - teams_url + - hooks_url + - issue_events_url + - events_url + - assignees_url + - branches_url + - tags_url + - blobs_url + - git_tags_url + - git_refs_url + - trees_url + - statuses_url + - languages_url + - stargazers_url + - contributors_url + - subscribers_url + - subscription_url + - commits_url + - git_commits_url + - comments_url + - issue_comment_url + - contents_url + - compare_url + - merges_url + - archive_url + - downloads_url + - issues_url + - pulls_url + - milestones_url + - notifications_url + - labels_url + - releases_url + - deployments_url + - created_at + - updated_at + - pushed_at + - git_url + - ssh_url + - clone_url + - svn_url + - homepage + - size + - stargazers_count + - watchers_count + - language + - has_issues + - has_projects + - has_downloads + - has_wiki + - has_pages + - has_discussions + - forks_count + - mirror_url + - archived + - open_issues_count + - license + - forks + - open_issues + - watchers + - default_branch + - topics + - visibility + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - ref + - before + - after + - created + - deleted + - forced + - base_ref + - compare + - commits + - head_commit + - repository + - pusher + webhook-registry-package-published: + type: object + properties: + action: + type: string + enum: + - published + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + registry_package: + type: object + properties: + created_at: + type: string + nullable: true + description: + type: string nullable: true + ecosystem: + type: string + html_url: + type: string + id: + type: integer + name: + type: string + namespace: + type: string + owner: + type: object properties: avatar_url: type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true events_url: type: string - format: uri-template followers_url: type: string - format: uri following_url: type: string - format: uri-template gists_url: type: string - format: uri-template gravatar_id: type: string html_url: type: string - format: uri id: type: integer login: type: string - name: - type: string node_id: type: string organizations_url: type: string - format: uri received_events_url: type: string - format: uri repos_url: type: string - format: uri site_admin: type: boolean starred_url: type: string - format: uri-template - subscriptions_url: + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - login + - id + - node_id + - avatar_url + - gravatar_id + - url + - html_url + - followers_url + - following_url + - gists_url + - starred_url + - subscriptions_url + - organizations_url + - repos_url + - events_url + - received_events_url + - type + - site_admin + package_type: + type: string + package_version: + type: object + nullable: true + properties: + author: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - login + - id + - node_id + - avatar_url + - gravatar_id + - url + - html_url + - followers_url + - following_url + - gists_url + - starred_url + - subscriptions_url + - organizations_url + - repos_url + - events_url + - received_events_url + - type + - site_admin + body: + oneOf: + - type: string + - type: object + body_html: + type: string + container_metadata: + type: object + properties: + labels: + type: object + nullable: true + manifest: + type: object + nullable: true + tag: + type: object + properties: + digest: + type: string + name: + type: string + created_at: + type: string + description: + type: string + docker_metadata: + type: array + items: + type: object + properties: + tags: + type: array + items: + type: string + draft: + type: boolean + html_url: + type: string + id: + type: integer + installation_command: + type: string + manifest: + type: string + metadata: + type: array + items: + type: object + additionalProperties: true + name: + type: string + npm_metadata: + type: object + nullable: true + properties: + name: + type: string + version: + type: string + npm_user: + type: string + author: + oneOf: + - type: string + - type: object + nullable: true + bugs: + oneOf: + - type: string + - type: object + nullable: true + dependencies: + type: object + dev_dependencies: + type: object + peer_dependencies: + type: object + optional_dependencies: + type: object + description: + type: string + dist: + oneOf: + - type: string + - type: object + nullable: true + git_head: + type: string + homepage: + type: string + license: + type: string + main: + type: string + repository: + oneOf: + - type: string + - type: object + nullable: true + scripts: + type: object + id: + type: string + node_version: + type: string + npm_version: + type: string + has_shrinkwrap: + type: boolean + maintainers: + type: array + items: + type: string + contributors: + type: array + items: + type: string + engines: + type: object + keywords: + type: array + items: + type: string + files: + type: array + items: + type: string + bin: + type: object + man: + type: object + directories: + oneOf: + - type: string + - type: object + nullable: true + os: + type: array + items: + type: string + cpu: + type: array + items: + type: string + readme: + type: string + installation_command: + type: string + release_id: + type: integer + commit_oid: + type: string + published_via_actions: + type: boolean + deleted_by_id: + type: integer + nuget_metadata: + type: array + nullable: true + items: + type: object + properties: + id: + oneOf: + - type: string + - type: object + - type: integer + nullable: true + name: + type: string + value: + oneOf: + - type: boolean + - type: string + - type: integer + - type: object + properties: + url: + type: string + branch: + type: string + commit: + type: string + type: + type: string + package_files: + type: array + items: + type: object + properties: + content_type: + type: string + created_at: + type: string + download_url: + type: string + id: + type: integer + md5: + type: string + nullable: true + name: + type: string + sha1: + type: string + nullable: true + sha256: + type: string + nullable: true + size: + type: integer + state: + type: string + nullable: true + updated_at: + type: string + required: + - download_url + - id + - name + - sha256 + - sha1 + - md5 + - content_type + - state + - size + - created_at + - updated_at + package_url: + type: string + prerelease: + type: boolean + release: + type: object + properties: + author: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + created_at: + type: string + draft: + type: boolean + html_url: + type: string + id: + type: integer + name: + type: string + nullable: true + prerelease: + type: boolean + published_at: + type: string + tag_name: + type: string + target_commitish: + type: string + url: + type: string + rubygems_metadata: + type: array + items: + "$ref": "#/components/schemas/webhook-rubygems-metadata" + summary: + type: string + tag_name: + type: string + target_commitish: + type: string + target_oid: type: string - format: uri - type: + updated_at: type: string - enum: - - Bot - - User - - Organization - url: + version: type: string - format: uri required: - - login - id - tier: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more information, - see the pending tier change payload. + - version + - name + - description + - summary + - html_url + - metadata + - package_files + - installation_command + - package_url + registry: type: object + nullable: true properties: - created_at: - type: string - description: + about_url: type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer name: type: string - node_id: + type: type: string - required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time + url: + type: string + vendor: + type: string + updated_at: + type: string + nullable: true required: - - node_id + - id + - name + - namespace + - description + - ecosystem + - package_type + - html_url - created_at - - sponsorable - - sponsor - - privacy_level - - tier + - updated_at + - owner + - package_version + - registry + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - sponsorship + - registry_package - sender - webhook-sponsorship-created: - title: sponsorship created event + webhook-registry-package-updated: type: object properties: action: type: string enum: - - created + - updated enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - sponsorship: + registry_package: type: object properties: created_at: type: string - maintainer: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - node_id: + description: + nullable: true + ecosystem: type: string - privacy_level: + html_url: type: string - sponsor: - title: User + id: + type: integer + name: + type: string + namespace: + type: string + owner: type: object - nullable: true properties: avatar_url: type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true events_url: type: string - format: uri-template followers_url: type: string - format: uri following_url: type: string - format: uri-template gists_url: type: string - format: uri-template gravatar_id: type: string html_url: type: string - format: uri id: type: integer login: type: string - name: - type: string node_id: type: string organizations_url: type: string - format: uri received_events_url: type: string - format: uri repos_url: type: string - format: uri site_admin: type: boolean starred_url: type: string - format: uri-template subscriptions_url: type: string - format: uri type: type: string - enum: - - Bot - - User - - Organization url: type: string - format: uri required: - login - id - sponsorable: - title: User + - node_id + - avatar_url + - gravatar_id + - url + - html_url + - followers_url + - following_url + - gists_url + - starred_url + - subscriptions_url + - organizations_url + - repos_url + - events_url + - received_events_url + - type + - site_admin + package_type: + type: string + package_version: type: object - nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: + author: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - login + - id + - node_id + - avatar_url + - gravatar_id + - url + - html_url + - followers_url + - following_url + - gists_url + - starred_url + - subscriptions_url + - organizations_url + - repos_url + - events_url + - received_events_url + - type + - site_admin + body: type: string - format: uri - following_url: + body_html: type: string - format: uri-template - gists_url: + created_at: type: string - format: uri-template - gravatar_id: + description: type: string + docker_metadata: + type: array + items: + type: object + nullable: true + properties: + tags: + type: array + items: + type: string + draft: + type: boolean html_url: type: string - format: uri id: type: integer - login: - type: string - name: - type: string - node_id: + installation_command: type: string - organizations_url: + manifest: type: string - format: uri - received_events_url: + metadata: + type: array + items: + type: object + additionalProperties: true + name: type: string - format: uri - repos_url: + package_files: + type: array + items: + type: object + properties: + content_type: + type: string + created_at: + type: string + download_url: + type: string + id: + type: integer + md5: + type: string + nullable: true + name: + type: string + sha1: + type: string + nullable: true + sha256: + type: string + size: + type: integer + state: + type: string + updated_at: + type: string + package_url: type: string - format: uri - site_admin: + prerelease: type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: + release: + type: object + properties: + author: + type: object + properties: + avatar_url: + type: string + events_url: + type: string + followers_url: + type: string + following_url: + type: string + gists_url: + type: string + gravatar_id: + type: string + html_url: + type: string + id: + type: integer + login: + type: string + node_id: + type: string + organizations_url: + type: string + received_events_url: + type: string + repos_url: + type: string + site_admin: + type: boolean + starred_url: + type: string + subscriptions_url: + type: string + type: + type: string + url: + type: string + required: + - login + - id + - node_id + - avatar_url + - gravatar_id + - url + - html_url + - followers_url + - following_url + - gists_url + - starred_url + - subscriptions_url + - organizations_url + - repos_url + - events_url + - received_events_url + - type + - site_admin + created_at: + type: string + draft: + type: boolean + html_url: + type: string + id: + type: integer + name: + type: string + prerelease: + type: boolean + published_at: + type: string + tag_name: + type: string + target_commitish: + type: string + url: + type: string + required: + - url + - html_url + - id + - tag_name + - target_commitish + - name + - draft + - author + - prerelease + - created_at + - published_at + rubygems_metadata: + type: array + items: + "$ref": "#/components/schemas/webhook-rubygems-metadata" + summary: type: string - enum: - - Bot - - User - - Organization - url: + tag_name: type: string - format: uri - required: - - login - - id - tier: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more information, - see the pending tier change payload. - type: object - properties: - created_at: + target_commitish: type: string - description: + target_oid: type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: + updated_at: type: string - node_id: + version: type: string required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars + - id + - version - name - - is_one_time + - description + - summary + - body + - body_html + - html_url + - target_commitish + - target_oid + - created_at + - updated_at + - metadata + - package_files + - author + - installation_command + - package_url + registry: + type: object + nullable: true + updated_at: + type: string required: - - node_id + - id + - name + - namespace + - description + - ecosystem + - package_type + - html_url - created_at - - sponsorable - - sponsor - - privacy_level - - tier + - updated_at + - owner + - package_version + - registry + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - sponsorship + - registry_package - sender - webhook-sponsorship-edited: - title: sponsorship edited event + webhook-release-created: + title: release created event type: object properties: action: type: string enum: - - edited - changes: - type: object - properties: - privacy_level: - type: object - properties: - from: - description: The `edited` event types include the details about - the change when someone edits a sponsorship to change the privacy. - type: string - required: - - from + - created enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" + release: + "$ref": "#/components/schemas/webhooks_release" repository: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" - sponsorship: + required: + - action + - release + - repository + - sender + webhook-release-deleted: + title: release deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + release: + "$ref": "#/components/schemas/webhooks_release" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - release + - repository + - sender + webhook-release-edited: + title: release edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: type: object properties: - created_at: - type: string - maintainer: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - node_id: - type: string - privacy_level: - type: string - sponsor: - title: User + body: type: object - nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: + from: + description: The previous version of the body if the action was + `edited`. type: string - format: uri required: - - login - - id - sponsorable: - title: User + - from + name: type: object - nullable: true properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: + from: + description: The previous version of the name if the action was + `edited`. type: string - format: uri required: - - login - - id - tier: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more information, - see the pending tier change payload. + - from + make_latest: type: object properties: - created_at: - type: string - description: - type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: + to: + description: Whether this release was explicitly `edited` to be + the latest. type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: - type: string - node_id: - type: string required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time - required: - - node_id - - created_at - - sponsorable - - sponsor - - privacy_level - - tier + - to + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + release: + "$ref": "#/components/schemas/webhooks_release" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" required: - action - changes - - sponsorship - - sender - webhook-sponsorship-pending-cancellation: - title: sponsorship pending_cancellation event + - release + - repository + webhook-release-prereleased: + title: release prereleased event type: object properties: action: type: string enum: - - pending_cancellation - effective_date: - description: The `pending_cancellation` and `pending_tier_change` event - types will include the date the cancellation or tier change will take - effect. - type: string + - prereleased enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: "$ref": "#/components/schemas/simple-installation" organization: "$ref": "#/components/schemas/organization-simple-webhooks" - repository: - "$ref": "#/components/schemas/repository-webhooks" - sender: - "$ref": "#/components/schemas/simple-user-webhooks" - sponsorship: + release: + title: Release + description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) + object. type: object + required: + - assets + - assets_url + - author + - body + - created_at + - draft + - html_url + - id + - name + - node_id + - prerelease + - published_at + - tag_name + - tarball_url + - target_commitish + - upload_url + - url + - zipball_url properties: - created_at: - type: string - maintainer: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - node_id: - type: string - privacy_level: - type: string - sponsor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - sponsorable: + assets: + type: array + items: + title: Release Asset + description: Data related to a release. + type: object + required: + - url + - browser_download_url + - id + - node_id + - name + - label + - state + - content_type + - size + - download_count + - created_at + - updated_at + nullable: true + properties: + browser_download_url: + type: string + format: uri + content_type: + type: string + created_at: + type: string + format: date-time + download_count: + type: integer + id: + type: integer + label: + type: string + nullable: true + name: + description: The file name of the asset. + type: string + node_id: + type: string + size: + type: integer + state: + description: State of the release asset. + type: string + enum: + - uploaded + updated_at: + type: string + format: date-time + uploader: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + url: + type: string + format: uri + assets_url: + type: string + format: uri + author: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -196975,109 +181487,496 @@ components: url: type: string format: uri - required: - - login - - id - tier: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more information, - see the pending tier change payload. + body: + type: string + nullable: true + created_at: + type: string + nullable: true + format: date-time + discussion_url: + type: string + format: uri + draft: + description: Whether the release is a draft or published + type: boolean + html_url: + type: string + format: uri + id: + type: integer + name: + type: string + nullable: true + node_id: + type: string + prerelease: + description: Whether the release is identified as a prerelease or a + full release. + type: boolean + enum: + - true + published_at: + type: string + nullable: true + format: date-time + reactions: + title: Reactions type: object + required: + - url + - total_count + - "+1" + - "-1" + - laugh + - confused + - heart + - hooray + - eyes + - rocket properties: - created_at: - type: string - description: - type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: + "+1": type: integer - monthly_price_in_dollars: + "-1": type: integer - name: + confused: + type: integer + eyes: + type: integer + heart: + type: integer + hooray: + type: integer + laugh: + type: integer + rocket: + type: integer + total_count: + type: integer + url: type: string - node_id: + format: uri + tag_name: + description: The name of the tag. + type: string + tarball_url: + type: string + nullable: true + format: uri + target_commitish: + description: Specifies the commitish value that determines where the + Git tag is created from. + type: string + upload_url: + type: string + format: uri-template + url: + type: string + format: uri + zipball_url: + type: string + nullable: true + format: uri + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - release + - repository + webhook-release-published: + title: release published event + type: object + properties: + action: + type: string + enum: + - published + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + release: + "$ref": "#/components/schemas/webhooks_release_1" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - release + - repository + webhook-release-released: + title: release released event + type: object + properties: + action: + type: string + enum: + - released + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + release: + "$ref": "#/components/schemas/webhooks_release" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - release + - repository + webhook-release-unpublished: + title: release unpublished event + type: object + properties: + action: + type: string + enum: + - unpublished + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + release: + "$ref": "#/components/schemas/webhooks_release_1" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - release + - repository + webhook-repository-advisory-published: + title: Repository advisory published event + type: object + properties: + action: + type: string + enum: + - published + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_advisory: + "$ref": "#/components/schemas/repository-advisory" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - repository_advisory + webhook-repository-advisory-reported: + title: Repository advisory reported event + type: object + properties: + action: + type: string + enum: + - reported + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_advisory: + "$ref": "#/components/schemas/repository-advisory" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - repository_advisory + webhook-repository-archived: + title: repository archived event + type: object + properties: + action: + type: string + enum: + - archived + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-repository-created: + title: repository created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-repository-deleted: + title: repository deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-repository-dispatch-sample: + title: repository_dispatch event + type: object + properties: + action: + type: string + description: The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` + request body. + branch: + type: string + client_payload: + type: object + nullable: true + additionalProperties: true + description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` + request body. + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - branch + - client_payload + - repository + - sender + - installation + webhook-repository-edited: + title: repository edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + type: object + properties: + default_branch: + type: object + properties: + from: type: string required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time - required: - - node_id - - created_at - - sponsorable - - sponsor - - privacy_level - - tier + - from + description: + type: object + properties: + from: + type: string + nullable: true + required: + - from + homepage: + type: object + properties: + from: + type: string + nullable: true + required: + - from + topics: + type: object + properties: + from: + type: array + nullable: true + items: + type: string + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - sponsorship + - changes + - repository - sender - webhook-sponsorship-pending-tier-change: - title: sponsorship pending_tier_change event + webhook-repository-import: + title: repository_import event + type: object + properties: + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + status: + type: string + enum: + - success + - cancelled + - failure + required: + - status + - repository + - sender + webhook-repository-privatized: + title: repository privatized event type: object properties: action: type: string enum: - - pending_tier_change + - privatized + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-repository-publicized: + title: repository publicized event + type: object + properties: + action: + type: string + enum: + - publicized + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-repository-renamed: + title: repository renamed event + type: object + properties: + action: + type: string + enum: + - renamed changes: type: object properties: - tier: + repository: type: object properties: - from: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more - information, see the pending tier change payload. + name: type: object properties: - created_at: - type: string - description: - type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: - type: string - node_id: + from: type: string required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time + - from required: - - from + - name required: - - tier - effective_date: - description: The `pending_cancellation` and `pending_tier_change` event - types will include the date the cancellation or tier change will take - effect. + - repository + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - repository + - sender + webhook-repository-ruleset-created: + title: repository ruleset created event + type: object + properties: + action: type: string + enum: + - created enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -197086,127 +181985,407 @@ components: "$ref": "#/components/schemas/organization-simple-webhooks" repository: "$ref": "#/components/schemas/repository-webhooks" + repository_ruleset: + "$ref": "#/components/schemas/repository-ruleset" sender: "$ref": "#/components/schemas/simple-user-webhooks" - sponsorship: + required: + - action + - repository_ruleset + - sender + webhook-repository-ruleset-deleted: + title: repository ruleset deleted event + type: object + properties: + action: + type: string + enum: + - deleted + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_ruleset: + "$ref": "#/components/schemas/repository-ruleset" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository_ruleset + - sender + webhook-repository-ruleset-edited: + title: repository ruleset edited event + type: object + properties: + action: + type: string + enum: + - edited + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + repository_ruleset: + "$ref": "#/components/schemas/repository-ruleset" + changes: type: object properties: - created_at: - type: string - maintainer: + name: type: object properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: + from: type: string - node_id: - type: string - privacy_level: - type: string - sponsor: - title: User + enforcement: type: object - nullable: true properties: - avatar_url: + from: type: string - format: uri + conditions: + type: object + properties: + added: + type: array + items: + "$ref": "#/components/schemas/repository-ruleset-conditions" deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri + type: array + items: + "$ref": "#/components/schemas/repository-ruleset-conditions" + updated: + type: array + items: + type: object + properties: + condition: + "$ref": "#/components/schemas/repository-ruleset-conditions" + changes: + type: object + properties: + condition_type: + type: object + properties: + from: + type: string + target: + type: object + properties: + from: + type: string + include: + type: object + properties: + from: + type: array + items: + type: string + exclude: + type: object + properties: + from: + type: array + items: + type: string + rules: + type: object + properties: + added: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + deleted: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + updated: + type: array + items: + type: object + properties: + rule: + "$ref": "#/components/schemas/repository-rule" + changes: + type: object + properties: + configuration: + type: object + properties: + from: + type: string + rule_type: + type: object + properties: + from: + type: string + pattern: + type: object + properties: + from: + type: string + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository_ruleset + - sender + webhook-repository-transferred: + title: repository transferred event + type: object + properties: + action: + type: string + enum: + - transferred + changes: + type: object + properties: + owner: + type: object + properties: + from: + type: object + properties: + organization: + title: Organization + type: object + properties: + avatar_url: + type: string + format: uri + description: + type: string + nullable: true + events_url: + type: string + format: uri + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + type: integer + issues_url: + type: string + format: uri + login: + type: string + members_url: + type: string + format: uri-template + node_id: + type: string + public_members_url: + type: string + format: uri-template + repos_url: + type: string + format: uri + url: + type: string + format: uri + required: + - login + - id + - node_id + - url + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description + user: + title: User + type: object + nullable: true + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + required: + - login + - id required: - - login - - id - sponsorable: + - from + required: + - owner + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - changes + - repository + - sender + webhook-repository-unarchived: + title: repository unarchived event + type: object + properties: + action: + type: string + enum: + - unarchived + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - repository + - sender + webhook-repository-vulnerability-alert-create: + title: repository_vulnerability_alert create event + type: object + properties: + action: + type: string + enum: + - create + alert: + "$ref": "#/components/schemas/webhooks_alert" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-repository-vulnerability-alert-dismiss: + title: repository_vulnerability_alert dismiss event + type: object + properties: + action: + type: string + enum: + - dismiss + alert: + title: Repository Vulnerability Alert Alert + description: The security alert of the vulnerable dependency. + type: object + required: + - affected_package_name + - affected_range + - created_at + - dismiss_reason + - dismissed_at + - dismisser + - external_identifier + - external_reference + - ghsa_id + - id + - node_id + - number + - severity + - state + properties: + affected_package_name: + type: string + affected_range: + type: string + created_at: + type: string + dismiss_comment: + type: string + nullable: true + dismiss_reason: + type: string + dismissed_at: + type: string + dismisser: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -197267,105 +182446,58 @@ components: url: type: string format: uri - required: - - login - - id - tier: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more information, - see the pending tier change payload. - type: object - properties: - created_at: - type: string - description: - type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: - type: string - node_id: - type: string - required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time - required: - - node_id - - created_at - - sponsorable - - sponsor - - privacy_level - - tier + external_identifier: + type: string + external_reference: + type: string + nullable: true + format: uri + fix_reason: + type: string + fixed_at: + type: string + format: date-time + fixed_in: + type: string + ghsa_id: + type: string + id: + type: integer + node_id: + type: string + number: + type: integer + severity: + type: string + state: + type: string + enum: + - dismissed + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" required: - action - - changes - - sponsorship + - alert + - repository - sender - webhook-sponsorship-tier-changed: - title: sponsorship tier_changed event + webhook-repository-vulnerability-alert-reopen: + title: repository_vulnerability_alert reopen event type: object properties: action: type: string enum: - - tier_changed - changes: - type: object - properties: - tier: - type: object - properties: - from: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more - information, see the pending tier change payload. - type: object - properties: - created_at: - type: string - description: - type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: - type: string - node_id: - type: string - required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time - required: - - from - required: - - tier + - reopen + alert: + "$ref": "#/components/schemas/webhooks_alert" enterprise: "$ref": "#/components/schemas/enterprise-webhooks" installation: @@ -197376,58 +182508,53 @@ components: "$ref": "#/components/schemas/repository-webhooks" sender: "$ref": "#/components/schemas/simple-user-webhooks" - sponsorship: + required: + - action + - alert + - repository + - sender + webhook-repository-vulnerability-alert-resolve: + title: repository_vulnerability_alert resolve event + type: object + properties: + action: + type: string + enum: + - resolve + alert: + title: Repository Vulnerability Alert Alert + description: The security alert of the vulnerable dependency. type: object + required: + - affected_package_name + - affected_range + - created_at + - external_identifier + - external_reference + - ghsa_id + - id + - node_id + - number + - severity + - state properties: + affected_package_name: + type: string + affected_range: + type: string created_at: type: string - maintainer: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - node_id: + dismiss_reason: type: string - privacy_level: + dismissed_at: type: string - sponsor: + dismisser: title: User type: object nullable: true + required: + - login + - id properties: avatar_url: type: string @@ -197488,116 +182615,567 @@ components: url: type: string format: uri - required: - - login - - id - sponsorable: - title: User - type: object + external_identifier: + type: string + external_reference: + type: string nullable: true + format: uri + fix_reason: + type: string + fixed_at: + type: string + format: date-time + fixed_in: + type: string + ghsa_id: + type: string + id: + type: integer + node_id: + type: string + number: + type: integer + severity: + type: string + state: + type: string + enum: + - fixed + - open + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + - sender + webhook-secret-scanning-alert-created: + title: secret_scanning_alert created event + type: object + properties: + action: + type: string + enum: + - created + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + webhook-secret-scanning-alert-location-created: + title: Secret Scanning Alert Location Created Event + type: object + properties: + action: + type: string + enum: + - created + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + installation: + "$ref": "#/components/schemas/simple-installation" + location: + "$ref": "#/components/schemas/secret-scanning-location" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - location + - alert + - repository + - sender + webhook-secret-scanning-alert-location-created-form-encoded: + title: Secret Scanning Alert Location Created Event + type: object + properties: + payload: + description: A URL-encoded string of the secret_scanning_alert_location.created + JSON payload. The decoded payload is a JSON object. + type: string + required: + - payload + webhook-secret-scanning-alert-reopened: + title: secret_scanning_alert reopened event + type: object + properties: + action: + type: string + enum: + - reopened + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + webhook-secret-scanning-alert-resolved: + title: secret_scanning_alert resolved event + type: object + properties: + action: + type: string + enum: + - resolved + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + webhook-secret-scanning-alert-revoked: + title: secret_scanning_alert revoked event + type: object + properties: + action: + type: string + enum: + - revoked + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + webhook-secret-scanning-alert-validated: + title: secret_scanning_alert validated event + type: object + properties: + action: + type: string + enum: + - validated + alert: + "$ref": "#/components/schemas/secret-scanning-alert-webhook" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - alert + - repository + webhook-security-advisory-published: + title: security_advisory published event + type: object + properties: + action: + type: string + enum: + - published + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + security_advisory: + "$ref": "#/components/schemas/webhooks_security_advisory" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - security_advisory + webhook-security-advisory-updated: + title: security_advisory updated event + type: object + properties: + action: + type: string + enum: + - updated + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + security_advisory: + "$ref": "#/components/schemas/webhooks_security_advisory" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - security_advisory + webhook-security-advisory-withdrawn: + title: security_advisory withdrawn event + type: object + properties: + action: + type: string + enum: + - withdrawn + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + security_advisory: + description: The details of the security advisory, including summary, description, + and severity. + type: object + properties: + cvss: + type: object properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: + score: + type: number + vector_string: type: string nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri required: - - login - - id - tier: - title: Sponsorship Tier - description: The `tier_changed` and `pending_tier_change` will include - the original tier before the change or pending change. For more information, - see the pending tier change payload. + - vector_string + - score + cwes: + type: array + items: + type: object + properties: + cwe_id: + type: string + name: + type: string + required: + - cwe_id + - name + description: + type: string + ghsa_id: + type: string + identifiers: + type: array + items: + type: object + properties: + type: + type: string + value: + type: string + required: + - value + - type + published_at: + type: string + references: + type: array + items: + type: object + properties: + url: + type: string + format: uri + required: + - url + severity: + type: string + summary: + type: string + updated_at: + type: string + vulnerabilities: + type: array + items: + type: object + properties: + first_patched_version: + type: object + nullable: true + properties: + identifier: + type: string + required: + - identifier + package: + type: object + properties: + ecosystem: + type: string + name: + type: string + required: + - ecosystem + - name + severity: + type: string + vulnerable_version_range: + type: string + required: + - package + - severity + - vulnerable_version_range + - first_patched_version + withdrawn_at: + type: string + required: + - cvss + - cwes + - ghsa_id + - summary + - description + - severity + - identifiers + - references + - published_at + - updated_at + - withdrawn_at + - vulnerabilities + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - action + - security_advisory + webhook-security-and-analysis: + title: security_and_analysis event + type: object + properties: + changes: + type: object + properties: + from: type: object properties: - created_at: - type: string - description: - type: string - is_custom_ammount: - type: boolean - is_custom_amount: - type: boolean - is_one_time: - type: boolean - monthly_price_in_cents: - type: integer - monthly_price_in_dollars: - type: integer - name: - type: string - node_id: + security_and_analysis: + "$ref": "#/components/schemas/security-and-analysis" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/full-repository" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + required: + - changes + - repository + webhook-sponsorship-cancelled: + title: sponsorship cancelled event + type: object + properties: + action: + type: string + enum: + - cancelled + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + sponsorship: + "$ref": "#/components/schemas/webhooks_sponsorship" + required: + - action + - sponsorship + - sender + webhook-sponsorship-created: + title: sponsorship created event + type: object + properties: + action: + type: string + enum: + - created + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + sponsorship: + "$ref": "#/components/schemas/webhooks_sponsorship" + required: + - action + - sponsorship + - sender + webhook-sponsorship-edited: + title: sponsorship edited event + type: object + properties: + action: + type: string + enum: + - edited + changes: + type: object + properties: + privacy_level: + type: object + properties: + from: + description: The `edited` event types include the details about + the change when someone edits a sponsorship to change the privacy. type: string required: - - node_id - - created_at - - description - - monthly_price_in_cents - - monthly_price_in_dollars - - name - - is_one_time - required: - - node_id - - created_at - - sponsorable - - sponsor - - privacy_level - - tier + - from + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + sponsorship: + "$ref": "#/components/schemas/webhooks_sponsorship" + required: + - action + - changes + - sponsorship + - sender + webhook-sponsorship-pending-cancellation: + title: sponsorship pending_cancellation event + type: object + properties: + action: + type: string + enum: + - pending_cancellation + effective_date: + "$ref": "#/components/schemas/webhooks_effective_date" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + sponsorship: + "$ref": "#/components/schemas/webhooks_sponsorship" + required: + - action + - sponsorship + - sender + webhook-sponsorship-pending-tier-change: + title: sponsorship pending_tier_change event + type: object + properties: + action: + type: string + enum: + - pending_tier_change + changes: + "$ref": "#/components/schemas/webhooks_changes_8" + effective_date: + "$ref": "#/components/schemas/webhooks_effective_date" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + sponsorship: + "$ref": "#/components/schemas/webhooks_sponsorship" + required: + - action + - changes + - sponsorship + - sender + webhook-sponsorship-tier-changed: + title: sponsorship tier_changed event + type: object + properties: + action: + type: string + enum: + - tier_changed + changes: + "$ref": "#/components/schemas/webhooks_changes_8" + enterprise: + "$ref": "#/components/schemas/enterprise-webhooks" + installation: + "$ref": "#/components/schemas/simple-installation" + organization: + "$ref": "#/components/schemas/organization-simple-webhooks" + repository: + "$ref": "#/components/schemas/repository-webhooks" + sender: + "$ref": "#/components/schemas/simple-user-webhooks" + sponsorship: + "$ref": "#/components/schemas/webhooks_sponsorship" required: - action - changes @@ -198062,119 +183640,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when their - team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team_1" required: - team - repository @@ -198649,119 +184115,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when their - team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team_1" required: - action - team @@ -199236,119 +184590,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when their - team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team_1" required: - action - team @@ -199824,119 +185066,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when their - team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team_1" required: - action - team @@ -200476,119 +185606,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when their - team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team_1" required: - action - changes @@ -201065,119 +186083,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - deleted: - type: boolean - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - parent: - type: object - nullable: true - properties: - description: - description: Description of the team - type: string - nullable: true - html_url: - type: string - format: uri - id: - description: Unique identifier of the team - type: integer - members_url: - type: string - format: uri-template - name: - description: Name of the team - type: string - node_id: - type: string - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when - their team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id - - node_id - - slug - - description - - privacy - - notification_setting - - url - - html_url - - members_url - - repositories_url - - permission - permission: - description: Permission that the team will have for its repositories - type: string - privacy: - type: string - enum: - - open - - closed - - secret - notification_setting: - description: Whether team members will receive notifications when their - team is @mentioned - type: string - enum: - - notifications_enabled - - notifications_disabled - repositories_url: - type: string - format: uri - slug: - type: string - url: - description: URL for the team - type: string - format: uri - required: - - name - - id + "$ref": "#/components/schemas/webhooks_team_1" required: - action - team @@ -202104,1411 +187010,916 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" workflow: - title: Workflow + "$ref": "#/components/schemas/webhooks_workflow" + workflow_run: + title: Workflow Run type: object - nullable: true + required: + - actor + - artifacts_url + - cancel_url + - check_suite_id + - check_suite_node_id + - check_suite_url + - conclusion + - created_at + - event + - head_branch + - head_commit + - head_repository + - head_sha + - html_url + - id + - jobs_url + - logs_url + - name + - node_id + - path + - previous_attempt_url + - pull_requests + - repository + - rerun_url + - run_attempt + - run_number + - run_started_at + - status + - triggering_actor + - updated_at + - url + - workflow_id + - workflow_url properties: - badge_url: + actor: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + artifacts_url: type: string format: uri - created_at: - type: string - format: date-time - html_url: + cancel_url: type: string format: uri - id: + check_suite_id: type: integer - name: - type: string - node_id: + check_suite_node_id: type: string - path: + check_suite_url: type: string - state: + format: uri + conclusion: type: string - updated_at: + nullable: true + enum: + - action_required + - cancelled + - failure + - neutral + - skipped + - stale + - success + - timed_out + created_at: type: string format: date-time - url: + event: type: string - format: uri - required: - - badge_url - - created_at - - html_url - - id - - name - - node_id - - path - - state - - updated_at - - url - workflow_run: - allOf: - - title: Workflow Run - type: object - properties: - actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - artifacts_url: - type: string - format: uri - cancel_url: - type: string - format: uri - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - format: uri - conclusion: - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - - - skipped - created_at: - type: string - format: date-time - event: - type: string - head_branch: - type: string - nullable: true - head_commit: - title: SimpleCommit - type: object - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - required: - - id - - tree_id - - message - - timestamp - - author - - committer - head_repository: - title: Repository Lite - type: object - properties: - archive_url: - type: string - format: uri-template - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - private: - description: Whether the repository is private or public. - type: boolean - pulls_url: - type: string - format: uri-template - releases_url: - type: string - format: uri-template - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - format: uri-template - url: - type: string - format: uri - 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 - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - node_id - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - jobs_url: - type: string - format: uri - logs_url: - type: string - format: uri - name: - type: string - nullable: true - node_id: - type: string - path: - type: string - previous_attempt_url: - type: string - nullable: true - format: uri - pull_requests: - type: array - items: + head_branch: + type: string + nullable: true + head_commit: + title: SimpleCommit + type: object + required: + - id + - tree_id + - message + - timestamp + - author + - committer + properties: + author: + title: Committer + description: Metaproperties for Git author/committer information. type: object + required: + - email + - name properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: number - number: - type: number - url: + date: type: string - format: uri + format: date-time + email: + type: string + nullable: true + format: email + name: + description: The git author's name. + type: string + username: + type: string + committer: + title: Committer + description: Metaproperties for Git author/committer information. + type: object + required: + - email + - name + properties: + date: + type: string + format: date-time + email: + type: string + nullable: true + format: email + name: + description: The git author's name. + type: string + username: + type: string + id: + type: string + message: + type: string + timestamp: + type: string + tree_id: + type: string + head_repository: + title: Repository Lite + type: object + 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 + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - node_id + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + properties: + archive_url: + type: string + format: uri-template + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + languages_url: + type: string + format: uri + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + owner: + title: User + type: object + nullable: true required: - - url + - login - id - - number - - head - - base - referenced_workflows: - type: array - nullable: true - items: - type: object properties: - path: + avatar_url: type: string - ref: + format: uri + deleted: + type: boolean + email: type: string - sha: + nullable: true + events_url: type: string - required: - - path - - sha - repository: - title: Repository Lite + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + private: + description: Whether the repository is private or public. + type: boolean + pulls_url: + type: string + format: uri-template + releases_url: + type: string + format: uri-template + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + trees_url: + type: string + format: uri-template + url: + type: string + format: uri + head_sha: + type: string + html_url: + type: string + format: uri + id: + type: integer + jobs_url: + type: string + format: uri + logs_url: + type: string + format: uri + name: + type: string + nullable: true + node_id: + type: string + path: + type: string + previous_attempt_url: + type: string + nullable: true + format: uri + pull_requests: + type: array + items: type: object - properties: - archive_url: - type: string - format: uri-template - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - private: - description: Whether the repository is private or public. - type: boolean - pulls_url: - type: string - format: uri-template - releases_url: - type: string - format: uri-template - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - format: uri-template - url: - type: string - format: uri 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 - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - node_id - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - url - rerun_url: - type: string - format: uri - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: - type: string - enum: - - requested - - in_progress - - completed - - queued - - pending - - waiting - triggering_actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - id - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - format: uri - required: - - artifacts_url - - cancel_url - - check_suite_url - - check_suite_id - - check_suite_node_id - - conclusion - - created_at - - event - - head_branch - - head_commit - - head_repository - - head_sha - - html_url - - id - - jobs_url - - logs_url - - node_id - - name - - path - - pull_requests - - repository - - rerun_url - - run_number - - status - - updated_at - - url - - workflow_id - - workflow_url - - run_attempt - - run_started_at - - previous_attempt_url - - actor - - triggering_actor - - type: object - properties: - actor: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - conclusion: - type: string - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - skipped - created_at: - type: string - event: - type: string - head_branch: - type: string + - number + - head + - base nullable: true - head_commit: - type: object properties: - author: + base: type: object + required: + - ref + - sha + - repo properties: - email: + ref: type: string - name: + repo: + title: Repo Ref + type: object + required: + - id + - url + - name + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + sha: type: string - committer: + head: type: object + required: + - ref + - sha + - repo properties: - email: + ref: type: string - name: + repo: + title: Repo Ref + type: object + required: + - id + - url + - name + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + sha: type: string id: + type: number + number: + type: number + url: type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - head_repository: + format: uri + referenced_workflows: + type: array + nullable: true + items: type: object + required: + - path + - sha properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: + path: type: string - trees_url: + ref: type: string - url: + sha: type: string - head_sha: - type: string - html_url: - type: string - id: - type: integer - jobs_url: - type: string - logs_url: - type: string - name: - type: string - nullable: true - node_id: - type: string - path: - type: string - previous_attempt_url: - type: string - nullable: true - pull_requests: - type: array - items: - type: object + repository: + title: Repository Lite + type: object + 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 + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - node_id + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + properties: + archive_url: + type: string + format: uri-template + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + deployments_url: + type: string + format: uri + description: + type: string nullable: true - referenced_workflows: - type: array - nullable: true - items: + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + languages_url: + type: string + format: uri + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + owner: + title: User type: object + nullable: true + required: + - login + - id properties: - path: + avatar_url: type: string - ref: + format: uri + deleted: + type: boolean + email: type: string - sha: + nullable: true + events_url: type: string - required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: - type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - status: - type: string - triggering_actor: - type: object - nullable: true - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - updated_at: - type: string - url: - type: string - workflow_id: - type: integer - workflow_url: - type: string - required: - - conclusion + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + private: + description: Whether the repository is private or public. + type: boolean + pulls_url: + type: string + format: uri-template + releases_url: + type: string + format: uri-template + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + trees_url: + type: string + format: uri-template + url: + type: string + format: uri + rerun_url: + type: string + format: uri + run_attempt: + type: integer + run_number: + type: integer + run_started_at: + type: string + format: date-time + status: + type: string + enum: + - requested + - in_progress + - completed + - queued + - pending + - waiting + triggering_actor: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + format: uri + display_title: + type: string + example: Simple Workflow + description: The event-specific title associated with the run or the + run-name if set, or the value of `run-name` if it is set in the workflow. required: - action - repository @@ -203534,1411 +187945,911 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" workflow: - title: Workflow + "$ref": "#/components/schemas/webhooks_workflow" + workflow_run: + title: Workflow Run type: object - nullable: true + required: + - actor + - artifacts_url + - cancel_url + - check_suite_id + - check_suite_node_id + - check_suite_url + - conclusion + - created_at + - event + - head_branch + - head_commit + - head_repository + - head_sha + - html_url + - id + - jobs_url + - logs_url + - name + - node_id + - path + - previous_attempt_url + - pull_requests + - repository + - rerun_url + - run_attempt + - run_number + - run_started_at + - status + - triggering_actor + - updated_at + - url + - workflow_id + - workflow_url properties: - badge_url: + actor: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + artifacts_url: type: string format: uri - created_at: - type: string - format: date-time - html_url: + cancel_url: type: string format: uri - id: + check_suite_id: type: integer - name: - type: string - node_id: + check_suite_node_id: type: string - path: + check_suite_url: type: string - state: + format: uri + conclusion: type: string - updated_at: + nullable: true + enum: + - action_required + - cancelled + - failure + - neutral + - skipped + - stale + - success + - timed_out + created_at: type: string format: date-time - url: + event: type: string - format: uri - required: - - badge_url - - created_at - - html_url - - id - - name - - node_id - - path - - state - - updated_at - - url - workflow_run: - allOf: - - title: Workflow Run - type: object - properties: - actor: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - artifacts_url: - type: string - format: uri - cancel_url: - type: string - format: uri - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - format: uri - conclusion: - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - stale - - skipped - - - created_at: - type: string - format: date-time - event: - type: string - head_branch: - type: string - nullable: true - head_commit: - title: SimpleCommit - type: object - properties: - author: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - committer: - title: Committer - description: Metaproperties for Git author/committer information. - type: object - properties: - date: - type: string - format: date-time - email: - type: string - nullable: true - format: email - name: - description: The git author's name. - type: string - username: - type: string - required: - - email - - name - id: - type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - required: - - id - - tree_id - - message - - timestamp - - author - - committer - head_repository: - title: Repository Lite - type: object - properties: - archive_url: - type: string - format: uri-template - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - private: - description: Whether the repository is private or public. - type: boolean - pulls_url: - type: string - format: uri-template - releases_url: - type: string - format: uri-template - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - format: uri-template - url: - type: string - format: uri - 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 - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - node_id - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - head_sha: - type: string - html_url: - type: string - format: uri - id: - type: integer - jobs_url: - type: string - format: uri - logs_url: - type: string - format: uri - name: - type: string - nullable: true - node_id: - type: string - path: - type: string - previous_attempt_url: - type: string - nullable: true - format: uri - pull_requests: - type: array - items: + head_branch: + type: string + nullable: true + head_commit: + title: SimpleCommit + type: object + required: + - id + - tree_id + - message + - timestamp + - author + - committer + properties: + author: + title: Committer + description: Metaproperties for Git author/committer information. type: object + required: + - email + - name properties: - base: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - head: - type: object - properties: - ref: - type: string - repo: - title: Repo Ref - type: object - properties: - id: - type: integer - name: - type: string - url: - type: string - format: uri - required: - - id - - url - - name - sha: - type: string - required: - - ref - - sha - - repo - id: - type: number - number: - type: number - url: + date: type: string - format: uri - required: - - url - - id - - number - - head - - base - referenced_workflows: - type: array - nullable: true - items: + format: date-time + email: + type: string + nullable: true + format: email + name: + description: The git author's name. + type: string + username: + type: string + committer: + title: Committer + description: Metaproperties for Git author/committer information. type: object + required: + - email + - name properties: - path: + date: type: string - ref: + format: date-time + email: type: string - sha: + nullable: true + format: email + name: + description: The git author's name. type: string - required: - - path - - sha - repository: - title: Repository Lite - type: object - properties: - archive_url: - type: string - format: uri-template - assignees_url: - type: string - format: uri-template - blobs_url: - type: string - format: uri-template - branches_url: - type: string - format: uri-template - collaborators_url: - type: string - format: uri-template - comments_url: - type: string - format: uri-template - commits_url: - type: string - format: uri-template - compare_url: - type: string - format: uri-template - contents_url: - type: string - format: uri-template - contributors_url: - type: string - format: uri - deployments_url: - type: string - format: uri - description: - type: string - nullable: true - downloads_url: - type: string - format: uri - events_url: - type: string - format: uri - fork: - type: boolean - forks_url: - type: string - format: uri - full_name: - type: string - git_commits_url: - type: string - format: uri-template - git_refs_url: - type: string - format: uri-template - git_tags_url: - type: string - format: uri-template - hooks_url: - type: string - format: uri - html_url: - type: string - format: uri - id: - description: Unique identifier of the repository - type: integer - issue_comment_url: - type: string - format: uri-template - issue_events_url: - type: string - format: uri-template - issues_url: - type: string - format: uri-template - keys_url: - type: string - format: uri-template - labels_url: - type: string - format: uri-template - languages_url: - type: string - format: uri - merges_url: - type: string - format: uri - milestones_url: - type: string - format: uri-template - name: - description: The name of the repository. - type: string - node_id: - type: string - notifications_url: - type: string - format: uri-template - owner: - title: User - type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri - required: - - login - - id - private: - description: Whether the repository is private or public. - type: boolean - pulls_url: - type: string - format: uri-template - releases_url: - type: string - format: uri-template - stargazers_url: - type: string - format: uri - statuses_url: - type: string - format: uri-template - subscribers_url: - type: string - format: uri - subscription_url: - type: string - format: uri - tags_url: - type: string - format: uri - teams_url: - type: string - format: uri - trees_url: - type: string - format: uri-template - url: - type: string - format: uri - 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 - - issue_comment_url - - issue_events_url - - issues_url - - keys_url - - labels_url - - languages_url - - merges_url - - milestones_url - - name - - node_id - - notifications_url - - owner - - private - - pulls_url - - releases_url - - stargazers_url - - statuses_url - - subscribers_url - - subscription_url - - tags_url - - teams_url - - trees_url - - url - rerun_url: - type: string - format: uri - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - format: date-time - status: - type: string - enum: - - requested - - in_progress - - completed - - queued - - pending - triggering_actor: - title: User + username: + type: string + id: + type: string + message: + type: string + timestamp: + type: string + tree_id: + type: string + head_repository: + title: Repository Lite + type: object + 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 + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - node_id + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + properties: + archive_url: + type: string + format: uri-template + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + deployments_url: + type: string + format: uri + description: + type: string + nullable: true + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + languages_url: + type: string + format: uri + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + name: + description: The name of the repository. + type: string + nullable: true + node_id: + type: string + notifications_url: + type: string + format: uri-template + owner: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + private: + description: Whether the repository is private or public. + type: boolean + pulls_url: + type: string + format: uri-template + releases_url: + type: string + format: uri-template + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + trees_url: + type: string + format: uri-template + url: + type: string + format: uri + head_sha: + type: string + html_url: + type: string + format: uri + id: + type: integer + jobs_url: + type: string + format: uri + logs_url: + type: string + format: uri + name: + type: string + nullable: true + node_id: + type: string + path: + type: string + previous_attempt_url: + type: string + nullable: true + format: uri + pull_requests: + type: array + items: type: object - nullable: true - properties: - avatar_url: - type: string - format: uri - deleted: - type: boolean - email: - type: string - nullable: true - events_url: - type: string - format: uri-template - followers_url: - type: string - format: uri - following_url: - type: string - format: uri-template - gists_url: - type: string - format: uri-template - gravatar_id: - type: string - html_url: - type: string - format: uri - id: - type: integer - login: - type: string - name: - type: string - node_id: - type: string - organizations_url: - type: string - format: uri - received_events_url: - type: string - format: uri - repos_url: - type: string - format: uri - site_admin: - type: boolean - starred_url: - type: string - format: uri-template - subscriptions_url: - type: string - format: uri - type: - type: string - enum: - - Bot - - User - - Organization - url: - type: string - format: uri required: - - login + - url - id - updated_at: - type: string - format: date-time - url: - type: string - format: uri - workflow_id: - type: integer - workflow_url: - type: string - format: uri - required: - - artifacts_url - - cancel_url - - check_suite_url - - check_suite_id - - check_suite_node_id - - conclusion - - created_at - - event - - head_branch - - head_commit - - head_repository - - head_sha - - html_url - - id - - jobs_url - - logs_url - - node_id - - name - - path - - pull_requests - - repository - - rerun_url - - run_number - - status - - updated_at - - url - - workflow_id - - workflow_url - - run_attempt - - run_started_at - - previous_attempt_url - - actor - - triggering_actor - - type: object - properties: - actor: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - artifacts_url: - type: string - cancel_url: - type: string - check_suite_id: - type: integer - check_suite_node_id: - type: string - check_suite_url: - type: string - conclusion: - type: string - nullable: true - enum: - - success - - failure - - neutral - - cancelled - - timed_out - - action_required - - skipped - - stale - created_at: - type: string - event: - type: string - head_branch: - type: string + - number + - head + - base nullable: true - head_commit: - type: object properties: - author: + base: type: object + required: + - ref + - sha + - repo properties: - email: + ref: type: string - name: + repo: + title: Repo Ref + type: object + required: + - id + - url + - name + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + sha: type: string - committer: + head: type: object + required: + - ref + - sha + - repo properties: - email: + ref: type: string - name: + repo: + title: Repo Ref + type: object + required: + - id + - url + - name + properties: + id: + type: integer + name: + type: string + url: + type: string + format: uri + sha: type: string id: + type: number + number: + type: number + url: type: string - message: - type: string - timestamp: - type: string - tree_id: - type: string - head_repository: + format: uri + referenced_workflows: + type: array + nullable: true + items: type: object + required: + - path + - sha properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - nullable: true - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: + path: type: string - trees_url: + ref: type: string - url: + sha: type: string - head_sha: - type: string - html_url: - type: string - id: - type: integer - jobs_url: - type: string - logs_url: - type: string - name: - type: string - nullable: true - node_id: - type: string - path: - type: string - previous_attempt_url: - type: string - nullable: true - pull_requests: - type: array - items: - type: object + repository: + title: Repository Lite + type: object + 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 + - issue_comment_url + - issue_events_url + - issues_url + - keys_url + - labels_url + - languages_url + - merges_url + - milestones_url + - name + - node_id + - notifications_url + - owner + - private + - pulls_url + - releases_url + - stargazers_url + - statuses_url + - subscribers_url + - subscription_url + - tags_url + - teams_url + - trees_url + - url + properties: + archive_url: + type: string + format: uri-template + assignees_url: + type: string + format: uri-template + blobs_url: + type: string + format: uri-template + branches_url: + type: string + format: uri-template + collaborators_url: + type: string + format: uri-template + comments_url: + type: string + format: uri-template + commits_url: + type: string + format: uri-template + compare_url: + type: string + format: uri-template + contents_url: + type: string + format: uri-template + contributors_url: + type: string + format: uri + deployments_url: + type: string + format: uri + description: + type: string nullable: true - referenced_workflows: - type: array - nullable: true - items: + downloads_url: + type: string + format: uri + events_url: + type: string + format: uri + fork: + type: boolean + forks_url: + type: string + format: uri + full_name: + type: string + git_commits_url: + type: string + format: uri-template + git_refs_url: + type: string + format: uri-template + git_tags_url: + type: string + format: uri-template + hooks_url: + type: string + format: uri + html_url: + type: string + format: uri + id: + description: Unique identifier of the repository + type: integer + issue_comment_url: + type: string + format: uri-template + issue_events_url: + type: string + format: uri-template + issues_url: + type: string + format: uri-template + keys_url: + type: string + format: uri-template + labels_url: + type: string + format: uri-template + languages_url: + type: string + format: uri + merges_url: + type: string + format: uri + milestones_url: + type: string + format: uri-template + name: + description: The name of the repository. + type: string + node_id: + type: string + notifications_url: + type: string + format: uri-template + owner: + title: User type: object + nullable: true + required: + - login + - id properties: - path: + avatar_url: type: string - ref: + format: uri + deleted: + type: boolean + email: type: string - sha: + nullable: true + events_url: type: string - required: - - path - - sha - repository: - type: object - properties: - archive_url: - type: string - assignees_url: - type: string - blobs_url: - type: string - branches_url: - type: string - collaborators_url: - type: string - comments_url: - type: string - commits_url: - type: string - compare_url: - type: string - contents_url: - type: string - contributors_url: - type: string - deployments_url: - type: string - description: - type: string - nullable: true - downloads_url: - type: string - events_url: - type: string - fork: - type: boolean - forks_url: - type: string - full_name: - type: string - git_commits_url: - type: string - git_refs_url: - type: string - git_tags_url: - type: string - hooks_url: - type: string - html_url: - type: string - id: - type: integer - issue_comment_url: - type: string - issue_events_url: - type: string - issues_url: - type: string - keys_url: - type: string - labels_url: - type: string - languages_url: - type: string - merges_url: - type: string - milestones_url: - type: string - name: - type: string - node_id: - type: string - notifications_url: - type: string - owner: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - private: - type: boolean - pulls_url: - type: string - releases_url: - type: string - stargazers_url: - type: string - statuses_url: - type: string - subscribers_url: - type: string - subscription_url: - type: string - tags_url: - type: string - teams_url: - type: string - trees_url: - type: string - url: - type: string - rerun_url: - type: string - run_attempt: - type: integer - run_number: - type: integer - run_started_at: - type: string - status: - type: string - triggering_actor: - type: object - properties: - avatar_url: - type: string - events_url: - type: string - followers_url: - type: string - following_url: - type: string - gists_url: - type: string - gravatar_id: - type: string - html_url: - type: string - id: - type: integer - login: - type: string - node_id: - type: string - organizations_url: - type: string - received_events_url: - type: string - repos_url: - type: string - site_admin: - type: boolean - starred_url: - type: string - subscriptions_url: - type: string - type: - type: string - url: - type: string - updated_at: - type: string - url: - type: string - workflow_id: - type: integer - workflow_url: - type: string - required: - - conclusion + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + private: + description: Whether the repository is private or public. + type: boolean + pulls_url: + type: string + format: uri-template + releases_url: + type: string + format: uri-template + stargazers_url: + type: string + format: uri + statuses_url: + type: string + format: uri-template + subscribers_url: + type: string + format: uri + subscription_url: + type: string + format: uri + tags_url: + type: string + format: uri + teams_url: + type: string + format: uri + trees_url: + type: string + format: uri-template + url: + type: string + format: uri + rerun_url: + type: string + format: uri + run_attempt: + type: integer + run_number: + type: integer + run_started_at: + type: string + format: date-time + status: + type: string + enum: + - requested + - in_progress + - completed + - queued + - pending + triggering_actor: + title: User + type: object + nullable: true + required: + - login + - id + properties: + avatar_url: + type: string + format: uri + deleted: + type: boolean + email: + type: string + nullable: true + events_url: + type: string + format: uri-template + followers_url: + type: string + format: uri + following_url: + type: string + format: uri-template + gists_url: + type: string + format: uri-template + gravatar_id: + type: string + html_url: + type: string + format: uri + id: + type: integer + login: + type: string + name: + type: string + node_id: + type: string + organizations_url: + type: string + format: uri + received_events_url: + type: string + format: uri + repos_url: + type: string + format: uri + site_admin: + type: boolean + starred_url: + type: string + format: uri-template + subscriptions_url: + type: string + format: uri + type: + type: string + enum: + - Bot + - User + - Organization + url: + type: string + format: uri + updated_at: + type: string + format: date-time + url: + type: string + format: uri + workflow_id: + type: integer + workflow_url: + type: string + format: uri required: - action - repository @@ -204964,46 +188875,7 @@ components: sender: "$ref": "#/components/schemas/simple-user-webhooks" workflow: - title: Workflow - type: object - nullable: true - properties: - badge_url: - type: string - format: uri - created_at: - type: string - format: date-time - html_url: - type: string - format: uri - id: - type: integer - name: - type: string - node_id: - type: string - path: - type: string - state: - type: string - updated_at: - type: string - format: date-time - url: - type: string - format: uri - required: - - badge_url - - created_at - - html_url - - id - - name - - node_id - - path - - state - - updated_at - - url + "$ref": "#/components/schemas/webhooks_workflow" workflow_run: title: Workflow Run type: object @@ -208690,6 +192562,70 @@ 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-usage-metrics-enterprise: + 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 dependabot-alerts-for-organization: value: - number: 2 @@ -210645,7 +194581,6 @@ components: members_can_fork_private_repositories: false web_commit_signoff_required: false updated_at: '2014-03-03T18:58:10Z' - archived_at: dependency_graph_enabled_for_new_repositories: false dependabot_alerts_enabled_for_new_repositories: false dependabot_security_updates_enabled_for_new_repositories: false @@ -211831,6 +195766,70 @@ components: received_events_url: https://api.github.com/users/octokitten/received_events type: User site_admin: 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 organization-dependabot-secret-paginated: value: total_count: 3 @@ -213270,6 +197269,7 @@ components: allowed_values: - production - development + values_editable_by: org_actors - property_name: service value_type: string - property_name: team @@ -213309,7 +197309,7 @@ components: value: web - property_name: team value: octocat - repository: + full-repository: value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -213381,25 +197381,24 @@ components: hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks svn_url: https://svn.github.com/octocat/Hello-World homepage: https://github.com - organization: + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://github.com/licenses/mit language: - forks: 9 forks_count: 9 + forks: 9 stargazers_count: 80 watchers_count: 80 watchers: 80 size: 108 default_branch: master - open_issues: 0 open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit + open_issues: 0 + is_template: false topics: - octocat - atom @@ -213417,18 +197416,389 @@ components: created_at: '2011-01-26T19:01:12Z' updated_at: '2011-01-26T19:14:43Z' permissions: - admin: false - push: false pull: true + push: false + admin: false allow_rebase_merge: true - template_repository: + template_repository: + id: 1296269 + node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 + name: Hello-World-Template + full_name: octocat/Hello-World-Template + 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-Template + description: This your first repo! + fork: false + url: https://api.github.com/repos/octocat/Hello-World-Template + archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} + assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} + blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} + branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} + collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} + comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} + commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} + compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} + contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} + contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors + deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments + downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads + events_url: https://api.github.com/repos/octocat/Hello-World-Template/events + forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks + git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} + git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} + git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} + git_url: git:github.com/octocat/Hello-World-Template.git + issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} + issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} + issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} + keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} + labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} + languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages + merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges + milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} + notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} + pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} + releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} + ssh_url: git@github.com:octocat/Hello-World-Template.git + stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers + statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} + subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers + subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription + tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags + teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams + trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} + clone_url: https://github.com/octocat/Hello-World-Template.git + mirror_url: git:git.example.com/octocat/Hello-World-Template + hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks + svn_url: https://svn.github.com/octocat/Hello-World-Template + homepage: https://github.com + language: + forks: 9 + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + watchers: 80 + size: 108 + default_branch: master + open_issues: 0 + open_issues_count: 0 + is_template: true + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O allow_squash_merge: true allow_auto_merge: false delete_branch_on_merge: true allow_merge_commit: true + allow_forking: true + web_commit_signoff_required: false subscribers_count: 42 network_count: 0 + organization: + 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: Organization + site_admin: false + parent: + 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} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + source: + 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} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + language: + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 org-ruleset-items: value: - id: 21 @@ -214794,7 +199164,6 @@ components: hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks svn_url: https://svn.github.com/octocat/Hello-World homepage: https://github.com - language: forks_count: 9 forks: 9 stargazers_count: 80 @@ -215093,620 +199462,129 @@ components: forks: 1 open_issues: 1 watchers: 1 - source: - 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} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - security_and_analysis: - advanced_security: - status: enabled - secret_scanning: - status: enabled - secret_scanning_push_protection: - status: disabled - full-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} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit - language: - forks_count: 9 - forks: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues_count: 0 - open_issues: 0 - is_template: false - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - pull: true - push: false - admin: false - allow_rebase_merge: true - template_repository: - id: 1296269 - node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 - name: Hello-World-Template - full_name: octocat/Hello-World-Template - 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-Template - description: This your first repo! - fork: false - url: https://api.github.com/repos/octocat/Hello-World-Template - archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref} - assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user} - blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha} - branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch} - collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator} - comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number} - commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha} - compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head} - contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path} - contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors - deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments - downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads - events_url: https://api.github.com/repos/octocat/Hello-World-Template/events - forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks - git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha} - git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha} - git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha} - git_url: git:github.com/octocat/Hello-World-Template.git - issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number} - issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number} - issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number} - keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id} - labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name} - languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages - merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges - milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number} - notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating} - pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number} - releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id} - ssh_url: git@github.com:octocat/Hello-World-Template.git - stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers - statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha} - subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers - subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription - tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags - teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams - trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha} - clone_url: https://github.com/octocat/Hello-World-Template.git - mirror_url: git:git.example.com/octocat/Hello-World-Template - hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks - svn_url: https://svn.github.com/octocat/Hello-World-Template - homepage: https://github.com - language: - forks: 9 - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues: 0 - open_issues_count: 0 - is_template: true - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - allow_forking: true - web_commit_signoff_required: false - subscribers_count: 42 - network_count: 0 - organization: - 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: Organization - site_admin: false - parent: - 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} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 - source: - 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} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - stargazers_count: 80 - watchers_count: 80 - size: 108 - default_branch: master - open_issues_count: 0 - is_template: true - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O - allow_squash_merge: true - allow_auto_merge: false - delete_branch_on_merge: true - allow_merge_commit: true - subscribers_count: 42 - network_count: 0 - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://api.github.com/licenses/mit - forks: 1 - open_issues: 1 - watchers: 1 + source: + 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} + clone_url: https://github.com/octocat/Hello-World.git + mirror_url: git:git.example.com/octocat/Hello-World + hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks + svn_url: https://svn.github.com/octocat/Hello-World + homepage: https://github.com + forks_count: 9 + stargazers_count: 80 + watchers_count: 80 + size: 108 + default_branch: master + open_issues_count: 0 + is_template: true + topics: + - octocat + - atom + - electron + - api + has_issues: true + has_projects: true + has_wiki: true + has_pages: false + has_downloads: true + archived: false + disabled: false + visibility: public + pushed_at: '2011-01-26T19:06:43Z' + created_at: '2011-01-26T19:01:12Z' + updated_at: '2011-01-26T19:14:43Z' + permissions: + admin: false + push: false + pull: true + allow_rebase_merge: true + temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O + allow_squash_merge: true + allow_auto_merge: false + delete_branch_on_merge: true + allow_merge_commit: true + subscribers_count: 42 + network_count: 0 + license: + key: mit + name: MIT License + url: https://api.github.com/licenses/mit + spdx_id: MIT + node_id: MDc6TGljZW5zZW1pdA== + html_url: https://api.github.com/licenses/mit + forks: 1 + open_issues: 1 + watchers: 1 + security_and_analysis: + advanced_security: + status: enabled + secret_scanning: + status: enabled + secret_scanning_push_protection: + status: disabled artifact-paginated: value: total_count: 2 @@ -223305,8 +207183,12 @@ components: updated_at: '2014-02-10T19:00:51Z' page-deployment: value: + id: 4fd754f7e594640989b406850d0bc8f06a121251 status_url: https://api.github.com/repos/github/developer.github.com/pages/deployments/4fd754f7e594640989b406850d0bc8f06a121251/status page_url: developer.github.com + pages-deployment-status: + value: + status: succeed pages-health-check: value: domain: @@ -223408,6 +207290,15 @@ components: value: web - property_name: team value: octocat + create-or-update-custom-properties-values: + value: + properties: + - property_name: environment + value: production + - property_name: service + value: web + - property_name: team + value: octocat pull-request: value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 @@ -225847,6 +209738,17 @@ components: blob_url: https://api.github.com/repos/octocat/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b commit_url: https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b + - type: wiki_commit + details: + path: "/example/Home.md" + start_line: 1 + end_line: 1 + start_column: 1 + end_column: 64 + blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b + page_url: https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_sha: 302c0b7e200761c9dd9b57e57db540ee0b4293a5 + commit_url: https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5 - type: issue_title details: issue_title_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 @@ -225856,6 +209758,30 @@ components: - type: issue_comment details: issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 + - type: discussion_title + details: + discussion_title_url: https://github.com/community/community/discussions/39082 + - type: discussion_body + details: + discussion_body_url: https://github.com/community/community/discussions/39082#discussion-4566270 + - type: discussion_comment + details: + 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 + - type: pull_request_body + details: + pull_request_body_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846 + - type: pull_request_comment + details: + pull_request_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1825855898 + - type: pull_request_review + details: + pull_request_review_url: https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 + - type: pull_request_review_comment + details: + pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 repository-advisory: value: ghsa_id: GHSA-abcd-1234-efgh @@ -226827,118 +210753,6 @@ components: allow_forking: true subscribers_count: 42 network_count: 0 - repository-3: - 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} - clone_url: https://github.com/octocat/Hello-World.git - mirror_url: git:git.example.com/octocat/Hello-World - hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks - svn_url: https://svn.github.com/octocat/Hello-World - homepage: https://github.com - language: - forks_count: 9 - forks: 9 - stargazers_count: 80 - watchers_count: 80 - watchers: 80 - size: 108 - default_branch: master - open_issues_count: 0 - open_issues: 0 - is_template: false - topics: - - octocat - - atom - - electron - - api - has_issues: true - has_projects: true - has_wiki: true - has_pages: false - has_downloads: true - archived: false - disabled: false - visibility: public - pushed_at: '2011-01-26T19:06:43Z' - created_at: '2011-01-26T19:01:12Z' - updated_at: '2011-01-26T19:14:43Z' - permissions: - admin: false - push: false - pull: true - allow_rebase_merge: true - allow_auto_merge: false - license: - key: mit - name: MIT License - url: https://api.github.com/licenses/mit - spdx_id: MIT - node_id: MDc6TGljZW5zZW1pdA== - html_url: https://github.com/licenses/mit public-repository-items: value: - id: 1296269 @@ -231877,7 +215691,8 @@ components: pagination-before: name: 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 before this cursor. + 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)." in: query required: false schema: @@ -231885,7 +215700,8 @@ components: pagination-after: name: after 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. + 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)." in: query required: false schema: @@ -231910,7 +215726,8 @@ components: type: string per-page: name: per_page - description: The number of results per page (max 100). + 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 schema: type: integer @@ -231932,7 +215749,8 @@ components: type: integer page: name: page - description: Page number of the results to fetch. + 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)." in: query schema: type: integer @@ -232270,7 +216088,8 @@ components: type: string variables-per-page: name: per_page - description: The number of results per page (max 30). + description: The number of results per page (max 30). 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 @@ -232714,7 +216533,8 @@ components: name: status description: Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can - be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. + be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, + or `requested`. in: query required: false schema: @@ -232911,7 +216731,8 @@ components: name: environment_name in: path required: true - description: The name of the environment. + description: The name of the environment. The name must be URL encoded. For + example, any slashes in the name must be replaced with `%2F`. schema: type: string branch-policy-id: @@ -232928,6 +216749,16 @@ components: required: true schema: type: integer + git-ref-only: + name: ref + description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" + in the Git documentation. + in: path + required: true + example: heads/feature-a + schema: + type: string + x-multi-segment: true since-user: name: since description: A user ID. Only return users with an ID greater than this ID. @@ -232956,6 +216787,16 @@ components: required: true schema: type: integer + pages-deployment-id: + name: pages_deployment_id + description: The ID of the Pages deployment. You can also give the commit SHA + of the deployment. + in: path + required: true + schema: + oneOf: + - type: integer + - type: string pull-number: name: pull_number description: The number that identifies the pull request. @@ -233148,6 +216989,12 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + internal_error: + description: Internal Error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" service_unavailable: description: Service unavailable content: @@ -233250,12 +217097,6 @@ components: examples: default: "$ref": "#/components/examples/runner-labels-readonly" - internal_error: - description: Internal Error - 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. @@ -233307,6 +217148,12 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" + unacceptable: + description: Unacceptable + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" headers: link: example: ; rel="next", ; diff --git a/packages/openapi-typescript/examples/stripe-api.ts b/packages/openapi-typescript/examples/stripe-api.ts index 49920feb8..b6702c9a8 100644 --- a/packages/openapi-typescript/examples/stripe-api.ts +++ b/packages/openapi-typescript/examples/stripe-api.ts @@ -88,20 +88,25 @@ export interface paths { /** @description

Retrieves the details of an account.

*/ get: operations["GetAccountsAccount"]; put?: never; - /** @description

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are + /** @description

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are * left unchanged.

* - *

For Custom accounts, you can update any information on the account. For other accounts, you can update all information until that - * account has started to go through Connect Onboarding. Once you create an Account Link - * for a Standard or Express account, some parameters can no longer be changed. These are marked as Custom Only or Custom and Express - * below.

+ *

For accounts where controller.requirement_collection + * is application, which includes Custom accounts, you can update any information on the account.

+ * + *

For accounts where controller.requirement_collection + * is stripe, which includes Standard and Express accounts, you can update all information until you create + * an Account Link or Account Session to start Connect onboarding, + * after which some properties can no longer be updated.

* *

To update your own account, use the Dashboard. Refer to our * Connect documentation to learn more about updating accounts.

*/ post: operations["PostAccountsAccount"]; - /** @description

With Connect, you can delete accounts you manage.

+ /** @description

With Connect, you can delete accounts you manage.

+ * + *

Test-mode accounts can be deleted at any time.

* - *

Accounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.

+ *

Live-mode accounts where Stripe is responsible for negative account balances cannot be deleted, which includes Standard accounts. Live-mode accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be deleted when all balances are zero.

* *

If you want to delete your own account, use the account information tab in your account settings instead.

*/ delete: operations["DeleteAccountsAccount"]; @@ -137,9 +142,14 @@ export interface paths { /** @description

Retrieve a specified external account for a given account.

*/ get: operations["GetAccountsAccountBankAccountsId"]; put?: never; - /** @description

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

+ /** @description

Updates the metadata, account holder name, account holder type of a bank account belonging to + * a connected account and optionally sets it as the default for its currency. Other bank account + * details are not editable by design.

+ * + *

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

* - *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ + *

You can re-enable a disabled bank account by performing an update call without providing any + * arguments or changes.

*/ post: operations["PostAccountsAccountBankAccountsId"]; /** @description

Delete a specified external account for a given account.

*/ delete: operations["DeleteAccountsAccountBankAccountsId"]; @@ -211,9 +221,14 @@ export interface paths { /** @description

Retrieve a specified external account for a given account.

*/ get: operations["GetAccountsAccountExternalAccountsId"]; put?: never; - /** @description

Updates the metadata, account holder name, account holder type of a bank account belonging to a Custom account, and optionally sets it as the default for its currency. Other bank account details are not editable by design.

+ /** @description

Updates the metadata, account holder name, account holder type of a bank account belonging to + * a connected account and optionally sets it as the default for its currency. Other bank account + * details are not editable by design.

* - *

You can re-enable a disabled bank account by performing an update call without providing any arguments or changes.

*/ + *

You can only update bank accounts when account.controller.requirement_collection is application, which includes Custom accounts.

+ * + *

You can re-enable a disabled bank account by performing an update call without providing any + * arguments or changes.

*/ post: operations["PostAccountsAccountExternalAccountsId"]; /** @description

Delete a specified external account for a given account.

*/ delete: operations["DeleteAccountsAccountExternalAccountsId"]; @@ -231,9 +246,9 @@ export interface paths { }; get?: never; put?: never; - /** @description

Creates a single-use login link for an Express account to access their Stripe dashboard.

+ /** @description

Creates a single-use login link for a connected account to access the Express Dashboard.

* - *

You may only create login links for Express accounts connected to your platform.

*/ + *

You can only create login links for accounts that use the Express Dashboard and are connected to your platform.

*/ post: operations["PostAccountsAccountLoginLinks"]; delete?: never; options?: never; @@ -324,9 +339,9 @@ export interface paths { }; get?: never; put?: never; - /** @description

With Connect, you may flag accounts as suspicious.

+ /** @description

With Connect, you can reject accounts that you have flagged as suspicious.

* - *

Test-mode Custom and Express accounts can be rejected at any time. Accounts created using live-mode keys may only be rejected once all balances are zero.

*/ + *

Only accounts where your platform is liable for negative account balances, which includes Custom and Express accounts, can be rejected. Test-mode accounts can be rejected at any time. Live-mode accounts can only be rejected after all balances are zero.

*/ post: operations["PostAccountsAccountReject"]; delete?: never; options?: never; @@ -612,6 +627,127 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/billing/meter_event_adjustments": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Creates a billing meter event adjustment

*/ + post: operations["PostBillingMeterEventAdjustments"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/meter_events": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Creates a billing meter event

*/ + post: operations["PostBillingMeterEvents"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/meters": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieve a list of billing meters.

*/ + get: operations["GetBillingMeters"]; + put?: never; + /** @description

Creates a billing meter

*/ + post: operations["PostBillingMeters"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/meters/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves a billing meter given an ID

*/ + get: operations["GetBillingMetersId"]; + put?: never; + /** @description

Updates a billing meter

*/ + post: operations["PostBillingMetersId"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/meters/{id}/deactivate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Deactivates a billing meter

*/ + post: operations["PostBillingMetersIdDeactivate"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/meters/{id}/event_summaries": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieve a list of billing meter event summaries.

*/ + get: operations["GetBillingMetersIdEventSummaries"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/billing/meters/{id}/reactivate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Reactivates a billing meter

*/ + post: operations["PostBillingMetersIdReactivate"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/billing_portal/configurations": { parameters: { query?: never; @@ -675,9 +811,9 @@ export interface paths { /** @description

Returns a list of charges you’ve previously created. The charges are returned in sorted order, with the most recent charges appearing first.

*/ get: operations["GetCharges"]; put?: never; - /** @description

Use the Payment Intents API to initiate a new payment instead - * of using this method. Confirmation of the PaymentIntent creates the Charge - * object used to request payment, so this method is limited to legacy integrations.

*/ + /** @description

This method is no longer recommended—use the Payment Intents API + * to initiate a new payment instead. Confirmation of the PaymentIntent creates the Charge + * object used to request payment.

*/ post: operations["PostCharges"]; delete?: never; options?: never; @@ -921,6 +1057,149 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/climate/orders": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Lists all Climate order objects. The orders are returned sorted by creation date, with the + * most recently created orders appearing first.

*/ + get: operations["GetClimateOrders"]; + put?: never; + /** @description

Creates a Climate order object for a given Climate product. The order will be processed immediately + * after creation and payment will be deducted your Stripe balance.

*/ + post: operations["PostClimateOrders"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/climate/orders/{order}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves the details of a Climate order object with the given ID.

*/ + get: operations["GetClimateOrdersOrder"]; + put?: never; + /** @description

Updates the specified order by setting the values of the parameters passed.

*/ + post: operations["PostClimateOrdersOrder"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/climate/orders/{order}/cancel": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Cancels a Climate order. You can cancel an order within 30 days of creation. Stripe refunds the + * reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier + * might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe + * provides 90 days advance notice and refunds the amount_total.

*/ + post: operations["PostClimateOrdersOrderCancel"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/climate/products": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Lists all available Climate product objects.

*/ + get: operations["GetClimateProducts"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/climate/products/{product}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves the details of a Climate product with the given ID.

*/ + get: operations["GetClimateProductsProduct"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/climate/suppliers": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Lists all available Climate supplier objects.

*/ + get: operations["GetClimateSuppliers"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/climate/suppliers/{supplier}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves a Climate supplier object.

*/ + get: operations["GetClimateSuppliersSupplier"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/confirmation_tokens/{confirmation_token}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves an existing ConfirmationToken object

*/ + get: operations["GetConfirmationTokensConfirmationToken"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/country_specs": { parameters: { query?: never; @@ -1111,6 +1390,23 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/customer_sessions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Creates a customer session object that includes a single-use client secret that you can use on your front-end to grant client-side API access for certain customer resources.

*/ + post: operations["PostCustomerSessions"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/customers": { parameters: { query?: never; @@ -1649,6 +1945,76 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/entitlements/active_entitlements": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieve a list of active entitlements for a customer

*/ + get: operations["GetEntitlementsActiveEntitlements"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/entitlements/active_entitlements/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieve an active entitlement

*/ + get: operations["GetEntitlementsActiveEntitlementsId"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/entitlements/features": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieve a list of features

*/ + get: operations["GetEntitlementsFeatures"]; + put?: never; + /** @description

Creates a feature

*/ + post: operations["PostEntitlementsFeatures"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/entitlements/features/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves a feature

*/ + get: operations["GetEntitlementsFeaturesId"]; + put?: never; + /** @description

Update a feature’s metadata or permanently deactivate it.

*/ + post: operations["PostEntitlementsFeaturesId"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/ephemeral_keys": { parameters: { query?: never; @@ -1690,7 +2056,7 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

*/ + /** @description

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

*/ get: operations["GetEvents"]; put?: never; post?: never; @@ -1909,6 +2275,40 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/financial_connections/accounts/{account}/subscribe": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Subscribes to periodic refreshes of data associated with a Financial Connections Account.

*/ + post: operations["PostFinancialConnectionsAccountsAccountSubscribe"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/financial_connections/accounts/{account}/unsubscribe": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Unsubscribes from periodic refreshes of data associated with a Financial Connections Account.

*/ + post: operations["PostFinancialConnectionsAccountsAccountUnsubscribe"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/financial_connections/sessions": { parameters: { query?: never; @@ -1943,6 +2343,75 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/financial_connections/transactions": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Returns a list of Financial Connections Transaction objects.

*/ + get: operations["GetFinancialConnectionsTransactions"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/financial_connections/transactions/{transaction}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves the details of a Financial Connections Transaction

*/ + get: operations["GetFinancialConnectionsTransactionsTransaction"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/forwarding/requests": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Lists all ForwardingRequest objects.

*/ + get: operations["GetForwardingRequests"]; + put?: never; + /** @description

Creates a ForwardingRequest object.

*/ + post: operations["PostForwardingRequests"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/forwarding/requests/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves a ForwardingRequest object.

*/ + get: operations["GetForwardingRequestsId"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/identity/verification_reports": { parameters: { query?: never; @@ -2134,6 +2603,27 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/invoices/create_preview": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

At any time, you can preview the upcoming invoice for a customer. This will show you all the charges that are pending, including subscription renewal charges, invoice item charges, etc. It will also show you any discounts that are applicable to the invoice.

+ * + *

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

+ * + *

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.

*/ + post: operations["PostInvoicesCreatePreview"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/invoices/search": { parameters: { query?: never; @@ -2165,7 +2655,7 @@ export interface paths { * *

Note that when you are viewing an upcoming invoice, you are simply viewing a preview – the invoice has not yet been created. As such, the upcoming invoice will not show up in invoice listing calls, and you cannot use the API to pay or edit the invoice. If you want to change the amount that your customer will be billed, you can add, remove, or update pending invoice items, or update the customer’s discount.

* - *

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass a proration_date parameter when doing the actual subscription update. The value passed in should be the same as the subscription_proration_date returned on the upcoming invoice resource. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_proration_date on the upcoming invoice resource.

*/ + *

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you should pass the subscription_details.proration_date parameter when doing the actual subscription update. The recommended way to get only the prorations being previewed is to consider only proration line items where period[start] is equal to the subscription_details.proration_date value passed in the request.

*/ get: operations["GetInvoicesUpcoming"]; put?: never; post?: never; @@ -2332,7 +2822,9 @@ export interface paths { }; get?: never; put?: never; - /** @description

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

*/ + /** @description

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

+ * + *

Consult with local regulations to determine whether and how an invoice might be amended, canceled, or voided in the jurisdiction you’re doing business in. You might need to issue another invoice or credit note instead. Stripe recommends that you consult with your legal counsel for advice specific to your business.

*/ post: operations["PostInvoicesInvoiceVoid"]; delete?: never; options?: never; @@ -2384,8 +2876,11 @@ export interface paths { }; get?: never; put?: never; - /** @description

[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. - * This method is deprecated. Instead, respond directly to the webhook request to approve an authorization.

*/ + /** + * @deprecated + * @description

[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. + * This method is deprecated. Instead, respond directly to the webhook request to approve an authorization.

+ */ post: operations["PostIssuingAuthorizationsAuthorizationApprove"]; delete?: never; options?: never; @@ -2402,8 +2897,11 @@ export interface paths { }; get?: never; put?: never; - /** @description

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow. - * This method is deprecated. Instead, respond directly to the webhook request to decline an authorization.

*/ + /** + * @deprecated + * @description

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow. + * This method is deprecated. Instead, respond directly to the webhook request to decline an authorization.

+ */ post: operations["PostIssuingAuthorizationsAuthorizationDecline"]; delete?: never; options?: never; @@ -2536,6 +3034,76 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/issuing/personalization_designs": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ + get: operations["GetIssuingPersonalizationDesigns"]; + put?: never; + /** @description

Creates a personalization design object.

*/ + post: operations["PostIssuingPersonalizationDesigns"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/issuing/personalization_designs/{personalization_design}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves a personalization design object.

*/ + get: operations["GetIssuingPersonalizationDesignsPersonalizationDesign"]; + put?: never; + /** @description

Updates a card personalization object.

*/ + post: operations["PostIssuingPersonalizationDesignsPersonalizationDesign"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/issuing/physical_bundles": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

*/ + get: operations["GetIssuingPhysicalBundles"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/issuing/physical_bundles/{physical_bundle}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves a physical bundle object.

*/ + get: operations["GetIssuingPhysicalBundlesPhysicalBundle"]; + put?: never; + post?: never; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/issuing/settlements": { parameters: { query?: never; @@ -2941,8 +3509,7 @@ export interface paths { * return to the requires_confirmation state * after those actions are completed. Your server needs to then * explicitly re-confirm the PaymentIntent to initiate the next payment - * attempt. Read the expanded documentation - * to learn more about manual confirmation.

*/ + * attempt.

*/ post: operations["PostPaymentIntentsIntentConfirm"]; delete?: never; options?: never; @@ -3287,7 +3854,7 @@ export interface paths { }; get?: never; put?: never; - /** @description

You can cancel a previously created payout if it hasn’t been paid out yet. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

*/ + /** @description

You can cancel a previously created payout if its status is pending. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.

*/ post: operations["PostPayoutsPayoutCancel"]; delete?: never; options?: never; @@ -3304,7 +3871,7 @@ export interface paths { }; get?: never; put?: never; - /** @description

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is in the pending status, use /v1/payouts/:id/cancel instead.

+ /** @description

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is manual and in the pending status, use /v1/payouts/:id/cancel instead.

* *

By requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.

*/ post: operations["PostPayoutsPayoutReverse"]; @@ -3464,6 +4031,42 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/products/{product}/features": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieve a list of features for a product

*/ + get: operations["GetProductsProductFeatures"]; + put?: never; + /** @description

Creates a product_feature, which represents a feature attachment to a product

*/ + post: operations["PostProductsProductFeatures"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/products/{product}/features/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves a product_feature, which represents a feature attachment to a product

*/ + get: operations["GetProductsProductFeaturesId"]; + put?: never; + post?: never; + /** @description

Deletes the feature attachment to a product

*/ + delete: operations["DeleteProductsProductFeaturesId"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/promotion_codes": { parameters: { query?: never; @@ -3628,7 +4231,7 @@ export interface paths { path?: never; cookie?: never; }; - /** @description

Download the PDF for a finalized quote

*/ + /** @description

Download the PDF for a finalized quote. Explanation for special handling can be found here

*/ get: operations["GetQuotesQuotePdf"]; put?: never; post?: never; @@ -4564,7 +5167,8 @@ export interface paths { path?: never; cookie?: never; }; - get?: never; + /** @description

Returns a Tax Registration object.

*/ + get: operations["GetTaxRegistrationsId"]; put?: never; /** @description

Updates an existing Tax Registration object.

* @@ -4696,6 +5300,42 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/tax_ids": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Returns a list of tax IDs.

*/ + get: operations["GetTaxIds"]; + put?: never; + /** @description

Creates a new account or customer tax_id object.

*/ + post: operations["PostTaxIds"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/tax_ids/{id}": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + /** @description

Retrieves an account or customer tax_id object.

*/ + get: operations["GetTaxIdsId"]; + put?: never; + post?: never; + /** @description

Deletes an existing account or customer tax_id object.

*/ + delete: operations["DeleteTaxIdsId"]; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/tax_rates": { parameters: { query?: never; @@ -4946,6 +5586,23 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/test_helpers/confirmation_tokens": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Creates a test mode Confirmation Token server side for your integration tests.

*/ + post: operations["PostTestHelpersConfirmationTokens"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/test_helpers/customers/{customer}/fund_cash_balance": { parameters: { query?: never; @@ -5116,6 +5773,57 @@ export interface paths { patch?: never; trace?: never; }; + "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Updates the status of the specified testmode personalization design object to active.

*/ + post: operations["PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Updates the status of the specified testmode personalization design object to inactive.

*/ + post: operations["PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; + "/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject": { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + get?: never; + put?: never; + /** @description

Updates the status of the specified testmode personalization design object to rejected.

*/ + post: operations["PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject"]; + delete?: never; + options?: never; + head?: never; + patch?: never; + trace?: never; + }; "/v1/test_helpers/issuing/transactions/create_force_capture": { parameters: { query?: never; @@ -5451,7 +6159,7 @@ export interface paths { get?: never; put?: never; /** @description

Creates a single-use token that represents a bank account’s details. - * You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a Custom account.

*/ + * You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a connected account where controller.requirement_collection is application, which includes Custom accounts.

*/ post: operations["PostTokens"]; delete?: never; options?: never; @@ -6072,16 +6780,20 @@ export interface components { * properties on the account like its current requirements or if the account is * enabled to make live charges or receive payouts. * - * For Custom accounts, the properties below are always returned. For other accounts, some properties are returned until that - * account has started to go through Connect Onboarding. Once you create an [Account Link](https://stripe.com/docs/api/account_links) - * for a Standard or Express account, some parameters are no longer returned. These are marked as **Custom Only** or **Custom and Express** - * below. Learn about the differences [between accounts](https://stripe.com/docs/connect/accounts). + * For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + * is `application`, which includes Custom accounts, the properties below are always + * returned. + * + * For accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + * is `stripe`, which includes Standard and Express accounts, some properties are only returned + * until you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions) + * to start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts). */ account: { /** @description Business information about the account. */ business_profile?: components["schemas"]["account_business_profile"] | null; /** - * @description The business type. + * @description The business type. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. * @enum {string|null} */ business_type?: "company" | "government_entity" | "individual" | "non_profit"; @@ -6099,13 +6811,13 @@ export interface components { created?: number; /** @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://stripe.com/docs/payouts). */ default_currency?: string; - /** @description Whether account details have been submitted. Standard accounts cannot receive payouts before this is true. */ + /** @description Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. */ details_submitted?: boolean; /** @description An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform. */ email?: string | null; /** * ExternalAccountList - * @description External accounts (bank accounts and debit cards) currently attached to this account + * @description External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true. */ external_accounts?: { /** @description The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards. */ @@ -6140,10 +6852,19 @@ export interface components { settings?: components["schemas"]["account_settings"] | null; tos_acceptance?: components["schemas"]["account_tos_acceptance"]; /** - * @description The Stripe account type. Can be `standard`, `express`, or `custom`. + * @description The Stripe account type. Can be `standard`, `express`, `custom`, or `none`. * @enum {string} */ - type?: "custom" | "express" | "standard"; + type?: "custom" | "express" | "none" | "standard"; + }; + /** AccountAnnualRevenue */ + account_annual_revenue: { + /** @description A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/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). */ + 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; }; /** AccountBacsDebitPaymentsSettings */ account_bacs_debit_payments_settings: { @@ -6165,6 +6886,10 @@ export interface components { }; /** AccountBusinessProfile */ account_business_profile: { + /** @description The applicant's gross annual revenue for its preceding fiscal year. */ + annual_revenue?: components["schemas"]["account_annual_revenue"] | null; + /** @description An estimated upper bound of employees, contractors, vendors, etc. currently working for the business. */ + estimated_worker_count?: number | null; /** @description [The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide. */ mcc?: string | null; monthly_estimated_revenue?: components["schemas"]["account_monthly_estimated_revenue"]; @@ -6200,6 +6925,11 @@ export interface components { * @enum {string} */ afterpay_clearpay_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments. + * @enum {string} + */ + amazon_pay_payments?: "active" | "inactive" | "pending"; /** * @description The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges. * @enum {string} @@ -6305,6 +7035,11 @@ export interface components { * @enum {string} */ link_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the MobilepPay capability of the account, or whether the account can directly process MobilePay charges. + * @enum {string} + */ + mobilepay_payments?: "active" | "inactive" | "pending"; /** * @description The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges. * @enum {string} @@ -6340,6 +7075,11 @@ export interface components { * @enum {string} */ sofort_payments?: "active" | "inactive" | "pending"; + /** + * @description The status of the Swish capability of the account, or whether the account can directly process Swish payments. + * @enum {string} + */ + swish_payments?: "active" | "inactive" | "pending"; /** * @description The status of the tax reporting 1099-K (US) capability of the account. * @enum {string} @@ -6390,7 +7130,7 @@ export interface components { 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[]; - /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ + /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. */ pending_verification: string[]; }; /** AccountCapabilityRequirements */ @@ -6404,13 +7144,13 @@ export interface components { current_deadline?: number | null; /** @description Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled. */ currently_due: string[]; - /** @description If the capability is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`. + /** @description If the capability is disabled, this string describes why. Can be `requirements.fields_needed`, `pending.onboarding`, `pending.review`, `rejected.fraud`, `rejected.other`, `platform_paused`, `action_required.requested_capabilities`, `rejected.inactivty`, or `rejected.unsupported_business`. * - * `rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service: + * `rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service, such as in [Afterpay Clearpay's terms of service](/afterpay-clearpay/legal#restricted-businesses). * - * - [Afterpay Clearpay's terms of service](/afterpay-clearpay/legal#restricted-businesses) + * `rejected.inactivity` means that the capability has been paused for inactivity. This disabled reason currently only applies to the Issuing capability. See [Issuing: Managing Inactive Connects](https://support.stripe.com/questions/issuing-managing-inactive-connect-accounts) for more details. * - * If you believe that the rejection is in error, please contact support at https://support.stripe.com/contact/ for assistance. */ + * If you believe that a rejection is in error, please contact support at https://support.stripe.com/contact/ for assistance. */ disabled_reason?: string | null; /** @description Fields that are `currently_due` and need to be collected again because validation or verification failed. */ errors: components["schemas"]["account_requirements_error"][]; @@ -6418,7 +7158,7 @@ export interface components { 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[]; - /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ + /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ pending_verification: string[]; }; /** AccountCardIssuingSettings */ @@ -6468,9 +7208,14 @@ export interface components { 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; - /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ + /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. */ pending_verification?: string[] | null; }; + /** AccountInvoicesSettings */ + account_invoices_settings: { + /** @description The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized. */ + default_account_tax_ids?: (string | components["schemas"]["tax_id"])[] | null; + }; /** * AccountLink * @description Account Links are the means by which a Connect platform grants a connected account permission to access @@ -6499,7 +7244,7 @@ export interface components { }; /** AccountMonthlyEstimatedRevenue */ account_monthly_estimated_revenue: { - /** @description A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/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). */ currency: string; @@ -6519,7 +7264,7 @@ export interface components { }; /** AccountPayoutSettings */ account_payout_settings: { - /** @description A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details. Default value is `false` for Custom accounts, otherwise `true`. */ + /** @description A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`. */ debit_negative_balances: boolean; schedule: components["schemas"]["transfer_schedule"]; /** @description The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard. */ @@ -6544,7 +7289,7 @@ export interface components { 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; - /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ + /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ pending_verification?: string[] | null; }; /** AccountRequirementsAlternative */ @@ -6560,7 +7305,7 @@ export interface components { * @description The code for the type of error. * @enum {string} */ - code: "invalid_address_city_state_postal_code" | "invalid_address_highway_contract_box" | "invalid_address_private_mailbox" | "invalid_business_profile_name" | "invalid_business_profile_name_denylisted" | "invalid_company_name_denylisted" | "invalid_dob_age_over_maximum" | "invalid_dob_age_under_18" | "invalid_dob_age_under_minimum" | "invalid_product_description_length" | "invalid_product_description_url_match" | "invalid_representative_country" | "invalid_statement_descriptor_business_mismatch" | "invalid_statement_descriptor_denylisted" | "invalid_statement_descriptor_length" | "invalid_statement_descriptor_prefix_denylisted" | "invalid_statement_descriptor_prefix_mismatch" | "invalid_street_address" | "invalid_tax_id" | "invalid_tax_id_format" | "invalid_tos_acceptance" | "invalid_url_denylisted" | "invalid_url_format" | "invalid_url_web_presence_detected" | "invalid_url_website_business_information_mismatch" | "invalid_url_website_empty" | "invalid_url_website_inaccessible" | "invalid_url_website_inaccessible_geoblocked" | "invalid_url_website_inaccessible_password_protected" | "invalid_url_website_incomplete" | "invalid_url_website_incomplete_cancellation_policy" | "invalid_url_website_incomplete_customer_service_details" | "invalid_url_website_incomplete_legal_restrictions" | "invalid_url_website_incomplete_refund_policy" | "invalid_url_website_incomplete_return_policy" | "invalid_url_website_incomplete_terms_and_conditions" | "invalid_url_website_incomplete_under_construction" | "invalid_url_website_other" | "invalid_value_other" | "verification_directors_mismatch" | "verification_document_address_mismatch" | "verification_document_address_missing" | "verification_document_corrupt" | "verification_document_country_not_supported" | "verification_document_directors_mismatch" | "verification_document_dob_mismatch" | "verification_document_duplicate_type" | "verification_document_expired" | "verification_document_failed_copy" | "verification_document_failed_greyscale" | "verification_document_failed_other" | "verification_document_failed_test_mode" | "verification_document_fraudulent" | "verification_document_id_number_mismatch" | "verification_document_id_number_missing" | "verification_document_incomplete" | "verification_document_invalid" | "verification_document_issue_or_expiry_date_missing" | "verification_document_manipulated" | "verification_document_missing_back" | "verification_document_missing_front" | "verification_document_name_mismatch" | "verification_document_name_missing" | "verification_document_nationality_mismatch" | "verification_document_not_readable" | "verification_document_not_signed" | "verification_document_not_uploaded" | "verification_document_photo_mismatch" | "verification_document_too_large" | "verification_document_type_not_supported" | "verification_extraneous_directors" | "verification_failed_address_match" | "verification_failed_business_iec_number" | "verification_failed_document_match" | "verification_failed_id_number_match" | "verification_failed_keyed_identity" | "verification_failed_keyed_match" | "verification_failed_name_match" | "verification_failed_other" | "verification_failed_residential_address" | "verification_failed_tax_id_match" | "verification_failed_tax_id_not_issued" | "verification_missing_directors" | "verification_missing_executives" | "verification_missing_owners" | "verification_requires_additional_memorandum_of_associations"; + code: "invalid_address_city_state_postal_code" | "invalid_address_highway_contract_box" | "invalid_address_private_mailbox" | "invalid_business_profile_name" | "invalid_business_profile_name_denylisted" | "invalid_company_name_denylisted" | "invalid_dob_age_over_maximum" | "invalid_dob_age_under_18" | "invalid_dob_age_under_minimum" | "invalid_product_description_length" | "invalid_product_description_url_match" | "invalid_representative_country" | "invalid_statement_descriptor_business_mismatch" | "invalid_statement_descriptor_denylisted" | "invalid_statement_descriptor_length" | "invalid_statement_descriptor_prefix_denylisted" | "invalid_statement_descriptor_prefix_mismatch" | "invalid_street_address" | "invalid_tax_id" | "invalid_tax_id_format" | "invalid_tos_acceptance" | "invalid_url_denylisted" | "invalid_url_format" | "invalid_url_web_presence_detected" | "invalid_url_website_business_information_mismatch" | "invalid_url_website_empty" | "invalid_url_website_inaccessible" | "invalid_url_website_inaccessible_geoblocked" | "invalid_url_website_inaccessible_password_protected" | "invalid_url_website_incomplete" | "invalid_url_website_incomplete_cancellation_policy" | "invalid_url_website_incomplete_customer_service_details" | "invalid_url_website_incomplete_legal_restrictions" | "invalid_url_website_incomplete_refund_policy" | "invalid_url_website_incomplete_return_policy" | "invalid_url_website_incomplete_terms_and_conditions" | "invalid_url_website_incomplete_under_construction" | "invalid_url_website_other" | "invalid_value_other" | "verification_directors_mismatch" | "verification_document_address_mismatch" | "verification_document_address_missing" | "verification_document_corrupt" | "verification_document_country_not_supported" | "verification_document_directors_mismatch" | "verification_document_dob_mismatch" | "verification_document_duplicate_type" | "verification_document_expired" | "verification_document_failed_copy" | "verification_document_failed_greyscale" | "verification_document_failed_other" | "verification_document_failed_test_mode" | "verification_document_fraudulent" | "verification_document_id_number_mismatch" | "verification_document_id_number_missing" | "verification_document_incomplete" | "verification_document_invalid" | "verification_document_issue_or_expiry_date_missing" | "verification_document_manipulated" | "verification_document_missing_back" | "verification_document_missing_front" | "verification_document_name_mismatch" | "verification_document_name_missing" | "verification_document_nationality_mismatch" | "verification_document_not_readable" | "verification_document_not_signed" | "verification_document_not_uploaded" | "verification_document_photo_mismatch" | "verification_document_too_large" | "verification_document_type_not_supported" | "verification_extraneous_directors" | "verification_failed_address_match" | "verification_failed_business_iec_number" | "verification_failed_document_match" | "verification_failed_id_number_match" | "verification_failed_keyed_identity" | "verification_failed_keyed_match" | "verification_failed_name_match" | "verification_failed_other" | "verification_failed_representative_authority" | "verification_failed_residential_address" | "verification_failed_tax_id_match" | "verification_failed_tax_id_not_issued" | "verification_missing_directors" | "verification_missing_executives" | "verification_missing_owners" | "verification_requires_additional_memorandum_of_associations"; /** @description An informative message that indicates the error type and provides additional details about the error. */ reason: string; /** @description The specific user onboarding requirement field (in the requirements hash) that needs to be resolved. */ @@ -6611,6 +7356,7 @@ export interface components { card_issuing?: components["schemas"]["account_card_issuing_settings"]; card_payments: components["schemas"]["account_card_payments_settings"]; dashboard: components["schemas"]["account_dashboard_settings"]; + invoices?: components["schemas"]["account_invoices_settings"]; payments: components["schemas"]["account_payments_settings"]; payouts?: components["schemas"]["account_payout_settings"]; sepa_debit_payments?: components["schemas"]["account_sepa_debit_payments_settings"]; @@ -6645,14 +7391,46 @@ export interface components { }; /** AccountUnificationAccountController */ account_unification_account_controller: { + fees?: components["schemas"]["account_unification_account_controller_fees"]; /** @description `true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null. */ is_controller?: boolean; + losses?: components["schemas"]["account_unification_account_controller_losses"]; + /** + * @description A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account. + * @enum {string} + */ + requirement_collection?: "application" | "stripe"; + stripe_dashboard?: components["schemas"]["account_unification_account_controller_stripe_dashboard"]; /** * @description The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself. * @enum {string} */ type: "account" | "application"; }; + /** AccountUnificationAccountControllerFees */ + account_unification_account_controller_fees: { + /** + * @description A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior). + * @enum {string} + */ + payer: "account" | "application" | "application_custom" | "application_express"; + }; + /** AccountUnificationAccountControllerLosses */ + account_unification_account_controller_losses: { + /** + * @description A value indicating who is liable when this account can't pay back negative balances from payments. + * @enum {string} + */ + payments: "application" | "stripe"; + }; + /** AccountUnificationAccountControllerStripeDashboard */ + account_unification_account_controller_stripe_dashboard: { + /** + * @description A value indicating the Stripe dashboard this account has access to independent of the Connect application. + * @enum {string} + */ + type: "express" | "full" | "none"; + }; /** Address */ address: { /** @description City, district, suburb, town, or village. */ @@ -6823,6 +7601,8 @@ export interface components { automatic_tax: { /** @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. */ + liability?: components["schemas"]["connect_account_reference"] | null; /** * @description The status of the most recent automated tax calculation for this invoice. * @enum {string|null} @@ -6846,7 +7626,7 @@ export interface components { balance: { /** @description Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property. */ available: components["schemas"]["balance_amount"][]; - /** @description Funds held due to negative balances on connected Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property. */ + /** @description Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property. */ connect_reserved?: components["schemas"]["balance_amount"][]; /** @description Funds that you can pay out using Instant Payouts. */ instant_available?: components["schemas"]["balance_amount_net"][]; @@ -6937,20 +7717,21 @@ 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`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `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`, `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" | "connect_collection_transfer" | "contribution" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "obligation_inbound" | "obligation_outbound" | "obligation_payout" | "obligation_payout_failure" | "obligation_reversal_inbound" | "obligation_reversal_outbound" | "payment" | "payment_failure_refund" | "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" | "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 * @description These bank accounts are payment methods on `Customer` objects. * - * On the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer - * destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts). + * On the other hand [External Accounts](/api#external_accounts) are transfer + * destinations on `Account` objects for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + * is `application`, which includes [Custom accounts](/connect/custom-accounts). * They can be bank accounts or debit cards as well, and are documented in the links above. * - * Related guide: [Bank debits and transfers](https://stripe.com/docs/payments/bank-debits-transfers) + * Related guide: [Bank debits and transfers](/payments/bank-debits-transfers) */ bank_account: { /** @description The ID of the account that the bank account is associated with. */ @@ -6996,7 +7777,7 @@ export interface components { routing_number?: string | null; /** @description For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated. * - * For external accounts, possible values are `new`, `errored` and `verification_failed`. If a payouts fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. */ + * For external accounts, possible values are `new`, `errored` and `verification_failed`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply. */ status: string; }; /** BankConnectionsResourceAccountholder */ @@ -7063,6 +7844,11 @@ export interface components { * @description The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. */ last_attempted_at: number; + /** + * Format: unix-time + * @description Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. + */ + next_refresh_available_at?: number | null; /** * @description The status of the last refresh attempt. * @enum {string} @@ -7081,12 +7867,182 @@ export interface components { * @description The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. */ last_attempted_at: number; + /** + * Format: unix-time + * @description Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. + */ + next_refresh_available_at?: number | null; /** * @description The status of the last refresh attempt. * @enum {string} */ status: "failed" | "pending" | "succeeded"; }; + /** BankConnectionsResourceTransactionRefresh */ + bank_connections_resource_transaction_refresh: { + /** @description Unique identifier for the object. */ + id: string; + /** + * Format: unix-time + * @description The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch. + */ + last_attempted_at: number; + /** + * Format: unix-time + * @description Time at which the next transaction refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch. + */ + next_refresh_available_at?: number | null; + /** + * @description The status of the last refresh attempt. + * @enum {string} + */ + status: "failed" | "pending" | "succeeded"; + }; + /** BankConnectionsResourceTransactionResourceStatusTransitions */ + bank_connections_resource_transaction_resource_status_transitions: { + /** + * Format: unix-time + * @description Time at which this transaction posted. Measured in seconds since the Unix epoch. + */ + posted_at?: number | null; + /** + * Format: unix-time + * @description Time at which this transaction was voided. Measured in seconds since the Unix epoch. + */ + void_at?: number | null; + }; + /** + * 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. + */ + "billing.meter": { + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + customer_mapping: components["schemas"]["billing_meter_resource_customer_mapping_settings"]; + default_aggregation: components["schemas"]["billing_meter_resource_aggregation_settings"]; + /** @description The meter's name. */ + 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; + /** + * @description The time window to pre-aggregate meter events for, if any. + * @enum {string|null} + */ + event_time_window?: "day" | "hour"; + /** @description Unique identifier for the object. */ + id: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "billing.meter"; + /** + * @description The meter's status. + * @enum {string} + */ + status: "active" | "inactive"; + status_transitions: components["schemas"]["billing_meter_resource_billing_meter_status_transitions"]; + /** + * Format: unix-time + * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. + */ + updated: number; + value_settings: components["schemas"]["billing_meter_resource_billing_meter_value"]; + }; + /** + * 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. + */ + "billing.meter_event": { + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** @description The name of the meter event. Corresponds with the `event_name` field on a meter. */ + event_name: string; + /** @description A unique identifier for the event. */ + identifier: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "billing.meter_event"; + /** @description The payload of the event. This contains 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://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). */ + payload: { + [key: string]: string | undefined; + }; + /** + * Format: unix-time + * @description The timestamp passed in when creating the event. Measured in seconds since the Unix epoch. + */ + timestamp: number; + }; + /** + * BillingMeterEventAdjustment + * @description A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer. + */ + "billing.meter_event_adjustment": { + /** @description Specifies which event to cancel. */ + cancel?: components["schemas"]["billing_meter_resource_billing_meter_event_adjustment_cancel"] | null; + /** @description The name of the meter event. Corresponds with the `event_name` field on a meter. */ + event_name: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "billing.meter_event_adjustment"; + /** + * @description The meter event adjustment's status. + * @enum {string} + */ + status: "complete" | "pending"; + /** + * @description Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet. + * @enum {string} + */ + type: "cancel"; + }; + /** + * BillingMeterEventSummary + * @description A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much + * usage was accrued by a customer for that period. + */ + "billing.meter_event_summary": { + /** @description Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`. */ + aggregated_value: number; + /** + * Format: unix-time + * @description End timestamp for this event summary (inclusive). + */ + end_time: number; + /** @description Unique identifier for the object. */ + id: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** @description The meter associated with this event summary. */ + meter: string; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "billing.meter_event_summary"; + /** + * Format: unix-time + * @description Start timestamp for this event summary (inclusive). + */ + start_time: number; + }; /** billing_details */ billing_details: { /** @description Billing address. */ @@ -7098,6 +8054,42 @@ export interface components { /** @description Billing phone number (including extension). */ phone?: string | null; }; + /** BillingMeterResourceAggregationSettings */ + billing_meter_resource_aggregation_settings: { + /** + * @description Specifies how events are aggregated. + * @enum {string} + */ + formula: "count" | "sum"; + }; + /** BillingMeterResourceBillingMeterEventAdjustmentCancel */ + billing_meter_resource_billing_meter_event_adjustment_cancel: { + /** @description Unique identifier for the event. */ + identifier?: string | null; + }; + /** BillingMeterResourceBillingMeterStatusTransitions */ + billing_meter_resource_billing_meter_status_transitions: { + /** + * Format: unix-time + * @description The time the meter was deactivated, if any. Measured in seconds since Unix epoch. + */ + deactivated_at?: number | null; + }; + /** BillingMeterResourceBillingMeterValue */ + billing_meter_resource_billing_meter_value: { + /** @description The key in the meter event payload to use as the value for this meter. */ + event_payload_key: string; + }; + /** BillingMeterResourceCustomerMappingSettings */ + billing_meter_resource_customer_mapping_settings: { + /** @description The key in the meter event payload to use for mapping the event to a customer. */ + event_payload_key: string; + /** + * @description The method for mapping a meter event to a customer. + * @enum {string} + */ + type: "by_id"; + }; /** * PortalConfiguration * @description A portal configuration describes the functionality and behavior of a portal session. @@ -7181,7 +8173,7 @@ export interface components { * @enum {string} */ object: "billing_portal.session"; - /** @description The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. */ + /** @description The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. */ on_behalf_of?: string | null; /** @description The URL to redirect customers to when they click on the portal's link to return to your website. */ return_url?: string | null; @@ -7243,7 +8235,7 @@ export interface components { * Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards) */ card: { - /** @description The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. */ + /** @description The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. 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. */ account?: (string | components["schemas"]["account"]) | null; /** @description City/District/Suburb/Town/Village. */ address_city?: string | null; @@ -7267,13 +8259,13 @@ export interface components { 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://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. */ + /** @description Three-letter [ISO code for currency](https://stripe.com/docs/payouts). 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; /** @description If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge). */ cvc_check?: string | null; - /** @description Whether this card is the default external account for its currency. */ + /** @description Whether this card is the default external account for its 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. */ default_for_currency?: boolean | null; /** @description (For tokenized numbers only.) The last four digits of the device account number. */ dynamic_last4?: string | null; @@ -7297,6 +8289,7 @@ export interface components { } | null; /** @description Cardholder name. */ name?: string | null; + networks?: components["schemas"]["token_card_networks"]; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} @@ -7360,9 +8353,9 @@ export interface components { amount_refunded: number; /** @description ID of the Connect application that created the charge. */ application?: (string | components["schemas"]["application"]) | null; - /** @description The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ + /** @description The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. */ application_fee?: (string | components["schemas"]["application_fee"]) | null; - /** @description The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) for details. */ + /** @description The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. */ application_fee_amount?: number | null; /** @description ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). */ balance_transaction?: (string | components["schemas"]["balance_transaction"]) | null; @@ -7526,7 +8519,7 @@ export interface components { amount_total?: number | null; automatic_tax: components["schemas"]["payment_pages_checkout_session_automatic_tax"]; /** - * @description Describes whether Checkout should collect the customer's billing address. + * @description Describes whether Checkout should collect the customer's billing address. Defaults to `auto`. * @enum {string|null} */ billing_address_collection?: "auto" | "required"; @@ -7551,7 +8544,7 @@ export interface components { currency?: string | null; /** @description Currency conversion details for automatic currency conversion sessions */ currency_conversion?: components["schemas"]["payment_pages_checkout_session_currency_conversion"] | null; - /** @description Collect additional information from your customer using custom fields. Up to 2 fields are supported. */ + /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ custom_fields: components["schemas"]["payment_pages_checkout_session_custom_fields"][]; custom_text: components["schemas"]["payment_pages_checkout_session_custom_text"]; /** @description The ID of the customer for this Session. @@ -7565,7 +8558,7 @@ export interface components { * @enum {string|null} */ customer_creation?: "always" | "if_required"; - /** @description The customer details including the customer's tax exempt status and the customer's tax IDs. Only the customer's email is present on Sessions in `setup` mode. */ + /** @description The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode. */ customer_details?: components["schemas"]["payment_pages_checkout_session_customer_details"] | null; /** @description If provided, this value will be used when the Customer object is created. * If not provided, customers will be asked to enter their email address. @@ -7627,7 +8620,7 @@ export interface components { /** @description The ID of the Payment Link that created this Session. */ payment_link?: (string | components["schemas"]["payment_link"]) | null; /** - * @description Configure whether a Checkout Session should collect a payment method. + * @description Configure whether a Checkout Session should collect a payment method. Defaults to `always`. * @enum {string|null} */ payment_method_collection?: "always" | "if_required"; @@ -7648,12 +8641,14 @@ export interface components { /** @description The ID of the original expired Checkout Session that triggered the recovery flow. */ recovered_from?: string | null; /** - * @description Applies to Checkout Sessions with `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we will only redirect if your user chooses a redirect-based payment method. + * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`. * @enum {string} */ redirect_on_completion?: "always" | "if_required" | "never"; /** @description Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. */ return_url?: string; + /** @description Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode. */ + saved_payment_method_options?: components["schemas"]["payment_pages_checkout_session_saved_payment_method_options"] | null; /** @description The ID of the SetupIntent for Checkout Sessions in `setup` mode. */ setup_intent?: (string | components["schemas"]["setup_intent"]) | null; /** @description When set, provides configuration for Checkout to collect a shipping address from a customer. */ @@ -7672,8 +8667,7 @@ export interface components { /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be - * specified on Checkout Sessions in `payment` mode, but not Checkout Sessions - * in `subscription` or `setup` mode. + * specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used. * @enum {string|null} */ submit_type?: "auto" | "book" | "donate" | "pay"; @@ -7686,7 +8680,7 @@ export interface components { /** @description Tax and discount details for the computed total amount. */ total_details?: components["schemas"]["payment_pages_checkout_session_total_details"] | null; /** - * @description The UI mode of the Session. Can be `hosted` (default) or `embedded`. + * @description The UI mode of the Session. Defaults to `hosted`. * @enum {string|null} */ ui_mode?: "embedded" | "hosted"; @@ -7772,6 +8766,18 @@ export interface components { */ setup_future_usage?: "none"; }; + /** CheckoutAmazonPayPaymentMethodOptions */ + checkout_amazon_pay_payment_method_options: { + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * + * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none" | "off_session"; + }; /** CheckoutAuBecsDebitPaymentMethodOptions */ checkout_au_becs_debit_payment_method_options: { /** @@ -7830,6 +8836,11 @@ export interface components { /** CheckoutCardPaymentMethodOptions */ checkout_card_payment_method_options: { installments?: components["schemas"]["checkout_card_installments_options"]; + /** + * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. + * @enum {string} + */ + request_three_d_secure: "any" | "automatic" | "challenge"; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -7985,6 +8996,18 @@ export interface components { */ setup_future_usage?: "none" | "off_session"; }; + /** CheckoutMobilepayPaymentMethodOptions */ + checkout_mobilepay_payment_method_options: { + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * + * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none"; + }; /** CheckoutOxxoPaymentMethodOptions */ checkout_oxxo_payment_method_options: { /** @description The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time. */ @@ -8050,7 +9073,17 @@ export interface components { expires_after_seconds?: number | null; }; /** CheckoutRevolutPayPaymentMethodOptions */ - checkout_revolut_pay_payment_method_options: Record; + checkout_revolut_pay_payment_method_options: { + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * + * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none" | "off_session"; + }; /** CheckoutSepaDebitPaymentMethodOptions */ checkout_sepa_debit_payment_method_options: { /** @@ -8069,6 +9102,7 @@ export interface components { affirm?: components["schemas"]["checkout_affirm_payment_method_options"]; afterpay_clearpay?: components["schemas"]["checkout_afterpay_clearpay_payment_method_options"]; alipay?: components["schemas"]["checkout_alipay_payment_method_options"]; + amazon_pay?: components["schemas"]["checkout_amazon_pay_payment_method_options"]; au_becs_debit?: components["schemas"]["checkout_au_becs_debit_payment_method_options"]; bacs_debit?: components["schemas"]["checkout_bacs_debit_payment_method_options"]; bancontact?: components["schemas"]["checkout_bancontact_payment_method_options"]; @@ -8084,6 +9118,7 @@ export interface components { klarna?: components["schemas"]["checkout_klarna_payment_method_options"]; konbini?: components["schemas"]["checkout_konbini_payment_method_options"]; link?: components["schemas"]["checkout_link_payment_method_options"]; + mobilepay?: components["schemas"]["checkout_mobilepay_payment_method_options"]; oxxo?: components["schemas"]["checkout_oxxo_payment_method_options"]; p24?: components["schemas"]["checkout_p24_payment_method_options"]; paynow?: components["schemas"]["checkout_paynow_payment_method_options"]; @@ -8092,6 +9127,7 @@ export interface components { revolut_pay?: components["schemas"]["checkout_revolut_pay_payment_method_options"]; sepa_debit?: components["schemas"]["checkout_sepa_debit_payment_method_options"]; sofort?: components["schemas"]["checkout_sofort_payment_method_options"]; + swish?: components["schemas"]["checkout_swish_payment_method_options"]; us_bank_account?: components["schemas"]["checkout_us_bank_account_payment_method_options"]; }; /** CheckoutSofortPaymentMethodOptions */ @@ -8106,6 +9142,11 @@ export interface components { */ setup_future_usage?: "none"; }; + /** CheckoutSwishPaymentMethodOptions */ + checkout_swish_payment_method_options: { + /** @description The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent. */ + reference?: string | null; + }; /** CheckoutUsBankAccountPaymentMethodOptions */ checkout_us_bank_account_payment_method_options: { financial_connections?: components["schemas"]["linked_account_options_us_bank_account"]; @@ -8124,6 +9165,343 @@ export interface components { */ verification_method?: "automatic" | "instant"; }; + /** + * ClimateRemovalsOrders + * @description Orders represent your intent to purchase a particular Climate product. When you create an order, the + * payment is deducted from your merchant balance. + */ + "climate.order": { + /** @description Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit. */ + amount_fees: number; + /** @description Total amount of the carbon removal in the currency's smallest unit. */ + amount_subtotal: number; + /** @description Total amount of the order including fees in the currency's smallest unit. */ + amount_total: number; + beneficiary?: components["schemas"]["climate_removals_beneficiary"]; + /** + * Format: unix-time + * @description Time at which the order was canceled. Measured in seconds since the Unix epoch. + */ + canceled_at?: number | null; + /** + * @description Reason for the cancellation of this order. + * @enum {string|null} + */ + cancellation_reason?: "expired" | "product_unavailable" | "requested"; + /** @description For delivered orders, a URL to a delivery certificate for the order. */ + certificate?: string | null; + /** + * Format: unix-time + * @description Time at which the order was confirmed. Measured in seconds since the Unix epoch. + */ + confirmed_at?: number | null; + /** + * Format: unix-time + * @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, representing the currency for this order. */ + currency: string; + /** + * Format: unix-time + * @description Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch. + */ + delayed_at?: number | null; + /** + * Format: unix-time + * @description Time at which the order was delivered. Measured in seconds since the Unix epoch. + */ + delivered_at?: number | null; + /** @description Details about the delivery of carbon removal for this order. */ + delivery_details: components["schemas"]["climate_removals_order_deliveries"][]; + /** @description The year this order is expected to be delivered. */ + expected_delivery_year: number; + /** @description Unique identifier for the object. */ + id: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** @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. */ + metadata: { + [key: string]: string | undefined; + }; + /** + * Format: decimal + * @description Quantity of carbon removal that is included in this order. + */ + metric_tons: string; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "climate.order"; + /** @description Unique ID for the Climate `Product` this order is purchasing. */ + product: string | components["schemas"]["climate.product"]; + /** + * Format: unix-time + * @description Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch. + */ + product_substituted_at?: number | null; + /** + * @description The current status of this order. + * @enum {string} + */ + status: "awaiting_funds" | "canceled" | "confirmed" | "delivered" | "open"; + }; + /** + * ClimateRemovalsProducts + * @description A Climate product represents a type of carbon removal unit available for reservation. + * You can retrieve it to see the current price and availability. + */ + "climate.product": { + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** @description Current prices for a metric ton of carbon removal in a currency's smallest unit. */ + current_prices_per_metric_ton: { + [key: string]: components["schemas"]["climate_removals_products_price"] | undefined; + }; + /** @description The year in which the carbon removal is expected to be delivered. */ + delivery_year?: number | null; + /** @description Unique identifier for the object. For convenience, Climate product IDs are human-readable strings + * that start with `climsku_`. See [carbon removal inventory](https://stripe.com/docs/climate/orders/carbon-removal-inventory) + * for a list of available carbon removal products. */ + id: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** + * Format: decimal + * @description The quantity of metric tons available for reservation. + */ + metric_tons_available: string; + /** @description The Climate product's name. */ + name: string; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "climate.product"; + /** @description The carbon removal suppliers that fulfill orders for this Climate product. */ + suppliers: components["schemas"]["climate.supplier"][]; + }; + /** + * ClimateRemovalsSuppliers + * @description A supplier of carbon removal. + */ + "climate.supplier": { + /** @description Unique identifier for the object. */ + id: string; + /** @description Link to a webpage to learn more about the supplier. */ + info_url: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** @description The locations in which this supplier operates. */ + locations: components["schemas"]["climate_removals_location"][]; + /** @description Name of this carbon removal supplier. */ + name: string; + /** + * @description String representing the object’s type. Objects of the same type share the same value. + * @enum {string} + */ + object: "climate.supplier"; + /** + * @description The scientific pathway used for carbon removal. + * @enum {string} + */ + removal_pathway: "biomass_carbon_removal_and_storage" | "direct_air_capture" | "enhanced_weathering"; + }; + /** ClimateRemovalsBeneficiary */ + climate_removals_beneficiary: { + /** @description Publicly displayable name for the end beneficiary of carbon removal. */ + public_name: string; + }; + /** ClimateRemovalsLocation */ + climate_removals_location: { + /** @description The city where the supplier is located. */ + city?: string | null; + /** @description Two-letter ISO code representing the country where the supplier is located. */ + country: string; + /** @description The geographic latitude where the supplier is located. */ + latitude?: number | null; + /** @description The geographic longitude where the supplier is located. */ + longitude?: number | null; + /** @description The state/county/province/region where the supplier is located. */ + region?: string | null; + }; + /** + * ClimateRemovalsOrderDeliveries + * @description The delivery of a specified quantity of carbon for an order. + */ + climate_removals_order_deliveries: { + /** + * Format: unix-time + * @description Time at which the delivery occurred. Measured in seconds since the Unix epoch. + */ + delivered_at: number; + /** @description Specific location of this delivery. */ + location?: components["schemas"]["climate_removals_location"] | null; + /** @description Quantity of carbon removal supplied by this delivery. */ + metric_tons: string; + /** @description Once retired, a URL to the registry entry for the tons from this delivery. */ + registry_url?: string | null; + supplier: components["schemas"]["climate.supplier"]; + }; + /** ClimateRemovalsProductsPrice */ + climate_removals_products_price: { + /** @description Fees for one metric ton of carbon removal in the currency's smallest unit. */ + amount_fees: number; + /** @description Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit. */ + amount_subtotal: number; + /** @description Total for one metric ton of carbon removal (including fees) in the currency's smallest unit. */ + amount_total: number; + }; + /** + * ConfirmationTokensResourceConfirmationToken + * @description ConfirmationTokens help transport client side data collected by Stripe JS over + * to your server for confirming a PaymentIntent or SetupIntent. If the confirmation + * is successful, values present on the ConfirmationToken are written onto the Intent. + * + * To learn more about how to use ConfirmationToken, visit the related guides: + * - [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server) + * - [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation). + */ + confirmation_token: { + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** + * Format: unix-time + * @description Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent. + */ + expires_at?: number | null; + /** @description Unique identifier for the object. */ + id: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** @description Data used for generating a Mandate. */ + mandate_data?: components["schemas"]["confirmation_tokens_resource_mandate_data"] | null; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "confirmation_token"; + /** @description ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. */ + payment_intent?: string | null; + /** @description Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken. */ + payment_method_preview?: components["schemas"]["confirmation_tokens_resource_payment_method_preview"] | null; + /** @description Return URL used to confirm the Intent. */ + return_url?: string | null; + /** + * @description Indicates that you intend to make future payments with this ConfirmationToken's payment method. + * + * The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. + * @enum {string|null} + */ + setup_future_usage?: "off_session" | "on_session"; + /** @description ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used. */ + setup_intent?: string | null; + /** @description Shipping information collected on this ConfirmationToken. */ + shipping?: components["schemas"]["confirmation_tokens_resource_shipping"] | null; + /** @description Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken. */ + use_stripe_sdk: boolean; + }; + /** + * ConfirmationTokensResourceMandateData + * @description Data used for generating a Mandate. + */ + confirmation_tokens_resource_mandate_data: { + customer_acceptance: components["schemas"]["confirmation_tokens_resource_mandate_data_resource_customer_acceptance"]; + }; + /** + * ConfirmationTokensResourceMandateDataResourceCustomerAcceptance + * @description This hash contains details about the customer acceptance of the Mandate. + */ + confirmation_tokens_resource_mandate_data_resource_customer_acceptance: { + /** @description If this is a Mandate accepted online, this hash contains details about the online acceptance. */ + online?: components["schemas"]["confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online"] | null; + /** @description The type of customer acceptance information included with the Mandate. */ + type: string; + }; + /** + * ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline + * @description This hash contains details about the online acceptance. + */ + confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online: { + /** @description The IP address from which the Mandate was accepted by the customer. */ + ip_address?: string | null; + /** @description The user agent of the browser from which the Mandate was accepted by the customer. */ + user_agent?: string | null; + }; + /** + * ConfirmationTokensResourcePaymentMethodPreview + * @description Details of the PaymentMethod collected by Payment Element + */ + confirmation_tokens_resource_payment_method_preview: { + acss_debit?: components["schemas"]["payment_method_acss_debit"]; + affirm?: components["schemas"]["payment_method_affirm"]; + afterpay_clearpay?: components["schemas"]["payment_method_afterpay_clearpay"]; + alipay?: components["schemas"]["payment_flows_private_payment_methods_alipay"]; + amazon_pay?: components["schemas"]["payment_method_amazon_pay"]; + au_becs_debit?: components["schemas"]["payment_method_au_becs_debit"]; + bacs_debit?: components["schemas"]["payment_method_bacs_debit"]; + bancontact?: components["schemas"]["payment_method_bancontact"]; + billing_details: components["schemas"]["billing_details"]; + blik?: components["schemas"]["payment_method_blik"]; + boleto?: components["schemas"]["payment_method_boleto"]; + card?: components["schemas"]["payment_method_card"]; + card_present?: components["schemas"]["payment_method_card_present"]; + cashapp?: components["schemas"]["payment_method_cashapp"]; + customer_balance?: components["schemas"]["payment_method_customer_balance"]; + eps?: components["schemas"]["payment_method_eps"]; + fpx?: components["schemas"]["payment_method_fpx"]; + giropay?: components["schemas"]["payment_method_giropay"]; + grabpay?: components["schemas"]["payment_method_grabpay"]; + ideal?: components["schemas"]["payment_method_ideal"]; + interac_present?: components["schemas"]["payment_method_interac_present"]; + klarna?: components["schemas"]["payment_method_klarna"]; + konbini?: components["schemas"]["payment_method_konbini"]; + link?: components["schemas"]["payment_method_link"]; + mobilepay?: components["schemas"]["payment_method_mobilepay"]; + oxxo?: components["schemas"]["payment_method_oxxo"]; + p24?: components["schemas"]["payment_method_p24"]; + paynow?: components["schemas"]["payment_method_paynow"]; + paypal?: components["schemas"]["payment_method_paypal"]; + pix?: components["schemas"]["payment_method_pix"]; + promptpay?: components["schemas"]["payment_method_promptpay"]; + revolut_pay?: components["schemas"]["payment_method_revolut_pay"]; + sepa_debit?: components["schemas"]["payment_method_sepa_debit"]; + sofort?: components["schemas"]["payment_method_sofort"]; + swish?: components["schemas"]["payment_method_swish"]; + /** + * @description The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. + * @enum {string} + */ + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay" | "zip"; + us_bank_account?: components["schemas"]["payment_method_us_bank_account"]; + wechat_pay?: components["schemas"]["payment_method_wechat_pay"]; + zip?: components["schemas"]["payment_method_zip"]; + }; + /** ConfirmationTokensResourceShipping */ + confirmation_tokens_resource_shipping: { + address: components["schemas"]["address"]; + /** @description Recipient name. */ + name: string; + /** @description Recipient phone (including extension). */ + phone?: string | null; + }; + /** ConnectAccountReference */ + connect_account_reference: { + /** @description The connected account being referenced when `type` is `account`. */ + account?: string | components["schemas"]["account"]; + /** + * @description Type of the account referenced. + * @enum {string} + */ + type: "account" | "self"; + }; /** ConnectCollectionTransfer */ connect_collection_transfer: { /** @description Amount transferred, in cents (or local equivalent). */ @@ -8142,14 +9520,68 @@ export interface components { */ object: "connect_collection_transfer"; }; + /** ConnectEmbeddedAccountConfigClaim */ + connect_embedded_account_config_claim: { + /** @description Whether the embedded component is enabled. */ + enabled: boolean; + features: components["schemas"]["connect_embedded_account_features_claim"]; + }; + /** ConnectEmbeddedAccountFeaturesClaim */ + connect_embedded_account_features_claim: { + /** @description Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements. */ + external_account_collection: boolean; + }; /** ConnectEmbeddedAccountSessionCreateComponents */ connect_embedded_account_session_create_components: { - account_onboarding: components["schemas"]["connect_embedded_base_config_claim"]; + account_management: components["schemas"]["connect_embedded_account_config_claim"]; + account_onboarding: components["schemas"]["connect_embedded_account_config_claim"]; + balances: components["schemas"]["connect_embedded_payouts_config_claim"]; + documents: components["schemas"]["connect_embedded_base_config_claim"]; + notification_banner: components["schemas"]["connect_embedded_account_config_claim"]; + payment_details: components["schemas"]["connect_embedded_payments_config_claim"]; + payments: components["schemas"]["connect_embedded_payments_config_claim"]; + payouts: components["schemas"]["connect_embedded_payouts_config_claim"]; + payouts_list: components["schemas"]["connect_embedded_base_config_claim"]; }; /** ConnectEmbeddedBaseConfigClaim */ connect_embedded_base_config_claim: { /** @description Whether the embedded component is enabled. */ enabled: boolean; + features: components["schemas"]["connect_embedded_base_features"]; + }; + /** ConnectEmbeddedBaseFeatures */ + connect_embedded_base_features: Record; + /** ConnectEmbeddedPaymentsConfigClaim */ + connect_embedded_payments_config_claim: { + /** @description Whether the embedded component is enabled. */ + enabled: boolean; + features: components["schemas"]["connect_embedded_payments_features"]; + }; + /** ConnectEmbeddedPaymentsFeatures */ + connect_embedded_payments_features: { + /** @description Whether to allow capturing and cancelling payment intents. This is `true` by default. */ + capture_payments: boolean; + /** @description Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default. */ + destination_on_behalf_of_charge_management: boolean; + /** @description Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default. */ + dispute_management: boolean; + /** @description Whether to allow sending refunds. This is `true` by default. */ + refund_management: boolean; + }; + /** ConnectEmbeddedPayoutsConfigClaim */ + connect_embedded_payouts_config_claim: { + /** @description Whether the embedded component is enabled. */ + enabled: boolean; + features: components["schemas"]["connect_embedded_payouts_features"]; + }; + /** ConnectEmbeddedPayoutsFeatures */ + connect_embedded_payouts_features: { + /** @description Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise. */ + edit_payout_schedule: boolean; + /** @description Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise. */ + instant_payouts: boolean; + /** @description Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise. */ + standard_payouts: boolean; }; /** * CountrySpec @@ -8340,7 +9772,7 @@ export interface components { /** @description Refund related to this credit note. */ refund?: (string | components["schemas"]["refund"]) | null; /** @description The details of the cost of shipping, including the ShippingRate applied to the invoice. */ - shipping_cost?: components["schemas"]["invoices_shipping_cost"] | null; + shipping_cost?: components["schemas"]["invoices_resource_shipping_cost"] | null; /** * @description Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). * @enum {string} @@ -8684,6 +10116,11 @@ export interface components { /** @description The [Refund](https://stripe.com/docs/api/refunds/object) that moved these funds into the customer's cash balance. */ refund: string | components["schemas"]["refund"]; }; + /** CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance */ + customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance: { + /** @description The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance. */ + balance_transaction: string | components["schemas"]["balance_transaction"]; + }; /** CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction */ customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction: { /** @description The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were unapplied from. */ @@ -8771,6 +10208,7 @@ export interface components { */ object: "customer_cash_balance_transaction"; refunded_from_payment?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction"]; + transferred_to_balance?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance"]; /** * @description The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types. * @enum {string} @@ -8778,6 +10216,61 @@ export interface components { type: "adjusted_for_overdraft" | "applied_to_payment" | "funded" | "funding_reversed" | "refunded_from_payment" | "return_canceled" | "return_initiated" | "transferred_to_balance" | "unapplied_from_payment"; unapplied_from_payment?: components["schemas"]["customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction"]; }; + /** + * CustomerSessionResourceCustomerSession + * @description A customer session allows you to grant client access to Stripe's frontend SDKs (like StripeJs) + * control over a customer. + */ + customer_session: { + /** @description The client secret of this customer session. Used on the client to set up secure access to the given `customer`. + * + * The client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret. */ + client_secret: string; + components?: components["schemas"]["customer_session_resource_components"]; + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** @description The customer the customer session was created for. */ + customer: string | components["schemas"]["customer"]; + /** + * Format: unix-time + * @description The timestamp at which this customer session will expire. + */ + expires_at: number; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "customer_session"; + }; + /** + * CustomerSessionResourceComponents + * @description Configuration for the components supported by this customer session. + */ + customer_session_resource_components: { + buy_button: components["schemas"]["customer_session_resource_components_resource_buy_button"]; + pricing_table: components["schemas"]["customer_session_resource_components_resource_pricing_table"]; + }; + /** + * CustomerSessionResourceComponentsResourceBuyButton + * @description This hash contains whether the buy button is enabled. + */ + customer_session_resource_components_resource_buy_button: { + /** @description Whether the buy button is enabled. */ + enabled: boolean; + }; + /** + * CustomerSessionResourceComponentsResourcePricingTable + * @description This hash contains whether the pricing table is enabled. + */ + customer_session_resource_components_resource_pricing_table: { + /** @description Whether the pricing table is enabled. */ + enabled: boolean; + }; /** CustomerTax */ customer_tax: { /** @@ -8945,6 +10438,8 @@ export interface components { start: number; /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ subscription?: string | null; + /** @description The subscription item that this coupon is applied to, if it is applied to a particular subscription item. */ + subscription_item?: string | null; }; /** Polymorphic */ deleted_external_account: components["schemas"]["deleted_bank_account"] | components["schemas"]["deleted_card"]; @@ -9040,6 +10535,21 @@ export interface components { */ object: "product"; }; + /** DeletedProductFeature */ + deleted_product_feature: { + /** + * @description Always true for a deleted object + * @enum {boolean} + */ + deleted: true; + /** @description Unique identifier for the object. */ + id: string; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "product_feature"; + }; /** RadarListDeletedList */ "deleted_radar.value_list": { /** @@ -9175,6 +10685,8 @@ export interface components { */ object: "webhook_endpoint"; }; + /** destination_details_unimplemented */ + destination_details_unimplemented: Record; /** * Discount * @description A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes). @@ -9213,6 +10725,8 @@ export interface components { start: number; /** @description The subscription that this coupon is applied to, if it is applied to a particular subscription. */ subscription?: string | null; + /** @description The subscription item that this coupon is applied to, if it is applied to a particular subscription item. */ + subscription_item?: string | null; }; /** DiscountsResourceDiscountAmount */ discounts_resource_discount_amount: { @@ -9221,6 +10735,15 @@ export interface components { /** @description The discount that was applied to get this discount amount. */ discount: string | components["schemas"]["discount"] | components["schemas"]["deleted_discount"]; }; + /** DiscountsResourceStackableDiscount */ + discounts_resource_stackable_discount: { + /** @description ID of the coupon to create a new discount for. */ + coupon?: (string | components["schemas"]["coupon"]) | null; + /** @description ID of an existing discount on the object (or one of its ancestors) to reuse. */ + discount?: (string | components["schemas"]["discount"]) | null; + /** @description ID of the promotion code to create a new discount for. */ + promotion_code?: (string | components["schemas"]["promotion_code"]) | null; + }; /** * Dispute * @description A dispute occurs when a customer questions your charge with their card issuer. @@ -9344,8 +10867,7 @@ export interface components { }; /** DisputePaymentMethodDetails */ dispute_payment_method_details: { - /** @description Card specific dispute details. */ - card?: components["schemas"]["dispute_payment_method_details_card"] | null; + card?: components["schemas"]["dispute_payment_method_details_card"]; /** * @description Payment method type. * @enum {string} @@ -9369,6 +10891,51 @@ export interface components { /** @description The recipient's email address. */ email_sent_to: string; }; + /** + * ActiveEntitlement + * @description An active entitlement describes access to a feature for a customer. + */ + "entitlements.active_entitlement": { + /** @description The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to. */ + feature: string | components["schemas"]["entitlements.feature"]; + /** @description Unique identifier for the object. */ + id: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** @description A unique key you provide as your own system identifier. This may be up to 80 characters. */ + lookup_key: string; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "entitlements.active_entitlement"; + }; + /** + * Feature + * @description A feature represents a monetizable ability or functionality in your system. + * Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer. + */ + "entitlements.feature": { + /** @description Inactive features cannot be attached to new products and will not be returned from the features list endpoint. */ + active: boolean; + /** @description Unique identifier for the object. */ + id: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** @description A unique key you provide as your own system identifier. This may be up to 80 characters. */ + lookup_key: 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 in a structured format. */ + metadata: { + [key: string]: string | undefined; + }; + /** @description The feature's name, for your own purpose, not meant to be displayable to the customer. */ + name: string; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "entitlements.feature"; + }; /** EphemeralKey */ ephemeral_key: { /** @@ -9420,10 +10987,10 @@ export interface components { * `Event` objects directly to an endpoint on your server. You can manage * webhooks in your * [account settings](https://dashboard.stripe.com/account/webhooks). Learn how - * to [listen for events](https://stripe.com/docs/webhooks) + * to [listen for events](https://docs.stripe.com/webhooks) * so that your integration can automatically trigger reactions. * - * When using [Connect](https://stripe.com/docs/connect), you can also receive event notifications + * When using [Connect](https://docs.stripe.com/connect), you can also receive event notifications * that occur in connected accounts. For these events, there's an * additional `account` attribute in the received `Event` object. * @@ -9509,7 +11076,7 @@ export interface components { errors?: components["schemas"]["account_requirements_error"][] | null; /** @description Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account. */ past_due?: string[] | null; - /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ + /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ pending_verification?: string[] | null; }; /** Fee */ @@ -9522,7 +11089,7 @@ export interface components { currency: string; /** @description An arbitrary string attached to the object. Often useful for displaying to users. */ description?: string | null; - /** @description Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`. */ + /** @description Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`. */ type: string; }; /** @@ -9564,7 +11131,7 @@ export interface components { * @description This object represents files hosted on Stripe's servers. You can upload * files with the [create file](https://stripe.com/docs/api#create_file) request * (for example, when uploading dispute evidence). Stripe also - * creates files independetly (for example, the results of a [Sigma scheduled + * creates files independently (for example, the results of a [Sigma scheduled * query](#scheduled_queries)). * * Related guide: [File upload guide](https://stripe.com/docs/file-upload) @@ -9722,8 +11289,12 @@ export interface components { * @enum {string} */ subcategory: "checking" | "credit_card" | "line_of_credit" | "mortgage" | "other" | "savings"; + /** @description The list of data refresh subscriptions requested on this account. */ + subscriptions?: "transactions"[] | null; /** @description The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account. */ supported_payment_method_types: ("link" | "us_bank_account")[]; + /** @description The state of the most recent attempt to refresh the account transactions. */ + transaction_refresh?: components["schemas"]["bank_connections_resource_transaction_refresh"] | null; }; /** * BankConnectionsResourceOwner @@ -9827,10 +11398,51 @@ export interface components { /** @description Permissions requested for accounts collected during this session. */ permissions: ("balances" | "ownership" | "payment_method" | "transactions")[]; /** @description Data features requested to be retrieved upon account creation. */ - prefetch?: ("balances" | "ownership")[] | null; + prefetch?: ("balances" | "ownership" | "transactions")[] | null; /** @description For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. */ return_url?: string; }; + /** + * BankConnectionsResourceTransaction + * @description A Transaction represents a real transaction that affects a Financial Connections Account balance. + */ + "financial_connections.transaction": { + /** @description The ID of the Financial Connections Account this transaction belongs to. */ + account: string; + /** @description The amount of this transaction, 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). */ + currency: string; + /** @description The description of this transaction. */ + description: string; + /** @description Unique identifier for the object. */ + id: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "financial_connections.transaction"; + /** + * @description The status of the transaction. + * @enum {string} + */ + status: "pending" | "posted" | "void"; + status_transitions: components["schemas"]["bank_connections_resource_transaction_resource_status_transitions"]; + /** + * Format: unix-time + * @description Time at which the transaction was transacted. Measured in seconds since the Unix epoch. + */ + transacted_at: number; + /** @description The token of the transaction refresh that last updated or created this transaction. */ + transaction_refresh: string; + /** + * Format: unix-time + * @description Time at which the object was last updated. Measured in seconds since the Unix epoch. + */ + updated: number; + }; /** FinancialReportingFinanceReportRunRunParameters */ financial_reporting_finance_report_run_run_parameters: { /** @description The set of output columns requested for inclusion in the report run. */ @@ -9856,6 +11468,100 @@ export interface components { /** @description Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`. */ timezone?: string; }; + /** + * ForwardedRequestContext + * @description Metadata about the forwarded request. + */ + forwarded_request_context: { + /** @description The time it took in milliseconds for the destination endpoint to respond. */ + destination_duration: number; + /** @description The IP address of the destination. */ + destination_ip_address: string; + }; + /** + * ForwardedRequestDetails + * @description Details about the request forwarded to the destination endpoint. + */ + forwarded_request_details: { + /** @description The body payload to send to the destination endpoint. */ + body: string; + /** @description The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included. */ + headers: components["schemas"]["forwarded_request_header"][]; + /** + * @description The HTTP method used to call the destination endpoint. + * @enum {string} + */ + http_method: "POST"; + }; + /** + * ForwardedRequestHeader + * @description Header data. + */ + forwarded_request_header: { + /** @description The header name. */ + name: string; + /** @description The header value. */ + value: string; + }; + /** + * ForwardedResponseDetails + * @description Details about the response from the destination endpoint. + */ + forwarded_response_details: { + /** @description The response body from the destination endpoint to Stripe. */ + body: string; + /** @description HTTP headers that the destination endpoint returned. */ + headers: components["schemas"]["forwarded_request_header"][]; + /** @description The HTTP status code that the destination endpoint returned. */ + status: number; + }; + /** + * ForwardingRequest + * @description Instructs Stripe to make a request on your behalf using the destination URL. The destination URL + * is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials + * provided during onboarding, and injects card details from the payment_method into the request. + * + * Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers, + * before storing the request and response data in the forwarding Request object, which are subject to a + * 30-day retention period. + * + * You can provide a Stripe idempotency key to make sure that requests with the same key result in only one + * outbound request. The Stripe idempotency key provided should be unique and different from any idempotency + * keys provided on the underlying third-party request. + * + * Forwarding Requests are synchronous requests that return a response or time out according to + * Stripe’s limits. + * + * Related guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding). + */ + "forwarding.request": { + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** @description Unique identifier for the object. */ + id: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "forwarding.request"; + /** @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")[]; + /** @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. */ + request_details?: components["schemas"]["forwarded_request_details"] | null; + /** @description The response that the destination endpoint returned to us. We redact any sensitive fields. */ + response_details?: components["schemas"]["forwarded_response_details"] | null; + /** @description The destination URL for the forwarded request. Must be supported by the config. */ + url?: string | null; + }; /** * CustomerBalanceFundingInstructionsCustomerBalanceFundingInstructions * @description Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is @@ -10100,6 +11806,31 @@ export interface components { /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ reason?: string | null; }; + /** + * GelatoEmailReport + * @description Result from a email check + */ + gelato_email_report: { + /** @description Email to be verified. */ + email?: string | null; + /** @description Details on the verification error. Present when status is `unverified`. */ + error?: components["schemas"]["gelato_email_report_error"] | null; + /** + * @description Status of this `email` check. + * @enum {string} + */ + status: "unverified" | "verified"; + }; + /** GelatoEmailReportError */ + gelato_email_report_error: { + /** + * @description A short machine-readable string giving the reason for the verification failure. + * @enum {string|null} + */ + code?: "email_unverified_other" | "email_verification_declined"; + /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + reason?: string | null; + }; /** * GelatoIdNumberReport * @description Result from an id_number check @@ -10111,7 +11842,7 @@ export interface components { error?: components["schemas"]["gelato_id_number_report_error"] | null; /** @description First name. */ first_name?: string | null; - /** @description ID number. */ + /** @description ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present. */ id_number?: string | null; /** * @description Type of ID number. @@ -10136,6 +11867,38 @@ export interface components { /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ reason?: string | null; }; + /** + * GelatoPhoneReport + * @description Result from a phone check + */ + gelato_phone_report: { + /** @description Details on the verification error. Present when status is `unverified`. */ + error?: components["schemas"]["gelato_phone_report_error"] | null; + /** @description Phone to be verified. */ + phone?: string | null; + /** + * @description Status of this `phone` check. + * @enum {string} + */ + status: "unverified" | "verified"; + }; + /** GelatoPhoneReportError */ + gelato_phone_report_error: { + /** + * @description A short machine-readable string giving the reason for the verification failure. + * @enum {string|null} + */ + code?: "phone_unverified_other" | "phone_verification_declined"; + /** @description A human-readable message giving the reason for the failure. These messages can be shown to your users. */ + reason?: string | null; + }; + /** GelatoProvidedDetails */ + gelato_provided_details: { + /** @description Email of user being verified */ + email?: string; + /** @description Phone number of user being verified */ + phone?: string; + }; /** GelatoReportDocumentOptions */ gelato_report_document_options: { /** @description Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code. */ @@ -10187,6 +11950,11 @@ export interface components { /** @description Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie). */ require_matching_selfie?: boolean; }; + /** GelatoSessionEmailOptions */ + gelato_session_email_options: { + /** @description Request one time password verification of `provided_details.email`. */ + require_verification?: boolean; + }; /** GelatoSessionIdNumberOptions */ gelato_session_id_number_options: Record; /** @@ -10198,10 +11966,15 @@ export interface components { * @description A short machine-readable string giving the reason for the verification or user-session failure. * @enum {string|null} */ - code?: "abandoned" | "consent_declined" | "country_not_supported" | "device_not_supported" | "document_expired" | "document_type_not_supported" | "document_unverified_other" | "id_number_insufficient_document_data" | "id_number_mismatch" | "id_number_unverified_other" | "selfie_document_missing_photo" | "selfie_face_mismatch" | "selfie_manipulated" | "selfie_unverified_other" | "under_supported_age"; + code?: "abandoned" | "consent_declined" | "country_not_supported" | "device_not_supported" | "document_expired" | "document_type_not_supported" | "document_unverified_other" | "email_unverified_other" | "email_verification_declined" | "id_number_insufficient_document_data" | "id_number_mismatch" | "id_number_unverified_other" | "phone_unverified_other" | "phone_verification_declined" | "selfie_document_missing_photo" | "selfie_face_mismatch" | "selfie_manipulated" | "selfie_unverified_other" | "under_supported_age"; /** @description A message that explains the reason for verification or user-session failure. */ reason?: string | null; }; + /** GelatoSessionPhoneOptions */ + gelato_session_phone_options: { + /** @description Request one time password verification of `provided_details.phone`. */ + require_verification?: boolean; + }; /** GelatoVerificationReportOptions */ gelato_verification_report_options: { document?: components["schemas"]["gelato_report_document_options"]; @@ -10210,7 +11983,9 @@ export interface components { /** GelatoVerificationSessionOptions */ gelato_verification_session_options: { document?: components["schemas"]["gelato_session_document_options"]; + email?: components["schemas"]["gelato_session_email_options"]; id_number?: components["schemas"]["gelato_session_id_number_options"]; + phone?: components["schemas"]["gelato_session_phone_options"]; }; /** GelatoVerifiedOutputs */ gelato_verified_outputs: { @@ -10218,6 +11993,8 @@ export interface components { address?: components["schemas"]["address"] | null; /** @description The user’s verified date of birth. */ dob?: components["schemas"]["gelato_data_verified_outputs_date"] | null; + /** @description The user's verified email address */ + email?: string | null; /** @description The user's verified first name. */ first_name?: string | null; /** @description The user's verified id number. */ @@ -10229,6 +12006,8 @@ export interface components { id_number_type?: "br_cpf" | "sg_nric" | "us_ssn"; /** @description The user's verified last name. */ last_name?: string | null; + /** @description The user's verified phone number */ + phone?: string | null; }; /** * GelatoVerificationReport @@ -10245,12 +12024,15 @@ export interface components { * Related guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results). */ "identity.verification_report": { + /** @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ + client_reference_id?: string | null; /** * Format: unix-time * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; document?: components["schemas"]["gelato_document_report"]; + email?: components["schemas"]["gelato_email_report"]; /** @description Unique identifier for the object. */ id: string; id_number?: components["schemas"]["gelato_id_number_report"]; @@ -10262,12 +12044,15 @@ export interface components { */ object: "identity.verification_report"; options?: components["schemas"]["gelato_verification_report_options"]; + phone?: components["schemas"]["gelato_phone_report"]; selfie?: components["schemas"]["gelato_selfie_report"]; /** * @description Type of report. * @enum {string} */ - type?: "document" | "id_number"; + type: "document" | "id_number" | "verification_flow"; + /** @description The configuration token of a Verification Flow from the dashboard. */ + verification_flow?: string; /** @description ID of the VerificationSession that created this report. */ verification_session?: string | null; }; @@ -10286,6 +12071,8 @@ export interface components { * Related guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions) */ "identity.verification_session": { + /** @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ + client_reference_id?: string | null; /** @description The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more. */ client_secret?: string | null; /** @@ -10312,6 +12099,8 @@ export interface components { object: "identity.verification_session"; /** @description A set of options for the session’s verification checks. */ options?: components["schemas"]["gelato_verification_session_options"] | null; + /** @description Details provided about the user being verified. These details may be shown to the user. */ + provided_details?: components["schemas"]["gelato_provided_details"] | null; /** @description Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null. */ redaction?: components["schemas"]["verification_session_redaction"] | null; /** @@ -10321,11 +12110,13 @@ export interface components { status: "canceled" | "processing" | "requires_input" | "verified"; /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. - * @enum {string|null} + * @enum {string} */ - type?: "document" | "id_number"; + type: "document" | "id_number" | "verification_flow"; /** @description The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe. */ url?: string | null; + /** @description The configuration token of a Verification Flow from the dashboard. */ + verification_flow?: string; /** @description The user’s verified data. */ verified_outputs?: components["schemas"]["gelato_verified_outputs"] | null; }; @@ -10357,14 +12148,29 @@ export interface components { fingerprint?: string | null; /** @description Last four digits of the bank account number. */ last4?: string | null; + /** @description ID of the mandate used to make this payment. */ + mandate?: string | components["schemas"]["mandate"]; /** - * @description The US bank account network used to debit funds. + * @description The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. * @enum {string} */ network: "ach"; /** @description Routing number of the bank account. */ routing_number?: string | null; }; + /** internal_card */ + internal_card: { + /** @description Brand of the card used in the transaction */ + brand?: string | null; + /** @description Two-letter ISO code representing the country of the card */ + country?: string | null; + /** @description Two digit number representing the card's expiration month */ + exp_month?: number | null; + /** @description Two digit number representing the card's expiration year */ + exp_year?: number | null; + /** @description The last 4 digits of the card */ + last4?: string | null; + }; /** * Invoice * @description Invoices are statements of amounts owed by a customer, and are either @@ -10485,7 +12291,7 @@ export interface components { /** @description Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts. */ discount?: components["schemas"]["discount"] | null; /** @description The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts?: (string | components["schemas"]["discount"] | components["schemas"]["deleted_discount"])[] | null; + discounts: (string | components["schemas"]["discount"] | components["schemas"]["deleted_discount"])[]; /** * Format: unix-time * @description The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`. @@ -10501,13 +12307,14 @@ export interface components { /** @description Footer displayed on the invoice. */ footer?: string | null; /** @description Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details. */ - from_invoice?: components["schemas"]["invoices_from_invoice"] | null; + from_invoice?: components["schemas"]["invoices_resource_from_invoice"] | null; /** @description The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null. */ hosted_invoice_url?: string | null; /** @description Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details. */ id?: string; /** @description The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null. */ invoice_pdf?: string | null; + issuer: components["schemas"]["connect_account_reference"]; /** @description The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized. */ last_finalization_error?: components["schemas"]["api_errors"] | null; /** @description The ID of the most recent non-draft revision of this invoice */ @@ -10558,12 +12365,12 @@ export interface components { payment_settings: components["schemas"]["invoices_payment_settings"]; /** * Format: unix-time - * @description End of the usage period during which invoice items were added to this invoice. + * @description End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. */ period_end: number; /** * Format: unix-time - * @description Start of the usage period during which invoice items were added to this invoice. + * @description Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price. */ period_start: number; /** @description Total amount of all post-payment credit notes issued for this invoice. */ @@ -10575,9 +12382,9 @@ export interface components { /** @description This is the transaction number that appears on email receipts sent for this invoice. */ receipt_number?: string | null; /** @description The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. */ - rendering?: components["schemas"]["invoices_invoice_rendering"] | null; + rendering?: components["schemas"]["invoices_resource_invoice_rendering"] | null; /** @description The details of the cost of shipping, including the ShippingRate applied on the invoice. */ - shipping_cost?: components["schemas"]["invoices_shipping_cost"] | null; + shipping_cost?: components["schemas"]["invoices_resource_shipping_cost"] | null; /** @description Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer. */ shipping_details?: components["schemas"]["shipping"] | null; /** @description Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice. */ @@ -10589,7 +12396,7 @@ export interface components { * @enum {string|null} */ status?: "draft" | "open" | "paid" | "uncollectible" | "void"; - status_transitions: components["schemas"]["invoices_status_transitions"]; + status_transitions: components["schemas"]["invoices_resource_status_transitions"]; /** @description The subscription that this invoice was prepared for, if any. */ subscription?: (string | components["schemas"]["subscription"]) | null; /** @description Details about the subscription that created this invoice. */ @@ -10687,10 +12494,10 @@ export interface components { invoice_payment_method_options_card: { installments?: components["schemas"]["invoice_installments_card"]; /** - * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. + * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: "any" | "automatic" | "challenge"; }; /** invoice_payment_method_options_customer_balance */ invoice_payment_method_options_customer_balance: { @@ -10717,6 +12524,8 @@ export interface components { }; /** invoice_payment_method_options_konbini */ invoice_payment_method_options_konbini: Record; + /** invoice_payment_method_options_sepa_debit */ + invoice_payment_method_options_sepa_debit: Record; /** invoice_payment_method_options_us_bank_account */ invoice_payment_method_options_us_bank_account: { financial_connections?: components["schemas"]["invoice_payment_method_options_us_bank_account_linked_account_options"]; @@ -10729,9 +12538,9 @@ export interface components { /** invoice_payment_method_options_us_bank_account_linked_account_options */ invoice_payment_method_options_us_bank_account_linked_account_options: { /** @description The list of permissions to request. The `payment_method` permission must be included. */ - permissions?: ("balances" | "payment_method" | "transactions")[]; + permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; /** @description Data features requested to be retrieved upon account creation. */ - prefetch?: "balances"[] | null; + prefetch?: ("balances" | "ownership" | "transactions")[] | null; }; /** InvoiceRenderingPdf */ invoice_rendering_pdf: { @@ -10748,6 +12557,11 @@ export interface components { /** @description The value of the custom field. */ value: string; }; + /** InvoiceSettingCustomerRenderingOptions */ + invoice_setting_customer_rendering_options: { + /** @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ + amount_tax_display?: string | null; + }; /** InvoiceSettingCustomerSetting */ invoice_setting_customer_setting: { /** @description Default custom fields to be displayed on invoices for this customer. */ @@ -10757,12 +12571,13 @@ export interface components { /** @description Default footer to be displayed on invoices for this customer. */ footer?: string | null; /** @description Default options for invoice PDF rendering for this customer. */ - rendering_options?: components["schemas"]["invoice_setting_rendering_options"] | null; + rendering_options?: components["schemas"]["invoice_setting_customer_rendering_options"] | null; }; /** InvoiceSettingQuoteSetting */ invoice_setting_quote_setting: { /** @description Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`. */ days_until_due?: number | null; + issuer: components["schemas"]["connect_account_reference"]; }; /** InvoiceSettingRenderingOptions */ invoice_setting_rendering_options: { @@ -10771,13 +12586,20 @@ export interface components { }; /** InvoiceSettingSubscriptionSchedulePhaseSetting */ invoice_setting_subscription_schedule_phase_setting: { + /** @description The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule. */ + account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; /** @description Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. */ days_until_due?: number | null; + /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ + issuer?: components["schemas"]["connect_account_reference"] | null; }; /** InvoiceSettingSubscriptionScheduleSetting */ invoice_setting_subscription_schedule_setting: { + /** @description The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule. */ + account_tax_ids?: (string | components["schemas"]["tax_id"] | components["schemas"]["deleted_tax_id"])[] | null; /** @description Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`. */ days_until_due?: number | null; + issuer: components["schemas"]["connect_account_reference"]; }; /** InvoiceTaxAmount */ invoice_tax_amount: { @@ -10879,20 +12701,6 @@ export interface components { */ unit_amount_decimal?: string | null; }; - /** InvoicesFromInvoice */ - invoices_from_invoice: { - /** @description The relation between this invoice and the cloned invoice */ - action: string; - /** @description The invoice that was cloned. */ - invoice: string | components["schemas"]["invoice"]; - }; - /** InvoicesInvoiceRendering */ - invoices_invoice_rendering: { - /** @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ - amount_tax_display?: string | null; - /** @description Invoice pdf rendering options */ - pdf?: components["schemas"]["invoice_rendering_pdf"] | null; - }; /** InvoicesPaymentMethodOptions */ invoices_payment_method_options: { /** @description If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent. */ @@ -10905,6 +12713,8 @@ export interface components { customer_balance?: components["schemas"]["invoice_payment_method_options_customer_balance"] | null; /** @description If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent. */ konbini?: components["schemas"]["invoice_payment_method_options_konbini"] | null; + /** @description If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent. */ + sepa_debit?: components["schemas"]["invoice_payment_method_options_sepa_debit"] | null; /** @description If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent. */ us_bank_account?: components["schemas"]["invoice_payment_method_options_us_bank_account"] | null; }; @@ -10915,15 +12725,29 @@ export interface components { /** @description Payment-method-specific configuration to provide to the invoice’s PaymentIntent. */ payment_method_options?: components["schemas"]["invoices_payment_method_options"] | null; /** @description The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). */ - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "paynow" | "paypal" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | null; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | null; + }; + /** InvoicesResourceFromInvoice */ + invoices_resource_from_invoice: { + /** @description The relation between this invoice and the cloned invoice */ + action: string; + /** @description The invoice that was cloned. */ + invoice: string | components["schemas"]["invoice"]; + }; + /** InvoicesResourceInvoiceRendering */ + invoices_resource_invoice_rendering: { + /** @description How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. */ + amount_tax_display?: string | null; + /** @description Invoice pdf rendering options */ + pdf?: components["schemas"]["invoice_rendering_pdf"] | null; }; /** 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`, `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`, `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`, `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`, 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`, `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`, `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`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "no_vat" | "nz_gst" | "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" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "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" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -10939,8 +12763,8 @@ export interface components { /** @description For a credit proration `line_item`, the original debit line_items to which the credit proration applies. */ credited_items?: components["schemas"]["invoices_resource_line_items_credited_items"] | null; }; - /** InvoicesShippingCost */ - invoices_shipping_cost: { + /** InvoicesResourceShippingCost */ + invoices_resource_shipping_cost: { /** @description Total shipping cost before any taxes are applied. */ amount_subtotal: number; /** @description Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0. */ @@ -10952,8 +12776,8 @@ export interface components { /** @description The taxes applied to the shipping rate. */ taxes?: components["schemas"]["line_items_tax_amount"][]; }; - /** InvoicesStatusTransitions */ - invoices_status_transitions: { + /** InvoicesResourceStatusTransitions */ + invoices_resource_status_transitions: { /** * Format: unix-time * @description The time that the invoice draft was finalized. @@ -11091,6 +12915,8 @@ export interface components { * @enum {string} */ object: "issuing.card"; + /** @description The personalization design object belonging to this card. */ + personalization_design?: (string | components["schemas"]["issuing.personalization_design"]) | null; /** @description The latest card that replaces this card, if any. */ replaced_by?: (string | components["schemas"]["issuing.card"]) | null; /** @description The card this card replaces, if any. */ @@ -11211,6 +13037,75 @@ export interface components { /** @description [Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts */ treasury?: components["schemas"]["issuing_dispute_treasury"] | null; }; + /** + * IssuingPersonalizationDesign + * @description A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line. + */ + "issuing.personalization_design": { + /** @description The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. */ + card_logo?: (string | components["schemas"]["file"]) | null; + /** @description Hash containing carrier text, for use with physical bundles that support carrier text. */ + carrier_text?: components["schemas"]["issuing_personalization_design_carrier_text"] | null; + /** + * Format: unix-time + * @description Time at which the object was created. Measured in seconds since the Unix epoch. + */ + created: number; + /** @description Unique identifier for the object. */ + id: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** @description A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. */ + lookup_key?: string | null; + /** @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. */ + metadata: { + [key: string]: string | undefined; + }; + /** @description Friendly display name. */ + name?: string | null; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "issuing.personalization_design"; + /** @description The physical bundle object belonging to this personalization design. */ + physical_bundle: string | components["schemas"]["issuing.physical_bundle"]; + preferences: components["schemas"]["issuing_personalization_design_preferences"]; + rejection_reasons: components["schemas"]["issuing_personalization_design_rejection_reasons"]; + /** + * @description Whether this personalization design can be used to create cards. + * @enum {string} + */ + status: "active" | "inactive" | "rejected" | "review"; + }; + /** + * IssuingPhysicalBundle + * @description A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card. + */ + "issuing.physical_bundle": { + features?: components["schemas"]["issuing_physical_bundle_features"]; + /** @description Unique identifier for the object. */ + id: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** @description Friendly display name. */ + name: string; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "issuing.physical_bundle"; + /** + * @description Whether this physical bundle can be used to create cards. + * @enum {string} + */ + status: "active" | "inactive" | "review"; + /** + * @description Whether this physical bundle is a standard Stripe offering or custom-made for you. + * @enum {string} + */ + type: "custom" | "standard"; + }; /** * IssuingSettlement * @description When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object. @@ -11272,7 +13167,7 @@ export interface components { * @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; - /** @description The hashed ID derived from the device ID from the card network associated with the token */ + /** @description The hashed ID derived from the device ID from the card network associated with the token. */ device_fingerprint?: string | null; /** @description Unique identifier for the object. */ id: string; @@ -11392,7 +13287,7 @@ export interface components { * @description The specific exemption claimed for this authorization. * @enum {string} */ - type: "low_value_transaction" | "transaction_risk_analysis"; + type: "low_value_transaction" | "transaction_risk_analysis" | "unknown"; }; /** IssuingAuthorizationMerchantData */ issuing_authorization_merchant_data: { @@ -11539,8 +13434,12 @@ export interface components { issuing_card_authorization_controls: { /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. */ allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; + /** @description Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. */ + allowed_merchant_countries?: string[] | null; /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. */ blocked_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; + /** @description Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. */ + 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. */ @@ -11629,8 +13528,12 @@ export interface components { issuing_cardholder_authorization_controls: { /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`. */ allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; + /** @description Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control. */ + allowed_merchant_countries?: string[] | null; /** @description Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`. */ blocked_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[] | null; + /** @description Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control. */ + 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`. */ @@ -11638,7 +13541,7 @@ export interface components { }; /** IssuingCardholderCardIssuing */ issuing_cardholder_card_issuing: { - /** @description Information about cardholder acceptance of [Authorized User Terms](https://stripe.com/docs/issuing/cards). */ + /** @description Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program. */ user_terms_acceptance?: components["schemas"]["issuing_cardholder_user_terms_acceptance"] | null; }; /** IssuingCardholderCompany */ @@ -11701,10 +13604,10 @@ export interface components { issuing_cardholder_user_terms_acceptance: { /** * Format: unix-time - * @description The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. + * @description The Unix timestamp marking when the cardholder accepted the Authorized User Terms. */ date?: number | null; - /** @description The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. */ + /** @description The IP address from which the cardholder accepted the Authorized User Terms. */ ip?: string | null; /** @description The user agent of the browser from which the cardholder accepted the Authorized User Terms. */ user_agent?: string | null; @@ -11959,6 +13862,49 @@ export interface components { /** @description The version of the standard for mapping reason codes followed by the wallet provider. */ suggested_decision_version?: string; }; + /** IssuingPersonalizationDesignCarrierText */ + issuing_personalization_design_carrier_text: { + /** @description The footer body text of the carrier letter. */ + footer_body?: string | null; + /** @description The footer title text of the carrier letter. */ + footer_title?: string | null; + /** @description The header body text of the carrier letter. */ + header_body?: string | null; + /** @description The header title text of the carrier letter. */ + header_title?: string | null; + }; + /** IssuingPersonalizationDesignPreferences */ + issuing_personalization_design_preferences: { + /** @description Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design. */ + is_default: boolean; + /** @description Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist. */ + is_platform_default?: boolean | null; + }; + /** IssuingPersonalizationDesignRejectionReasons */ + issuing_personalization_design_rejection_reasons: { + /** @description The reason(s) the card logo was rejected. */ + card_logo?: ("geographic_location" | "inappropriate" | "network_name" | "non_binary_image" | "non_fiat_currency" | "other" | "other_entity" | "promotional_material")[] | null; + /** @description The reason(s) the carrier text was rejected. */ + carrier_text?: ("geographic_location" | "inappropriate" | "network_name" | "non_fiat_currency" | "other" | "other_entity" | "promotional_material")[] | null; + }; + /** IssuingPhysicalBundleFeatures */ + issuing_physical_bundle_features: { + /** + * @description The policy for how to use card logo images in a card design with this physical bundle. + * @enum {string} + */ + card_logo: "optional" | "required" | "unsupported"; + /** + * @description The policy for how to use carrier letter text in a card design with this physical bundle. + * @enum {string} + */ + carrier_text: "optional" | "required" | "unsupported"; + /** + * @description The policy for how to use a second line on a card with this physical bundle. + * @enum {string} + */ + second_line: "optional" | "required" | "unsupported"; + }; /** IssuingTransactionAmountDetails */ issuing_transaction_amount_details: { /** @description The fee charged by the ATM for the cash withdrawal. */ @@ -11998,7 +13944,7 @@ export interface components { issuing_transaction_fuel_data: { /** @description The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`. */ type: string; - /** @description The units for `volume_decimal`. One of `us_gallon` or `liter`. */ + /** @description The units for `volume_decimal`. One of `liter`, `us_gallon`, or `other`. */ unit: string; /** * Format: decimal @@ -12122,7 +14068,7 @@ export interface components { * @description The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details. * @enum {string} */ - structure?: "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; + structure?: "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "registered_charity" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; /** @description Whether the company's business ID number was provided. */ tax_id_provided?: boolean; /** @description The jurisdiction in which the `tax_id` is registered (Germany-based companies only). */ @@ -12223,14 +14169,16 @@ export interface components { /** @description If true, discounts will apply to this line item. Always false for prorations. */ discountable: boolean; /** @description The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount. */ - discounts?: (string | components["schemas"]["discount"])[] | null; + discounts: (string | components["schemas"]["discount"])[]; /** @description Unique identifier for the object. */ id: string; + /** @description The ID of the invoice that contains this line item. */ + invoice?: string | null; /** @description The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any. */ invoice_item?: string | components["schemas"]["invoiceitem"]; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - /** @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. Note that for line items with `type=subscription` this will reflect the metadata of the subscription that caused the line item to be created. */ + /** @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. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation. */ metadata: { [key: string]: string | undefined; }; @@ -12291,13 +14239,13 @@ export interface components { /** @description The list of permissions to request. The `payment_method` permission must be included. */ permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; /** @description Data features requested to be retrieved upon account creation. */ - prefetch?: "balances"[] | null; + prefetch?: ("balances" | "ownership" | "transactions")[] | null; /** @description For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. */ return_url?: string; }; /** * LoginLink - * @description Login Links are single-use login link for an Express account to access their Stripe dashboard. + * @description Login Links are single-use URLs for a connected account to access the Express Dashboard. The connected account's [account.controller.stripe_dashboard.type](/api/accounts/object#account_object-controller-stripe_dashboard-type) must be `express` to have access to the Express Dashboard. */ login_link: { /** @@ -12363,6 +14311,8 @@ export interface components { */ transaction_type: "business" | "personal"; }; + /** mandate_amazon_pay */ + mandate_amazon_pay: Record; /** mandate_au_becs_debit */ mandate_au_becs_debit: { /** @description The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively. */ @@ -12377,6 +14327,11 @@ export interface components { network_status: "accepted" | "pending" | "refused" | "revoked"; /** @description The unique reference identifying the mandate on the Bacs network. */ reference: string; + /** + * @description When the mandate is revoked on the Bacs network this field displays the reason for the revocation. + * @enum {string|null} + */ + revocation_reason?: "account_closed" | "bank_account_restricted" | "bank_ownership_changed" | "could_not_process" | "debit_not_authorized"; /** @description The URL that will contain the mandate that the customer has signed. */ url: string; }; @@ -12389,12 +14344,14 @@ export interface components { /** mandate_payment_method_details */ mandate_payment_method_details: { acss_debit?: components["schemas"]["mandate_acss_debit"]; + amazon_pay?: components["schemas"]["mandate_amazon_pay"]; au_becs_debit?: components["schemas"]["mandate_au_becs_debit"]; bacs_debit?: components["schemas"]["mandate_bacs_debit"]; card?: components["schemas"]["card_mandate_payment_method_details"]; cashapp?: components["schemas"]["mandate_cashapp"]; link?: components["schemas"]["mandate_link"]; paypal?: components["schemas"]["mandate_paypal"]; + revolut_pay?: components["schemas"]["mandate_revolut_pay"]; sepa_debit?: components["schemas"]["mandate_sepa_debit"]; /** @description This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method. */ type: string; @@ -12407,6 +14364,8 @@ export interface components { /** @description PayPal account PayerID. This identifier uniquely identifies the PayPal customer. */ payer_id?: string | null; }; + /** mandate_revolut_pay */ + mandate_revolut_pay: Record; /** mandate_sepa_debit */ mandate_sepa_debit: { /** @description The unique reference of the mandate. */ @@ -12422,12 +14381,18 @@ export interface components { currency: string; }; /** mandate_us_bank_account */ - mandate_us_bank_account: Record; + mandate_us_bank_account: { + /** + * @description Mandate collection method + * @enum {string} + */ + collection_method?: "paper"; + }; /** networks */ networks: { /** @description All available networks for the card. */ available: string[]; - /** @description The preferred network for the card. */ + /** @description The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. */ preferred?: string | null; }; /** NotificationEventData */ @@ -12492,8 +14457,10 @@ export interface components { fingerprint?: string | null; /** @description Last four digits of the bank account number. */ last4?: string | null; + /** @description ID of the mandate used to make this payment. */ + mandate?: string | components["schemas"]["mandate"]; /** - * @description The US bank account network used to send funds. + * @description The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. * @enum {string} */ network: "ach" | "us_domestic_wire"; @@ -12528,8 +14495,10 @@ export interface components { fingerprint?: string | null; /** @description Last four digits of the bank account number. */ last4?: string | null; + /** @description ID of the mandate used to make this payment. */ + mandate?: string | components["schemas"]["mandate"]; /** - * @description The US bank account network used to send funds. + * @description The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. * @enum {string} */ network: "ach" | "us_domestic_wire"; @@ -12688,7 +14657,10 @@ export interface components { * * Refer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled. */ client_secret?: string | null; - /** @enum {string} */ + /** + * @description Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. + * @enum {string} + */ confirmation_method: "automatic" | "manual"; /** * Format: unix-time @@ -12753,7 +14725,7 @@ export interface components { setup_future_usage?: "off_session" | "on_session"; /** @description Shipping information for this PaymentIntent. */ shipping?: components["schemas"]["shipping"] | null; - /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ + /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ statement_descriptor?: string | null; /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ statement_descriptor_suffix?: string | null; @@ -12784,6 +14756,7 @@ export interface components { pix_display_qr_code?: components["schemas"]["payment_intent_next_action_pix_display_qr_code"]; promptpay_display_qr_code?: components["schemas"]["payment_intent_next_action_promptpay_display_qr_code"]; redirect_to_url?: components["schemas"]["payment_intent_next_action_redirect_to_url"]; + swish_handle_redirect_or_display_qr_code?: components["schemas"]["payment_intent_next_action_swish_handle_redirect_or_display_qr_code"]; /** @description Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`. */ type: string; /** @description When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js. */ @@ -12970,6 +14943,21 @@ export interface components { /** @description The URL you must redirect your customer to in order to authenticate the payment. */ url?: string | null; }; + /** PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode */ + payment_intent_next_action_swish_handle_redirect_or_display_qr_code: { + /** @description The URL to the hosted Swish instructions page, which allows customers to view the QR code. */ + hosted_instructions_url: string; + qr_code: components["schemas"]["payment_intent_next_action_swish_qr_code"]; + }; + /** PaymentIntentNextActionSwishQRCode */ + payment_intent_next_action_swish_qr_code: { + /** @description The raw data string used to generate QR code, it should be used together with QR code library. */ + data: string; + /** @description The image_url_png string used to render QR code */ + image_url_png: string; + /** @description The image_url_svg string used to render QR code */ + image_url_svg: string; + }; /** PaymentIntentNextActionVerifyWithMicrodeposits */ payment_intent_next_action_verify_with_microdeposits: { /** @@ -13026,6 +15014,7 @@ export interface components { affirm?: components["schemas"]["payment_method_options_affirm"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; afterpay_clearpay?: components["schemas"]["payment_method_options_afterpay_clearpay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; alipay?: components["schemas"]["payment_method_options_alipay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + amazon_pay?: components["schemas"]["payment_method_options_amazon_pay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; au_becs_debit?: components["schemas"]["payment_intent_payment_method_options_au_becs_debit"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; bacs_debit?: components["schemas"]["payment_method_options_bacs_debit"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; bancontact?: components["schemas"]["payment_method_options_bancontact"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; @@ -13044,6 +15033,7 @@ export interface components { klarna?: components["schemas"]["payment_method_options_klarna"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; konbini?: components["schemas"]["payment_method_options_konbini"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; link?: components["schemas"]["payment_intent_payment_method_options_link"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + mobilepay?: components["schemas"]["payment_intent_payment_method_options_mobilepay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; oxxo?: components["schemas"]["payment_method_options_oxxo"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; p24?: components["schemas"]["payment_method_options_p24"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; paynow?: components["schemas"]["payment_method_options_paynow"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; @@ -13053,6 +15043,7 @@ export interface components { revolut_pay?: components["schemas"]["payment_method_options_revolut_pay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; sepa_debit?: components["schemas"]["payment_intent_payment_method_options_sepa_debit"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; sofort?: components["schemas"]["payment_method_options_sofort"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; + swish?: components["schemas"]["payment_intent_payment_method_options_swish"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; us_bank_account?: components["schemas"]["payment_intent_payment_method_options_us_bank_account"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; wechat_pay?: components["schemas"]["payment_method_options_wechat_pay"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; zip?: components["schemas"]["payment_method_options_zip"] | components["schemas"]["payment_intent_type_specific_payment_method_options_client"]; @@ -13088,7 +15079,17 @@ export interface components { setup_future_usage?: "none" | "off_session" | "on_session"; }; /** payment_intent_payment_method_options_blik */ - payment_intent_payment_method_options_blik: Record; + payment_intent_payment_method_options_blik: { + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * + * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none"; + }; /** payment_intent_payment_method_options_card */ payment_intent_payment_method_options_card: { /** @@ -13113,7 +15114,7 @@ export interface components { */ request_extended_authorization?: "if_available" | "never"; /** - * @description Request ability to [increment](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. + * @description Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. * @enum {string} */ request_incremental_authorization?: "if_available" | "never"; @@ -13128,10 +15129,12 @@ export interface components { */ request_overcapture?: "if_available" | "never"; /** - * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. + * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: "any" | "automatic" | "challenge_only"; + request_three_d_secure?: "any" | "automatic" | "challenge"; + /** @description When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). */ + require_cvc_recollection?: boolean; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -13194,6 +15197,23 @@ export interface components { }; /** payment_intent_payment_method_options_mandate_options_sepa_debit */ payment_intent_payment_method_options_mandate_options_sepa_debit: Record; + /** payment_intent_payment_method_options_mobilepay */ + payment_intent_payment_method_options_mobilepay: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * + * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none"; + }; /** payment_intent_payment_method_options_sepa_debit */ payment_intent_payment_method_options_sepa_debit: { mandate_options?: components["schemas"]["payment_intent_payment_method_options_mandate_options_sepa_debit"]; @@ -13207,9 +15227,24 @@ export interface components { */ setup_future_usage?: "none" | "off_session" | "on_session"; }; + /** 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. */ + reference?: string | null; + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * + * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none"; + }; /** payment_intent_payment_method_options_us_bank_account */ payment_intent_payment_method_options_us_bank_account: { financial_connections?: components["schemas"]["linked_account_options_us_bank_account"]; + mandate_options?: components["schemas"]["payment_method_options_us_bank_account_mandate_options"]; /** * @description Preferred transaction settlement speed * @enum {string} @@ -13257,6 +15292,8 @@ export interface components { */ capture_method?: "manual" | "manual_preferred"; installments?: components["schemas"]["payment_flows_installment_options"]; + /** @description When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter). */ + require_cvc_recollection?: boolean; /** * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. * @@ -13294,7 +15331,7 @@ export interface components { application_fee_percent?: number | null; automatic_tax: components["schemas"]["payment_links_resource_automatic_tax"]; /** - * @description Configuration for collecting the customer's billing address. + * @description Configuration for collecting the customer's billing address. Defaults to `auto`. * @enum {string} */ billing_address_collection: "auto" | "required"; @@ -13302,7 +15339,7 @@ export interface components { 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). */ currency: string; - /** @description Collect additional information from your customer using custom fields. Up to 2 fields are supported. */ + /** @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"][]; custom_text: components["schemas"]["payment_links_resource_custom_text"]; /** @@ -13312,6 +15349,8 @@ export interface components { customer_creation: "always" | "if_required"; /** @description Unique identifier for the object. */ id: string; + /** @description The custom message to be displayed to a customer when a payment link is no longer active. */ + inactive_message?: string | null; /** @description Configuration for creating invoice for payment mode payment links. */ invoice_creation?: components["schemas"]["payment_links_resource_invoice_creation"] | null; /** @@ -13347,13 +15386,15 @@ export interface components { /** @description Indicates the parameters to be passed to PaymentIntent creation during checkout. */ payment_intent_data?: components["schemas"]["payment_links_resource_payment_intent_data"] | null; /** - * @description Configuration for collecting a payment method during checkout. + * @description Configuration for collecting a payment method during checkout. Defaults to `always`. * @enum {string} */ payment_method_collection: "always" | "if_required"; /** @description The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ - payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | null; + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | null; phone_number_collection: components["schemas"]["payment_links_resource_phone_number_collection"]; + /** @description Settings that restrict the usage of a payment link. */ + restrictions?: components["schemas"]["payment_links_resource_restrictions"] | null; /** @description Configuration for collecting the customer's shipping address. */ shipping_address_collection?: components["schemas"]["payment_links_resource_shipping_address_collection"] | null; /** @description The shipping rate options applied to the session. */ @@ -13385,6 +15426,15 @@ export interface components { payment_links_resource_automatic_tax: { /** @description If `true`, tax will be calculated automatically using the customer's location. */ 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. */ + liability?: components["schemas"]["connect_account_reference"] | null; + }; + /** PaymentLinksResourceCompletedSessions */ + payment_links_resource_completed_sessions: { + /** @description The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met. */ + count: number; + /** @description The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met. */ + limit: number; }; /** PaymentLinksResourceCompletionBehaviorConfirmationPage */ payment_links_resource_completion_behavior_confirmation_page: { @@ -13398,6 +15448,8 @@ export interface components { }; /** PaymentLinksResourceConsentCollection */ payment_links_resource_consent_collection: { + /** @description Settings related to the payment method reuse text shown in the Checkout UI. */ + payment_method_reuse_agreement?: components["schemas"]["payment_links_resource_payment_method_reuse_agreement"] | null; /** * @description If set to `auto`, enables the collection of customer consent for promotional communications. * @enum {string|null} @@ -13463,6 +15515,8 @@ export interface components { }; /** PaymentLinksResourceCustomText */ payment_links_resource_custom_text: { + /** @description Custom text that should be displayed after the payment confirmation button. */ + after_submit?: components["schemas"]["payment_links_resource_custom_text_position"] | null; /** @description Custom text that should be displayed alongside shipping address collection. */ shipping_address?: components["schemas"]["payment_links_resource_custom_text_position"] | null; /** @description Custom text that should be displayed alongside the payment confirmation button. */ @@ -13492,6 +15546,8 @@ export interface components { description?: string | null; /** @description Footer to be displayed on the invoice. */ footer?: string | null; + /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ + issuer?: components["schemas"]["connect_account_reference"] | null; /** @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. */ metadata?: { [key: string]: string | undefined; @@ -13521,12 +15577,28 @@ export interface components { statement_descriptor?: string | null; /** @description Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ statement_descriptor_suffix?: string | null; + /** @description A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details. */ + transfer_group?: string | null; + }; + /** PaymentLinksResourcePaymentMethodReuseAgreement */ + payment_links_resource_payment_method_reuse_agreement: { + /** + * @description Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used. + * + * When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI. + * @enum {string} + */ + position: "auto" | "hidden"; }; /** PaymentLinksResourcePhoneNumberCollection */ payment_links_resource_phone_number_collection: { /** @description If `true`, a phone number will be collected during checkout. */ enabled: boolean; }; + /** PaymentLinksResourceRestrictions */ + payment_links_resource_restrictions: { + completed_sessions: components["schemas"]["payment_links_resource_completed_sessions"]; + }; /** PaymentLinksResourceShippingAddressCollection */ payment_links_resource_shipping_address_collection: { /** @description An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`. */ @@ -13543,12 +15615,19 @@ export interface components { payment_links_resource_subscription_data: { /** @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string | null; + invoice_settings: components["schemas"]["payment_links_resource_subscription_data_invoice_settings"]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. */ metadata: { [key: string]: string | undefined; }; /** @description Integer representing the number of trial period days before the customer is charged for the first time. */ trial_period_days?: number | null; + /** @description Settings related to subscription trials. */ + trial_settings?: components["schemas"]["subscriptions_trials_resource_trial_settings"] | null; + }; + /** PaymentLinksResourceSubscriptionDataInvoiceSettings */ + payment_links_resource_subscription_data_invoice_settings: { + issuer: components["schemas"]["connect_account_reference"]; }; /** PaymentLinksResourceTaxIdCollection */ payment_links_resource_tax_id_collection: { @@ -13575,6 +15654,7 @@ export interface components { affirm?: components["schemas"]["payment_method_affirm"]; afterpay_clearpay?: components["schemas"]["payment_method_afterpay_clearpay"]; alipay?: components["schemas"]["payment_flows_private_payment_methods_alipay"]; + amazon_pay?: components["schemas"]["payment_method_amazon_pay"]; au_becs_debit?: components["schemas"]["payment_method_au_becs_debit"]; bacs_debit?: components["schemas"]["payment_method_bacs_debit"]; bancontact?: components["schemas"]["payment_method_bancontact"]; @@ -13609,6 +15689,7 @@ export interface components { metadata?: { [key: string]: string | undefined; } | null; + mobilepay?: components["schemas"]["payment_method_mobilepay"]; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} @@ -13624,11 +15705,12 @@ export interface components { revolut_pay?: components["schemas"]["payment_method_revolut_pay"]; sepa_debit?: components["schemas"]["payment_method_sepa_debit"]; sofort?: components["schemas"]["payment_method_sofort"]; + swish?: components["schemas"]["payment_method_swish"]; /** * @description The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. * @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "card_present" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "interac_present" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay" | "zip"; us_bank_account?: components["schemas"]["payment_method_us_bank_account"]; wechat_pay?: components["schemas"]["payment_method_wechat_pay"]; zip?: components["schemas"]["payment_method_zip"]; @@ -13650,6 +15732,8 @@ export interface components { payment_method_affirm: Record; /** payment_method_afterpay_clearpay */ payment_method_afterpay_clearpay: Record; + /** payment_method_amazon_pay */ + payment_method_amazon_pay: Record; /** payment_method_au_becs_debit */ payment_method_au_becs_debit: { /** @description Six-digit number identifying bank and branch associated with this bank account. */ @@ -13685,6 +15769,8 @@ export interface components { checks?: components["schemas"]["payment_method_card_checks"] | 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 The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future. */ + display_brand?: string | null; /** @description Two-digit number representing the card's expiration month. */ exp_month: number; /** @description Four-digit number representing the card's expiration year. */ @@ -13855,6 +15941,8 @@ export interface components { * * Child configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API. * + * **Note:** The ability to turn off cards is in limited preview. Please [contact us](https://support.stripe.com/contact) if you require this functionality. + * * Related guides: * - [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations) * - [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs) @@ -13867,6 +15955,7 @@ export interface components { affirm?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; afterpay_clearpay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; alipay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + amazon_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; apple_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; /** @description For child configs, the Connect application associated with the configuration. */ application?: string | null; @@ -13878,6 +15967,7 @@ export interface components { card?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; cartes_bancaires?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; cashapp?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + customer_balance?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; eps?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; fpx?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; giropay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; @@ -13885,7 +15975,6 @@ export interface components { grabpay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; /** @description Unique identifier for the object. */ id: string; - id_bank_transfer?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; ideal?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; /** @description The default configuration is used whenever a payment method configuration is not specified. */ is_default: boolean; @@ -13895,10 +15984,9 @@ export interface components { link?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; - multibanco?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + mobilepay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; /** @description The configuration's name. */ name: string; - netbanking?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} @@ -13908,15 +15996,16 @@ export interface components { p24?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; /** @description For child configs, the configuration's parent configuration. */ parent?: string | null; - pay_by_bank?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; paynow?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; paypal?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; promptpay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + revolut_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; sepa_debit?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; sofort?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; - upi?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + swish?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; us_bank_account?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; wechat_pay?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; + zip?: components["schemas"]["payment_method_config_resource_payment_method_properties"]; }; /** payment_method_customer_balance */ payment_method_customer_balance: Record; @@ -13928,6 +16017,7 @@ export interface components { affirm?: components["schemas"]["payment_method_details_affirm"]; afterpay_clearpay?: components["schemas"]["payment_method_details_afterpay_clearpay"]; alipay?: components["schemas"]["payment_flows_private_payment_methods_alipay_details"]; + amazon_pay?: components["schemas"]["payment_method_details_amazon_pay"]; au_becs_debit?: components["schemas"]["payment_method_details_au_becs_debit"]; bacs_debit?: components["schemas"]["payment_method_details_bacs_debit"]; bancontact?: components["schemas"]["payment_method_details_bancontact"]; @@ -13946,6 +16036,7 @@ export interface components { klarna?: components["schemas"]["payment_method_details_klarna"]; konbini?: components["schemas"]["payment_method_details_konbini"]; link?: components["schemas"]["payment_method_details_link"]; + mobilepay?: components["schemas"]["payment_method_details_mobilepay"]; multibanco?: components["schemas"]["payment_method_details_multibanco"]; oxxo?: components["schemas"]["payment_method_details_oxxo"]; p24?: components["schemas"]["payment_method_details_p24"]; @@ -13957,6 +16048,7 @@ export interface components { sepa_debit?: components["schemas"]["payment_method_details_sepa_debit"]; sofort?: components["schemas"]["payment_method_details_sofort"]; stripe_account?: components["schemas"]["payment_method_details_stripe_account"]; + swish?: components["schemas"]["payment_method_details_swish"]; /** @description The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`. * An additional hash is included on `payment_method_details` with a name matching this value. * It contains information specific to the payment method. */ @@ -14019,6 +16111,8 @@ export interface components { /** @description Order identifier shown to the merchant in Afterpay’s online portal. */ reference?: string | null; }; + /** payment_method_details_amazon_pay */ + payment_method_details_amazon_pay: Record; /** payment_method_details_au_becs_debit */ payment_method_details_au_becs_debit: { /** @description Bank-State-Branch number of the bank account. */ @@ -14223,7 +16317,7 @@ export interface components { authorization_code?: string | null; /** @description EMV tag 8A. A code returned by the card issuer. */ authorization_response_code?: string | null; - /** @description How the cardholder verified ownership of the card. */ + /** @description Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. */ cardholder_verification_method?: string | null; /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ dedicated_file_name?: string | null; @@ -14333,15 +16427,15 @@ export interface components { /** payment_method_details_ideal */ payment_method_details_ideal: { /** - * @description The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + * @description The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. * @enum {string|null} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; /** * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ - bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U"; + bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NNBANL2G" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U"; /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. */ @@ -14403,7 +16497,7 @@ export interface components { authorization_code?: string | null; /** @description EMV tag 8A. A code returned by the card issuer. */ authorization_response_code?: string | null; - /** @description How the cardholder verified ownership of the card. */ + /** @description Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`. */ cardholder_verification_method?: string | null; /** @description EMV tag 84. Similar to the application identifier stored on the integrated circuit chip. */ dedicated_file_name?: string | null; @@ -14440,6 +16534,10 @@ export interface components { * You could use this attribute to get a sense of international fees. */ country?: string | null; }; + /** payment_method_details_mobilepay */ + payment_method_details_mobilepay: { + card?: components["schemas"]["internal_card"] | null; + }; /** payment_method_details_multibanco */ payment_method_details_multibanco: { /** @description Entity number associated with this Multibanco payment. */ @@ -14455,10 +16553,10 @@ export interface components { /** payment_method_details_p24 */ payment_method_details_p24: { /** - * @description The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`. + * @description The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`. * @enum {string|null} */ - bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "volkswagen_bank"; + bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; /** @description Unique reference for this Przelewy24 payment. */ reference?: string | null; /** @description Owner's verified full name. Values are verified or provided by Przelewy24 directly @@ -14541,6 +16639,15 @@ export interface components { }; /** payment_method_details_stripe_account */ payment_method_details_stripe_account: Record; + /** payment_method_details_swish */ + payment_method_details_swish: { + /** @description Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer */ + fingerprint?: string | null; + /** @description Payer bank reference number for the payment */ + payment_reference?: string | null; + /** @description The last four digits of the Swish account phone number */ + verified_phone_last4?: string | null; + }; /** payment_method_details_us_bank_account */ payment_method_details_us_bank_account: { /** @@ -14559,6 +16666,10 @@ export interface components { fingerprint?: string | null; /** @description Last four digits of the bank account number. */ last4?: string | null; + /** @description ID of the mandate used to make this payment. */ + mandate?: string | components["schemas"]["mandate"]; + /** @description Reference number to locate ACH payments with customer's bank. */ + payment_reference?: string | null; /** @description Routing number of the bank account. */ routing_number?: string | null; }; @@ -14647,15 +16758,15 @@ export interface components { /** payment_method_ideal */ payment_method_ideal: { /** - * @description The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + * @description The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. * @enum {string|null} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; /** * @description The Bank Identifier Code of the customer's bank, if the bank was provided. * @enum {string|null} */ - bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U"; + bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NNBANL2G" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U"; }; /** payment_method_interac_present */ payment_method_interac_present: { @@ -14699,6 +16810,8 @@ export interface components { /** @description Account owner's email address. */ email?: string | null; }; + /** payment_method_mobilepay */ + payment_method_mobilepay: Record; /** payment_method_options_affirm */ payment_method_options_affirm: { /** @@ -14750,6 +16863,23 @@ export interface components { */ setup_future_usage?: "none" | "off_session"; }; + /** payment_method_options_amazon_pay */ + payment_method_options_amazon_pay: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * + * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none" | "off_session"; + }; /** payment_method_options_bacs_debit */ payment_method_options_bacs_debit: { /** @@ -15078,7 +17208,22 @@ export interface components { setup_future_usage?: "none"; }; /** payment_method_options_revolut_pay */ - payment_method_options_revolut_pay: Record; + payment_method_options_revolut_pay: { + /** + * @description Controls when the funds will be captured from the customer's account. + * @enum {string} + */ + capture_method?: "manual"; + /** + * @description Indicates that you intend to make future payments with this PaymentIntent's payment method. + * + * Providing this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes. + * + * When processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication). + * @enum {string} + */ + setup_future_usage?: "none" | "off_session"; + }; /** payment_method_options_sofort */ payment_method_options_sofort: { /** @@ -15096,6 +17241,14 @@ export interface components { */ setup_future_usage?: "none" | "off_session"; }; + /** payment_method_options_us_bank_account_mandate_options */ + payment_method_options_us_bank_account_mandate_options: { + /** + * @description Mandate collection method + * @enum {string} + */ + collection_method?: "paper"; + }; /** payment_method_options_wechat_pay */ payment_method_options_wechat_pay: { /** @description The app ID registered with WeChat Pay. Only required when client is ios or android. */ @@ -15135,7 +17288,7 @@ export interface components { * @description The customer's bank, if provided. * @enum {string|null} */ - bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "volkswagen_bank"; + bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** payment_method_paynow */ payment_method_paynow: Record; @@ -15173,6 +17326,8 @@ export interface components { /** @description Two-letter ISO code representing the country the bank account is located in. */ country?: string | null; }; + /** payment_method_swish */ + payment_method_swish: Record; /** payment_method_us_bank_account */ payment_method_us_bank_account: { /** @@ -15246,6 +17401,8 @@ export interface components { payment_pages_checkout_session_automatic_tax: { /** @description Indicates whether automatic tax is enabled for the session */ 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. */ + liability?: components["schemas"]["connect_account_reference"] | null; /** * @description The status of the most recent automated tax calculation for this session. * @enum {string|null} @@ -15268,6 +17425,8 @@ export interface components { }; /** PaymentPagesCheckoutSessionConsentCollection */ payment_pages_checkout_session_consent_collection: { + /** @description If set to `hidden`, it will hide legal text related to the reuse of a payment method. */ + payment_method_reuse_agreement?: components["schemas"]["payment_pages_checkout_session_payment_method_reuse_agreement"] | null; /** * @description If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout * Session will determine whether to display an option to opt into promotional communication @@ -15355,6 +17514,8 @@ export interface components { }; /** PaymentPagesCheckoutSessionCustomText */ payment_pages_checkout_session_custom_text: { + /** @description Custom text that should be displayed after the payment confirmation button. */ + after_submit?: components["schemas"]["payment_pages_checkout_session_custom_text_position"] | null; /** @description Custom text that should be displayed alongside shipping address collection. */ shipping_address?: components["schemas"]["payment_pages_checkout_session_custom_text_position"] | null; /** @description Custom text that should be displayed alongside the payment confirmation button. */ @@ -15402,6 +17563,8 @@ export interface components { description?: string | null; /** @description Footer displayed on the invoice. */ footer?: string | null; + /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ + issuer?: components["schemas"]["connect_account_reference"] | null; /** @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. */ metadata?: { [key: string]: string | undefined; @@ -15409,11 +17572,31 @@ export interface components { /** @description Options for invoice PDF rendering. */ rendering_options?: components["schemas"]["invoice_setting_rendering_options"] | null; }; + /** PaymentPagesCheckoutSessionPaymentMethodReuseAgreement */ + payment_pages_checkout_session_payment_method_reuse_agreement: { + /** + * @description Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used. + * + * When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI. + * @enum {string} + */ + position: "auto" | "hidden"; + }; /** PaymentPagesCheckoutSessionPhoneNumberCollection */ payment_pages_checkout_session_phone_number_collection: { /** @description Indicates whether phone number collection is enabled for the session */ enabled: boolean; }; + /** PaymentPagesCheckoutSessionSavedPaymentMethodOptions */ + payment_pages_checkout_session_saved_payment_method_options: { + /** @description Controls which payment methods are eligible to be redisplayed to returning customers. Corresponds to `allow_redisplay` on the payment method. */ + allow_redisplay_filters?: ("always" | "limited" | "unspecified")[] | null; + /** + * @description Enable customers to choose if they wish to save their payment method for future use. + * @enum {string|null} + */ + payment_method_save?: "disabled" | "enabled"; + }; /** PaymentPagesCheckoutSessionShippingAddressCollection */ payment_pages_checkout_session_shipping_address_collection: { /** @description An array of two-letter ISO country codes representing which countries Checkout should provide as options for @@ -15443,10 +17626,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`, `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`, `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`, `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`, 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`, `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`, `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`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "no_vat" | "nz_gst" | "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" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "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" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value?: string | null; }; @@ -15577,10 +17760,9 @@ export interface components { * Person * @description This is an object representing a person associated with a Stripe account. * - * A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account. - * See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform prefilling and account onboarding steps. + * A platform cannot access a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding. * - * Related guide: [Handling identity verification with the API](https://stripe.com/docs/connect/handling-api-verification#person-information) + * See the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information). */ person: { /** @description The account the person is associated with. */ @@ -15675,7 +17857,7 @@ export interface components { 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[]; - /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. */ + /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending. */ pending_verification: string[]; }; /** PersonRelationship */ @@ -15707,7 +17889,7 @@ export interface components { 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[]; - /** @description Fields that may become required depending on the results of verification or review. Will be an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. */ + /** @description Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending. */ pending_verification: string[]; }; /** @@ -15763,6 +17945,8 @@ export interface components { metadata?: { [key: string]: string | undefined; } | null; + /** @description The meter tracking the usage of a metered price */ + meter?: string | null; /** @description A brief description of the plan, hidden from customers. */ nickname?: string | null; /** @@ -15846,7 +18030,6 @@ export interface components { invoice_history: components["schemas"]["portal_invoice_list"]; payment_method_update: components["schemas"]["portal_payment_method_update"]; subscription_cancel: components["schemas"]["portal_subscription_cancel"]; - subscription_pause: components["schemas"]["portal_subscription_pause"]; subscription_update: components["schemas"]["portal_subscription_update"]; }; /** PortalFlowsAfterCompletionHostedConfirmation */ @@ -15980,11 +18163,6 @@ export interface components { /** @description Which cancellation reasons will be given as options to the customer. */ options: ("customer_service" | "low_quality" | "missing_features" | "other" | "switched_service" | "too_complex" | "too_expensive" | "unused")[]; }; - /** PortalSubscriptionPause */ - portal_subscription_pause: { - /** @description Whether the feature is enabled. */ - enabled: boolean; - }; /** PortalSubscriptionUpdate */ portal_subscription_update: { /** @description The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable. */ @@ -15994,7 +18172,7 @@ export interface components { /** @description The list of up to 10 products that support subscription updates. */ products?: components["schemas"]["portal_subscription_update_product"][] | null; /** - * @description Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. + * @description Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation. * @enum {string} */ proration_behavior: "always_invoice" | "create_prorations" | "none"; @@ -16126,14 +18304,14 @@ export interface components { default_price?: (string | components["schemas"]["price"]) | null; /** @description The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes. */ description?: string | null; - /** @description A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). */ - features: components["schemas"]["product_feature"][]; /** @description Unique identifier for the object. */ id: string; /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ images: string[]; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; + /** @description A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). */ + marketing_features: components["schemas"]["product_marketing_feature"][]; /** @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. */ metadata: { [key: string]: string | undefined; @@ -16163,9 +18341,26 @@ export interface components { /** @description A URL of a publicly-accessible webpage for this product. */ url?: string | null; }; - /** ProductFeature */ + /** + * ProductFeature + * @description A product_feature represents an attachment between a feature and a product. + * When a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer. + */ product_feature: { - /** @description The feature's name. Up to 80 characters long. */ + entitlement_feature: components["schemas"]["entitlements.feature"]; + /** @description Unique identifier for the object. */ + id: string; + /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ + livemode: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "product_feature"; + }; + /** ProductMarketingFeature */ + product_marketing_feature: { + /** @description The marketing feature name. Up to 80 characters long. */ name?: string; }; /** @@ -16281,8 +18476,7 @@ export interface components { id: string; /** @description The invoice that was created from this quote. */ invoice?: (string | components["schemas"]["invoice"] | components["schemas"]["deleted_invoice"]) | null; - /** @description All invoices will be billed using the specified settings. */ - invoice_settings?: components["schemas"]["invoice_setting_quote_setting"] | null; + invoice_settings: components["schemas"]["invoice_setting_quote_setting"]; /** * QuotesResourceListLineItems * @description A list of items the customer is being quoted for. @@ -16336,6 +18530,8 @@ export interface components { quotes_resource_automatic_tax: { /** @description Automatically calculate taxes */ 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. */ + liability?: components["schemas"]["connect_account_reference"] | null; /** * @description The status of the most recent automated tax calculation for this quote. * @enum {string|null} @@ -16613,7 +18809,7 @@ export interface components { /** Recurring */ recurring: { /** - * @description Specifies a usage aggregation strategy for prices of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`. + * @description Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`. * @enum {string|null} */ aggregate_usage?: "last_during_period" | "last_ever" | "max" | "sum"; @@ -16624,6 +18820,8 @@ export interface components { interval: "day" | "month" | "week" | "year"; /** @description The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. */ interval_count: number; + /** @description The meter tracking the usage of a metered price */ + meter?: string | null; /** * @description Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`. * @enum {string} @@ -16654,6 +18852,7 @@ export interface components { 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; + destination_details?: components["schemas"]["refund_destination_details"]; /** @description After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction. */ failure_balance_transaction?: string | components["schemas"]["balance_transaction"]; /** @description Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`. */ @@ -16683,11 +18882,66 @@ export interface components { receipt_number?: string | null; /** @description The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account. */ source_transfer_reversal?: (string | components["schemas"]["transfer_reversal"]) | null; - /** @description Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds). */ + /** @description Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds). */ status?: string | null; /** @description This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter. */ transfer_reversal?: (string | components["schemas"]["transfer_reversal"]) | null; }; + /** refund_destination_details */ + refund_destination_details: { + affirm?: components["schemas"]["destination_details_unimplemented"]; + afterpay_clearpay?: components["schemas"]["destination_details_unimplemented"]; + alipay?: components["schemas"]["destination_details_unimplemented"]; + amazon_pay?: components["schemas"]["destination_details_unimplemented"]; + au_bank_transfer?: components["schemas"]["destination_details_unimplemented"]; + blik?: components["schemas"]["refund_destination_details_generic"]; + br_bank_transfer?: components["schemas"]["refund_destination_details_generic"]; + card?: components["schemas"]["refund_destination_details_card"]; + cashapp?: components["schemas"]["destination_details_unimplemented"]; + customer_cash_balance?: components["schemas"]["destination_details_unimplemented"]; + eps?: components["schemas"]["destination_details_unimplemented"]; + eu_bank_transfer?: components["schemas"]["refund_destination_details_generic"]; + gb_bank_transfer?: components["schemas"]["refund_destination_details_generic"]; + giropay?: components["schemas"]["destination_details_unimplemented"]; + grabpay?: components["schemas"]["destination_details_unimplemented"]; + jp_bank_transfer?: components["schemas"]["refund_destination_details_generic"]; + klarna?: components["schemas"]["destination_details_unimplemented"]; + mx_bank_transfer?: components["schemas"]["refund_destination_details_generic"]; + p24?: components["schemas"]["refund_destination_details_generic"]; + paynow?: components["schemas"]["destination_details_unimplemented"]; + paypal?: components["schemas"]["destination_details_unimplemented"]; + pix?: components["schemas"]["destination_details_unimplemented"]; + revolut?: components["schemas"]["destination_details_unimplemented"]; + sofort?: components["schemas"]["destination_details_unimplemented"]; + swish?: components["schemas"]["refund_destination_details_generic"]; + th_bank_transfer?: components["schemas"]["refund_destination_details_generic"]; + /** @description The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction. */ + type: string; + us_bank_transfer?: components["schemas"]["refund_destination_details_generic"]; + wechat_pay?: components["schemas"]["destination_details_unimplemented"]; + zip?: components["schemas"]["destination_details_unimplemented"]; + }; + /** refund_destination_details_card */ + refund_destination_details_card: { + /** @description Value of the reference number assigned to the refund. */ + reference?: string; + /** @description Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`. */ + reference_status?: string; + /** @description Type of the reference number assigned to the refund. */ + reference_type?: string; + /** + * @description The type of refund. This can be `refund`, `reversal`, or `pending`. + * @enum {string} + */ + type: "pending" | "refund" | "reversal"; + }; + /** refund_destination_details_generic */ + refund_destination_details_generic: { + /** @description The reference assigned to the refund. */ + reference?: string | null; + /** @description Status of the reference on the refund. This can be `pending`, `available` or `unavailable`. */ + reference_status?: string | null; + }; /** RefundNextAction */ refund_next_action: { /** @description Contains the refund details. */ @@ -16912,6 +19166,8 @@ export interface components { schedules_phase_automatic_tax: { /** @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. */ + liability?: components["schemas"]["connect_account_reference"] | null; }; /** SecretServiceResourceScope */ secret_service_resource_scope: { @@ -16981,6 +19237,7 @@ export interface components { /** SetupAttemptPaymentMethodDetails */ setup_attempt_payment_method_details: { acss_debit?: components["schemas"]["setup_attempt_payment_method_details_acss_debit"]; + amazon_pay?: components["schemas"]["setup_attempt_payment_method_details_amazon_pay"]; au_becs_debit?: components["schemas"]["setup_attempt_payment_method_details_au_becs_debit"]; bacs_debit?: components["schemas"]["setup_attempt_payment_method_details_bacs_debit"]; bancontact?: components["schemas"]["setup_attempt_payment_method_details_bancontact"]; @@ -16992,6 +19249,7 @@ export interface components { klarna?: components["schemas"]["setup_attempt_payment_method_details_klarna"]; link?: components["schemas"]["setup_attempt_payment_method_details_link"]; paypal?: components["schemas"]["setup_attempt_payment_method_details_paypal"]; + revolut_pay?: components["schemas"]["setup_attempt_payment_method_details_revolut_pay"]; sepa_debit?: components["schemas"]["setup_attempt_payment_method_details_sepa_debit"]; sofort?: components["schemas"]["setup_attempt_payment_method_details_sofort"]; /** @description The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method. */ @@ -17000,6 +19258,8 @@ export interface components { }; /** setup_attempt_payment_method_details_acss_debit */ setup_attempt_payment_method_details_acss_debit: Record; + /** setup_attempt_payment_method_details_amazon_pay */ + setup_attempt_payment_method_details_amazon_pay: Record; /** setup_attempt_payment_method_details_au_becs_debit */ setup_attempt_payment_method_details_au_becs_debit: Record; /** setup_attempt_payment_method_details_bacs_debit */ @@ -17070,6 +19330,8 @@ export interface components { setup_attempt_payment_method_details_card_present: { /** @description The ID of the Card PaymentMethod which was generated by this SetupAttempt. */ generated_card?: (string | components["schemas"]["payment_method"]) | null; + /** @description Details about payments collected offline. */ + offline?: components["schemas"]["payment_method_details_card_present_offline"] | null; }; /** setup_attempt_payment_method_details_card_wallet */ setup_attempt_payment_method_details_card_wallet: { @@ -17086,15 +19348,15 @@ export interface components { /** setup_attempt_payment_method_details_ideal */ setup_attempt_payment_method_details_ideal: { /** - * @description The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. + * @description The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. * @enum {string|null} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; /** * @description The Bank Identifier Code of the customer's bank. * @enum {string|null} */ - bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U"; + bic?: "ABNANL2A" | "ASNBNL21" | "BITSNL2A" | "BUNQNL2A" | "FVLBNL22" | "HANDNL2A" | "INGBNL2A" | "KNABNL2H" | "MOYONL21" | "NNBANL2G" | "NTSBDEB1" | "RABONL2U" | "RBRBNL21" | "REVOIE23" | "REVOLT21" | "SNSBNL2A" | "TRIONL2U"; /** @description The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ generated_sepa_debit?: (string | components["schemas"]["payment_method"]) | null; /** @description The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt. */ @@ -17111,6 +19373,8 @@ export interface components { setup_attempt_payment_method_details_link: Record; /** setup_attempt_payment_method_details_paypal */ setup_attempt_payment_method_details_paypal: Record; + /** setup_attempt_payment_method_details_revolut_pay */ + setup_attempt_payment_method_details_revolut_pay: Record; /** setup_attempt_payment_method_details_sepa_debit */ setup_attempt_payment_method_details_sepa_debit: Record; /** setup_attempt_payment_method_details_sofort */ @@ -17147,13 +19411,13 @@ export interface components { * * Create a SetupIntent when you're ready to collect your customer's payment credentials. * Don't maintain long-lived, unconfirmed SetupIntents because they might not be valid. - * The SetupIntent transitions through multiple [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as it guides + * The SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides * you through the setup process. * * Successful SetupIntents result in payment credentials that are optimized for future payments. - * For example, cardholders in [certain regions](/guides/strong-customer-authentication) might need to be run through - * [Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) during payment method collection - * to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents). + * For example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through + * [Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection + * to streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents). * If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), * it automatically attaches the resulting payment method to that Customer after successful setup. * We recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on @@ -17161,7 +19425,7 @@ export interface components { * * By using SetupIntents, you can reduce friction for your customers, even as regulations change over time. * - * Related guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents) + * Related guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents) */ setup_intent: { /** @description ID of the Connect application that created the SetupIntent. */ @@ -17274,7 +19538,9 @@ export interface components { /** SetupIntentPaymentMethodOptions */ setup_intent_payment_method_options: { acss_debit?: components["schemas"]["setup_intent_payment_method_options_acss_debit"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; + amazon_pay?: components["schemas"]["setup_intent_payment_method_options_amazon_pay"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; card?: components["schemas"]["setup_intent_payment_method_options_card"]; + card_present?: components["schemas"]["setup_intent_payment_method_options_card_present"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; link?: components["schemas"]["setup_intent_payment_method_options_link"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; paypal?: components["schemas"]["setup_intent_payment_method_options_paypal"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; sepa_debit?: components["schemas"]["setup_intent_payment_method_options_sepa_debit"] | components["schemas"]["setup_intent_type_specific_payment_method_options_client"]; @@ -17294,6 +19560,8 @@ export interface components { */ verification_method?: "automatic" | "instant" | "microdeposits"; }; + /** setup_intent_payment_method_options_amazon_pay */ + setup_intent_payment_method_options_amazon_pay: Record; /** setup_intent_payment_method_options_card */ setup_intent_payment_method_options_card: { /** @description Configuration options for setting up an eMandate for cards issued in India. */ @@ -17304,10 +19572,10 @@ export interface components { */ network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** - * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. + * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: "any" | "automatic" | "challenge_only"; + request_three_d_secure?: "any" | "automatic" | "challenge"; }; /** setup_intent_payment_method_options_card_mandate_options */ setup_intent_payment_method_options_card_mandate_options: { @@ -17344,6 +19612,8 @@ export interface components { /** @description Specifies the type of mandates supported. Possible values are `india`. */ supported_types?: "india"[] | null; }; + /** setup_intent_payment_method_options_card_present */ + setup_intent_payment_method_options_card_present: Record; /** setup_intent_payment_method_options_link */ setup_intent_payment_method_options_link: Record; /** setup_intent_payment_method_options_mandate_options_acss_debit */ @@ -17379,6 +19649,7 @@ export interface components { /** setup_intent_payment_method_options_us_bank_account */ setup_intent_payment_method_options_us_bank_account: { financial_connections?: components["schemas"]["linked_account_options_us_bank_account"]; + mandate_options?: components["schemas"]["payment_method_options_us_bank_account_mandate_options"]; /** * @description Bank account verification method. * @enum {string} @@ -18004,9 +20275,11 @@ export interface components { automatic_tax: components["schemas"]["subscription_automatic_tax"]; /** * Format: unix-time - * @description Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format. + * @description The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format. */ billing_cycle_anchor: number; + /** @description The fixed values used to calculate the `billing_cycle_anchor`. */ + billing_cycle_anchor_config?: components["schemas"]["subscriptions_resource_billing_cycle_anchor_config"] | null; /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period */ billing_thresholds?: components["schemas"]["subscription_billing_thresholds"] | null; /** @@ -18057,8 +20330,10 @@ export interface components { default_tax_rates?: components["schemas"]["tax_rate"][] | null; /** @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string | null; - /** @description Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. */ + /** @description Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead. */ discount?: components["schemas"]["discount"] | null; + /** @description The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. */ + discounts: (string | components["schemas"]["discount"])[]; /** * Format: unix-time * @description If the subscription has ended, the date the subscription ended. @@ -18103,7 +20378,7 @@ export interface components { object: "subscription"; /** @description The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details. */ on_behalf_of?: (string | components["schemas"]["account"]) | null; - /** @description If specified, payment collection for this subscription will be paused. */ + /** @description If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment). */ pause_collection?: components["schemas"]["subscriptions_resource_pause_collection"] | null; /** @description Payment settings passed on to invoices created by the subscription. */ payment_settings?: components["schemas"]["subscriptions_resource_payment_settings"] | null; @@ -18121,12 +20396,14 @@ export interface components { */ start_date: number; /** - * @description Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. + * @description Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`. * - * For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further invoices will be generated. + * For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated. * * A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. * + * A subscription can only enter a `paused` status [when a trial ends without a payment method](/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. + * * If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). * * If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices. @@ -18154,6 +20431,8 @@ export interface components { subscription_automatic_tax: { /** @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. */ + liability?: components["schemas"]["connect_account_reference"] | null; }; /** SubscriptionBillingThresholds */ subscription_billing_thresholds: { @@ -18164,7 +20443,8 @@ export interface components { }; /** SubscriptionDetailsData */ subscription_details_data: { - /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will reflect the metadata of the subscription at the time of invoice creation. *Note: This attribute is populated only for invoices created on or after June 29, 2023.* */ + /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. + * *Note: This attribute is populated only for invoices created on or after June 29, 2023.* */ metadata?: { [key: string]: string | undefined; } | null; @@ -18179,6 +20459,8 @@ export interface components { billing_thresholds?: components["schemas"]["subscription_item_billing_thresholds"] | null; /** @description Time at which the object was created. Measured in seconds since the Unix epoch. */ created: number; + /** @description The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. */ + discounts: (string | components["schemas"]["discount"])[]; /** @description Unique identifier for the object. */ id: 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. */ @@ -18212,10 +20494,10 @@ export interface components { */ network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** - * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. + * @description We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. * @enum {string|null} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: "any" | "automatic" | "challenge"; }; /** SubscriptionPendingInvoiceItemInterval */ subscription_pending_invoice_item_interval: { @@ -18257,7 +20539,7 @@ export interface components { customer: string | components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; default_settings: components["schemas"]["subscription_schedules_resource_default_settings"]; /** - * @description Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription. + * @description Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. * @enum {string} */ end_behavior: "cancel" | "none" | "release" | "renew"; @@ -18298,6 +20580,8 @@ export interface components { * @description An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase. */ subscription_schedule_add_invoice_item: { + /** @description The stackable discounts that will be applied to the item. */ + discounts: components["schemas"]["discounts_resource_stackable_discount"][]; /** @description ID of the price used to generate the invoice item. */ price: string | components["schemas"]["price"] | components["schemas"]["deleted_price"]; /** @description The quantity of the invoice item. */ @@ -18312,6 +20596,8 @@ export interface components { subscription_schedule_configuration_item: { /** @description Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period */ billing_thresholds?: components["schemas"]["subscription_item_billing_thresholds"] | null; + /** @description The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount. */ + discounts: components["schemas"]["discounts_resource_stackable_discount"][]; /** @description Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered. */ metadata?: { [key: string]: string | undefined; @@ -18368,6 +20654,8 @@ export interface components { default_tax_rates?: components["schemas"]["tax_rate"][] | null; /** @description Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string | null; + /** @description The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts. */ + discounts: components["schemas"]["discounts_resource_stackable_discount"][]; /** * Format: unix-time * @description The end of this phase of the subscription schedule. @@ -18422,8 +20710,7 @@ export interface components { default_payment_method?: (string | components["schemas"]["payment_method"]) | null; /** @description Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string | null; - /** @description The subscription schedule's default invoice settings. */ - invoice_settings?: components["schemas"]["invoice_setting_subscription_schedule_setting"] | null; + invoice_settings: components["schemas"]["invoice_setting_subscription_schedule_setting"]; /** @description The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details. */ on_behalf_of?: (string | components["schemas"]["account"]) | null; /** @description The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices. */ @@ -18433,6 +20720,8 @@ export interface components { subscription_schedules_resource_default_settings_automatic_tax: { /** @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. */ + liability?: components["schemas"]["connect_account_reference"] | null; }; /** SubscriptionTransferData */ subscription_transfer_data: { @@ -18441,6 +20730,19 @@ export interface components { /** @description The account where funds from the payment will be transferred to upon payment success. */ destination: string | components["schemas"]["account"]; }; + /** SubscriptionsResourceBillingCycleAnchorConfig */ + subscriptions_resource_billing_cycle_anchor_config: { + /** @description The day of the month of the billing_cycle_anchor. */ + day_of_month: number; + /** @description The hour of the day of the billing_cycle_anchor. */ + hour?: number | null; + /** @description The minute of the hour of the billing_cycle_anchor. */ + minute?: number | null; + /** @description The month to start full cycle billing periods. */ + month?: number | null; + /** @description The second of the minute of the billing_cycle_anchor. */ + second?: number | null; + }; /** * SubscriptionsResourcePauseCollection * @description The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription @@ -18470,6 +20772,8 @@ export interface components { customer_balance?: components["schemas"]["invoice_payment_method_options_customer_balance"] | null; /** @description This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription. */ konbini?: components["schemas"]["invoice_payment_method_options_konbini"] | null; + /** @description This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription. */ + sepa_debit?: components["schemas"]["invoice_payment_method_options_sepa_debit"] | null; /** @description This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription. */ us_bank_account?: components["schemas"]["invoice_payment_method_options_us_bank_account"] | null; }; @@ -18478,7 +20782,7 @@ export interface components { /** @description Payment-method-specific configuration to provide to invoices created by the subscription. */ payment_method_options?: components["schemas"]["subscriptions_resource_payment_method_options"] | null; /** @description The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). */ - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "paynow" | "paypal" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | null; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | null; /** * @description Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds. * @enum {string|null} @@ -18574,6 +20878,8 @@ export interface components { * @enum {string} */ object: "tax.calculation"; + /** @description The details of the ship from location, such as the address. */ + ship_from_details?: components["schemas"]["tax_product_resource_ship_from_details"] | null; /** @description The shipping cost details for the calculation. */ shipping_cost?: components["schemas"]["tax_product_resource_tax_calculation_shipping_cost"] | null; /** @description The amount of tax to be collected on top of the line item prices. */ @@ -18590,9 +20896,9 @@ export interface components { }; /** TaxProductResourceTaxCalculationLineItem */ "tax.calculation_line_item": { - /** @description The line item amount in integer cents. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ + /** @description The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ amount: number; - /** @description The amount of tax calculated for this line item, in integer cents. */ + /** @description The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ amount_tax: number; /** @description Unique identifier for the object. */ id: string; @@ -18736,6 +21042,8 @@ export interface components { reference: string; /** @description If `type=reversal`, contains information about what was reversed. */ reversal?: components["schemas"]["tax_product_resource_tax_transaction_resource_reversal"] | null; + /** @description The details of the ship from location, such as the address. */ + ship_from_details?: components["schemas"]["tax_product_resource_ship_from_details"] | null; /** @description The shipping cost details for the transaction. */ shipping_cost?: components["schemas"]["tax_product_resource_tax_transaction_shipping_cost"] | null; /** @@ -18751,9 +21059,9 @@ export interface components { }; /** TaxProductResourceTaxTransactionLineItem */ "tax.transaction_line_item": { - /** @description The line item amount in integer cents. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ + /** @description The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ amount: number; - /** @description The amount of tax calculated for this line item, in integer cents. */ + /** @description The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ amount_tax: number; /** @description Unique identifier for the object. */ id: string; @@ -18828,6 +21136,20 @@ export interface components { /** @description The TAN that was supplied to Stripe when TDS was assessed */ tax_deduction_account_number: string; }; + /** TaxIDsOwner */ + tax_i_ds_owner: { + /** @description The account being referenced when `type` is `account`. */ + account?: string | components["schemas"]["account"]; + /** @description The Connect Application being referenced when `type` is `application`. */ + application?: string | components["schemas"]["application"]; + /** @description The customer being referenced when `type` is `customer`. */ + customer?: string | components["schemas"]["customer"]; + /** + * @description Type of owner referenced. + * @enum {string} + */ + type: "account" | "application" | "customer" | "self"; + }; /** * tax_id * @description You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account. @@ -18854,11 +21176,13 @@ export interface components { * @enum {string} */ object: "tax_id"; + /** @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`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `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`, `ua_vat`, `us_ein`, `uy_ruc`, `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`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `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`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "no_vat" | "nz_gst" | "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" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "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" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description Value of the tax ID. */ value: string; /** @description Tax ID verification information. */ @@ -19019,10 +21343,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`, `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`, `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`, `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`, 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`, `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`, `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`, or `unknown` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "no_vat" | "nz_gst" | "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" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "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" | "ua_vat" | "unknown" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description The value of the tax ID. */ value: string; }; @@ -19042,7 +21366,7 @@ export interface components { }; /** TaxProductResourceLineItemTaxBreakdown */ tax_product_resource_line_item_tax_breakdown: { - /** @description The amount of tax, in integer cents. */ + /** @description The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ amount: number; jurisdiction: components["schemas"]["tax_product_resource_jurisdiction"]; /** @@ -19057,7 +21381,7 @@ export interface components { * @enum {string} */ taxability_reason: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated"; - /** @description The amount on which tax is calculated, in integer cents. */ + /** @description The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ taxable_amount: number; }; /** TaxProductResourceLineItemTaxRateDetails */ @@ -19087,9 +21411,13 @@ export interface components { /** @description State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: "NY" or "TX". */ state?: string | null; }; + /** TaxProductResourceShipFromDetails */ + tax_product_resource_ship_from_details: { + address: components["schemas"]["tax_product_resource_postal_address"]; + }; /** TaxProductResourceTaxBreakdown */ tax_product_resource_tax_breakdown: { - /** @description The amount of tax, in integer cents. */ + /** @description The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ amount: number; /** @description Specifies whether the tax amount is included in the line item amount. */ inclusive: boolean; @@ -19099,14 +21427,14 @@ export interface components { * @enum {string} */ taxability_reason: "customer_exempt" | "not_collecting" | "not_subject_to_tax" | "not_supported" | "portion_product_exempt" | "portion_reduced_rated" | "portion_standard_rated" | "product_exempt" | "product_exempt_holiday" | "proportionally_rated" | "reduced_rated" | "reverse_charge" | "standard_rated" | "taxable_basis_reduced" | "zero_rated"; - /** @description The amount on which tax is calculated, in integer cents. */ + /** @description The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ taxable_amount: number; }; /** TaxProductResourceTaxCalculationShippingCost */ tax_product_resource_tax_calculation_shipping_cost: { - /** @description The shipping amount in integer cents. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ + /** @description The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ amount: number; - /** @description The amount of tax calculated for shipping, in integer cents. */ + /** @description The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ amount_tax: number; /** @description The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object). */ shipping_rate?: string; @@ -19172,9 +21500,9 @@ export interface components { }; /** TaxProductResourceTaxTransactionShippingCost */ tax_product_resource_tax_transaction_shipping_cost: { - /** @description The shipping amount in integer cents. If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ + /** @description The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount. */ amount: number; - /** @description The amount of tax calculated for shipping, in integer cents. */ + /** @description The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ amount_tax: number; /** @description The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object). */ shipping_rate?: string; @@ -19216,6 +21544,11 @@ export interface components { inclusive: boolean; /** @description The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice. */ jurisdiction?: string | null; + /** + * @description The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates. + * @enum {string|null} + */ + jurisdiction_level?: "city" | "country" | "county" | "district" | "multiple" | "state"; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; /** @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. */ @@ -19235,7 +21568,7 @@ export interface components { * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string|null} */ - tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "service_tax" | "vat"; + tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; }; /** * TerminalConfigurationConfiguration @@ -19249,6 +21582,8 @@ export interface components { is_account_default?: boolean | null; /** @description Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. */ livemode: boolean; + /** @description String indicating the name of the Configuration object, set by the user */ + name?: string | null; /** * @description String representing the object's type. Objects of the same type share the same value. * @enum {string} @@ -19313,10 +21648,10 @@ export interface components { /** @description The current software version of the reader. */ device_sw_version?: string | null; /** - * @description Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, or `simulated_wisepos_e`. + * @description Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`. * @enum {string} */ - device_type: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "simulated_wisepos_e" | "stripe_m2" | "verifone_P400"; + device_type: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "mobile_phone_reader" | "simulated_wisepos_e" | "stripe_m2" | "verifone_P400"; /** @description Unique identifier for the object. */ id: string; /** @description The local IP address of the reader. */ @@ -19338,8 +21673,11 @@ export interface components { object: "terminal.reader"; /** @description Serial number of the reader. */ serial_number: string; - /** @description The networking status of the reader. */ - status?: string | null; + /** + * @description The networking status of the reader. + * @enum {string|null} + */ + status?: "offline" | "online"; }; /** TerminalConfigurationConfigurationResourceCurrencySpecificConfig */ terminal_configuration_configuration_resource_currency_specific_config: { @@ -19408,6 +21746,8 @@ export interface components { * @description Represents a per-transaction override of a reader configuration */ terminal_reader_reader_resource_process_config: { + /** @description Enable customer initiated cancellation when processing this payment. */ + enable_customer_cancellation?: boolean; /** @description Override showing a tipping selection screen on this transaction. */ skip_tipping?: boolean; tipping?: components["schemas"]["terminal_reader_reader_resource_tipping_config"]; @@ -19425,7 +21765,10 @@ export interface components { * TerminalReaderReaderResourceProcessSetupConfig * @description Represents a per-setup override of a reader configuration */ - terminal_reader_reader_resource_process_setup_config: Record; + terminal_reader_reader_resource_process_setup_config: { + /** @description Enable customer initiated cancellation when processing this SetupIntent. */ + enable_customer_cancellation?: boolean; + }; /** * TerminalReaderReaderResourceProcessSetupIntentAction * @description Represents a reader action to process a setup intent @@ -19485,9 +21828,18 @@ export interface components { refund?: string | components["schemas"]["refund"]; /** @description Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. */ refund_application_fee?: boolean; + refund_payment_config?: components["schemas"]["terminal_reader_reader_resource_refund_payment_config"]; /** @description Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge. */ reverse_transfer?: boolean; }; + /** + * TerminalReaderReaderResourceRefundPaymentConfig + * @description Represents a per-transaction override of a reader configuration + */ + terminal_reader_reader_resource_refund_payment_config: { + /** @description Enable customer initiated cancellation when refunding this payment. */ + enable_customer_cancellation?: boolean; + }; /** * TerminalReaderReaderResourceSetReaderDisplayAction * @description Represents a reader action to set the reader display @@ -19556,6 +21908,12 @@ export interface components { * @enum {string|null} */ authentication_flow?: "challenge" | "frictionless"; + /** + * @description The Electronic Commerce Indicator (ECI). A protocol-level field + * indicating what degree of authentication was performed. + * @enum {string|null} + */ + electronic_commerce_indicator?: "01" | "02" | "05" | "06" | "07"; /** * @description Indicates the outcome of 3D Secure authentication. * @enum {string|null} @@ -19567,6 +21925,9 @@ export interface components { * @enum {string|null} */ result_reason?: "abandoned" | "bypassed" | "canceled" | "card_not_enrolled" | "network_not_supported" | "protocol_error" | "rejected"; + /** @description The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID + * (dsTransId) for this payment. */ + transaction_id?: string | null; /** * @description The version of 3D Secure that was used. * @enum {string|null} @@ -19581,6 +21942,20 @@ export interface components { * @enum {string|null} */ authentication_flow?: "challenge" | "frictionless"; + /** + * @description The Electronic Commerce Indicator (ECI). A protocol-level field + * indicating what degree of authentication was performed. + * @enum {string|null} + */ + electronic_commerce_indicator?: "01" | "02" | "05" | "06" | "07"; + /** + * @description The exemption requested via 3DS and accepted by the issuer at authentication time. + * @enum {string|null} + */ + exemption_indicator?: "low_risk" | "none"; + /** @description Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on + * the outcome of Stripe's internal risk assessment. */ + exemption_indicator_applied?: boolean; /** * @description Indicates the outcome of 3D Secure authentication. * @enum {string|null} @@ -19592,6 +21967,9 @@ export interface components { * @enum {string|null} */ result_reason?: "abandoned" | "bypassed" | "canceled" | "card_not_enrolled" | "network_not_supported" | "protocol_error" | "rejected"; + /** @description The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID + * (dsTransId) for this payment. */ + transaction_id?: string | null; /** * @description The version of 3D Secure that was used. * @enum {string|null} @@ -19622,7 +22000,7 @@ export interface components { * * You can't store or use tokens more than once. To store card or bank account * information for later use, create [Customer](https://stripe.com/docs/api#customers) - * objects or [Custom accounts](https://stripe.com/docs/api#external_accounts). + * objects or [External accounts](/api#external_accounts). * [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection, * performs best with integrations that use client-side tokenization. */ @@ -19650,6 +22028,11 @@ export interface components { /** @description Determines if you have already used this token (you can only use tokens once). */ used: boolean; }; + /** token_card_networks */ + token_card_networks: { + /** @description The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card. */ + preferred?: string | null; + }; /** * Topup * @description To top up your Stripe balance, you create a top-up object. You can retrieve @@ -19798,7 +22181,7 @@ export interface components { * transfer only if the destination account has enough balance to cover the * reversal. * - * Related guide: [Reversing transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reversing-transfers) + * Related guide: [Reverse transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers) */ transfer_reversal: { /** @description Amount, in cents (or local equivalent). */ @@ -20744,6 +23127,8 @@ export interface components { issuing_authorization?: string | null; /** @description Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object. */ issuing_transaction?: string | null; + /** @description Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object. */ + payout?: string | null; }; /** TreasuryReceivedDebitsResourceReversalDetails */ treasury_received_debits_resource_reversal_details: { @@ -20855,6 +23240,8 @@ export interface components { * metered billing of subscription prices. * * Related guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing) + * + * This is our legacy usage-based billing API. See the [updated usage-based billing docs](https://docs.stripe.com/billing/subscriptions/usage-based). */ usage_record: { /** @description Unique identifier for the object. */ @@ -20905,13 +23292,13 @@ export interface components { }; /** * NotificationWebhookEndpoint - * @description You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be + * @description You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be * notified about events that happen in your Stripe account or connected * accounts. * * Most users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints. * - * Related guide: [Setting up webhooks](https://stripe.com/docs/webhooks/configure) + * Related guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure) */ webhook_endpoint: { /** @description The API version events are rendered as for this webhook endpoint. */ @@ -20940,7 +23327,7 @@ export interface components { * @enum {string} */ object: "webhook_endpoint"; - /** @description The endpoint's secret, used to generate [webhook signatures](https://stripe.com/docs/webhooks/signatures). Only returned at creation. */ + /** @description The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation. */ secret?: string; /** @description The status of the webhook. It can be `enabled` or `disabled`. */ status: string; @@ -21005,10 +23392,20 @@ export interface operations { /** @description The identifier of the account to create an account link for. */ account: string; /** - * @description Which information the platform needs to collect from the user. One of `currently_due` or `eventually_due`. Default is `currently_due`. + * @description The collect parameter is deprecated. Use `collection_options` instead. * @enum {string} */ collect?: "currently_due" | "eventually_due"; + /** + * collection_options_params + * @description Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow. + */ + collection_options?: { + /** @enum {string} */ + fields: "currently_due" | "eventually_due"; + /** @enum {string} */ + future_requirements?: "include" | "omit"; + }; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @description The URL the user will be redirected to if the account link is expired, has been previously-visited, or is otherwise invalid. The URL you specify should attempt to generate a new account link with the same parameters used to create the original account link, then redirect the user to the new account link's URL so they can continue with Connect Onboarding. If a new account link cannot be generated or the redirect fails you should display a useful error to the user. */ @@ -21061,9 +23458,83 @@ export interface operations { * @description Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not). */ components: { - /** base_config_param */ + /** account_config_param */ + account_management?: { + enabled: boolean; + /** account_features_param */ + features?: { + external_account_collection?: boolean; + }; + }; + /** account_config_param */ account_onboarding?: { enabled: boolean; + /** account_features_param */ + features?: { + external_account_collection?: boolean; + }; + }; + /** payouts_config_param */ + balances?: { + enabled: boolean; + /** payouts_features_param */ + features?: { + edit_payout_schedule?: boolean; + instant_payouts?: boolean; + standard_payouts?: boolean; + }; + }; + /** base_config_param */ + documents?: { + enabled: boolean; + /** base_features_param */ + features?: Record; + }; + /** account_config_param */ + notification_banner?: { + enabled: boolean; + /** account_features_param */ + features?: { + external_account_collection?: boolean; + }; + }; + /** payments_config_param */ + payment_details?: { + enabled: boolean; + /** payments_features_param */ + features?: { + capture_payments?: boolean; + destination_on_behalf_of_charge_management?: boolean; + dispute_management?: boolean; + refund_management?: boolean; + }; + }; + /** payments_config_param */ + payments?: { + enabled: boolean; + /** payments_features_param */ + features?: { + capture_payments?: boolean; + destination_on_behalf_of_charge_management?: boolean; + dispute_management?: boolean; + refund_management?: boolean; + }; + }; + /** payouts_config_param */ + payouts?: { + enabled: boolean; + /** payouts_features_param */ + features?: { + edit_payout_schedule?: boolean; + instant_payouts?: boolean; + standard_payouts?: boolean; + }; + }; + /** base_config_param */ + payouts_list?: { + enabled: boolean; + /** base_features_param */ + features?: Record; }; }; /** @description Specifies which fields in the response should be expanded. */ @@ -21095,6 +23566,7 @@ export interface operations { GetAccounts: { parameters: { query?: { + /** @description Only return connected accounts that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -21189,6 +23661,13 @@ export interface operations { * @description Business information about the account. */ business_profile?: { + /** annual_revenue_specs */ + annual_revenue?: { + amount: number; + currency: string; + fiscal_year_end: string; + }; + estimated_worker_count?: number; mcc?: string; /** monthly_estimated_revenue_specs */ monthly_estimated_revenue?: { @@ -21212,13 +23691,20 @@ export interface operations { url?: string; }; /** - * @description The business type. + * @description The 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. * @enum {string} */ business_type?: "company" | "government_entity" | "individual" | "non_profit"; /** * capabilities_param - * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. + * @description Each key of the dictionary represents a capability, and each capability + * maps to its settings (for example, whether it has been requested or not). Each + * capability is inactive until you have provided its specific + * requirements and Stripe has verified them. An account might have some + * of its requested capabilities be active and some be inactive. + * + * Required when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type) + * is `none`, which includes Custom accounts. */ capabilities?: { /** capability_param */ @@ -21234,6 +23720,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + amazon_pay_payments?: { + requested?: boolean; + }; + /** capability_param */ au_becs_debit_payments?: { requested?: boolean; }; @@ -21318,6 +23808,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + mobilepay_payments?: { + requested?: boolean; + }; + /** capability_param */ oxxo_payments?: { requested?: boolean; }; @@ -21346,6 +23840,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + swish_payments?: { + requested?: boolean; + }; + /** capability_param */ tax_reporting_us_1099_k?: { requested?: boolean; }; @@ -21372,7 +23870,7 @@ export interface operations { }; /** * company_specs - * @description Information about the company or business. This field is available for any `business_type`. + * @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?: { /** address_specs */ @@ -21422,7 +23920,7 @@ export interface operations { phone?: string; registration_number?: string; /** @enum {string} */ - structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; + structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "registered_charity" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; tax_id?: string; tax_id_registrar?: string; vat_id?: string; @@ -21435,9 +23933,32 @@ export interface operations { }; }; }; + /** + * controller_specs + * @description A hash of configuration describing the account controller's attributes. + */ + controller?: { + /** controller_fees_specs */ + fees?: { + /** @enum {string} */ + payer?: "account" | "application"; + }; + /** controller_losses_specs */ + losses?: { + /** @enum {string} */ + payments?: "application" | "stripe"; + }; + /** @enum {string} */ + requirement_collection?: "application" | "stripe"; + /** controller_dashboard_specs */ + stripe_dashboard?: { + /** @enum {string} */ + type?: "express" | "full" | "none"; + }; + }; /** @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://stripe.com/docs/payouts). */ + /** @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 @@ -21473,15 +23994,15 @@ export interface operations { files?: string[]; }; }; - /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ + /** @description The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent. */ email?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs. */ + /** @description A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After 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. */ external_account?: string; /** * individual_specs - * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. + * @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?: { /** address_specs */ @@ -21545,6 +24066,14 @@ export interface operations { postal_code?: string; state?: string; }; + /** individual_relationship_specs */ + relationship?: { + director?: boolean; + executive?: boolean; + owner?: boolean; + percent_ownership?: number | ""; + title?: string; + }; ssn_last_4?: string; /** person_verification_specs */ verification?: { @@ -21634,7 +24163,7 @@ export interface operations { }; /** * tos_acceptance_specs - * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). + * @description Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). 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. */ tos_acceptance?: { /** Format: unix-time */ @@ -21729,6 +24258,13 @@ export interface operations { * @description Business information about the account. */ business_profile?: { + /** annual_revenue_specs */ + annual_revenue?: { + amount: number; + currency: string; + fiscal_year_end: string; + }; + estimated_worker_count?: number; mcc?: string; /** monthly_estimated_revenue_specs */ monthly_estimated_revenue?: { @@ -21752,13 +24288,20 @@ export interface operations { url?: string; }; /** - * @description The business type. + * @description The 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. * @enum {string} */ business_type?: "company" | "government_entity" | "individual" | "non_profit"; /** * capabilities_param - * @description Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and Stripe has verified them. An account may have some of its requested capabilities be active and some be inactive. + * @description Each key of the dictionary represents a capability, and each capability + * maps to its settings (for example, whether it has been requested or not). Each + * capability is inactive until you have provided its specific + * requirements and Stripe has verified them. An account might have some + * of its requested capabilities be active and some be inactive. + * + * Required when [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type) + * is `none`, which includes Custom accounts. */ capabilities?: { /** capability_param */ @@ -21774,6 +24317,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + amazon_pay_payments?: { + requested?: boolean; + }; + /** capability_param */ au_becs_debit_payments?: { requested?: boolean; }; @@ -21858,6 +24405,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + mobilepay_payments?: { + requested?: boolean; + }; + /** capability_param */ oxxo_payments?: { requested?: boolean; }; @@ -21886,6 +24437,10 @@ export interface operations { requested?: boolean; }; /** capability_param */ + swish_payments?: { + requested?: boolean; + }; + /** capability_param */ tax_reporting_us_1099_k?: { requested?: boolean; }; @@ -21912,7 +24467,7 @@ export interface operations { }; /** * company_specs - * @description Information about the company or business. This field is available for any `business_type`. + * @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?: { /** address_specs */ @@ -21962,7 +24517,7 @@ export interface operations { phone?: string; registration_number?: string; /** @enum {string} */ - structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; + structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "registered_charity" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; tax_id?: string; tax_id_registrar?: string; vat_id?: string; @@ -21975,7 +24530,7 @@ 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://stripe.com/docs/payouts). */ + /** @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 @@ -22011,15 +24566,15 @@ export interface operations { files?: string[]; }; }; - /** @description The email address of the account holder. This is only to make the account easier to identify to you. Stripe only emails Custom accounts with your consent. */ + /** @description The email address of the account holder. This is only to make the account easier to identify to you. If [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, Stripe doesn't email the account without your consent. */ email?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description A card or bank account to attach to the account for receiving [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://stripe.com/docs/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://stripe.com/docs/api#account_create_bank_account) or [card creation](https://stripe.com/docs/api#account_create_card) APIs. */ + /** @description A card or bank account to attach to the account for receiving [payouts](/connect/bank-debit-card-payouts) (you won’t be able to use it for top-ups). You can provide either a token, like the ones returned by [Stripe.js](/js), or a dictionary, as documented in the `external_account` parameter for [bank account](/api#account_create_bank_account) creation.

By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](/api#account_create_bank_account) or [card creation](/api#account_create_card) APIs. After 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. */ external_account?: string; /** * individual_specs - * @description Information about the person represented by the account. This field is null unless `business_type` is set to `individual`. + * @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?: { /** address_specs */ @@ -22083,6 +24638,14 @@ export interface operations { postal_code?: string; state?: string; }; + /** individual_relationship_specs */ + relationship?: { + director?: boolean; + executive?: boolean; + owner?: boolean; + percent_ownership?: number | ""; + title?: string; + }; ssn_last_4?: string; /** person_verification_specs */ verification?: { @@ -22139,6 +24702,10 @@ export interface operations { statement_descriptor_prefix_kana?: string | ""; statement_descriptor_prefix_kanji?: string | ""; }; + /** invoices_settings_specs */ + invoices?: { + default_account_tax_ids?: string[] | ""; + }; /** payments_settings_specs */ payments?: { statement_descriptor?: string; @@ -22172,7 +24739,7 @@ export interface operations { }; /** * tos_acceptance_specs - * @description Details on the account's acceptance of the [Stripe Services Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). + * @description Details on the account's acceptance of the [Stripe Services Agreement](/connect/updating-accounts#tos-acceptance). 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. */ tos_acceptance?: { /** Format: unix-time */ @@ -23085,9 +25652,9 @@ export interface operations { full_name_aliases?: string[] | ""; /** @description The person's gender (International regulations require either "male" or "female"). */ gender?: string; - /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). */ + /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number?: string; - /** @description The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). */ + /** @description The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number_secondary?: string; /** @description The person's last name. */ last_name?: string; @@ -23103,7 +25670,7 @@ export interface operations { } | ""; /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ nationality?: string; - /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ + /** @description A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. */ person_token?: string; /** @description The person's phone number. */ phone?: string; @@ -23317,9 +25884,9 @@ export interface operations { full_name_aliases?: string[] | ""; /** @description The person's gender (International regulations require either "male" or "female"). */ gender?: string; - /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). */ + /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number?: string; - /** @description The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). */ + /** @description The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number_secondary?: string; /** @description The person's last name. */ last_name?: string; @@ -23335,7 +25902,7 @@ export interface operations { } | ""; /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ nationality?: string; - /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ + /** @description A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. */ person_token?: string; /** @description The person's phone number. */ phone?: string; @@ -23608,9 +26175,9 @@ export interface operations { full_name_aliases?: string[] | ""; /** @description The person's gender (International regulations require either "male" or "female"). */ gender?: string; - /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). */ + /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number?: string; - /** @description The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). */ + /** @description The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number_secondary?: string; /** @description The person's last name. */ last_name?: string; @@ -23626,7 +26193,7 @@ export interface operations { } | ""; /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ nationality?: string; - /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ + /** @description A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. */ person_token?: string; /** @description The person's phone number. */ phone?: string; @@ -23840,9 +26407,9 @@ export interface operations { full_name_aliases?: string[] | ""; /** @description The person's gender (International regulations require either "male" or "female"). */ gender?: string; - /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). */ + /** @description The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number?: string; - /** @description The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). */ + /** @description The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). */ id_number_secondary?: string; /** @description The person's last name. */ last_name?: string; @@ -23858,7 +26425,7 @@ export interface operations { } | ""; /** @description The country where the person is a national. Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), or "XX" if unavailable. */ nationality?: string; - /** @description A [person token](https://stripe.com/docs/connect/account-tokens), used to securely provide details to the person. */ + /** @description A [person token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. */ person_token?: string; /** @description The person's phone number. */ phone?: string; @@ -24176,6 +26743,7 @@ export interface operations { query?: { /** @description Only return application fees for the charge specified by this charge ID. */ charge?: string; + /** @description Only return applications fees that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -24735,6 +27303,7 @@ export interface operations { GetBalanceHistory: { parameters: { query?: { + /** @description Only return transactions that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -24755,7 +27324,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`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `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`, `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; @@ -24840,6 +27409,7 @@ export interface operations { GetBalanceTransactions: { parameters: { query?: { + /** @description Only return transactions that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -24860,7 +27430,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`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `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`, `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; @@ -24942,21 +27512,118 @@ export interface operations { }; }; }; - GetBillingPortalConfigurations: { + PostBillingMeterEventAdjustments: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** + * event_adjustment_cancel_settings_param + * @description Specifies which event to cancel. + */ + cancel?: { + identifier?: string; + }; + /** @description The name of the meter event. Corresponds with the `event_name` field on a meter. */ + event_name: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * @description Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet. + * @enum {string} + */ + type: "cancel"; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.meter_event_adjustment"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingMeterEvents: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description The name of the meter event. Corresponds with the `event_name` field on a meter. */ + 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 recommend using a globally unique identifier for this. We'll enforce uniqueness within a rolling 24 hour period. */ + 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: { + [key: string]: string | undefined; + }; + /** + * Format: unix-time + * @description The time of the event. Measured in seconds since the Unix epoch. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to current timestamp if not specified. + */ + timestamp?: number; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.meter_event"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetBillingMeters: { parameters: { query?: { - /** @description Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations). */ - active?: boolean; /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ ending_before?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration). */ - is_default?: boolean; /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ limit?: number; /** @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 Filter results to only include meters with the given status. */ + status?: "active" | "inactive"; }; header?: never; path?: never; @@ -24975,7 +27642,7 @@ export interface operations { }; content: { "application/json": { - data: components["schemas"]["billing_portal.configuration"][]; + data: components["schemas"]["billing.meter"][]; /** @description True if this list has another page of items after this one that can be fetched. */ has_more: boolean; /** @@ -24999,7 +27666,7 @@ export interface operations { }; }; }; - PostBillingPortalConfigurations: { + PostBillingMeters: { parameters: { query?: never; header?: never; @@ -25010,75 +27677,39 @@ export interface operations { content: { "application/x-www-form-urlencoded": { /** - * business_profile_create_param - * @description The business information shown to customers in the portal. + * customer_mapping_param + * @description Fields that specify how to map a meter event to a customer. */ - business_profile: { - headline?: string | ""; - privacy_policy_url?: string; - terms_of_service_url?: string; + customer_mapping?: { + event_payload_key: string; + /** @enum {string} */ + type: "by_id"; }; - /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. */ - default_return_url?: string | ""; - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; /** - * features_creation_param - * @description Information about the features available in the portal. + * aggregation_settings_param + * @description The default settings to aggregate a meter's events with. */ - features: { - /** customer_update_creation_param */ - customer_update?: { - allowed_updates?: ("address" | "email" | "name" | "phone" | "shipping" | "tax_id")[] | ""; - enabled: boolean; - }; - /** invoice_list_param */ - invoice_history?: { - enabled: boolean; - }; - /** payment_method_update_param */ - payment_method_update?: { - enabled: boolean; - }; - /** subscription_cancel_creation_param */ - subscription_cancel?: { - /** subscription_cancellation_reason_creation_param */ - cancellation_reason?: { - enabled: boolean; - options: ("customer_service" | "low_quality" | "missing_features" | "other" | "switched_service" | "too_complex" | "too_expensive" | "unused")[] | ""; - }; - enabled: boolean; - /** @enum {string} */ - mode?: "at_period_end" | "immediately"; - /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - /** subscription_pause_param */ - subscription_pause?: { - enabled?: boolean; - }; - /** subscription_update_creation_param */ - subscription_update?: { - default_allowed_updates: ("price" | "promotion_code" | "quantity")[] | ""; - enabled: boolean; - products: { - prices: string[]; - product: string; - }[] | ""; - /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; + default_aggregation: { + /** @enum {string} */ + formula: "count" | "sum"; }; + /** @description The meter's name. */ + 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; /** - * login_page_create_param - * @description The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share). + * @description The time window to pre-aggregate meter events for, if any. + * @enum {string} */ - login_page?: { - enabled: boolean; - }; - /** @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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - metadata?: { - [key: string]: string | undefined; + event_time_window?: "day" | "hour"; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * meter_value_settings_param + * @description Fields that specify how to calculate a meter event's value. + */ + value_settings?: { + event_payload_key: string; }; }; }; @@ -25090,7 +27721,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["billing_portal.configuration"]; + "application/json": components["schemas"]["billing.meter"]; }; }; /** @description Error response. */ @@ -25104,7 +27735,7 @@ export interface operations { }; }; }; - GetBillingPortalConfigurationsConfiguration: { + GetBillingMetersId: { parameters: { query?: { /** @description Specifies which fields in the response should be expanded. */ @@ -25112,7 +27743,8 @@ export interface operations { }; header?: never; path: { - configuration: string; + /** @description Unique identifier for the object. */ + id: string; }; cookie?: never; }; @@ -25128,7 +27760,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["billing_portal.configuration"]; + "application/json": components["schemas"]["billing.meter"]; }; }; /** @description Error response. */ @@ -25142,91 +27774,23 @@ export interface operations { }; }; }; - PostBillingPortalConfigurationsConfiguration: { + PostBillingMetersId: { parameters: { query?: never; header?: never; path: { - configuration: string; + /** @description Unique identifier for the object. */ + id: string; }; cookie?: never; }; requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description Whether the configuration is active and can be used to create portal sessions. */ - active?: boolean; - /** - * business_profile_update_param - * @description The business information shown to customers in the portal. - */ - business_profile?: { - headline?: string | ""; - privacy_policy_url?: string | ""; - terms_of_service_url?: string | ""; - }; - /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. */ - default_return_url?: string | ""; + /** @description The meter's name. */ + display_name?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** - * features_updating_param - * @description Information about the features available in the portal. - */ - features?: { - /** customer_update_updating_param */ - customer_update?: { - allowed_updates?: ("address" | "email" | "name" | "phone" | "shipping" | "tax_id")[] | ""; - enabled?: boolean; - }; - /** invoice_list_param */ - invoice_history?: { - enabled: boolean; - }; - /** payment_method_update_param */ - payment_method_update?: { - enabled: boolean; - }; - /** subscription_cancel_updating_param */ - subscription_cancel?: { - /** subscription_cancellation_reason_updating_param */ - cancellation_reason?: { - enabled: boolean; - options?: ("customer_service" | "low_quality" | "missing_features" | "other" | "switched_service" | "too_complex" | "too_expensive" | "unused")[] | ""; - }; - enabled?: boolean; - /** @enum {string} */ - mode?: "at_period_end" | "immediately"; - /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - /** subscription_pause_param */ - subscription_pause?: { - enabled?: boolean; - }; - /** subscription_update_updating_param */ - subscription_update?: { - default_allowed_updates?: ("price" | "promotion_code" | "quantity")[] | ""; - enabled?: boolean; - products?: { - prices: string[]; - product: string; - }[] | ""; - /** @enum {string} */ - proration_behavior?: "always_invoice" | "create_prorations" | "none"; - }; - }; - /** - * login_page_update_param - * @description The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share). - */ - login_page?: { - enabled: boolean; - }; - /** @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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - metadata?: { - [key: string]: string | undefined; - } | ""; }; }; }; @@ -25237,7 +27801,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["billing_portal.configuration"]; + "application/json": components["schemas"]["billing.meter"]; }; }; /** @description Error response. */ @@ -25251,82 +27815,21 @@ export interface operations { }; }; }; - PostBillingPortalSessions: { + PostBillingMetersIdDeactivate: { parameters: { query?: never; header?: never; - path?: never; + path: { + /** @description Unique identifier for the object. */ + id: string; + }; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. */ - configuration?: string; - /** @description The ID of an existing customer. */ - customer: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** - * flow_data_param - * @description Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. - */ - flow_data?: { - /** flow_data_after_completion_param */ - after_completion?: { - /** after_completion_hosted_confirmation_param */ - hosted_confirmation?: { - custom_message?: string; - }; - /** after_completion_redirect_param */ - redirect?: { - return_url: string; - }; - /** @enum {string} */ - type: "hosted_confirmation" | "portal_homepage" | "redirect"; - }; - /** flow_data_subscription_cancel_param */ - subscription_cancel?: { - /** retention_param */ - retention?: { - /** coupon_offer_param */ - coupon_offer: { - coupon: string; - }; - /** @enum {string} */ - type: "coupon_offer"; - }; - subscription: string; - }; - /** flow_data_subscription_update_param */ - subscription_update?: { - subscription: string; - }; - /** flow_data_subscription_update_confirm_param */ - subscription_update_confirm?: { - discounts?: { - coupon?: string; - promotion_code?: string; - }[]; - items: { - id: string; - price?: string; - quantity?: number; - }[]; - subscription: string; - }; - /** @enum {string} */ - type: "payment_method_update" | "subscription_cancel" | "subscription_update" | "subscription_update_confirm"; - }; - /** - * @description The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used. - * @enum {string} - */ - locale?: "auto" | "bg" | "cs" | "da" | "de" | "el" | "en" | "en-AU" | "en-CA" | "en-GB" | "en-IE" | "en-IN" | "en-NZ" | "en-SG" | "es" | "es-419" | "et" | "fi" | "fil" | "fr" | "fr-CA" | "hr" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "lv" | "ms" | "mt" | "nb" | "nl" | "pl" | "pt" | "pt-BR" | "ro" | "ru" | "sk" | "sl" | "sv" | "th" | "tr" | "vi" | "zh" | "zh-HK" | "zh-TW"; - /** @description The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. */ - on_behalf_of?: string; - /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. */ - return_url?: string; }; }; }; @@ -25337,7 +27840,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["billing_portal.session"]; + "application/json": components["schemas"]["billing.meter"]; }; }; /** @description Error response. */ @@ -25351,32 +27854,31 @@ export interface operations { }; }; }; - GetCharges: { + GetBillingMetersIdEventSummaries: { parameters: { - query?: { - created?: { - gt?: number; - gte?: number; - lt?: number; - lte?: number; - } | number; - /** @description Only return charges for the customer specified by this customer ID. */ - customer?: string; + query: { + /** @description The customer for which to fetch event summaries. */ + customer: string; + /** @description The timestamp from when to stop aggregating meter events (exclusive). */ + end_time: number; /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ ending_before?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ limit?: number; - /** @description Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ - payment_intent?: string; + /** @description The timestamp from when to start aggregating meter events (inclusive). */ + start_time: number; /** @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 return charges for this transfer group. */ - transfer_group?: string; + /** @description Specifies what granularity to use when generating event summaries. If not specified, a single event summary would be returned for the specified time range. */ + value_grouping_window?: "hour"; }; header?: never; - path?: never; + path: { + /** @description Unique identifier for the object. */ + id: string; + }; cookie?: never; }; requestBody?: { @@ -25392,7 +27894,513 @@ export interface operations { }; content: { "application/json": { - data: components["schemas"]["charge"][]; + data: components["schemas"]["billing.meter_event_summary"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingMetersIdReactivate: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Unique identifier for the object. */ + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing.meter"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetBillingPortalConfigurations: { + parameters: { + query?: { + /** @description Only return configurations that are active or inactive (e.g., pass `true` to only list active configurations). */ + active?: boolean; + /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description Only return the default or non-default configurations (e.g., pass `true` to only list the default configuration). */ + is_default?: boolean; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @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; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["billing_portal.configuration"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingPortalConfigurations: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** + * business_profile_create_param + * @description The business information shown to customers in the portal. + */ + business_profile: { + headline?: string | ""; + privacy_policy_url?: string; + terms_of_service_url?: string; + }; + /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. */ + default_return_url?: string | ""; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * features_creation_param + * @description Information about the features available in the portal. + */ + features: { + /** customer_update_creation_param */ + customer_update?: { + allowed_updates?: ("address" | "email" | "name" | "phone" | "shipping" | "tax_id")[] | ""; + enabled: boolean; + }; + /** invoice_list_param */ + invoice_history?: { + enabled: boolean; + }; + /** payment_method_update_param */ + payment_method_update?: { + enabled: boolean; + }; + /** subscription_cancel_creation_param */ + subscription_cancel?: { + /** subscription_cancellation_reason_creation_param */ + cancellation_reason?: { + enabled: boolean; + options: ("customer_service" | "low_quality" | "missing_features" | "other" | "switched_service" | "too_complex" | "too_expensive" | "unused")[] | ""; + }; + enabled: boolean; + /** @enum {string} */ + mode?: "at_period_end" | "immediately"; + /** @enum {string} */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + }; + /** subscription_update_creation_param */ + subscription_update?: { + default_allowed_updates: ("price" | "promotion_code" | "quantity")[] | ""; + enabled: boolean; + products: { + prices: string[]; + product: string; + }[] | ""; + /** @enum {string} */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + }; + }; + /** + * login_page_create_param + * @description The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share). + */ + login_page?: { + enabled: boolean; + }; + /** @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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + metadata?: { + [key: string]: string | undefined; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing_portal.configuration"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetBillingPortalConfigurationsConfiguration: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + configuration: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing_portal.configuration"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingPortalConfigurationsConfiguration: { + parameters: { + query?: never; + header?: never; + path: { + configuration: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Whether the configuration is active and can be used to create portal sessions. */ + active?: boolean; + /** + * business_profile_update_param + * @description The business information shown to customers in the portal. + */ + business_profile?: { + headline?: string | ""; + privacy_policy_url?: string | ""; + terms_of_service_url?: string | ""; + }; + /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session. */ + default_return_url?: string | ""; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * features_updating_param + * @description Information about the features available in the portal. + */ + features?: { + /** customer_update_updating_param */ + customer_update?: { + allowed_updates?: ("address" | "email" | "name" | "phone" | "shipping" | "tax_id")[] | ""; + enabled?: boolean; + }; + /** invoice_list_param */ + invoice_history?: { + enabled: boolean; + }; + /** payment_method_update_param */ + payment_method_update?: { + enabled: boolean; + }; + /** subscription_cancel_updating_param */ + subscription_cancel?: { + /** subscription_cancellation_reason_updating_param */ + cancellation_reason?: { + enabled: boolean; + options?: ("customer_service" | "low_quality" | "missing_features" | "other" | "switched_service" | "too_complex" | "too_expensive" | "unused")[] | ""; + }; + enabled?: boolean; + /** @enum {string} */ + mode?: "at_period_end" | "immediately"; + /** @enum {string} */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + }; + /** subscription_update_updating_param */ + subscription_update?: { + default_allowed_updates?: ("price" | "promotion_code" | "quantity")[] | ""; + enabled?: boolean; + products?: { + prices: string[]; + product: string; + }[] | ""; + /** @enum {string} */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + }; + }; + /** + * login_page_update_param + * @description The hosted login page for this configuration. Learn more about the portal login page in our [integration docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share). + */ + login_page?: { + enabled: boolean; + }; + /** @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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + metadata?: { + [key: string]: string | undefined; + } | ""; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing_portal.configuration"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostBillingPortalSessions: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description The ID of an existing [configuration](https://stripe.com/docs/api/customer_portal/configuration) to use for this session, describing its functionality and features. If not specified, the session uses the default configuration. */ + configuration?: string; + /** @description The ID of an existing customer. */ + customer: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * flow_data_param + * @description Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows. + */ + flow_data?: { + /** flow_data_after_completion_param */ + after_completion?: { + /** after_completion_hosted_confirmation_param */ + hosted_confirmation?: { + custom_message?: string; + }; + /** after_completion_redirect_param */ + redirect?: { + return_url: string; + }; + /** @enum {string} */ + type: "hosted_confirmation" | "portal_homepage" | "redirect"; + }; + /** flow_data_subscription_cancel_param */ + subscription_cancel?: { + /** retention_param */ + retention?: { + /** coupon_offer_param */ + coupon_offer: { + coupon: string; + }; + /** @enum {string} */ + type: "coupon_offer"; + }; + subscription: string; + }; + /** flow_data_subscription_update_param */ + subscription_update?: { + subscription: string; + }; + /** flow_data_subscription_update_confirm_param */ + subscription_update_confirm?: { + discounts?: { + coupon?: string; + promotion_code?: string; + }[]; + items: { + id: string; + price?: string; + quantity?: number; + }[]; + subscription: string; + }; + /** @enum {string} */ + type: "payment_method_update" | "subscription_cancel" | "subscription_update" | "subscription_update_confirm"; + }; + /** + * @description The IETF language tag of the locale customer portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used. + * @enum {string} + */ + locale?: "auto" | "bg" | "cs" | "da" | "de" | "el" | "en" | "en-AU" | "en-CA" | "en-GB" | "en-IE" | "en-IN" | "en-NZ" | "en-SG" | "es" | "es-419" | "et" | "fi" | "fil" | "fr" | "fr-CA" | "hr" | "hu" | "id" | "it" | "ja" | "ko" | "lt" | "lv" | "ms" | "mt" | "nb" | "nl" | "pl" | "pt" | "pt-BR" | "ro" | "ru" | "sk" | "sl" | "sv" | "th" | "tr" | "vi" | "zh" | "zh-HK" | "zh-TW"; + /** @description The `on_behalf_of` account to use for this session. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays. */ + on_behalf_of?: string; + /** @description The default URL to redirect customers to when they click on the portal's link to return to your website. */ + return_url?: string; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["billing_portal.session"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetCharges: { + parameters: { + query?: { + /** @description Only return charges that were created during the given date interval. */ + created?: { + gt?: number; + gte?: number; + lt?: number; + lte?: number; + } | number; + /** @description Only return charges for the customer specified by this customer ID. */ + customer?: string; + /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @description Only return charges that were created by the PaymentIntent specified by this PaymentIntent ID. */ + payment_intent?: 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 return charges for this transfer group. */ + transfer_group?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["charge"][]; /** @description True if this list has another page of items after this one that can be fetched. */ has_more: boolean; /** @@ -25429,7 +28437,7 @@ export interface operations { /** @description Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). */ amount?: number; application_fee?: number; - /** @description A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). */ + /** @description A fee in cents (or local equivalent) that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees). */ application_fee_amount?: number; /** @description Whether to immediately capture the charge. Defaults to `true`. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](https://stripe.com/docs/api#capture_charge) later. Uncaptured charges expire after a set number of days (7 by default). For more information, see the [authorizing charges and settling later](https://stripe.com/docs/charges/placing-a-hold) documentation. */ capture?: boolean; @@ -25468,7 +28476,7 @@ export interface operations { metadata?: { [key: string]: string | undefined; } | ""; - /** @description The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). */ + /** @description The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). */ on_behalf_of?: string; /** * radar_options_with_hidden_options @@ -25932,7 +28940,7 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description A positive integer in cents (or local equivalent) representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge. */ + /** @description A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge. */ amount?: number; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -26183,6 +29191,13 @@ export interface operations { GetCheckoutSessions: { parameters: { query?: { + /** @description Only return Checkout Sessions that were created during the given date interval. */ + created?: { + gt?: number; + gte?: number; + lt?: number; + lte?: number; + } | number; /** @description Only return the Checkout Sessions for the Customer specified. */ customer?: string; /** @description Only return the Checkout Sessions for the Customer details specified. */ @@ -26276,9 +29291,15 @@ export interface operations { */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** - * @description Specify whether Checkout should collect the customer's billing address. + * @description Specify whether Checkout should collect the customer's billing address. Defaults to `auto`. * @enum {string} */ billing_address_collection?: "auto" | "required"; @@ -26293,6 +29314,11 @@ export interface operations { * @description Configure fields for the Checkout Session to gather active consent from customers. */ consent_collection?: { + /** payment_method_reuse_agreement_params */ + payment_method_reuse_agreement?: { + /** @enum {string} */ + position: "auto" | "hidden"; + }; /** @enum {string} */ promotions?: "auto" | "none"; /** @enum {string} */ @@ -26300,7 +29326,7 @@ export interface operations { }; /** @description Three-letter [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 2 fields are supported. */ + /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ custom_fields?: { /** custom_field_dropdown_param */ dropdown?: { @@ -26335,6 +29361,9 @@ export interface operations { * @description Display additional text for your customers using custom text. */ custom_text?: { + after_submit?: { + message: string; + } | ""; shipping_address?: { message: string; } | ""; @@ -26415,6 +29444,12 @@ export interface operations { }[] | ""; description?: string; footer?: string; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; metadata?: { [key: string]: string | undefined; }; @@ -26526,7 +29561,7 @@ export interface operations { * @description Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0. * This may occur if the Checkout Session includes a free trial or a discount. * - * Can only be set in `subscription` mode. + * Can only be set in `subscription` mode. Defaults to `always`. * * If you'd like information on how to collect a payment method outside of Checkout, read the guide on configuring [subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). * @enum {string} @@ -26534,6 +29569,14 @@ export interface operations { payment_method_collection?: "always" | "if_required"; /** @description The ID of the payment method configuration to use with this Checkout session. */ payment_method_configuration?: string; + /** + * payment_method_data_param + * @description This parameter allows you to set some attributes on the payment method created during a Checkout session. + */ + payment_method_data?: { + /** @enum {string} */ + allow_redisplay?: "always" | "limited" | "unspecified"; + }; /** * payment_method_options_param * @description Payment-method-specific configuration. @@ -26574,6 +29617,11 @@ export interface operations { setup_future_usage?: "none"; }; /** payment_method_options_param */ + amazon_pay?: { + /** @enum {string} */ + setup_future_usage?: "none" | "off_session"; + }; + /** payment_method_options_param */ au_becs_debit?: { /** @enum {string} */ setup_future_usage?: "none"; @@ -26601,6 +29649,8 @@ export interface operations { enabled?: boolean; }; /** @enum {string} */ + request_three_d_secure?: "any" | "automatic" | "challenge"; + /** @enum {string} */ setup_future_usage?: "off_session" | "on_session"; statement_descriptor_suffix_kana?: string; statement_descriptor_suffix_kanji?: string; @@ -26669,6 +29719,11 @@ export interface operations { setup_future_usage?: "none" | "off_session"; }; /** payment_method_options_param */ + mobilepay?: { + /** @enum {string} */ + setup_future_usage?: "none"; + }; + /** payment_method_options_param */ oxxo?: { expires_after_days?: number; /** @enum {string} */ @@ -26716,11 +29771,15 @@ export interface operations { setup_future_usage?: "none"; }; /** payment_method_options_param */ + swish?: { + reference?: string; + }; + /** payment_method_options_param */ us_bank_account?: { /** linked_account_options_param */ financial_connections?: { permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - prefetch?: "balances"[]; + prefetch?: ("balances" | "ownership" | "transactions")[]; }; /** @enum {string} */ setup_future_usage?: "none" | "off_session" | "on_session"; @@ -26747,7 +29806,7 @@ export interface operations { * If multiple payment methods are passed, Checkout will dynamically reorder them to * prioritize the most relevant payment methods based on the customer's location and * other characteristics. */ - payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip")[]; + payment_method_types?: ("acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay" | "zip")[]; /** * phone_number_collection_params * @description Controls phone number collection settings for the session. @@ -26759,7 +29818,7 @@ export interface operations { enabled: boolean; }; /** - * @description This parameter applies to `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we will only redirect if your user chooses a redirect-based payment method. + * @description This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`. * @enum {string} */ redirect_on_completion?: "always" | "if_required" | "never"; @@ -26767,6 +29826,15 @@ export interface operations { * payment method's app or site. This parameter is required if ui_mode is `embedded` * and redirect-based payment methods are enabled on the session. */ return_url?: string; + /** + * saved_payment_method_options_param + * @description Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode. + */ + saved_payment_method_options?: { + allow_redisplay_filters?: ("always" | "limited" | "unspecified")[]; + /** @enum {string} */ + payment_method_save?: "disabled" | "enabled"; + }; /** * setup_intent_data_param * @description A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode. @@ -26831,8 +29899,7 @@ export interface operations { /** * @description Describes the type of transaction being performed by Checkout in order to customize * relevant text on the page, such as the submit button. `submit_type` can only be - * specified on Checkout Sessions in `payment` mode, but not Checkout Sessions - * in `subscription` or `setup` mode. + * specified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used. * @enum {string} */ submit_type?: "auto" | "book" | "donate" | "pay"; @@ -26846,6 +29913,15 @@ export interface operations { billing_cycle_anchor?: number; default_tax_rates?: string[]; description?: string; + /** invoice_settings_params */ + invoice_settings?: { + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + }; metadata?: { [key: string]: string | undefined; }; @@ -26883,7 +29959,7 @@ export interface operations { enabled: boolean; }; /** - * @description `ui_mode` can be `hosted` or `embedded`. The default is `hosted`. + * @description The UI mode of the Session. Defaults to `hosted`. * @enum {string} */ ui_mode?: "embedded" | "hosted"; @@ -27043,6 +30119,462 @@ export interface operations { }; }; }; + GetClimateOrders: { + parameters: { + query?: { + /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @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; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["climate.order"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostClimateOrders: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Requested amount of carbon removal units. Either this or `metric_tons` must be specified. */ + amount?: number; + /** + * beneficiary_params + * @description Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set. + */ + beneficiary?: { + public_name: string; + }; + /** @description Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used. */ + currency?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + metadata?: { + [key: string]: string | undefined; + }; + /** + * Format: decimal + * @description Requested number of tons for the order. Either this or `amount` must be specified. + */ + metric_tons?: string; + /** @description Unique identifier of the Climate product. */ + product: string; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["climate.order"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetClimateOrdersOrder: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + /** @description Unique identifier of the order. */ + order: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["climate.order"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostClimateOrdersOrder: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Unique identifier of the order. */ + order: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set. */ + beneficiary?: { + public_name: string | ""; + } | ""; + /** @description Specifies which fields in the response should be expanded. */ + expand?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + metadata?: { + [key: string]: string | undefined; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["climate.order"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostClimateOrdersOrderCancel: { + parameters: { + query?: never; + header?: never; + path: { + /** @description Unique identifier of the order. */ + order: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["climate.order"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetClimateProducts: { + parameters: { + query?: { + /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @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; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["climate.product"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetClimateProductsProduct: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + product: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["climate.product"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetClimateSuppliers: { + parameters: { + query?: { + /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @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; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["climate.supplier"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetClimateSuppliersSupplier: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + supplier: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["climate.supplier"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetConfirmationTokensConfirmationToken: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + confirmation_token: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["confirmation_token"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetCountrySpecs: { parameters: { query?: { @@ -27397,6 +30929,13 @@ export interface operations { GetCreditNotes: { parameters: { query?: { + /** @description Only return credit notes that were created during the given date interval. */ + created?: { + gt?: number; + gte?: number; + lt?: number; + lte?: number; + } | number; /** @description Only return credit notes for the customer specified by this customer ID. */ customer?: string; /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ @@ -27894,9 +31433,62 @@ export interface operations { }; }; }; + PostCustomerSessions: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** + * components + * @description Configuration for each component. Exactly 1 component must be enabled. + */ + components: { + /** buy_button_param */ + buy_button?: { + enabled: boolean; + }; + /** pricing_table_param */ + pricing_table?: { + enabled: boolean; + }; + }; + /** @description The ID of an existing customer for which to create the customer session. */ + customer: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["customer_session"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetCustomers: { parameters: { query?: { + /** @description Only return customers that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -28027,7 +31619,276 @@ export interface operations { phone?: string; /** @description Customer's preferred languages, ordered by preference. */ preferred_locales?: string[]; - /** @description The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ + /** @description The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ + promotion_code?: string; + /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ + shipping?: { + /** optional_fields_address */ + address: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + }; + name: string; + phone?: string; + } | ""; + source?: string; + /** + * tax_param + * @description Tax details about the customer. + */ + tax?: { + ip_address?: string | ""; + /** @enum {string} */ + validate_location?: "deferred" | "immediately"; + }; + /** + * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. + * @enum {string} + */ + tax_exempt?: "" | "exempt" | "none" | "reverse"; + /** @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" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "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" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + value: string; + }[]; + /** @description ID of the test clock to attach to the customer. */ + test_clock?: string; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["customer"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetCustomersSearch: { + parameters: { + query: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @description A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ + page?: string; + /** @description The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers). */ + query: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["customer"][]; + has_more: boolean; + next_page?: string | null; + /** + * @description String representing the object's type. Objects of the same type share the same value. + * @enum {string} + */ + object: "search_result"; + /** @description The total number of objects that match the query, only accurate up to 10,000. */ + total_count?: number; + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetCustomersCustomer: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + customer: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostCustomersCustomer: { + parameters: { + query?: never; + header?: never; + path: { + customer: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description The customer's address. */ + address?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + } | ""; + /** @description An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ + balance?: number; + /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ + bank_account?: { + account_holder_name?: string; + /** @enum {string} */ + account_holder_type?: "company" | "individual"; + account_number: string; + country: string; + currency?: string; + /** @enum {string} */ + object?: "bank_account"; + routing_number?: string; + } | string; + /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ + card?: { + address_city?: string; + address_country?: string; + address_line1?: string; + address_line2?: string; + address_state?: string; + address_zip?: string; + cvc?: string; + exp_month: number; + exp_year: number; + metadata?: { + [key: string]: string | undefined; + }; + name?: string; + number: string; + /** @enum {string} */ + object?: "card"; + } | string; + /** + * cash_balance_param + * @description Balance information and default balance settings for this customer. + */ + cash_balance?: { + /** balance_settings_param */ + settings?: { + /** @enum {string} */ + reconciliation_mode?: "automatic" | "manual" | "merchant_default"; + }; + }; + coupon?: string; + /** @description ID of Alipay account to make the customer's new default for invoice payments. */ + default_alipay_account?: string; + /** @description ID of bank account to make the customer's new default for invoice payments. */ + default_bank_account?: string; + /** @description ID of card to make the customer's new default for invoice payments. */ + default_card?: string; + /** @description If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. + * + * Provide the ID of a payment source already attached to this customer to make it this customer's default payment source. + * + * If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. */ + default_source?: string; + /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ + description?: string; + /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ + email?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ + invoice_prefix?: string; + /** + * customer_param + * @description Default invoice settings for this customer. + */ + invoice_settings?: { + custom_fields?: { + name: string; + value: string; + }[] | ""; + default_payment_method?: string; + footer?: string; + rendering_options?: { + /** @enum {string} */ + amount_tax_display?: "" | "exclude_tax" | "include_inclusive_tax"; + } | ""; + }; + /** @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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + metadata?: { + [key: string]: string | undefined; + } | ""; + /** @description The customer's full name or business name. */ + name?: string; + /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ + next_invoice_sequence?: number; + /** @description The customer's phone number. */ + phone?: string; + /** @description Customer's preferred languages, ordered by preference. */ + preferred_locales?: string[]; + /** @description The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ promotion_code?: string; /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ shipping?: { @@ -28050,273 +31911,8 @@ export interface operations { */ tax?: { ip_address?: string | ""; - }; - /** - * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. - * @enum {string} - */ - tax_exempt?: "" | "exempt" | "none" | "reverse"; - /** @description The customer's tax IDs. */ - tax_id_data?: { - /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "no_vat" | "nz_gst" | "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" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; - value: string; - }[]; - /** @description ID of the test clock to attach to the customer. */ - test_clock?: string; - }; - }; - }; - responses: { - /** @description Successful response. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["customer"]; - }; - }; - /** @description Error response. */ - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; - }; - GetCustomersSearch: { - parameters: { - query: { - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ - limit?: number; - /** @description A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results. */ - page?: string; - /** @description The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for customers](https://stripe.com/docs/search#query-fields-for-customers). */ - query: string; - }; - header?: never; - path?: never; - cookie?: never; - }; - requestBody?: { - content: { - "application/x-www-form-urlencoded": Record; - }; - }; - responses: { - /** @description Successful response. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": { - data: components["schemas"]["customer"][]; - has_more: boolean; - next_page?: string | null; - /** - * @description String representing the object's type. Objects of the same type share the same value. - * @enum {string} - */ - object: "search_result"; - /** @description The total number of objects that match the query, only accurate up to 10,000. */ - total_count?: number; - url: string; - }; - }; - }; - /** @description Error response. */ - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; - }; - GetCustomersCustomer: { - parameters: { - query?: { - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - }; - header?: never; - path: { - customer: string; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/x-www-form-urlencoded": Record; - }; - }; - responses: { - /** @description Successful response. */ - 200: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["customer"] | components["schemas"]["deleted_customer"]; - }; - }; - /** @description Error response. */ - default: { - headers: { - [name: string]: unknown; - }; - content: { - "application/json": components["schemas"]["error"]; - }; - }; - }; - }; - PostCustomersCustomer: { - parameters: { - query?: never; - header?: never; - path: { - customer: string; - }; - cookie?: never; - }; - requestBody?: { - content: { - "application/x-www-form-urlencoded": { - /** @description The customer's address. */ - address?: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - } | ""; - /** @description An integer amount in cents (or local equivalent) that represents the customer's current balance, which affect the customer's future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice. */ - balance?: number; - /** @description Either a token, like the ones returned by [Stripe.js](https://stripe.com/docs/js), or a dictionary containing a user's bank account details. */ - bank_account?: { - account_holder_name?: string; /** @enum {string} */ - account_holder_type?: "company" | "individual"; - account_number: string; - country: string; - currency?: string; - /** @enum {string} */ - object?: "bank_account"; - routing_number?: string; - } | string; - /** @description A token, like the ones returned by [Stripe.js](https://stripe.com/docs/js). */ - card?: { - address_city?: string; - address_country?: string; - address_line1?: string; - address_line2?: string; - address_state?: string; - address_zip?: string; - cvc?: string; - exp_month: number; - exp_year: number; - metadata?: { - [key: string]: string | undefined; - }; - name?: string; - number: string; - /** @enum {string} */ - object?: "card"; - } | string; - /** - * cash_balance_param - * @description Balance information and default balance settings for this customer. - */ - cash_balance?: { - /** balance_settings_param */ - settings?: { - /** @enum {string} */ - reconciliation_mode?: "automatic" | "manual" | "merchant_default"; - }; - }; - coupon?: string; - /** @description ID of Alipay account to make the customer's new default for invoice payments. */ - default_alipay_account?: string; - /** @description ID of bank account to make the customer's new default for invoice payments. */ - default_bank_account?: string; - /** @description ID of card to make the customer's new default for invoice payments. */ - default_card?: string; - /** @description If you are using payment methods created via the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method) parameter. - * - * Provide the ID of a payment source already attached to this customer to make it this customer's default payment source. - * - * If you want to add a new payment source and make it the default, see the [source](https://stripe.com/docs/api/customers/update#update_customer-source) property. */ - default_source?: string; - /** @description An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. */ - description?: string; - /** @description Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*. */ - email?: string; - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - /** @description The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. */ - invoice_prefix?: string; - /** - * customer_param - * @description Default invoice settings for this customer. - */ - invoice_settings?: { - custom_fields?: { - name: string; - value: string; - }[] | ""; - default_payment_method?: string; - footer?: string; - rendering_options?: { - /** @enum {string} */ - amount_tax_display?: "" | "exclude_tax" | "include_inclusive_tax"; - } | ""; - }; - /** @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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - metadata?: { - [key: string]: string | undefined; - } | ""; - /** @description The customer's full name or business name. */ - name?: string; - /** @description The sequence to be used on the customer's next invoice. Defaults to 1. */ - next_invoice_sequence?: number; - /** @description The customer's phone number. */ - phone?: string; - /** @description Customer's preferred languages, ordered by preference. */ - preferred_locales?: string[]; - /** @description The API ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. */ - promotion_code?: string; - /** @description The customer's shipping information. Appears on invoices emailed to this customer. */ - shipping?: { - /** optional_fields_address */ - address: { - city?: string; - country?: string; - line1?: string; - line2?: string; - postal_code?: string; - state?: string; - }; - name: string; - phone?: string; - } | ""; - source?: string; - /** - * tax_param - * @description Tax details about the customer. - */ - tax?: { - ip_address?: string | ""; + validate_location?: "deferred" | "immediately"; }; /** * @description The customer's tax exemption. One of `none`, `exempt`, or `reverse`. @@ -29511,6 +33107,8 @@ export interface operations { GetCustomersCustomerPaymentMethods: { parameters: { query?: { + /** @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`. */ + allow_redisplay?: "always" | "limited" | "unspecified"; /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ ending_before?: string; /** @description Specifies which fields in the response should be expanded. */ @@ -29520,7 +33118,7 @@ export interface operations { /** @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 An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. */ - type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay" | "zip"; }; header?: never; path: { @@ -30011,6 +33609,11 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[]; price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { @@ -30026,13 +33629,19 @@ export interface operations { tax_rates?: string[] | ""; }[]; /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number | ""; /** * automatic_tax_config * @description Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** * Format: unix-time @@ -30041,7 +33650,7 @@ export interface operations { backdate_start_date?: number; /** * Format: unix-time - * @description A future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format. + * @description A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. */ billing_cycle_anchor?: number; /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ @@ -30061,7 +33670,7 @@ export interface operations { * @enum {string} */ 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. */ + /** @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). */ currency?: string; @@ -30073,13 +33682,37 @@ export interface operations { default_source?: string; /** @description The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. */ default_tax_rates?: string[] | ""; + /** @description The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer. */ + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** + * invoice_settings_param + * @description All invoices will be billed using the specified settings. + */ + invoice_settings?: { + account_tax_ids?: string[] | ""; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + }; /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: { usage_gte: number; } | ""; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; metadata?: { [key: string]: string | undefined; }; @@ -30112,15 +33745,15 @@ export interface operations { /** * @description Only applies to subscriptions with `collection_method=charge_automatically`. * - * Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. + * Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * - * Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state. + * Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state. * - * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. + * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * - * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. + * `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription. * - * Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first invoice status. + * Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status. * @enum {string} */ payment_behavior?: "allow_incomplete" | "default_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; @@ -30155,7 +33788,7 @@ export interface operations { /** @enum {string} */ network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; customer_balance?: { /** bank_transfer_param */ @@ -30169,17 +33802,18 @@ export interface operations { funding_type?: string; } | ""; konbini?: Record | ""; + sepa_debit?: Record | ""; us_bank_account?: { /** invoice_linked_account_options_param */ financial_connections?: { permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - prefetch?: "balances"[]; + prefetch?: ("balances" | "ownership" | "transactions")[]; }; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "paynow" | "paypal" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; @@ -30189,10 +33823,10 @@ export interface operations { interval: "day" | "month" | "week" | "year"; interval_count?: number; } | ""; - /** @description The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ + /** @description The ID of a promotion code to apply to this subscription. A promotion code 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. */ promotion_code?: string; /** - * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. + * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; @@ -30299,6 +33933,11 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[]; price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { @@ -30314,13 +33953,19 @@ export interface operations { tax_rates?: string[] | ""; }[]; /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number | ""; /** * automatic_tax_config * @description Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). @@ -30350,7 +33995,7 @@ export interface operations { * @enum {string} */ 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. */ + /** @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 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; @@ -30360,8 +34005,27 @@ export interface operations { default_source?: string | ""; /** @description The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates. */ default_tax_rates?: string[] | ""; + /** @description The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer. */ + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** + * invoice_settings_param + * @description All invoices will be billed using the specified settings. + */ + invoice_settings?: { + account_tax_ids?: string[] | ""; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + }; /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: { @@ -30369,6 +34033,11 @@ export interface operations { } | ""; clear_usage?: boolean; deleted?: boolean; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; id?: string; metadata?: { [key: string]: string | undefined; @@ -30399,7 +34068,7 @@ export interface operations { } | ""; /** @description Indicates if a customer is on or off-session while an invoice payment is attempted. */ off_session?: boolean; - /** @description If specified, payment collection for this subscription will be paused. */ + /** @description If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment). */ pause_collection?: { /** @enum {string} */ behavior: "keep_as_draft" | "mark_uncollectible" | "void"; @@ -30448,7 +34117,7 @@ export interface operations { /** @enum {string} */ network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; customer_balance?: { /** bank_transfer_param */ @@ -30462,17 +34131,18 @@ export interface operations { funding_type?: string; } | ""; konbini?: Record | ""; + sepa_debit?: Record | ""; us_bank_account?: { /** invoice_linked_account_options_param */ financial_connections?: { permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - prefetch?: "balances"[]; + prefetch?: ("balances" | "ownership" | "transactions")[]; }; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "paynow" | "paypal" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; @@ -30485,7 +34155,7 @@ export interface operations { /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ promotion_code?: string; /** - * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; @@ -30727,10 +34397,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`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `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`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` + * @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`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `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`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` * @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "no_vat" | "nz_gst" | "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" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "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" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; /** @description Value of the tax ID. */ value: string; }; @@ -31048,6 +34718,282 @@ export interface operations { }; }; }; + GetEntitlementsActiveEntitlements: { + parameters: { + query: { + /** @description The ID of the customer. */ + customer: string; + /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @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; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["entitlements.active_entitlement"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetEntitlementsActiveEntitlementsId: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + /** @description The ID of the entitlement. */ + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["entitlements.active_entitlement"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetEntitlementsFeatures: { + parameters: { + query?: { + /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @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; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["entitlements.feature"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostEntitlementsFeatures: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A unique key you provide as your own system identifier. This may be up to 80 characters. */ + lookup_key: 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 in a structured format. */ + metadata?: { + [key: string]: string | undefined; + }; + /** @description The feature's name, for your own purpose, not meant to be displayable to the customer. */ + name: string; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["entitlements.feature"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetEntitlementsFeaturesId: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + /** @description The ID of the feature. */ + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["entitlements.feature"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostEntitlementsFeaturesId: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Inactive features cannot be attached to new products and will not be returned from the features list endpoint. */ + active?: boolean; + /** @description Specifies which fields in the response should be expanded. */ + expand?: 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 in a structured format. */ + metadata?: { + [key: string]: string | undefined; + }; + /** @description The feature's name, for your own purpose, not meant to be displayable to the customer. */ + name?: string; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["entitlements.feature"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostEphemeralKeys: { parameters: { query?: never; @@ -31133,6 +35079,7 @@ export interface operations { GetEvents: { parameters: { query?: { + /** @description Only return events that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -31327,6 +35274,7 @@ export interface operations { GetFileLinks: { parameters: { query?: { + /** @description Only return links that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -31520,6 +35468,7 @@ export interface operations { GetFiles: { parameters: { query?: { + /** @description Only return files that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -31869,23 +35818,356 @@ export interface operations { }; }; }; - PostFinancialConnectionsAccountsAccountRefresh: { + PostFinancialConnectionsAccountsAccountRefresh: { + parameters: { + query?: never; + header?: never; + path: { + account: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description The list of account features that you would like to refresh. */ + features: ("balance" | "ownership" | "transactions")[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["financial_connections.account"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostFinancialConnectionsAccountsAccountSubscribe: { + parameters: { + query?: never; + header?: never; + path: { + account: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description The list of account features to which you would like to subscribe. */ + features: "transactions"[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["financial_connections.account"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostFinancialConnectionsAccountsAccountUnsubscribe: { + parameters: { + query?: never; + header?: never; + path: { + account: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description The list of account features from which you would like to unsubscribe. */ + features: "transactions"[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["financial_connections.account"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostFinancialConnectionsSessions: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** + * accountholder_params + * @description The account holder to link accounts for. + */ + account_holder: { + account?: string; + customer?: string; + /** @enum {string} */ + type: "account" | "customer"; + }; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * filters_params + * @description Filters to restrict the kinds of accounts to collect. + */ + filters?: { + countries: string[]; + }; + /** @description List of data features that you would like to request access to. + * + * Possible values are `balances`, `transactions`, `ownership`, and `payment_method`. */ + permissions: ("balances" | "ownership" | "payment_method" | "transactions")[]; + /** @description List of data features that you would like to retrieve upon account creation. */ + prefetch?: ("balances" | "ownership" | "transactions")[]; + /** @description For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. */ + return_url?: string; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["financial_connections.session"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetFinancialConnectionsSessionsSession: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + session: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["financial_connections.session"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetFinancialConnectionsTransactions: { + parameters: { + query: { + /** @description The ID of the Stripe account whose transactions will be retrieved. */ + account: string; + /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @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 A filter on the list based on the object `transacted_at` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options: */ + transacted_at?: { + gt?: number; + gte?: number; + lt?: number; + lte?: number; + } | number; + /** @description A filter on the list based on the object `transaction_refresh` field. The value can be a dictionary with the following options: */ + transaction_refresh?: { + after: string; + }; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Details about each object. */ + data: components["schemas"]["financial_connections.transaction"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetFinancialConnectionsTransactionsTransaction: { parameters: { - query?: never; + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; header?: never; path: { - account: string; + transaction: string; }; cookie?: never; }; - requestBody: { + requestBody?: { content: { - "application/x-www-form-urlencoded": { - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; - /** @description The list of account features that you would like to refresh. */ - features: ("balance" | "ownership")[]; + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["financial_connections.transaction"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetForwardingRequests: { + parameters: { + query?: { + /** @description Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values. */ + created?: { + gt?: number; + gte?: number; + lt?: number; + lte?: number; }; + /** @description A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @description A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID. */ + starting_after?: string; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; }; }; responses: { @@ -31895,7 +36177,18 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["financial_connections.account"]; + "application/json": { + data: components["schemas"]["forwarding.request"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; }; }; /** @description Error response. */ @@ -31909,7 +36202,7 @@ export interface operations { }; }; }; - PostFinancialConnectionsSessions: { + PostForwardingRequests: { parameters: { query?: never; header?: never; @@ -31919,33 +36212,25 @@ export interface operations { requestBody: { content: { "application/x-www-form-urlencoded": { - /** - * accountholder_params - * @description The account holder to link accounts for. - */ - account_holder: { - account?: string; - customer?: string; - /** @enum {string} */ - type: "account" | "customer"; - }; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @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")[]; /** - * filters_params - * @description Filters to restrict the kinds of accounts to collect. + * request_param + * @description The request body and headers to be sent to the destination endpoint. */ - filters?: { - countries: string[]; + request?: { + body?: string; + headers?: { + name: string; + value: string; + }[]; }; - /** @description List of data features that you would like to request access to. - * - * Possible values are `balances`, `transactions`, `ownership`, and `payment_method`. */ - permissions: ("balances" | "ownership" | "payment_method" | "transactions")[]; - /** @description List of data features that you would like to retrieve upon account creation. */ - prefetch?: ("balances" | "ownership")[]; - /** @description For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. */ - return_url?: string; + /** @description The destination URL for the forwarded request. Must be supported by the config. */ + url: string; }; }; }; @@ -31956,7 +36241,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["financial_connections.session"]; + "application/json": components["schemas"]["forwarding.request"]; }; }; /** @description Error response. */ @@ -31970,7 +36255,7 @@ export interface operations { }; }; }; - GetFinancialConnectionsSessionsSession: { + GetForwardingRequestsId: { parameters: { query?: { /** @description Specifies which fields in the response should be expanded. */ @@ -31978,7 +36263,7 @@ export interface operations { }; header?: never; path: { - session: string; + id: string; }; cookie?: never; }; @@ -31994,7 +36279,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["financial_connections.session"]; + "application/json": components["schemas"]["forwarding.request"]; }; }; /** @description Error response. */ @@ -32011,6 +36296,9 @@ export interface operations { GetIdentityVerificationReports: { parameters: { query?: { + /** @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ + client_reference_id?: string; + /** @description Only return VerificationReports that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -32112,6 +36400,9 @@ export interface operations { GetIdentityVerificationSessions: { parameters: { query?: { + /** @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ + client_reference_id?: string; + /** @description Only return VerificationSessions that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -32177,9 +36468,11 @@ export interface operations { path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/x-www-form-urlencoded": { + /** @description A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems. */ + client_reference_id?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ @@ -32198,13 +36491,23 @@ export interface operations { require_matching_selfie?: boolean; } | ""; }; + /** + * provided_details_param + * @description Details provided about the user being verified. These details may be shown to the user. + */ + provided_details?: { + email?: string; + phone?: string; + }; /** @description The URL that the user will be redirected to upon completing the verification flow. */ return_url?: string; /** - * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. + * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. You must provide a `type` if not passing `verification_flow`. * @enum {string} */ - type: "document" | "id_number"; + type?: "document" | "id_number"; + /** @description The ID of a Verification Flow from the Dashboard. See https://docs.stripe.com/identity/verification-flows. */ + verification_flow?: string; }; }; }; @@ -32297,6 +36600,14 @@ export interface operations { require_matching_selfie?: boolean; } | ""; }; + /** + * provided_details_param + * @description Details provided about the user being verified. These details may be shown to the user. + */ + provided_details?: { + email?: string; + phone?: string; + }; /** * @description The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed. * @enum {string} @@ -32405,6 +36716,7 @@ export interface operations { GetInvoiceitems: { parameters: { query?: { + /** @description Only return invoice items that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -32487,10 +36799,11 @@ export interface operations { description?: string; /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. */ discountable?: boolean; - /** @description The coupons to redeem into discounts for the invoice item or invoice line item. */ + /** @description The coupons and promotion codes to redeem into discounts for the invoice item or invoice line item. */ discounts?: { coupon?: string; discount?: string; + promotion_code?: string; }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -32625,10 +36938,11 @@ export interface operations { description?: string; /** @description Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items. Cannot be set to true for prorations. */ discountable?: boolean; - /** @description The coupons & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. */ + /** @description The coupons, promotion codes & existing discounts which apply to the invoice item or invoice line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. */ discounts?: { coupon?: string; discount?: string; + promotion_code?: string; }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -32743,6 +37057,7 @@ export interface operations { query?: { /** @description The collection method of the invoice to retrieve. Either `charge_automatically` or `send_invoice`. */ collection_method?: "charge_automatically" | "send_invoice"; + /** @description Only return invoices that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -32833,6 +37148,12 @@ export interface operations { */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`. @@ -32858,10 +37179,11 @@ export interface operations { default_tax_rates?: string[]; /** @description An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard. */ description?: string; - /** @description The coupons to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts. */ + /** @description The coupons and promotion codes to redeem into discounts for the invoice. If not specified, inherits the discount from the invoice's customer. Pass an empty string to avoid inheriting any discounts. */ discounts?: { coupon?: string; discount?: string; + promotion_code?: string; }[] | ""; /** * Format: unix-time @@ -32886,10 +37208,21 @@ export interface operations { action: "revision"; invoice: string; }; + /** + * param + * @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. + */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; /** @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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { [key: string]: string | undefined; } | ""; + /** @description Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically. */ + number?: string; /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ on_behalf_of?: string; /** @@ -32926,7 +37259,7 @@ export interface operations { } | ""; }; /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; customer_balance?: { /** bank_transfer_param */ @@ -32940,23 +37273,24 @@ export interface operations { funding_type?: string; } | ""; konbini?: Record | ""; + sepa_debit?: Record | ""; us_bank_account?: { /** invoice_linked_account_options_param */ financial_connections?: { permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - prefetch?: "balances"[]; + prefetch?: ("balances" | "ownership" | "transactions")[]; }; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "paynow" | "paypal" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | ""; }; /** - * @description How to handle pending invoice items on invoice creation. One of `include` or `exclude`. `include` will include any pending invoice items, and will create an empty draft invoice if no pending invoice items exist. `exclude` will always create an empty invoice draft regardless if there are pending invoice items or not. Defaults to `exclude` if the parameter is omitted. + * @description How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted. * @enum {string} */ - pending_invoice_items_behavior?: "exclude" | "include" | "include_and_require"; + pending_invoice_items_behavior?: "exclude" | "include"; /** * rendering_param * @description The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page. @@ -33069,6 +37403,336 @@ export interface operations { }; }; }; + PostInvoicesCreatePreview: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** + * automatic_tax_param + * @description Settings for automatic tax lookup for this invoice preview. + */ + automatic_tax?: { + enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + }; + /** @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. */ + 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; + /** + * customer_details_param + * @description Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set. + */ + customer_details?: { + address?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + } | ""; + shipping?: { + /** optional_fields_address */ + address: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + }; + name: string; + phone?: string; + } | ""; + /** tax_param */ + tax?: { + ip_address?: string | ""; + }; + /** @enum {string} */ + 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" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "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" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + value: string; + }[]; + }; + /** @description The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. */ + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description List of invoice items to add or update in the upcoming invoice preview. */ + invoice_items?: { + amount?: number; + currency?: string; + description?: string; + discountable?: boolean; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; + invoiceitem?: string; + metadata?: { + [key: string]: string | undefined; + } | ""; + /** period */ + period?: { + /** Format: unix-time */ + end: number; + /** Format: unix-time */ + start: number; + }; + price?: string; + /** one_time_price_data */ + price_data?: { + currency: string; + product: string; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; + quantity?: number; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + tax_code?: string | ""; + tax_rates?: string[] | ""; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }[]; + /** + * param + * @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. + */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ + on_behalf_of?: string | ""; + /** @description The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ + schedule?: string; + /** + * schedule_details_params + * @description The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. + */ + schedule_details?: { + /** @enum {string} */ + end_behavior?: "cancel" | "release"; + phases?: { + add_invoice_items?: { + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[]; + price?: string; + /** one_time_price_data_with_negative_amounts */ + price_data?: { + currency: string; + product: string; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; + quantity?: number; + tax_rates?: string[] | ""; + }[]; + application_fee_percent?: number; + /** automatic_tax_config */ + automatic_tax?: { + enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + }; + /** @enum {string} */ + billing_cycle_anchor?: "automatic" | "phase_start"; + billing_thresholds?: { + amount_gte?: number; + reset_billing_cycle_anchor?: boolean; + } | ""; + /** @enum {string} */ + collection_method?: "charge_automatically" | "send_invoice"; + coupon?: string; + default_payment_method?: string; + default_tax_rates?: string[] | ""; + description?: string | ""; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; + end_date?: number | "now"; + /** invoice_settings */ + invoice_settings?: { + account_tax_ids?: string[] | ""; + days_until_due?: number; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + }; + items: { + billing_thresholds?: { + usage_gte: number; + } | ""; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; + metadata?: { + [key: string]: string | undefined; + }; + price?: string; + /** recurring_price_data */ + price_data?: { + currency: string; + product: string; + /** recurring_adhoc */ + recurring: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + }; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; + quantity?: number; + tax_rates?: string[] | ""; + }[]; + iterations?: number; + metadata?: { + [key: string]: string | undefined; + }; + on_behalf_of?: string; + /** @enum {string} */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + start_date?: number | "now"; + /** transfer_data_specs */ + transfer_data?: { + amount_percent?: number; + destination: string; + }; + trial?: boolean; + trial_end?: number | "now"; + }[]; + /** @enum {string} */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + }; + /** @description The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ + subscription?: string; + /** + * subscription_details_params + * @description The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. + */ + subscription_details?: { + billing_cycle_anchor?: ("now" | "unchanged") | number; + cancel_at?: number | ""; + cancel_at_period_end?: boolean; + cancel_now?: boolean; + default_tax_rates?: string[] | ""; + items?: { + billing_thresholds?: { + usage_gte: number; + } | ""; + clear_usage?: boolean; + deleted?: boolean; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; + id?: string; + metadata?: { + [key: string]: string | undefined; + } | ""; + price?: string; + /** recurring_price_data */ + price_data?: { + currency: string; + product: string; + /** recurring_adhoc */ + recurring: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + }; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; + quantity?: number; + tax_rates?: string[] | ""; + }[]; + /** @enum {string} */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + /** Format: unix-time */ + proration_date?: number; + /** @enum {string} */ + resume_at?: "now"; + /** Format: unix-time */ + start_date?: number; + trial_end?: "now" | number; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["invoice"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetInvoicesSearch: { parameters: { query: { @@ -33129,8 +37793,14 @@ export interface operations { /** @description Settings for automatic tax lookup for this invoice preview. */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; - /** @description The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ + /** @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. */ currency?: string; @@ -33167,14 +37837,15 @@ 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" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "no_vat" | "nz_gst" | "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" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "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" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; }; - /** @description The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead. */ + /** @description The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. */ discounts?: { coupon?: string; discount?: string; + promotion_code?: string; }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -33187,6 +37858,7 @@ export interface operations { discounts?: { coupon?: string; discount?: string; + promotion_code?: string; }[] | ""; invoiceitem?: string; metadata?: { @@ -33219,27 +37891,208 @@ export interface operations { /** Format: decimal */ unit_amount_decimal?: string; }[]; + /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ + on_behalf_of?: string | ""; /** @description The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ schedule?: string; + /** @description The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. */ + schedule_details?: { + /** @enum {string} */ + end_behavior?: "cancel" | "release"; + phases?: { + add_invoice_items?: { + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[]; + price?: string; + /** one_time_price_data_with_negative_amounts */ + price_data?: { + currency: string; + product: string; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; + quantity?: number; + tax_rates?: string[] | ""; + }[]; + application_fee_percent?: number; + /** automatic_tax_config */ + automatic_tax?: { + enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + }; + /** @enum {string} */ + billing_cycle_anchor?: "automatic" | "phase_start"; + billing_thresholds?: { + amount_gte?: number; + reset_billing_cycle_anchor?: boolean; + } | ""; + /** @enum {string} */ + collection_method?: "charge_automatically" | "send_invoice"; + coupon?: string; + default_payment_method?: string; + default_tax_rates?: string[] | ""; + description?: string | ""; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; + end_date?: number | "now"; + /** invoice_settings */ + invoice_settings?: { + account_tax_ids?: string[] | ""; + days_until_due?: number; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + }; + items: { + billing_thresholds?: { + usage_gte: number; + } | ""; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; + metadata?: { + [key: string]: string | undefined; + }; + price?: string; + /** recurring_price_data */ + price_data?: { + currency: string; + product: string; + /** recurring_adhoc */ + recurring: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + }; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; + quantity?: number; + tax_rates?: string[] | ""; + }[]; + iterations?: number; + metadata?: { + [key: string]: string | undefined; + }; + on_behalf_of?: string; + /** @enum {string} */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + start_date?: number | "now"; + /** transfer_data_specs */ + transfer_data?: { + amount_percent?: number; + destination: string; + }; + trial?: boolean; + trial_end?: number | "now"; + }[]; + /** @enum {string} */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + }; /** @description The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ subscription?: string; - /** @description For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. */ + /** @description For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead. */ subscription_billing_cycle_anchor?: ("now" | "unchanged") | number; - /** @description Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`. */ + /** @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. */ subscription_cancel_at?: number | ""; - /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ + /** @description Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. */ subscription_cancel_at_period_end?: boolean; - /** @description This simulates the subscription being canceled or expired immediately. */ + /** @description This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. */ subscription_cancel_now?: boolean; - /** @description If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. */ + /** @description If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead. */ subscription_default_tax_rates?: string[] | ""; - /** @description A list of up to 20 subscription items, each with an attached price. */ + /** @description The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. */ + subscription_details?: { + billing_cycle_anchor?: ("now" | "unchanged") | number; + cancel_at?: number | ""; + cancel_at_period_end?: boolean; + cancel_now?: boolean; + default_tax_rates?: string[] | ""; + items?: { + billing_thresholds?: { + usage_gte: number; + } | ""; + clear_usage?: boolean; + deleted?: boolean; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; + id?: string; + metadata?: { + [key: string]: string | undefined; + } | ""; + price?: string; + /** recurring_price_data */ + price_data?: { + currency: string; + product: string; + /** recurring_adhoc */ + recurring: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + }; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; + quantity?: number; + tax_rates?: string[] | ""; + }[]; + /** @enum {string} */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + /** Format: unix-time */ + proration_date?: number; + /** @enum {string} */ + resume_at?: "now"; + /** Format: unix-time */ + start_date?: number; + trial_end?: "now" | number; + }; + /** @description A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead. */ subscription_items?: { billing_thresholds?: { usage_gte: number; } | ""; clear_usage?: boolean; deleted?: boolean; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; id?: string; metadata?: { [key: string]: string | undefined; @@ -33264,18 +38117,16 @@ export interface operations { quantity?: number; tax_rates?: string[] | ""; }[]; - /** @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. */ + /** @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead. */ subscription_proration_behavior?: "always_invoice" | "create_prorations" | "none"; - /** @description If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. */ + /** @description If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead. */ subscription_proration_date?: number; - /** @description For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. */ + /** @description For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead. */ subscription_resume_at?: "now"; - /** @description Date a subscription is intended to start (can be future or past) */ + /** @description Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead. */ subscription_start_date?: number; - /** @description If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. */ + /** @description If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead. */ subscription_trial_end?: "now" | number; - /** @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - subscription_trial_from_plan?: boolean; }; header?: never; path?: never; @@ -33313,8 +38164,14 @@ export interface operations { /** @description Settings for automatic tax lookup for this invoice preview. */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; - /** @description The code of the coupon to apply. If `subscription` or `subscription_items` is provided, the invoice returned will preview updating or creating a subscription with that coupon. Otherwise, it will preview applying that coupon to the customer for the next upcoming invoice from among the customer's subscriptions. The invoice can be previewed without a coupon by passing this value as an empty string. */ + /** @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. */ currency?: string; @@ -33351,14 +38208,15 @@ 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" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "no_vat" | "nz_gst" | "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" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "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" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; }; - /** @description The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead. */ + /** @description The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the subscription or customer. This works for both coupons directly applied to an invoice and coupons applied to a subscription. Pass an empty string to avoid inheriting any discounts. */ discounts?: { coupon?: string; discount?: string; + promotion_code?: string; }[] | ""; /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ ending_before?: string; @@ -33373,6 +38231,7 @@ export interface operations { discounts?: { coupon?: string; discount?: string; + promotion_code?: string; }[] | ""; invoiceitem?: string; metadata?: { @@ -33405,31 +38264,212 @@ export interface operations { /** Format: decimal */ unit_amount_decimal?: string; }[]; + /** @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ limit?: number; + /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ + on_behalf_of?: string | ""; /** @description The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. */ schedule?: string; + /** @description The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields. */ + schedule_details?: { + /** @enum {string} */ + end_behavior?: "cancel" | "release"; + phases?: { + add_invoice_items?: { + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[]; + price?: string; + /** one_time_price_data_with_negative_amounts */ + price_data?: { + currency: string; + product: string; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; + quantity?: number; + tax_rates?: string[] | ""; + }[]; + application_fee_percent?: number; + /** automatic_tax_config */ + automatic_tax?: { + enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + }; + /** @enum {string} */ + billing_cycle_anchor?: "automatic" | "phase_start"; + billing_thresholds?: { + amount_gte?: number; + reset_billing_cycle_anchor?: boolean; + } | ""; + /** @enum {string} */ + collection_method?: "charge_automatically" | "send_invoice"; + coupon?: string; + default_payment_method?: string; + default_tax_rates?: string[] | ""; + description?: string | ""; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; + end_date?: number | "now"; + /** invoice_settings */ + invoice_settings?: { + account_tax_ids?: string[] | ""; + days_until_due?: number; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + }; + items: { + billing_thresholds?: { + usage_gte: number; + } | ""; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; + metadata?: { + [key: string]: string | undefined; + }; + price?: string; + /** recurring_price_data */ + price_data?: { + currency: string; + product: string; + /** recurring_adhoc */ + recurring: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + }; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; + quantity?: number; + tax_rates?: string[] | ""; + }[]; + iterations?: number; + metadata?: { + [key: string]: string | undefined; + }; + on_behalf_of?: string; + /** @enum {string} */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + start_date?: number | "now"; + /** transfer_data_specs */ + transfer_data?: { + amount_percent?: number; + destination: string; + }; + trial?: boolean; + trial_end?: number | "now"; + }[]; + /** @enum {string} */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + }; /** @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 The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is provided, you will preview creating a subscription with those items. If neither `subscription` nor `subscription_items` is provided, you will retrieve the next upcoming invoice from among the customer's subscriptions. */ subscription?: string; - /** @description For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. */ + /** @description For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.billing_cycle_anchor` instead. */ subscription_billing_cycle_anchor?: ("now" | "unchanged") | number; - /** @description Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`. */ + /** @description A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at` instead. */ subscription_cancel_at?: number | ""; - /** @description Boolean indicating whether this subscription should cancel at the end of the current period. */ + /** @description Boolean indicating whether this subscription should cancel at the end of the current period. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_at_period_end` instead. */ subscription_cancel_at_period_end?: boolean; - /** @description This simulates the subscription being canceled or expired immediately. */ + /** @description This simulates the subscription being canceled or expired immediately. This field has been deprecated and will be removed in a future API version. Use `subscription_details.cancel_now` instead. */ subscription_cancel_now?: boolean; - /** @description If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. */ + /** @description If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates will apply to any line item that does not have `tax_rates` set. This field has been deprecated and will be removed in a future API version. Use `subscription_details.default_tax_rates` instead. */ subscription_default_tax_rates?: string[] | ""; - /** @description A list of up to 20 subscription items, each with an attached price. */ + /** @description The subscription creation or modification params to apply as a preview. Cannot be used with `schedule` or `schedule_details` fields. */ + subscription_details?: { + billing_cycle_anchor?: ("now" | "unchanged") | number; + cancel_at?: number | ""; + cancel_at_period_end?: boolean; + cancel_now?: boolean; + default_tax_rates?: string[] | ""; + items?: { + billing_thresholds?: { + usage_gte: number; + } | ""; + clear_usage?: boolean; + deleted?: boolean; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; + id?: string; + metadata?: { + [key: string]: string | undefined; + } | ""; + price?: string; + /** recurring_price_data */ + price_data?: { + currency: string; + product: string; + /** recurring_adhoc */ + recurring: { + /** @enum {string} */ + interval: "day" | "month" | "week" | "year"; + interval_count?: number; + }; + /** @enum {string} */ + tax_behavior?: "exclusive" | "inclusive" | "unspecified"; + unit_amount?: number; + /** Format: decimal */ + unit_amount_decimal?: string; + }; + quantity?: number; + tax_rates?: string[] | ""; + }[]; + /** @enum {string} */ + proration_behavior?: "always_invoice" | "create_prorations" | "none"; + /** Format: unix-time */ + proration_date?: number; + /** @enum {string} */ + resume_at?: "now"; + /** Format: unix-time */ + start_date?: number; + trial_end?: "now" | number; + }; + /** @description A list of up to 20 subscription items, each with an attached price. This field has been deprecated and will be removed in a future API version. Use `subscription_details.items` instead. */ subscription_items?: { billing_thresholds?: { usage_gte: number; } | ""; clear_usage?: boolean; deleted?: boolean; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; id?: string; metadata?: { [key: string]: string | undefined; @@ -33454,18 +38494,16 @@ export interface operations { quantity?: number; tax_rates?: string[] | ""; }[]; - /** @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. */ + /** @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_behavior` instead. */ subscription_proration_behavior?: "always_invoice" | "create_prorations" | "none"; - /** @description If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. */ + /** @description If previewing an update to a subscription, and doing proration, `subscription_proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. This field has been deprecated and will be removed in a future API version. Use `subscription_details.proration_date` instead. */ subscription_proration_date?: number; - /** @description For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. */ + /** @description For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription is resumed. This field has been deprecated and will be removed in a future API version. Use `subscription_details.resume_at` instead. */ subscription_resume_at?: "now"; - /** @description Date a subscription is intended to start (can be future or past) */ + /** @description Date a subscription is intended to start (can be future or past). This field has been deprecated and will be removed in a future API version. Use `subscription_details.start_date` instead. */ subscription_start_date?: number; - /** @description If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. */ + /** @description If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of `subscription_items` or `subscription` is required. This field has been deprecated and will be removed in a future API version. Use `subscription_details.trial_end` instead. */ subscription_trial_end?: "now" | number; - /** @description Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `subscription_trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `subscription_trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more. */ - subscription_trial_from_plan?: boolean; }; header?: never; path?: never; @@ -33571,6 +38609,12 @@ export interface operations { */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** * @description Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices. @@ -33596,6 +38640,7 @@ export interface operations { discounts?: { coupon?: string; discount?: string; + promotion_code?: string; }[] | ""; /** * Format: unix-time @@ -33608,10 +38653,21 @@ export interface operations { expand?: string[]; /** @description Footer to be displayed on the invoice. */ footer?: string; + /** + * param + * @description The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account. + */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; /** @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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { [key: string]: string | undefined; } | ""; + /** @description Set the number for this invoice. If no number is present then a number will be assigned automatically when the invoice is finalized. In many markets, regulations require invoices to be unique, sequential and / or gapless. You are responsible for ensuring this is true across all your different invoicing systems in the event that you edit the invoice number using our API. If you use only Stripe for your invoices and do not change invoice numbers, Stripe handles this aspect of compliance for you automatically. */ + number?: string | ""; /** @description The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. */ on_behalf_of?: string | ""; /** @@ -33648,7 +38704,7 @@ export interface operations { } | ""; }; /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; customer_balance?: { /** bank_transfer_param */ @@ -33662,17 +38718,18 @@ export interface operations { funding_type?: string; } | ""; konbini?: Record | ""; + sepa_debit?: Record | ""; us_bank_account?: { /** invoice_linked_account_options_param */ financial_connections?: { permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - prefetch?: "balances"[]; + prefetch?: ("balances" | "ownership" | "transactions")[]; }; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "paynow" | "paypal" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | ""; }; /** * rendering_param @@ -33927,14 +38984,15 @@ export interface operations { description?: string; /** @description Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations. */ discountable?: boolean; - /** @description The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. */ + /** @description The coupons, promotion codes & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts. */ discounts?: { coupon?: string; discount?: string; + promotion_code?: string; }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + /** @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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. For `type=recurring` line items, the incoming metadata specified on the request is directly used to set this value, in contrast to `type=invoiceitem` line items, where any existing metadata on the invoice line is merged with the incoming data. */ metadata?: { [key: string]: string | undefined; } | ""; @@ -33988,7 +39046,7 @@ export interface operations { percentage: number; state?: string; /** @enum {string} */ - tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "service_tax" | "vat"; + tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; }; taxable_amount: number; }[] | ""; @@ -34569,7 +39627,9 @@ export interface operations { */ spending_controls?: { allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; + allowed_merchant_countries?: string[]; blocked_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; + blocked_merchant_countries?: string[]; spending_limits?: { amount: number; categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; @@ -34735,7 +39795,9 @@ export interface operations { */ spending_controls?: { allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; + allowed_merchant_countries?: string[]; blocked_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; + blocked_merchant_countries?: string[]; spending_limits?: { amount: number; categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; @@ -34797,6 +39859,7 @@ export interface operations { last4?: string; /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ limit?: number; + personalization_design?: 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 return cards that have the given status. One of `active`, `inactive`, or `canceled`. */ @@ -34866,6 +39929,15 @@ export interface operations { metadata?: { [key: string]: string | undefined; }; + /** @description The personalization design object belonging to this card. */ + personalization_design?: string; + /** + * encrypted_pin_param + * @description The desired PIN for this card. + */ + pin?: { + encrypted_number?: string; + }; /** @description The card this is meant to be a replacement for (if any). */ replacement_for?: string; /** @@ -34873,6 +39945,8 @@ export interface operations { * @enum {string} */ replacement_reason?: "damaged" | "expired" | "lost" | "stolen"; + /** @description The second line to print on the card. */ + second_line?: string | ""; /** * shipping_specs * @description The address where the card will be shipped. @@ -34905,7 +39979,9 @@ export interface operations { */ spending_controls?: { allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; + allowed_merchant_countries?: string[]; blocked_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; + blocked_merchant_countries?: string[]; spending_limits?: { amount: number; categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; @@ -35008,6 +40084,7 @@ export interface operations { metadata?: { [key: string]: string | undefined; } | ""; + personalization_design?: string; /** * encrypted_pin_param * @description The desired new PIN for this card. @@ -35021,7 +40098,9 @@ export interface operations { */ spending_controls?: { allowed_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; + allowed_merchant_countries?: string[]; blocked_categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; + blocked_merchant_countries?: string[]; spending_limits?: { amount: number; categories?: ("ac_refrigeration_repair" | "accounting_bookkeeping_services" | "advertising_services" | "agricultural_cooperative" | "airlines_air_carriers" | "airports_flying_fields" | "ambulance_services" | "amusement_parks_carnivals" | "antique_reproductions" | "antique_shops" | "aquariums" | "architectural_surveying_services" | "art_dealers_and_galleries" | "artists_supply_and_craft_shops" | "auto_and_home_supply_stores" | "auto_body_repair_shops" | "auto_paint_shops" | "auto_service_shops" | "automated_cash_disburse" | "automated_fuel_dispensers" | "automobile_associations" | "automotive_parts_and_accessories_stores" | "automotive_tire_stores" | "bail_and_bond_payments" | "bakeries" | "bands_orchestras" | "barber_and_beauty_shops" | "betting_casino_gambling" | "bicycle_shops" | "billiard_pool_establishments" | "boat_dealers" | "boat_rentals_and_leases" | "book_stores" | "books_periodicals_and_newspapers" | "bowling_alleys" | "bus_lines" | "business_secretarial_schools" | "buying_shopping_services" | "cable_satellite_and_other_pay_television_and_radio" | "camera_and_photographic_supply_stores" | "candy_nut_and_confectionery_stores" | "car_and_truck_dealers_new_used" | "car_and_truck_dealers_used_only" | "car_rental_agencies" | "car_washes" | "carpentry_services" | "carpet_upholstery_cleaning" | "caterers" | "charitable_and_social_service_organizations_fundraising" | "chemicals_and_allied_products" | "child_care_services" | "childrens_and_infants_wear_stores" | "chiropodists_podiatrists" | "chiropractors" | "cigar_stores_and_stands" | "civic_social_fraternal_associations" | "cleaning_and_maintenance" | "clothing_rental" | "colleges_universities" | "commercial_equipment" | "commercial_footwear" | "commercial_photography_art_and_graphics" | "commuter_transport_and_ferries" | "computer_network_services" | "computer_programming" | "computer_repair" | "computer_software_stores" | "computers_peripherals_and_software" | "concrete_work_services" | "construction_materials" | "consulting_public_relations" | "correspondence_schools" | "cosmetic_stores" | "counseling_services" | "country_clubs" | "courier_services" | "court_costs" | "credit_reporting_agencies" | "cruise_lines" | "dairy_products_stores" | "dance_hall_studios_schools" | "dating_escort_services" | "dentists_orthodontists" | "department_stores" | "detective_agencies" | "digital_goods_applications" | "digital_goods_games" | "digital_goods_large_volume" | "digital_goods_media" | "direct_marketing_catalog_merchant" | "direct_marketing_combination_catalog_and_retail_merchant" | "direct_marketing_inbound_telemarketing" | "direct_marketing_insurance_services" | "direct_marketing_other" | "direct_marketing_outbound_telemarketing" | "direct_marketing_subscription" | "direct_marketing_travel" | "discount_stores" | "doctors" | "door_to_door_sales" | "drapery_window_covering_and_upholstery_stores" | "drinking_places" | "drug_stores_and_pharmacies" | "drugs_drug_proprietaries_and_druggist_sundries" | "dry_cleaners" | "durable_goods" | "duty_free_stores" | "eating_places_restaurants" | "educational_services" | "electric_razor_stores" | "electric_vehicle_charging" | "electrical_parts_and_equipment" | "electrical_services" | "electronics_repair_shops" | "electronics_stores" | "elementary_secondary_schools" | "emergency_services_gcas_visa_use_only" | "employment_temp_agencies" | "equipment_rental" | "exterminating_services" | "family_clothing_stores" | "fast_food_restaurants" | "financial_institutions" | "fines_government_administrative_entities" | "fireplace_fireplace_screens_and_accessories_stores" | "floor_covering_stores" | "florists" | "florists_supplies_nursery_stock_and_flowers" | "freezer_and_locker_meat_provisioners" | "fuel_dealers_non_automotive" | "funeral_services_crematories" | "furniture_home_furnishings_and_equipment_stores_except_appliances" | "furniture_repair_refinishing" | "furriers_and_fur_shops" | "general_services" | "gift_card_novelty_and_souvenir_shops" | "glass_paint_and_wallpaper_stores" | "glassware_crystal_stores" | "golf_courses_public" | "government_licensed_horse_dog_racing_us_region_only" | "government_licensed_online_casions_online_gambling_us_region_only" | "government_owned_lotteries_non_us_region" | "government_owned_lotteries_us_region_only" | "government_services" | "grocery_stores_supermarkets" | "hardware_equipment_and_supplies" | "hardware_stores" | "health_and_beauty_spas" | "hearing_aids_sales_and_supplies" | "heating_plumbing_a_c" | "hobby_toy_and_game_shops" | "home_supply_warehouse_stores" | "hospitals" | "hotels_motels_and_resorts" | "household_appliance_stores" | "industrial_supplies" | "information_retrieval_services" | "insurance_default" | "insurance_underwriting_premiums" | "intra_company_purchases" | "jewelry_stores_watches_clocks_and_silverware_stores" | "landscaping_services" | "laundries" | "laundry_cleaning_services" | "legal_services_attorneys" | "luggage_and_leather_goods_stores" | "lumber_building_materials_stores" | "manual_cash_disburse" | "marinas_service_and_supplies" | "marketplaces" | "masonry_stonework_and_plaster" | "massage_parlors" | "medical_and_dental_labs" | "medical_dental_ophthalmic_and_hospital_equipment_and_supplies" | "medical_services" | "membership_organizations" | "mens_and_boys_clothing_and_accessories_stores" | "mens_womens_clothing_stores" | "metal_service_centers" | "miscellaneous" | "miscellaneous_apparel_and_accessory_shops" | "miscellaneous_auto_dealers" | "miscellaneous_business_services" | "miscellaneous_food_stores" | "miscellaneous_general_merchandise" | "miscellaneous_general_services" | "miscellaneous_home_furnishing_specialty_stores" | "miscellaneous_publishing_and_printing" | "miscellaneous_recreation_services" | "miscellaneous_repair_shops" | "miscellaneous_specialty_retail" | "mobile_home_dealers" | "motion_picture_theaters" | "motor_freight_carriers_and_trucking" | "motor_homes_dealers" | "motor_vehicle_supplies_and_new_parts" | "motorcycle_shops_and_dealers" | "motorcycle_shops_dealers" | "music_stores_musical_instruments_pianos_and_sheet_music" | "news_dealers_and_newsstands" | "non_fi_money_orders" | "non_fi_stored_value_card_purchase_load" | "nondurable_goods" | "nurseries_lawn_and_garden_supply_stores" | "nursing_personal_care" | "office_and_commercial_furniture" | "opticians_eyeglasses" | "optometrists_ophthalmologist" | "orthopedic_goods_prosthetic_devices" | "osteopaths" | "package_stores_beer_wine_and_liquor" | "paints_varnishes_and_supplies" | "parking_lots_garages" | "passenger_railways" | "pawn_shops" | "pet_shops_pet_food_and_supplies" | "petroleum_and_petroleum_products" | "photo_developing" | "photographic_photocopy_microfilm_equipment_and_supplies" | "photographic_studios" | "picture_video_production" | "piece_goods_notions_and_other_dry_goods" | "plumbing_heating_equipment_and_supplies" | "political_organizations" | "postal_services_government_only" | "precious_stones_and_metals_watches_and_jewelry" | "professional_services" | "public_warehousing_and_storage" | "quick_copy_repro_and_blueprint" | "railroads" | "real_estate_agents_and_managers_rentals" | "record_stores" | "recreational_vehicle_rentals" | "religious_goods_stores" | "religious_organizations" | "roofing_siding_sheet_metal" | "secretarial_support_services" | "security_brokers_dealers" | "service_stations" | "sewing_needlework_fabric_and_piece_goods_stores" | "shoe_repair_hat_cleaning" | "shoe_stores" | "small_appliance_repair" | "snowmobile_dealers" | "special_trade_services" | "specialty_cleaning" | "sporting_goods_stores" | "sporting_recreation_camps" | "sports_and_riding_apparel_stores" | "sports_clubs_fields" | "stamp_and_coin_stores" | "stationary_office_supplies_printing_and_writing_paper" | "stationery_stores_office_and_school_supply_stores" | "swimming_pools_sales" | "t_ui_travel_germany" | "tailors_alterations" | "tax_payments_government_agencies" | "tax_preparation_services" | "taxicabs_limousines" | "telecommunication_equipment_and_telephone_sales" | "telecommunication_services" | "telegraph_services" | "tent_and_awning_shops" | "testing_laboratories" | "theatrical_ticket_agencies" | "timeshares" | "tire_retreading_and_repair" | "tolls_bridge_fees" | "tourist_attractions_and_exhibits" | "towing_services" | "trailer_parks_campgrounds" | "transportation_services" | "travel_agencies_tour_operators" | "truck_stop_iteration" | "truck_utility_trailer_rentals" | "typesetting_plate_making_and_related_services" | "typewriter_stores" | "u_s_federal_government_agencies_or_departments" | "uniforms_commercial_clothing" | "used_merchandise_and_secondhand_stores" | "utilities" | "variety_stores" | "veterinary_services" | "video_amusement_game_supplies" | "video_game_arcades" | "video_tape_rental_stores" | "vocational_trade_schools" | "watch_jewelry_repair" | "welding_repair" | "wholesale_clubs" | "wig_and_toupee_stores" | "wires_money_orders" | "womens_accessory_and_specialty_shops" | "womens_ready_to_wear_stores" | "wrecking_and_salvage_yards")[]; @@ -35061,7 +40140,7 @@ export interface operations { GetIssuingDisputes: { parameters: { query?: { - /** @description Select Issuing disputes that were created during the given date interval. */ + /** @description Only return Issuing disputes that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -35122,98 +40201,416 @@ export interface operations { }; }; }; - PostIssuingDisputes: { + PostIssuingDisputes: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If not set, defaults to the full transaction amount. */ + amount?: number; + /** + * evidence_param + * @description Evidence provided for the dispute. + */ + evidence?: { + canceled?: { + additional_documentation?: string | ""; + canceled_at?: number | ""; + cancellation_policy_provided?: boolean | ""; + cancellation_reason?: string | ""; + expected_at?: number | ""; + explanation?: string | ""; + product_description?: string | ""; + /** @enum {string} */ + product_type?: "" | "merchandise" | "service"; + /** @enum {string} */ + return_status?: "" | "merchant_rejected" | "successful"; + returned_at?: number | ""; + } | ""; + duplicate?: { + additional_documentation?: string | ""; + card_statement?: string | ""; + cash_receipt?: string | ""; + check_image?: string | ""; + explanation?: string | ""; + original_transaction?: string; + } | ""; + fraudulent?: { + additional_documentation?: string | ""; + explanation?: string | ""; + } | ""; + merchandise_not_as_described?: { + additional_documentation?: string | ""; + explanation?: string | ""; + received_at?: number | ""; + return_description?: string | ""; + /** @enum {string} */ + return_status?: "" | "merchant_rejected" | "successful"; + returned_at?: number | ""; + } | ""; + not_received?: { + additional_documentation?: string | ""; + expected_at?: number | ""; + explanation?: string | ""; + product_description?: string | ""; + /** @enum {string} */ + product_type?: "" | "merchandise" | "service"; + } | ""; + other?: { + additional_documentation?: string | ""; + explanation?: string | ""; + product_description?: string | ""; + /** @enum {string} */ + product_type?: "" | "merchandise" | "service"; + } | ""; + /** @enum {string} */ + reason?: "canceled" | "duplicate" | "fraudulent" | "merchandise_not_as_described" | "not_received" | "other" | "service_not_as_described"; + service_not_as_described?: { + additional_documentation?: string | ""; + canceled_at?: number | ""; + cancellation_reason?: string | ""; + explanation?: string | ""; + received_at?: number | ""; + } | ""; + }; + /** @description Specifies which fields in the response should be expanded. */ + expand?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + metadata?: { + [key: string]: string | undefined; + }; + /** @description The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`. */ + transaction?: string; + /** + * treasury_param + * @description Params for disputes related to Treasury FinancialAccounts + */ + treasury?: { + received_debit: string; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issuing.dispute"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetIssuingDisputesDispute: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + dispute: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issuing.dispute"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostIssuingDisputesDispute: { + parameters: { + query?: never; + header?: never; + path: { + dispute: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + amount?: number; + /** + * evidence_param + * @description Evidence provided for the dispute. + */ + evidence?: { + canceled?: { + additional_documentation?: string | ""; + canceled_at?: number | ""; + cancellation_policy_provided?: boolean | ""; + cancellation_reason?: string | ""; + expected_at?: number | ""; + explanation?: string | ""; + product_description?: string | ""; + /** @enum {string} */ + product_type?: "" | "merchandise" | "service"; + /** @enum {string} */ + return_status?: "" | "merchant_rejected" | "successful"; + returned_at?: number | ""; + } | ""; + duplicate?: { + additional_documentation?: string | ""; + card_statement?: string | ""; + cash_receipt?: string | ""; + check_image?: string | ""; + explanation?: string | ""; + original_transaction?: string; + } | ""; + fraudulent?: { + additional_documentation?: string | ""; + explanation?: string | ""; + } | ""; + merchandise_not_as_described?: { + additional_documentation?: string | ""; + explanation?: string | ""; + received_at?: number | ""; + return_description?: string | ""; + /** @enum {string} */ + return_status?: "" | "merchant_rejected" | "successful"; + returned_at?: number | ""; + } | ""; + not_received?: { + additional_documentation?: string | ""; + expected_at?: number | ""; + explanation?: string | ""; + product_description?: string | ""; + /** @enum {string} */ + product_type?: "" | "merchandise" | "service"; + } | ""; + other?: { + additional_documentation?: string | ""; + explanation?: string | ""; + product_description?: string | ""; + /** @enum {string} */ + product_type?: "" | "merchandise" | "service"; + } | ""; + /** @enum {string} */ + reason?: "canceled" | "duplicate" | "fraudulent" | "merchandise_not_as_described" | "not_received" | "other" | "service_not_as_described"; + service_not_as_described?: { + additional_documentation?: string | ""; + canceled_at?: number | ""; + cancellation_reason?: string | ""; + explanation?: string | ""; + received_at?: number | ""; + } | ""; + }; + /** @description Specifies which fields in the response should be expanded. */ + expand?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + metadata?: { + [key: string]: string | undefined; + } | ""; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issuing.dispute"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostIssuingDisputesDisputeSubmit: { + parameters: { + query?: never; + header?: never; + path: { + dispute: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ + metadata?: { + [key: string]: string | undefined; + } | ""; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issuing.dispute"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetIssuingPersonalizationDesigns: { + parameters: { + query?: { + /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @description Only return personalization designs with the given lookup keys. */ + lookup_keys?: string[]; + /** @description Only return personalization designs with the given preferences. */ + preferences?: { + is_default?: boolean; + is_platform_default?: boolean; + }; + /** @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 return personalization designs with the given status. */ + status?: "active" | "inactive" | "rejected" | "review"; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["issuing.personalization_design"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostIssuingPersonalizationDesigns: { parameters: { query?: never; header?: never; path?: never; cookie?: never; }; - requestBody?: { + requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If not set, defaults to the full transaction amount. */ - amount?: number; + /** @description The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. */ + card_logo?: string; /** - * evidence_param - * @description Evidence provided for the dispute. + * carrier_text_param + * @description Hash containing carrier text, for use with physical bundles that support carrier text. */ - evidence?: { - canceled?: { - additional_documentation?: string | ""; - canceled_at?: number | ""; - cancellation_policy_provided?: boolean | ""; - cancellation_reason?: string | ""; - expected_at?: number | ""; - explanation?: string | ""; - product_description?: string | ""; - /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; - /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: number | ""; - } | ""; - duplicate?: { - additional_documentation?: string | ""; - card_statement?: string | ""; - cash_receipt?: string | ""; - check_image?: string | ""; - explanation?: string | ""; - original_transaction?: string; - } | ""; - fraudulent?: { - additional_documentation?: string | ""; - explanation?: string | ""; - } | ""; - merchandise_not_as_described?: { - additional_documentation?: string | ""; - explanation?: string | ""; - received_at?: number | ""; - return_description?: string | ""; - /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: number | ""; - } | ""; - not_received?: { - additional_documentation?: string | ""; - expected_at?: number | ""; - explanation?: string | ""; - product_description?: string | ""; - /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; - } | ""; - other?: { - additional_documentation?: string | ""; - explanation?: string | ""; - product_description?: string | ""; - /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; - } | ""; - /** @enum {string} */ - reason?: "canceled" | "duplicate" | "fraudulent" | "merchandise_not_as_described" | "not_received" | "other" | "service_not_as_described"; - service_not_as_described?: { - additional_documentation?: string | ""; - canceled_at?: number | ""; - cancellation_reason?: string | ""; - explanation?: string | ""; - received_at?: number | ""; - } | ""; + carrier_text?: { + footer_body?: string | ""; + footer_title?: string | ""; + header_body?: string | ""; + header_title?: string | ""; }; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @description A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. */ + lookup_key?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { [key: string]: string | undefined; }; - /** @description The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`. */ - transaction?: string; + /** @description Friendly display name. */ + name?: string; + /** @description The physical bundle object belonging to this personalization design. */ + physical_bundle: string; /** - * treasury_param - * @description Params for disputes related to Treasury FinancialAccounts + * preferences_param + * @description Information on whether this personalization design is used to create cards when one is not specified. */ - treasury?: { - received_debit: string; + preferences?: { + is_default: boolean; }; + /** @description If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design. */ + transfer_lookup_key?: boolean; }; }; }; @@ -35224,7 +40621,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["issuing.dispute"]; + "application/json": components["schemas"]["issuing.personalization_design"]; }; }; /** @description Error response. */ @@ -35238,7 +40635,7 @@ export interface operations { }; }; }; - GetIssuingDisputesDispute: { + GetIssuingPersonalizationDesignsPersonalizationDesign: { parameters: { query?: { /** @description Specifies which fields in the response should be expanded. */ @@ -35246,7 +40643,7 @@ export interface operations { }; header?: never; path: { - dispute: string; + personalization_design: string; }; cookie?: never; }; @@ -35262,7 +40659,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["issuing.dispute"]; + "application/json": components["schemas"]["issuing.personalization_design"]; }; }; /** @description Error response. */ @@ -35276,91 +40673,48 @@ export interface operations { }; }; }; - PostIssuingDisputesDispute: { + PostIssuingPersonalizationDesignsPersonalizationDesign: { parameters: { query?: never; header?: never; path: { - dispute: string; + personalization_design: string; }; cookie?: never; }; requestBody?: { content: { "application/x-www-form-urlencoded": { - /** @description The dispute amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ - amount?: number; - /** - * evidence_param - * @description Evidence provided for the dispute. - */ - evidence?: { - canceled?: { - additional_documentation?: string | ""; - canceled_at?: number | ""; - cancellation_policy_provided?: boolean | ""; - cancellation_reason?: string | ""; - expected_at?: number | ""; - explanation?: string | ""; - product_description?: string | ""; - /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; - /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: number | ""; - } | ""; - duplicate?: { - additional_documentation?: string | ""; - card_statement?: string | ""; - cash_receipt?: string | ""; - check_image?: string | ""; - explanation?: string | ""; - original_transaction?: string; - } | ""; - fraudulent?: { - additional_documentation?: string | ""; - explanation?: string | ""; - } | ""; - merchandise_not_as_described?: { - additional_documentation?: string | ""; - explanation?: string | ""; - received_at?: number | ""; - return_description?: string | ""; - /** @enum {string} */ - return_status?: "" | "merchant_rejected" | "successful"; - returned_at?: number | ""; - } | ""; - not_received?: { - additional_documentation?: string | ""; - expected_at?: number | ""; - explanation?: string | ""; - product_description?: string | ""; - /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; - } | ""; - other?: { - additional_documentation?: string | ""; - explanation?: string | ""; - product_description?: string | ""; - /** @enum {string} */ - product_type?: "" | "merchandise" | "service"; - } | ""; - /** @enum {string} */ - reason?: "canceled" | "duplicate" | "fraudulent" | "merchandise_not_as_described" | "not_received" | "other" | "service_not_as_described"; - service_not_as_described?: { - additional_documentation?: string | ""; - canceled_at?: number | ""; - cancellation_reason?: string | ""; - explanation?: string | ""; - received_at?: number | ""; - } | ""; - }; + /** @description The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`. */ + card_logo?: string | ""; + /** @description Hash containing carrier text, for use with physical bundles that support carrier text. */ + carrier_text?: { + footer_body?: string | ""; + footer_title?: string | ""; + header_body?: string | ""; + header_title?: string | ""; + } | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @description A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters. */ + lookup_key?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { [key: string]: string | undefined; - } | ""; + }; + /** @description Friendly display name. Providing an empty string will set the field to null. */ + name?: string | ""; + /** @description The physical bundle object belonging to this personalization design. */ + physical_bundle?: string; + /** + * preferences_param + * @description Information on whether this personalization design is used to create cards when one is not specified. + */ + preferences?: { + is_default: boolean; + }; + /** @description If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design. */ + transfer_lookup_key?: boolean; }; }; }; @@ -35371,7 +40725,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["issuing.dispute"]; + "application/json": components["schemas"]["issuing.personalization_design"]; }; }; /** @description Error response. */ @@ -35385,25 +40739,78 @@ export interface operations { }; }; }; - PostIssuingDisputesDisputeSubmit: { + GetIssuingPhysicalBundles: { parameters: { - query?: never; + query?: { + /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @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 return physical bundles with the given status. */ + status?: "active" | "inactive" | "review"; + /** @description Only return physical bundles with the given type. */ + type?: "custom" | "standard"; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["issuing.physical_bundle"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetIssuingPhysicalBundlesPhysicalBundle: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; header?: never; path: { - dispute: string; + physical_bundle: string; }; cookie?: never; }; requestBody?: { content: { - "application/x-www-form-urlencoded": { - /** @description Specifies which fields in the response should be expanded. */ - expand?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ - metadata?: { - [key: string]: string | undefined; - } | ""; - }; + "application/x-www-form-urlencoded": Record; }; }; responses: { @@ -35413,7 +40820,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["issuing.dispute"]; + "application/json": components["schemas"]["issuing.physical_bundle"]; }; }; /** @description Error response. */ @@ -35572,7 +40979,7 @@ export interface operations { query: { /** @description The Issuing card identifier to list tokens for. */ card: string; - /** @description Select Issuing tokens that were created during the given date interval. */ + /** @description Only return Issuing tokens that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -35892,7 +41299,7 @@ export interface operations { * Possible values are `balances`, `transactions`, `ownership`, and `payment_method`. */ permissions: ("balances" | "ownership" | "payment_method" | "transactions")[]; /** @description List of data features that you would like to retrieve upon account creation. */ - prefetch?: ("balances" | "ownership")[]; + prefetch?: ("balances" | "ownership" | "transactions")[]; /** @description For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app. */ return_url?: string; }; @@ -36167,7 +41574,7 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** @description The list of account features that you would like to refresh. */ - features: ("balance" | "ownership")[]; + features: ("balance" | "ownership" | "transactions")[]; }; }; }; @@ -36320,10 +41727,17 @@ export interface operations { * @enum {string} */ capture_method?: "automatic" | "automatic_async" | "manual"; - /** @description Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm). */ + /** @description Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm). */ confirm?: boolean; - /** @enum {string} */ + /** + * @description Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment. + * @enum {string} + */ confirmation_method?: "automatic" | "manual"; + /** @description ID of the ConfirmationToken used to confirm this PaymentIntent. + * + * 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). */ currency: string; /** @description ID of the Customer this PaymentIntent belongs to, if one exists. @@ -36390,6 +41804,10 @@ export interface operations { afterpay_clearpay?: Record; /** param */ alipay?: Record; + /** @enum {string} */ + allow_redisplay?: "always" | "limited" | "unspecified"; + /** param */ + amazon_pay?: Record; /** param */ au_becs_debit?: { account_number: string; @@ -36443,7 +41861,7 @@ export interface operations { /** param */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** param */ interac_present?: Record; @@ -36464,11 +41882,13 @@ export interface operations { [key: string]: string | undefined; }; /** param */ + mobilepay?: Record; + /** param */ oxxo?: Record; /** param */ p24?: { /** @enum {string} */ - bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "volkswagen_bank"; + bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ paynow?: Record; @@ -36478,7 +41898,7 @@ export interface operations { pix?: Record; /** param */ promptpay?: Record; - /** radar_options */ + /** radar_options_with_hidden_options */ radar_options?: { session?: string; }; @@ -36493,8 +41913,10 @@ export interface operations { /** @enum {string} */ country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; }; + /** param */ + swish?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -36548,6 +41970,12 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + amazon_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; au_becs_debit?: { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; @@ -36564,6 +41992,8 @@ export interface operations { } | ""; blik?: { code?: string; + /** @enum {string} */ + setup_future_usage?: "" | "none"; } | ""; boleto?: { expires_after_days?: number; @@ -36612,11 +42042,36 @@ export interface operations { /** @enum {string} */ request_overcapture?: "if_available" | "never"; /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: "any" | "automatic" | "challenge"; + require_cvc_recollection?: boolean; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; statement_descriptor_suffix_kana?: string | ""; statement_descriptor_suffix_kanji?: string | ""; + /** payment_method_options_param */ + three_d_secure?: { + /** @enum {string} */ + ares_trans_status?: "A" | "C" | "I" | "N" | "R" | "U" | "Y"; + cryptogram: string; + /** @enum {string} */ + electronic_commerce_indicator?: "01" | "02" | "05" | "06" | "07"; + /** @enum {string} */ + exemption_indicator?: "low_risk" | "none"; + /** network_options_param */ + network_options?: { + /** cartes_bancaires_network_options_param */ + cartes_bancaires?: { + /** @enum {string} */ + cb_avalgo: "0" | "1" | "2" | "3" | "4" | "A"; + cb_exemption?: string; + cb_score?: number; + }; + }; + requestor_challenge_indicator?: string; + transaction_id: string; + /** @enum {string} */ + version: "1.0.2" | "2.1.0" | "2.2.0"; + }; } | ""; card_present?: { request_extended_authorization?: boolean; @@ -36687,6 +42142,12 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + mobilepay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "none"; + } | ""; oxxo?: { expires_after_days?: number; /** @enum {string} */ @@ -36723,6 +42184,8 @@ export interface operations { setup_future_usage?: "none"; } | ""; revolut_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; @@ -36738,13 +42201,23 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + swish?: { + reference?: string | ""; + /** @enum {string} */ + setup_future_usage?: "none"; + } | ""; us_bank_account?: { /** linked_account_options_param */ financial_connections?: { permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - prefetch?: "balances"[]; + prefetch?: ("balances" | "ownership" | "transactions")[]; return_url?: string; }; + /** mandate_options_param */ + mandate_options?: { + /** @enum {string} */ + collection_method?: "" | "paper"; + }; /** networks_options_param */ networks?: { requested?: ("ach" | "us_domestic_wire")[]; @@ -36809,7 +42282,7 @@ export interface operations { phone?: string; tracking_number?: string; }; - /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. It must contain at least one letter and be 1–22 characters long. */ + /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ statement_descriptor?: string; /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. The concatenated descriptor must contain 1-22 characters. */ statement_descriptor_suffix?: string; @@ -37004,6 +42477,10 @@ export interface operations { afterpay_clearpay?: Record; /** param */ alipay?: Record; + /** @enum {string} */ + allow_redisplay?: "always" | "limited" | "unspecified"; + /** param */ + amazon_pay?: Record; /** param */ au_becs_debit?: { account_number: string; @@ -37057,7 +42534,7 @@ export interface operations { /** param */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** param */ interac_present?: Record; @@ -37078,11 +42555,13 @@ export interface operations { [key: string]: string | undefined; }; /** param */ + mobilepay?: Record; + /** param */ oxxo?: Record; /** param */ p24?: { /** @enum {string} */ - bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "volkswagen_bank"; + bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ paynow?: Record; @@ -37092,7 +42571,7 @@ export interface operations { pix?: Record; /** param */ promptpay?: Record; - /** radar_options */ + /** radar_options_with_hidden_options */ radar_options?: { session?: string; }; @@ -37107,8 +42586,10 @@ export interface operations { /** @enum {string} */ country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; }; + /** param */ + swish?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -37162,6 +42643,12 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + amazon_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; au_becs_debit?: { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; @@ -37178,6 +42665,8 @@ export interface operations { } | ""; blik?: { code?: string; + /** @enum {string} */ + setup_future_usage?: "" | "none"; } | ""; boleto?: { expires_after_days?: number; @@ -37226,11 +42715,36 @@ export interface operations { /** @enum {string} */ request_overcapture?: "if_available" | "never"; /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: "any" | "automatic" | "challenge"; + require_cvc_recollection?: boolean; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; statement_descriptor_suffix_kana?: string | ""; statement_descriptor_suffix_kanji?: string | ""; + /** payment_method_options_param */ + three_d_secure?: { + /** @enum {string} */ + ares_trans_status?: "A" | "C" | "I" | "N" | "R" | "U" | "Y"; + cryptogram: string; + /** @enum {string} */ + electronic_commerce_indicator?: "01" | "02" | "05" | "06" | "07"; + /** @enum {string} */ + exemption_indicator?: "low_risk" | "none"; + /** network_options_param */ + network_options?: { + /** cartes_bancaires_network_options_param */ + cartes_bancaires?: { + /** @enum {string} */ + cb_avalgo: "0" | "1" | "2" | "3" | "4" | "A"; + cb_exemption?: string; + cb_score?: number; + }; + }; + requestor_challenge_indicator?: string; + transaction_id: string; + /** @enum {string} */ + version: "1.0.2" | "2.1.0" | "2.2.0"; + }; } | ""; card_present?: { request_extended_authorization?: boolean; @@ -37301,6 +42815,12 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + mobilepay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "none"; + } | ""; oxxo?: { expires_after_days?: number; /** @enum {string} */ @@ -37337,6 +42857,8 @@ export interface operations { setup_future_usage?: "none"; } | ""; revolut_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; @@ -37352,13 +42874,23 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + swish?: { + reference?: string | ""; + /** @enum {string} */ + setup_future_usage?: "none"; + } | ""; us_bank_account?: { /** linked_account_options_param */ financial_connections?: { permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - prefetch?: "balances"[]; + prefetch?: ("balances" | "ownership" | "transactions")[]; return_url?: string; }; + /** mandate_options_param */ + mandate_options?: { + /** @enum {string} */ + collection_method?: "" | "paper"; + }; /** networks_options_param */ networks?: { requested?: ("ach" | "us_domestic_wire")[]; @@ -37413,7 +42945,7 @@ export interface operations { phone?: string; tracking_number?: string; } | ""; - /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ + /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ statement_descriptor?: string; /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor. */ statement_descriptor_suffix?: string; @@ -37565,7 +43097,7 @@ export interface operations { metadata?: { [key: string]: string | undefined; } | ""; - /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ + /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ statement_descriptor?: string; /** @description Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. The concatenated descriptor must be 1-22 characters long. */ statement_descriptor_suffix?: string; @@ -37620,6 +43152,10 @@ export interface operations { capture_method?: "automatic" | "automatic_async" | "manual"; /** @description The client secret of the PaymentIntent. */ client_secret?: string; + /** @description ID of the ConfirmationToken used to confirm this PaymentIntent. + * + * 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 Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). */ error_on_requires_action?: boolean; /** @description Specifies which fields in the response should be expanded. */ @@ -37676,6 +43212,10 @@ export interface operations { afterpay_clearpay?: Record; /** param */ alipay?: Record; + /** @enum {string} */ + allow_redisplay?: "always" | "limited" | "unspecified"; + /** param */ + amazon_pay?: Record; /** param */ au_becs_debit?: { account_number: string; @@ -37729,7 +43269,7 @@ export interface operations { /** param */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** param */ interac_present?: Record; @@ -37750,11 +43290,13 @@ export interface operations { [key: string]: string | undefined; }; /** param */ + mobilepay?: Record; + /** param */ oxxo?: Record; /** param */ p24?: { /** @enum {string} */ - bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "volkswagen_bank"; + bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ paynow?: Record; @@ -37764,7 +43306,7 @@ export interface operations { pix?: Record; /** param */ promptpay?: Record; - /** radar_options */ + /** radar_options_with_hidden_options */ radar_options?: { session?: string; }; @@ -37779,8 +43321,10 @@ export interface operations { /** @enum {string} */ country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; }; + /** param */ + swish?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -37834,6 +43378,12 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + amazon_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "" | "none" | "off_session"; + } | ""; au_becs_debit?: { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; @@ -37850,6 +43400,8 @@ export interface operations { } | ""; blik?: { code?: string; + /** @enum {string} */ + setup_future_usage?: "" | "none"; } | ""; boleto?: { expires_after_days?: number; @@ -37898,11 +43450,36 @@ export interface operations { /** @enum {string} */ request_overcapture?: "if_available" | "never"; /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: "any" | "automatic" | "challenge"; + require_cvc_recollection?: boolean; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session" | "on_session"; statement_descriptor_suffix_kana?: string | ""; statement_descriptor_suffix_kanji?: string | ""; + /** payment_method_options_param */ + three_d_secure?: { + /** @enum {string} */ + ares_trans_status?: "A" | "C" | "I" | "N" | "R" | "U" | "Y"; + cryptogram: string; + /** @enum {string} */ + electronic_commerce_indicator?: "01" | "02" | "05" | "06" | "07"; + /** @enum {string} */ + exemption_indicator?: "low_risk" | "none"; + /** network_options_param */ + network_options?: { + /** cartes_bancaires_network_options_param */ + cartes_bancaires?: { + /** @enum {string} */ + cb_avalgo: "0" | "1" | "2" | "3" | "4" | "A"; + cb_exemption?: string; + cb_score?: number; + }; + }; + requestor_challenge_indicator?: string; + transaction_id: string; + /** @enum {string} */ + version: "1.0.2" | "2.1.0" | "2.2.0"; + }; } | ""; card_present?: { request_extended_authorization?: boolean; @@ -37973,6 +43550,12 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + mobilepay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; + /** @enum {string} */ + setup_future_usage?: "none"; + } | ""; oxxo?: { expires_after_days?: number; /** @enum {string} */ @@ -38009,6 +43592,8 @@ export interface operations { setup_future_usage?: "none"; } | ""; revolut_pay?: { + /** @enum {string} */ + capture_method?: "" | "manual"; /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; @@ -38024,13 +43609,23 @@ export interface operations { /** @enum {string} */ setup_future_usage?: "" | "none" | "off_session"; } | ""; + swish?: { + reference?: string | ""; + /** @enum {string} */ + setup_future_usage?: "none"; + } | ""; us_bank_account?: { /** linked_account_options_param */ financial_connections?: { permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - prefetch?: "balances"[]; + prefetch?: ("balances" | "ownership" | "transactions")[]; return_url?: string; }; + /** mandate_options_param */ + mandate_options?: { + /** @enum {string} */ + collection_method?: "" | "paper"; + }; /** networks_options_param */ networks?: { requested?: ("ach" | "us_domestic_wire")[]; @@ -38146,7 +43741,7 @@ export interface operations { metadata?: { [key: string]: string | undefined; }; - /** @description For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters. */ + /** @description For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. */ statement_descriptor?: string; /** * transfer_data_update_params @@ -38317,9 +43912,15 @@ export interface operations { */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** - * @description Configuration for collecting the customer's billing address. + * @description Configuration for collecting the customer's billing address. Defaults to `auto`. * @enum {string} */ billing_address_collection?: "auto" | "required"; @@ -38328,6 +43929,11 @@ export interface operations { * @description Configure fields to gather active consent from customers. */ consent_collection?: { + /** payment_method_reuse_agreement_params */ + payment_method_reuse_agreement?: { + /** @enum {string} */ + position: "auto" | "hidden"; + }; /** @enum {string} */ promotions?: "auto" | "none"; /** @enum {string} */ @@ -38335,7 +43941,7 @@ export interface operations { }; /** @description Three-letter [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 2 fields are supported. */ + /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ custom_fields?: { /** custom_field_dropdown_param */ dropdown?: { @@ -38370,6 +43976,9 @@ export interface operations { * @description Display additional text for your customers using custom text. */ custom_text?: { + after_submit?: { + message: string; + } | ""; shipping_address?: { message: string; } | ""; @@ -38387,6 +43996,8 @@ export interface operations { customer_creation?: "always" | "if_required"; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @description The custom message to be displayed to a customer when a payment link is no longer active. */ + inactive_message?: string; /** * invoice_creation_create_params * @description Generate a post-purchase Invoice for one-time payments. @@ -38402,6 +44013,12 @@ export interface operations { }[] | ""; description?: string; footer?: string; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; metadata?: { [key: string]: string | undefined; } | ""; @@ -38443,18 +44060,19 @@ export interface operations { setup_future_usage?: "off_session" | "on_session"; statement_descriptor?: string; statement_descriptor_suffix?: string; + transfer_group?: string; }; /** * @description Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. * - * Can only be set in `subscription` mode. + * Can only be set in `subscription` mode. Defaults to `always`. * * If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). * @enum {string} */ payment_method_collection?: "always" | "if_required"; /** @description The list of payment method types that customers can use. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)). */ - payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[]; + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[]; /** * phone_number_collection_params * @description Controls phone number collection settings during checkout. @@ -38464,6 +44082,16 @@ export interface operations { phone_number_collection?: { enabled: boolean; }; + /** + * restrictions_params + * @description Settings that restrict the usage of a payment link. + */ + restrictions?: { + /** completed_sessions_params */ + completed_sessions: { + limit: number; + }; + }; /** * shipping_address_collection_params * @description Configuration for collecting the customer's shipping address. @@ -38486,10 +44114,27 @@ export interface operations { */ subscription_data?: { description?: string; + /** subscription_data_invoice_settings_params */ + invoice_settings?: { + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + }; metadata?: { [key: string]: string | undefined; }; trial_period_days?: number; + /** trial_settings_config */ + trial_settings?: { + /** end_behavior */ + end_behavior: { + /** @enum {string} */ + missing_payment_method: "cancel" | "create_invoice" | "pause"; + }; + }; }; /** * tax_id_collection_params @@ -38606,13 +44251,19 @@ export interface operations { */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** - * @description Configuration for collecting the customer's billing address. + * @description Configuration for collecting the customer's billing address. Defaults to `auto`. * @enum {string} */ billing_address_collection?: "auto" | "required"; - /** @description Collect additional information from your customer using custom fields. Up to 2 fields are supported. */ + /** @description Collect additional information from your customer using custom fields. Up to 3 fields are supported. */ custom_fields?: { /** custom_field_dropdown_param */ dropdown?: { @@ -38647,6 +44298,9 @@ export interface operations { * @description Display additional text for your customers using custom text. */ custom_text?: { + after_submit?: { + message: string; + } | ""; shipping_address?: { message: string; } | ""; @@ -38664,6 +44318,8 @@ export interface operations { customer_creation?: "always" | "if_required"; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @description The custom message to be displayed to a customer when a payment link is no longer active. */ + inactive_message?: string | ""; /** * invoice_creation_update_params * @description Generate a post-purchase Invoice for one-time payments. @@ -38679,6 +44335,12 @@ export interface operations { }[] | ""; description?: string; footer?: string; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; metadata?: { [key: string]: string | undefined; } | ""; @@ -38714,18 +44376,26 @@ export interface operations { } | ""; statement_descriptor?: string | ""; statement_descriptor_suffix?: string | ""; + transfer_group?: string | ""; }; /** * @description Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount. * - * Can only be set in `subscription` mode. + * Can only be set in `subscription` mode. Defaults to `always`. * * If you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials). * @enum {string} */ payment_method_collection?: "always" | "if_required"; /** @description The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). */ - payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay")[] | ""; + /** @description Settings that restrict the usage of a payment link. */ + restrictions?: { + /** completed_sessions_params */ + completed_sessions: { + limit: number; + }; + } | ""; /** @description Configuration for collecting the customer's shipping address. */ shipping_address_collection?: { allowed_countries: ("AC" | "AD" | "AE" | "AF" | "AG" | "AI" | "AL" | "AM" | "AO" | "AQ" | "AR" | "AT" | "AU" | "AW" | "AX" | "AZ" | "BA" | "BB" | "BD" | "BE" | "BF" | "BG" | "BH" | "BI" | "BJ" | "BL" | "BM" | "BN" | "BO" | "BQ" | "BR" | "BS" | "BT" | "BV" | "BW" | "BY" | "BZ" | "CA" | "CD" | "CF" | "CG" | "CH" | "CI" | "CK" | "CL" | "CM" | "CN" | "CO" | "CR" | "CV" | "CW" | "CY" | "CZ" | "DE" | "DJ" | "DK" | "DM" | "DO" | "DZ" | "EC" | "EE" | "EG" | "EH" | "ER" | "ES" | "ET" | "FI" | "FJ" | "FK" | "FO" | "FR" | "GA" | "GB" | "GD" | "GE" | "GF" | "GG" | "GH" | "GI" | "GL" | "GM" | "GN" | "GP" | "GQ" | "GR" | "GS" | "GT" | "GU" | "GW" | "GY" | "HK" | "HN" | "HR" | "HT" | "HU" | "ID" | "IE" | "IL" | "IM" | "IN" | "IO" | "IQ" | "IS" | "IT" | "JE" | "JM" | "JO" | "JP" | "KE" | "KG" | "KH" | "KI" | "KM" | "KN" | "KR" | "KW" | "KY" | "KZ" | "LA" | "LB" | "LC" | "LI" | "LK" | "LR" | "LS" | "LT" | "LU" | "LV" | "LY" | "MA" | "MC" | "MD" | "ME" | "MF" | "MG" | "MK" | "ML" | "MM" | "MN" | "MO" | "MQ" | "MR" | "MS" | "MT" | "MU" | "MV" | "MW" | "MX" | "MY" | "MZ" | "NA" | "NC" | "NE" | "NG" | "NI" | "NL" | "NO" | "NP" | "NR" | "NU" | "NZ" | "OM" | "PA" | "PE" | "PF" | "PG" | "PH" | "PK" | "PL" | "PM" | "PN" | "PR" | "PS" | "PT" | "PY" | "QA" | "RE" | "RO" | "RS" | "RU" | "RW" | "SA" | "SB" | "SC" | "SE" | "SG" | "SH" | "SI" | "SJ" | "SK" | "SL" | "SM" | "SN" | "SO" | "SR" | "SS" | "ST" | "SV" | "SX" | "SZ" | "TA" | "TC" | "TD" | "TF" | "TG" | "TH" | "TJ" | "TK" | "TL" | "TM" | "TN" | "TO" | "TR" | "TT" | "TV" | "TW" | "TZ" | "UA" | "UG" | "US" | "UY" | "UZ" | "VA" | "VC" | "VE" | "VG" | "VN" | "VU" | "WF" | "WS" | "XK" | "YE" | "YT" | "ZA" | "ZM" | "ZW" | "ZZ")[]; @@ -38735,9 +44405,25 @@ export interface operations { * @description When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`. */ subscription_data?: { + /** subscription_data_invoice_settings_params */ + invoice_settings?: { + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + }; metadata?: { [key: string]: string | undefined; } | ""; + trial_settings?: { + /** end_behavior */ + end_behavior: { + /** @enum {string} */ + missing_payment_method: "cancel" | "create_invoice" | "pause"; + }; + } | ""; }; }; }; @@ -38824,8 +44510,14 @@ export interface operations { query?: { /** @description The Connect application to filter by. */ application?: string | ""; + /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + ending_before?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @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; }; header?: never; path?: never; @@ -38922,6 +44614,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon. + */ + amazon_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** * payment_method_param * @description Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. @@ -39032,6 +44735,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details. + */ + customer_balance?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** * payment_method_param * @description EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details. @@ -39144,6 +44858,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details. + */ + mobilepay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** @description Configuration name. */ name?: string; /** @@ -39203,6 +44928,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase. + */ + revolut_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** * payment_method_param * @description The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. @@ -39225,6 +44961,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details. + */ + swish?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** * payment_method_param * @description Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details. @@ -39247,6 +44994,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability. + */ + zip?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; }; }; }; @@ -39367,6 +45125,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Amazon Pay is a wallet payment method that lets your customers check out the same way as on Amazon. + */ + amazon_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** * payment_method_param * @description Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details. @@ -39477,6 +45246,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Uses a customer’s [cash balance](https://stripe.com/docs/payments/customer-balance) for the payment. The cash balance can be funded via a bank transfer. Check this [page](https://stripe.com/docs/payments/bank-transfers) for more details. + */ + customer_balance?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** * payment_method_param * @description EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details. @@ -39589,6 +45369,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description MobilePay is a [single-use](https://stripe.com/docs/payments/payment-methods#usage) card wallet payment method used in Denmark and Finland. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the MobilePay app. Check this [page](https://stripe.com/docs/payments/mobilepay) for more details. + */ + mobilepay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** @description Configuration name. */ name?: string; /** @@ -39646,6 +45437,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase. + */ + revolut_pay?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** * payment_method_param * @description The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details. @@ -39668,6 +45470,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Swish is a [real-time](https://stripe.com/docs/payments/real-time) payment method popular in Sweden. It allows customers to [authenticate and approve](https://stripe.com/docs/payments/payment-methods#customer-actions) payments using the Swish mobile app and the Swedish BankID mobile app. Check this [page](https://stripe.com/docs/payments/swish) for more details. + */ + swish?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; /** * payment_method_param * @description Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details. @@ -39690,6 +45503,17 @@ export interface operations { preference?: "none" | "off" | "on"; }; }; + /** + * payment_method_param + * @description Zip gives your customers a way to split purchases over a series of payments. Check this [page](https://stripe.com/docs/payments/zip) for more details like country availability. + */ + zip?: { + /** display_preference_param */ + display_preference?: { + /** @enum {string} */ + preference?: "none" | "off" | "on"; + }; + }; }; }; }; @@ -39941,7 +45765,7 @@ export interface operations { /** @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 An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request. */ - type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay" | "zip"; }; header?: never; path?: never; @@ -40018,6 +45842,16 @@ export interface operations { * @description If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method. */ alipay?: Record; + /** + * @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} + */ + allow_redisplay?: "always" | "limited" | "unspecified"; + /** + * param + * @description If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method. + */ + amazon_pay?: Record; /** * param * @description If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account. @@ -40073,6 +45907,11 @@ export interface operations { cvc?: string; exp_month: number; exp_year: number; + /** networks_params */ + networks?: { + /** @enum {string} */ + preferred?: "cartes_bancaires" | "mastercard" | "visa"; + }; number: string; } | { token: string; @@ -40123,7 +45962,7 @@ export interface operations { */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** * param @@ -40156,6 +45995,11 @@ export interface operations { metadata?: { [key: string]: string | undefined; }; + /** + * param + * @description If this is a `mobilepay` PaymentMethod, this hash contains details about the MobilePay payment method. + */ + mobilepay?: Record; /** * param * @description If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method. @@ -40167,7 +46011,7 @@ export interface operations { */ p24?: { /** @enum {string} */ - bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "volkswagen_bank"; + bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** @description The PaymentMethod to share. */ payment_method?: string; @@ -40192,7 +46036,7 @@ export interface operations { */ promptpay?: Record; /** - * radar_options + * radar_options_with_hidden_options * @description Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information. */ radar_options?: { @@ -40218,11 +46062,16 @@ export interface operations { /** @enum {string} */ country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; }; + /** + * param + * @description If this is a `swish` PaymentMethod, this hash contains details about the Swish payment method. + */ + swish?: Record; /** * @description The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type. * @enum {string} */ - type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type?: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay" | "zip"; /** * payment_method_param * @description If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method. @@ -40320,6 +46169,11 @@ export interface operations { requestBody?: { content: { "application/x-www-form-urlencoded": { + /** + * @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} + */ + allow_redisplay?: "always" | "limited" | "unspecified"; /** * billing_details_inner_params * @description Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods. @@ -40344,6 +46198,11 @@ export interface operations { card?: { exp_month?: number; exp_year?: number; + /** networks_update_api_param */ + networks?: { + /** @enum {string} */ + preferred?: "" | "cartes_bancaires" | "mastercard" | "visa"; + }; }; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -40363,6 +46222,8 @@ export interface operations { us_bank_account?: { /** @enum {string} */ account_holder_type?: "company" | "individual"; + /** @enum {string} */ + account_type?: "checking" | "savings"; }; }; }; @@ -40469,12 +46330,14 @@ export interface operations { GetPayouts: { parameters: { query?: { + /** @description Only return payouts that are expected to arrive during the given date interval. */ arrival_date?: { gt?: number; gte?: number; lt?: number; lte?: number; } | number; + /** @description Only return payouts that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -40860,12 +46723,14 @@ export interface operations { * @enum {string} */ interval: "day" | "month" | "week" | "year"; - /** @description The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). */ + /** @description The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks). */ interval_count?: number; /** @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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { [key: string]: string | undefined; } | ""; + /** @description The meter tracking the usage of a metered price */ + meter?: string; /** @description A brief description of the plan, hidden from customers. */ nickname?: string; product?: { @@ -41085,6 +46950,7 @@ export interface operations { recurring?: { /** @enum {string} */ interval?: "day" | "month" | "week" | "year"; + meter?: string; /** @enum {string} */ usage_type?: "licensed" | "metered"; }; @@ -41227,6 +47093,7 @@ export interface operations { /** @enum {string} */ interval: "day" | "month" | "week" | "year"; interval_count?: number; + meter?: string; /** @enum {string} */ usage_type?: "licensed" | "metered"; }; @@ -41261,7 +47128,7 @@ export interface operations { /** @enum {string} */ round: "down" | "up"; }; - /** @description A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount` or `custom_unit_amount` is required, unless `billing_scheme=tiered`. */ + /** @description A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required, unless `billing_scheme=tiered`. */ unit_amount?: number; /** * Format: decimal @@ -41593,14 +47460,14 @@ export interface operations { description?: string; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). */ - features?: { - name: string; - }[]; /** @description An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. */ id?: string; /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ images?: string[]; + /** @description A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). */ + marketing_features?: { + name: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { [key: string]: string | undefined; @@ -41766,12 +47633,12 @@ export interface operations { description?: string | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). */ - features?: { - name: string; - }[] | ""; /** @description A list of up to 8 URLs of images for this product, meant to be displayable to the customer. */ images?: string[] | ""; + /** @description A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). */ + marketing_features?: { + name: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ metadata?: { [key: string]: string | undefined; @@ -41857,6 +47724,178 @@ export interface operations { }; }; }; + GetProductsProductFeatures: { + parameters: { + query?: { + /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @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; + }; + header?: never; + path: { + product: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + data: components["schemas"]["product_feature"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostProductsProductFeatures: { + parameters: { + query?: never; + header?: never; + path: { + product: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description The ID of the [Feature](https://stripe.com/docs/api/entitlements/feature) object attached to this product. */ + entitlement_feature: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["product_feature"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetProductsProductFeaturesId: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + /** @description The ID of the product_feature. */ + id: string; + /** @description The ID of the product. */ + product: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["product_feature"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + DeleteProductsProductFeaturesId: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + product: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["deleted_product_feature"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetPromotionCodes: { parameters: { query?: { @@ -42166,6 +48205,12 @@ export interface operations { */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. @@ -42182,6 +48227,7 @@ export interface operations { discounts?: { coupon?: string; discount?: string; + promotion_code?: string; }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -42208,9 +48254,20 @@ export interface operations { */ invoice_settings?: { days_until_due?: number; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** @description A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. */ line_items?: { + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; price?: string; /** price_data */ price_data?: { @@ -42341,6 +48398,12 @@ export interface operations { */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** * @description Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`. @@ -42357,6 +48420,7 @@ export interface operations { discounts?: { coupon?: string; discount?: string; + promotion_code?: string; }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; @@ -42375,9 +48439,20 @@ export interface operations { */ invoice_settings?: { days_until_due?: number; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** @description A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost. */ line_items?: { + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; id?: string; price?: string; /** price_data */ @@ -42721,6 +48796,13 @@ export interface operations { query?: { /** @description Only return early fraud warnings for the charge specified by this charge ID. */ charge?: string; + /** @description Only return early fraud warnings that were created during the given date interval. */ + created?: { + gt?: number; + gte?: number; + lt?: number; + lte?: number; + } | number; /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ ending_before?: string; /** @description Specifies which fields in the response should be expanded. */ @@ -42814,6 +48896,7 @@ export interface operations { GetRadarValueListItems: { parameters: { query: { + /** @description Only return items that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -42994,6 +49077,7 @@ export interface operations { alias?: string; /** @description A value contained within a value list - returns all value lists containing this value. */ contains?: string; + /** @description Only return value lists that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -43223,6 +49307,7 @@ export interface operations { query?: { /** @description Only return refunds for the charge specified by this charge ID. */ charge?: string; + /** @description Only return refunds that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -43467,6 +49552,7 @@ export interface operations { GetReportingReportRuns: { parameters: { query?: { + /** @description Only return Report Runs that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -43549,7 +49635,7 @@ export interface operations { interval_start?: number; payout?: string; /** @enum {string} */ - reporting_category?: "advance" | "advance_funding" | "anticipation_repayment" | "charge" | "charge_failure" | "connect_collection_transfer" | "connect_reserved_funds" | "contribution" | "dispute" | "dispute_reversal" | "fee" | "financing_paydown" | "financing_paydown_reversal" | "financing_payout" | "financing_payout_reversal" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "network_cost" | "obligation" | "other_adjustment" | "partial_capture_reversal" | "payout" | "payout_reversal" | "platform_earning" | "platform_earning_refund" | "refund" | "refund_failure" | "risk_reserved_funds" | "tax" | "topup" | "topup_reversal" | "transfer" | "transfer_reversal" | "unreconciled_customer_funds"; + reporting_category?: "advance" | "advance_funding" | "anticipation_repayment" | "charge" | "charge_failure" | "climate_order_purchase" | "climate_order_refund" | "connect_collection_transfer" | "connect_reserved_funds" | "contribution" | "dispute" | "dispute_reversal" | "fee" | "financing_paydown" | "financing_paydown_reversal" | "financing_payout" | "financing_payout_reversal" | "issuing_authorization_hold" | "issuing_authorization_release" | "issuing_dispute" | "issuing_transaction" | "network_cost" | "other_adjustment" | "partial_capture_reversal" | "payout" | "payout_reversal" | "platform_earning" | "platform_earning_refund" | "refund" | "refund_failure" | "risk_reserved_funds" | "tax" | "topup" | "topup_reversal" | "transfer" | "transfer_reversal" | "unreconciled_customer_funds"; /** @enum {string} */ timezone?: "Africa/Abidjan" | "Africa/Accra" | "Africa/Addis_Ababa" | "Africa/Algiers" | "Africa/Asmara" | "Africa/Asmera" | "Africa/Bamako" | "Africa/Bangui" | "Africa/Banjul" | "Africa/Bissau" | "Africa/Blantyre" | "Africa/Brazzaville" | "Africa/Bujumbura" | "Africa/Cairo" | "Africa/Casablanca" | "Africa/Ceuta" | "Africa/Conakry" | "Africa/Dakar" | "Africa/Dar_es_Salaam" | "Africa/Djibouti" | "Africa/Douala" | "Africa/El_Aaiun" | "Africa/Freetown" | "Africa/Gaborone" | "Africa/Harare" | "Africa/Johannesburg" | "Africa/Juba" | "Africa/Kampala" | "Africa/Khartoum" | "Africa/Kigali" | "Africa/Kinshasa" | "Africa/Lagos" | "Africa/Libreville" | "Africa/Lome" | "Africa/Luanda" | "Africa/Lubumbashi" | "Africa/Lusaka" | "Africa/Malabo" | "Africa/Maputo" | "Africa/Maseru" | "Africa/Mbabane" | "Africa/Mogadishu" | "Africa/Monrovia" | "Africa/Nairobi" | "Africa/Ndjamena" | "Africa/Niamey" | "Africa/Nouakchott" | "Africa/Ouagadougou" | "Africa/Porto-Novo" | "Africa/Sao_Tome" | "Africa/Timbuktu" | "Africa/Tripoli" | "Africa/Tunis" | "Africa/Windhoek" | "America/Adak" | "America/Anchorage" | "America/Anguilla" | "America/Antigua" | "America/Araguaina" | "America/Argentina/Buenos_Aires" | "America/Argentina/Catamarca" | "America/Argentina/ComodRivadavia" | "America/Argentina/Cordoba" | "America/Argentina/Jujuy" | "America/Argentina/La_Rioja" | "America/Argentina/Mendoza" | "America/Argentina/Rio_Gallegos" | "America/Argentina/Salta" | "America/Argentina/San_Juan" | "America/Argentina/San_Luis" | "America/Argentina/Tucuman" | "America/Argentina/Ushuaia" | "America/Aruba" | "America/Asuncion" | "America/Atikokan" | "America/Atka" | "America/Bahia" | "America/Bahia_Banderas" | "America/Barbados" | "America/Belem" | "America/Belize" | "America/Blanc-Sablon" | "America/Boa_Vista" | "America/Bogota" | "America/Boise" | "America/Buenos_Aires" | "America/Cambridge_Bay" | "America/Campo_Grande" | "America/Cancun" | "America/Caracas" | "America/Catamarca" | "America/Cayenne" | "America/Cayman" | "America/Chicago" | "America/Chihuahua" | "America/Ciudad_Juarez" | "America/Coral_Harbour" | "America/Cordoba" | "America/Costa_Rica" | "America/Creston" | "America/Cuiaba" | "America/Curacao" | "America/Danmarkshavn" | "America/Dawson" | "America/Dawson_Creek" | "America/Denver" | "America/Detroit" | "America/Dominica" | "America/Edmonton" | "America/Eirunepe" | "America/El_Salvador" | "America/Ensenada" | "America/Fort_Nelson" | "America/Fort_Wayne" | "America/Fortaleza" | "America/Glace_Bay" | "America/Godthab" | "America/Goose_Bay" | "America/Grand_Turk" | "America/Grenada" | "America/Guadeloupe" | "America/Guatemala" | "America/Guayaquil" | "America/Guyana" | "America/Halifax" | "America/Havana" | "America/Hermosillo" | "America/Indiana/Indianapolis" | "America/Indiana/Knox" | "America/Indiana/Marengo" | "America/Indiana/Petersburg" | "America/Indiana/Tell_City" | "America/Indiana/Vevay" | "America/Indiana/Vincennes" | "America/Indiana/Winamac" | "America/Indianapolis" | "America/Inuvik" | "America/Iqaluit" | "America/Jamaica" | "America/Jujuy" | "America/Juneau" | "America/Kentucky/Louisville" | "America/Kentucky/Monticello" | "America/Knox_IN" | "America/Kralendijk" | "America/La_Paz" | "America/Lima" | "America/Los_Angeles" | "America/Louisville" | "America/Lower_Princes" | "America/Maceio" | "America/Managua" | "America/Manaus" | "America/Marigot" | "America/Martinique" | "America/Matamoros" | "America/Mazatlan" | "America/Mendoza" | "America/Menominee" | "America/Merida" | "America/Metlakatla" | "America/Mexico_City" | "America/Miquelon" | "America/Moncton" | "America/Monterrey" | "America/Montevideo" | "America/Montreal" | "America/Montserrat" | "America/Nassau" | "America/New_York" | "America/Nipigon" | "America/Nome" | "America/Noronha" | "America/North_Dakota/Beulah" | "America/North_Dakota/Center" | "America/North_Dakota/New_Salem" | "America/Nuuk" | "America/Ojinaga" | "America/Panama" | "America/Pangnirtung" | "America/Paramaribo" | "America/Phoenix" | "America/Port-au-Prince" | "America/Port_of_Spain" | "America/Porto_Acre" | "America/Porto_Velho" | "America/Puerto_Rico" | "America/Punta_Arenas" | "America/Rainy_River" | "America/Rankin_Inlet" | "America/Recife" | "America/Regina" | "America/Resolute" | "America/Rio_Branco" | "America/Rosario" | "America/Santa_Isabel" | "America/Santarem" | "America/Santiago" | "America/Santo_Domingo" | "America/Sao_Paulo" | "America/Scoresbysund" | "America/Shiprock" | "America/Sitka" | "America/St_Barthelemy" | "America/St_Johns" | "America/St_Kitts" | "America/St_Lucia" | "America/St_Thomas" | "America/St_Vincent" | "America/Swift_Current" | "America/Tegucigalpa" | "America/Thule" | "America/Thunder_Bay" | "America/Tijuana" | "America/Toronto" | "America/Tortola" | "America/Vancouver" | "America/Virgin" | "America/Whitehorse" | "America/Winnipeg" | "America/Yakutat" | "America/Yellowknife" | "Antarctica/Casey" | "Antarctica/Davis" | "Antarctica/DumontDUrville" | "Antarctica/Macquarie" | "Antarctica/Mawson" | "Antarctica/McMurdo" | "Antarctica/Palmer" | "Antarctica/Rothera" | "Antarctica/South_Pole" | "Antarctica/Syowa" | "Antarctica/Troll" | "Antarctica/Vostok" | "Arctic/Longyearbyen" | "Asia/Aden" | "Asia/Almaty" | "Asia/Amman" | "Asia/Anadyr" | "Asia/Aqtau" | "Asia/Aqtobe" | "Asia/Ashgabat" | "Asia/Ashkhabad" | "Asia/Atyrau" | "Asia/Baghdad" | "Asia/Bahrain" | "Asia/Baku" | "Asia/Bangkok" | "Asia/Barnaul" | "Asia/Beirut" | "Asia/Bishkek" | "Asia/Brunei" | "Asia/Calcutta" | "Asia/Chita" | "Asia/Choibalsan" | "Asia/Chongqing" | "Asia/Chungking" | "Asia/Colombo" | "Asia/Dacca" | "Asia/Damascus" | "Asia/Dhaka" | "Asia/Dili" | "Asia/Dubai" | "Asia/Dushanbe" | "Asia/Famagusta" | "Asia/Gaza" | "Asia/Harbin" | "Asia/Hebron" | "Asia/Ho_Chi_Minh" | "Asia/Hong_Kong" | "Asia/Hovd" | "Asia/Irkutsk" | "Asia/Istanbul" | "Asia/Jakarta" | "Asia/Jayapura" | "Asia/Jerusalem" | "Asia/Kabul" | "Asia/Kamchatka" | "Asia/Karachi" | "Asia/Kashgar" | "Asia/Kathmandu" | "Asia/Katmandu" | "Asia/Khandyga" | "Asia/Kolkata" | "Asia/Krasnoyarsk" | "Asia/Kuala_Lumpur" | "Asia/Kuching" | "Asia/Kuwait" | "Asia/Macao" | "Asia/Macau" | "Asia/Magadan" | "Asia/Makassar" | "Asia/Manila" | "Asia/Muscat" | "Asia/Nicosia" | "Asia/Novokuznetsk" | "Asia/Novosibirsk" | "Asia/Omsk" | "Asia/Oral" | "Asia/Phnom_Penh" | "Asia/Pontianak" | "Asia/Pyongyang" | "Asia/Qatar" | "Asia/Qostanay" | "Asia/Qyzylorda" | "Asia/Rangoon" | "Asia/Riyadh" | "Asia/Saigon" | "Asia/Sakhalin" | "Asia/Samarkand" | "Asia/Seoul" | "Asia/Shanghai" | "Asia/Singapore" | "Asia/Srednekolymsk" | "Asia/Taipei" | "Asia/Tashkent" | "Asia/Tbilisi" | "Asia/Tehran" | "Asia/Tel_Aviv" | "Asia/Thimbu" | "Asia/Thimphu" | "Asia/Tokyo" | "Asia/Tomsk" | "Asia/Ujung_Pandang" | "Asia/Ulaanbaatar" | "Asia/Ulan_Bator" | "Asia/Urumqi" | "Asia/Ust-Nera" | "Asia/Vientiane" | "Asia/Vladivostok" | "Asia/Yakutsk" | "Asia/Yangon" | "Asia/Yekaterinburg" | "Asia/Yerevan" | "Atlantic/Azores" | "Atlantic/Bermuda" | "Atlantic/Canary" | "Atlantic/Cape_Verde" | "Atlantic/Faeroe" | "Atlantic/Faroe" | "Atlantic/Jan_Mayen" | "Atlantic/Madeira" | "Atlantic/Reykjavik" | "Atlantic/South_Georgia" | "Atlantic/St_Helena" | "Atlantic/Stanley" | "Australia/ACT" | "Australia/Adelaide" | "Australia/Brisbane" | "Australia/Broken_Hill" | "Australia/Canberra" | "Australia/Currie" | "Australia/Darwin" | "Australia/Eucla" | "Australia/Hobart" | "Australia/LHI" | "Australia/Lindeman" | "Australia/Lord_Howe" | "Australia/Melbourne" | "Australia/NSW" | "Australia/North" | "Australia/Perth" | "Australia/Queensland" | "Australia/South" | "Australia/Sydney" | "Australia/Tasmania" | "Australia/Victoria" | "Australia/West" | "Australia/Yancowinna" | "Brazil/Acre" | "Brazil/DeNoronha" | "Brazil/East" | "Brazil/West" | "CET" | "CST6CDT" | "Canada/Atlantic" | "Canada/Central" | "Canada/Eastern" | "Canada/Mountain" | "Canada/Newfoundland" | "Canada/Pacific" | "Canada/Saskatchewan" | "Canada/Yukon" | "Chile/Continental" | "Chile/EasterIsland" | "Cuba" | "EET" | "EST" | "EST5EDT" | "Egypt" | "Eire" | "Etc/GMT" | "Etc/GMT+0" | "Etc/GMT+1" | "Etc/GMT+10" | "Etc/GMT+11" | "Etc/GMT+12" | "Etc/GMT+2" | "Etc/GMT+3" | "Etc/GMT+4" | "Etc/GMT+5" | "Etc/GMT+6" | "Etc/GMT+7" | "Etc/GMT+8" | "Etc/GMT+9" | "Etc/GMT-0" | "Etc/GMT-1" | "Etc/GMT-10" | "Etc/GMT-11" | "Etc/GMT-12" | "Etc/GMT-13" | "Etc/GMT-14" | "Etc/GMT-2" | "Etc/GMT-3" | "Etc/GMT-4" | "Etc/GMT-5" | "Etc/GMT-6" | "Etc/GMT-7" | "Etc/GMT-8" | "Etc/GMT-9" | "Etc/GMT0" | "Etc/Greenwich" | "Etc/UCT" | "Etc/UTC" | "Etc/Universal" | "Etc/Zulu" | "Europe/Amsterdam" | "Europe/Andorra" | "Europe/Astrakhan" | "Europe/Athens" | "Europe/Belfast" | "Europe/Belgrade" | "Europe/Berlin" | "Europe/Bratislava" | "Europe/Brussels" | "Europe/Bucharest" | "Europe/Budapest" | "Europe/Busingen" | "Europe/Chisinau" | "Europe/Copenhagen" | "Europe/Dublin" | "Europe/Gibraltar" | "Europe/Guernsey" | "Europe/Helsinki" | "Europe/Isle_of_Man" | "Europe/Istanbul" | "Europe/Jersey" | "Europe/Kaliningrad" | "Europe/Kiev" | "Europe/Kirov" | "Europe/Kyiv" | "Europe/Lisbon" | "Europe/Ljubljana" | "Europe/London" | "Europe/Luxembourg" | "Europe/Madrid" | "Europe/Malta" | "Europe/Mariehamn" | "Europe/Minsk" | "Europe/Monaco" | "Europe/Moscow" | "Europe/Nicosia" | "Europe/Oslo" | "Europe/Paris" | "Europe/Podgorica" | "Europe/Prague" | "Europe/Riga" | "Europe/Rome" | "Europe/Samara" | "Europe/San_Marino" | "Europe/Sarajevo" | "Europe/Saratov" | "Europe/Simferopol" | "Europe/Skopje" | "Europe/Sofia" | "Europe/Stockholm" | "Europe/Tallinn" | "Europe/Tirane" | "Europe/Tiraspol" | "Europe/Ulyanovsk" | "Europe/Uzhgorod" | "Europe/Vaduz" | "Europe/Vatican" | "Europe/Vienna" | "Europe/Vilnius" | "Europe/Volgograd" | "Europe/Warsaw" | "Europe/Zagreb" | "Europe/Zaporozhye" | "Europe/Zurich" | "Factory" | "GB" | "GB-Eire" | "GMT" | "GMT+0" | "GMT-0" | "GMT0" | "Greenwich" | "HST" | "Hongkong" | "Iceland" | "Indian/Antananarivo" | "Indian/Chagos" | "Indian/Christmas" | "Indian/Cocos" | "Indian/Comoro" | "Indian/Kerguelen" | "Indian/Mahe" | "Indian/Maldives" | "Indian/Mauritius" | "Indian/Mayotte" | "Indian/Reunion" | "Iran" | "Israel" | "Jamaica" | "Japan" | "Kwajalein" | "Libya" | "MET" | "MST" | "MST7MDT" | "Mexico/BajaNorte" | "Mexico/BajaSur" | "Mexico/General" | "NZ" | "NZ-CHAT" | "Navajo" | "PRC" | "PST8PDT" | "Pacific/Apia" | "Pacific/Auckland" | "Pacific/Bougainville" | "Pacific/Chatham" | "Pacific/Chuuk" | "Pacific/Easter" | "Pacific/Efate" | "Pacific/Enderbury" | "Pacific/Fakaofo" | "Pacific/Fiji" | "Pacific/Funafuti" | "Pacific/Galapagos" | "Pacific/Gambier" | "Pacific/Guadalcanal" | "Pacific/Guam" | "Pacific/Honolulu" | "Pacific/Johnston" | "Pacific/Kanton" | "Pacific/Kiritimati" | "Pacific/Kosrae" | "Pacific/Kwajalein" | "Pacific/Majuro" | "Pacific/Marquesas" | "Pacific/Midway" | "Pacific/Nauru" | "Pacific/Niue" | "Pacific/Norfolk" | "Pacific/Noumea" | "Pacific/Pago_Pago" | "Pacific/Palau" | "Pacific/Pitcairn" | "Pacific/Pohnpei" | "Pacific/Ponape" | "Pacific/Port_Moresby" | "Pacific/Rarotonga" | "Pacific/Saipan" | "Pacific/Samoa" | "Pacific/Tahiti" | "Pacific/Tarawa" | "Pacific/Tongatapu" | "Pacific/Truk" | "Pacific/Wake" | "Pacific/Wallis" | "Pacific/Yap" | "Poland" | "Portugal" | "ROC" | "ROK" | "Singapore" | "Turkey" | "UCT" | "US/Alaska" | "US/Aleutian" | "US/Arizona" | "US/Central" | "US/East-Indiana" | "US/Eastern" | "US/Hawaii" | "US/Indiana-Starke" | "US/Michigan" | "US/Mountain" | "US/Pacific" | "US/Pacific-New" | "US/Samoa" | "UTC" | "Universal" | "W-SU" | "WET" | "Zulu"; }; @@ -43705,6 +49791,7 @@ export interface operations { GetReviews: { parameters: { query?: { + /** @description Only return reviews that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -43995,6 +50082,10 @@ export interface operations { }; /** @description Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary. */ confirm?: boolean; + /** @description ID of the ConfirmationToken used to confirm this SetupIntent. + * + * 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 ID of the Customer this SetupIntent belongs to, if one exists. * * If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent. */ @@ -44052,6 +50143,10 @@ export interface operations { afterpay_clearpay?: Record; /** param */ alipay?: Record; + /** @enum {string} */ + allow_redisplay?: "always" | "limited" | "unspecified"; + /** param */ + amazon_pay?: Record; /** param */ au_becs_debit?: { account_number: string; @@ -44105,7 +50200,7 @@ export interface operations { /** param */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** param */ interac_present?: Record; @@ -44126,11 +50221,13 @@ export interface operations { [key: string]: string | undefined; }; /** param */ + mobilepay?: Record; + /** param */ oxxo?: Record; /** param */ p24?: { /** @enum {string} */ - bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "volkswagen_bank"; + bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ paynow?: Record; @@ -44140,7 +50237,7 @@ export interface operations { pix?: Record; /** param */ promptpay?: Record; - /** radar_options */ + /** radar_options_with_hidden_options */ radar_options?: { session?: string; }; @@ -44155,8 +50252,10 @@ export interface operations { /** @enum {string} */ country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; }; + /** param */ + swish?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -44194,6 +50293,8 @@ export interface operations { /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; }; + /** setup_intent_payment_method_options_param */ + amazon_pay?: Record; /** setup_intent_param */ card?: { /** setup_intent_mandate_options_param */ @@ -44216,9 +50317,33 @@ export interface operations { /** @enum {string} */ network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: "any" | "automatic" | "challenge"; + /** setup_intent_payment_method_options_param */ + three_d_secure?: { + /** @enum {string} */ + ares_trans_status?: "A" | "C" | "I" | "N" | "R" | "U" | "Y"; + cryptogram?: string; + /** @enum {string} */ + electronic_commerce_indicator?: "01" | "02" | "05" | "06" | "07"; + /** network_options_param */ + network_options?: { + /** cartes_bancaires_network_options_param */ + cartes_bancaires?: { + /** @enum {string} */ + cb_avalgo: "0" | "1" | "2" | "3" | "4" | "A"; + cb_exemption?: string; + cb_score?: number; + }; + }; + requestor_challenge_indicator?: string; + transaction_id?: string; + /** @enum {string} */ + version?: "1.0.2" | "2.1.0" | "2.2.0"; + }; }; /** setup_intent_payment_method_options_param */ + card_present?: Record; + /** setup_intent_payment_method_options_param */ link?: Record; /** payment_method_options_param */ paypal?: { @@ -44234,9 +50359,14 @@ export interface operations { /** linked_account_options_param */ financial_connections?: { permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - prefetch?: "balances"[]; + prefetch?: ("balances" | "ownership" | "transactions")[]; return_url?: string; }; + /** mandate_options_param */ + mandate_options?: { + /** @enum {string} */ + collection_method?: "" | "paper"; + }; /** networks_options_param */ networks?: { requested?: ("ach" | "us_domestic_wire")[]; @@ -44382,6 +50512,10 @@ export interface operations { afterpay_clearpay?: Record; /** param */ alipay?: Record; + /** @enum {string} */ + allow_redisplay?: "always" | "limited" | "unspecified"; + /** param */ + amazon_pay?: Record; /** param */ au_becs_debit?: { account_number: string; @@ -44435,7 +50569,7 @@ export interface operations { /** param */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** param */ interac_present?: Record; @@ -44456,11 +50590,13 @@ export interface operations { [key: string]: string | undefined; }; /** param */ + mobilepay?: Record; + /** param */ oxxo?: Record; /** param */ p24?: { /** @enum {string} */ - bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "volkswagen_bank"; + bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ paynow?: Record; @@ -44470,7 +50606,7 @@ export interface operations { pix?: Record; /** param */ promptpay?: Record; - /** radar_options */ + /** radar_options_with_hidden_options */ radar_options?: { session?: string; }; @@ -44485,8 +50621,10 @@ export interface operations { /** @enum {string} */ country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; }; + /** param */ + swish?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -44524,6 +50662,8 @@ export interface operations { /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; }; + /** setup_intent_payment_method_options_param */ + amazon_pay?: Record; /** setup_intent_param */ card?: { /** setup_intent_mandate_options_param */ @@ -44546,9 +50686,33 @@ export interface operations { /** @enum {string} */ network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: "any" | "automatic" | "challenge"; + /** setup_intent_payment_method_options_param */ + three_d_secure?: { + /** @enum {string} */ + ares_trans_status?: "A" | "C" | "I" | "N" | "R" | "U" | "Y"; + cryptogram?: string; + /** @enum {string} */ + electronic_commerce_indicator?: "01" | "02" | "05" | "06" | "07"; + /** network_options_param */ + network_options?: { + /** cartes_bancaires_network_options_param */ + cartes_bancaires?: { + /** @enum {string} */ + cb_avalgo: "0" | "1" | "2" | "3" | "4" | "A"; + cb_exemption?: string; + cb_score?: number; + }; + }; + requestor_challenge_indicator?: string; + transaction_id?: string; + /** @enum {string} */ + version?: "1.0.2" | "2.1.0" | "2.2.0"; + }; }; /** setup_intent_payment_method_options_param */ + card_present?: Record; + /** setup_intent_payment_method_options_param */ link?: Record; /** payment_method_options_param */ paypal?: { @@ -44564,9 +50728,14 @@ export interface operations { /** linked_account_options_param */ financial_connections?: { permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - prefetch?: "balances"[]; + prefetch?: ("balances" | "ownership" | "transactions")[]; return_url?: string; }; + /** mandate_options_param */ + mandate_options?: { + /** @enum {string} */ + collection_method?: "" | "paper"; + }; /** networks_options_param */ networks?: { requested?: ("ach" | "us_domestic_wire")[]; @@ -44658,6 +50827,10 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description The client secret of the SetupIntent. */ client_secret?: string; + /** @description ID of the ConfirmationToken used to confirm this SetupIntent. + * + * 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 Specifies which fields in the response should be expanded. */ expand?: string[]; mandate_data?: { @@ -44707,6 +50880,10 @@ export interface operations { afterpay_clearpay?: Record; /** param */ alipay?: Record; + /** @enum {string} */ + allow_redisplay?: "always" | "limited" | "unspecified"; + /** param */ + amazon_pay?: Record; /** param */ au_becs_debit?: { account_number: string; @@ -44760,7 +50937,7 @@ export interface operations { /** param */ ideal?: { /** @enum {string} */ - bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; }; /** param */ interac_present?: Record; @@ -44781,11 +50958,13 @@ export interface operations { [key: string]: string | undefined; }; /** param */ + mobilepay?: Record; + /** param */ oxxo?: Record; /** param */ p24?: { /** @enum {string} */ - bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "volkswagen_bank"; + bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; }; /** param */ paynow?: Record; @@ -44795,7 +50974,7 @@ export interface operations { pix?: Record; /** param */ promptpay?: Record; - /** radar_options */ + /** radar_options_with_hidden_options */ radar_options?: { session?: string; }; @@ -44810,8 +50989,10 @@ export interface operations { /** @enum {string} */ country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; }; + /** param */ + swish?: Record; /** @enum {string} */ - type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay" | "zip"; + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay" | "zip"; /** payment_method_param */ us_bank_account?: { /** @enum {string} */ @@ -44849,6 +51030,8 @@ export interface operations { /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; }; + /** setup_intent_payment_method_options_param */ + amazon_pay?: Record; /** setup_intent_param */ card?: { /** setup_intent_mandate_options_param */ @@ -44871,9 +51054,33 @@ export interface operations { /** @enum {string} */ network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: "any" | "automatic" | "challenge"; + /** setup_intent_payment_method_options_param */ + three_d_secure?: { + /** @enum {string} */ + ares_trans_status?: "A" | "C" | "I" | "N" | "R" | "U" | "Y"; + cryptogram?: string; + /** @enum {string} */ + electronic_commerce_indicator?: "01" | "02" | "05" | "06" | "07"; + /** network_options_param */ + network_options?: { + /** cartes_bancaires_network_options_param */ + cartes_bancaires?: { + /** @enum {string} */ + cb_avalgo: "0" | "1" | "2" | "3" | "4" | "A"; + cb_exemption?: string; + cb_score?: number; + }; + }; + requestor_challenge_indicator?: string; + transaction_id?: string; + /** @enum {string} */ + version?: "1.0.2" | "2.1.0" | "2.2.0"; + }; }; /** setup_intent_payment_method_options_param */ + card_present?: Record; + /** setup_intent_payment_method_options_param */ link?: Record; /** payment_method_options_param */ paypal?: { @@ -44889,9 +51096,14 @@ export interface operations { /** linked_account_options_param */ financial_connections?: { permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - prefetch?: "balances"[]; + prefetch?: ("balances" | "ownership" | "transactions")[]; return_url?: string; }; + /** mandate_options_param */ + mandate_options?: { + /** @enum {string} */ + collection_method?: "" | "paper"; + }; /** networks_options_param */ networks?: { requested?: ("ach" | "us_domestic_wire")[]; @@ -45883,6 +52095,12 @@ export interface operations { billing_thresholds?: { usage_gte: number; } | ""; + /** @description The coupons to redeem into discounts for the subscription item. */ + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ @@ -45922,7 +52140,7 @@ export interface operations { unit_amount_decimal?: string; }; /** - * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; @@ -46015,6 +52233,12 @@ export interface operations { billing_thresholds?: { usage_gte: number; } | ""; + /** @description The coupons to redeem into discounts for the subscription item. */ + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ @@ -46056,7 +52280,7 @@ export interface operations { unit_amount_decimal?: string; }; /** - * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; @@ -46108,7 +52332,7 @@ export interface operations { /** @description Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`. */ clear_usage?: boolean; /** - * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; @@ -46349,6 +52573,12 @@ export interface operations { /** automatic_tax_config */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** @enum {string} */ billing_cycle_anchor?: "automatic" | "phase_start"; @@ -46362,7 +52592,14 @@ export interface operations { description?: string | ""; /** subscription_schedule_default_settings_param */ invoice_settings?: { + account_tax_ids?: string[] | ""; days_until_due?: number; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; on_behalf_of?: string | ""; transfer_data?: { @@ -46371,7 +52608,7 @@ export interface operations { } | ""; }; /** - * @description Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription. + * @description Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. * @enum {string} */ end_behavior?: "cancel" | "none" | "release" | "renew"; @@ -46386,6 +52623,11 @@ export interface operations { /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. */ phases?: { add_invoice_items?: { + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[]; price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { @@ -46404,6 +52646,12 @@ export interface operations { /** automatic_tax_config */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** @enum {string} */ billing_cycle_anchor?: "automatic" | "phase_start"; @@ -46418,16 +52666,33 @@ export interface operations { default_payment_method?: string; default_tax_rates?: string[] | ""; description?: string | ""; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; /** Format: unix-time */ end_date?: number; /** invoice_settings */ invoice_settings?: { + account_tax_ids?: string[] | ""; days_until_due?: number; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; items: { billing_thresholds?: { usage_gte: number; } | ""; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; metadata?: { [key: string]: string | undefined; }; @@ -46552,6 +52817,12 @@ export interface operations { /** automatic_tax_config */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** @enum {string} */ billing_cycle_anchor?: "automatic" | "phase_start"; @@ -46565,7 +52836,14 @@ export interface operations { description?: string | ""; /** subscription_schedule_default_settings_param */ invoice_settings?: { + account_tax_ids?: string[] | ""; days_until_due?: number; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; on_behalf_of?: string | ""; transfer_data?: { @@ -46574,7 +52852,7 @@ export interface operations { } | ""; }; /** - * @description Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription. + * @description Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. * @enum {string} */ end_behavior?: "cancel" | "none" | "release" | "renew"; @@ -46587,6 +52865,11 @@ export interface operations { /** @description List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase. Note that past phases can be omitted. */ phases?: { add_invoice_items?: { + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[]; price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { @@ -46605,6 +52888,12 @@ export interface operations { /** automatic_tax_config */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** @enum {string} */ billing_cycle_anchor?: "automatic" | "phase_start"; @@ -46618,15 +52907,32 @@ export interface operations { default_payment_method?: string; default_tax_rates?: string[] | ""; description?: string | ""; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; end_date?: number | "now"; /** invoice_settings */ invoice_settings?: { + account_tax_ids?: string[] | ""; days_until_due?: number; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; items: { billing_thresholds?: { usage_gte: number; } | ""; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; metadata?: { [key: string]: string | undefined; }; @@ -46786,6 +53092,7 @@ export interface operations { }; /** @description The collection method of the subscriptions to retrieve. Either `charge_automatically` or `send_invoice`. */ collection_method?: "charge_automatically" | "send_invoice"; + /** @description Only return subscriptions that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -46874,6 +53181,11 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[]; price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { @@ -46889,13 +53201,19 @@ export interface operations { tax_rates?: string[] | ""; }[]; /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number | ""; /** * automatic_tax_config * @description Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** * Format: unix-time @@ -46904,9 +53222,20 @@ export interface operations { backdate_start_date?: number; /** * Format: unix-time - * @description A future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format. + * @description A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future billing cycle dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. */ billing_cycle_anchor?: number; + /** + * billing_cycle_anchor_config_param + * @description Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC. + */ + billing_cycle_anchor_config?: { + day_of_month: number; + hour?: number; + minute?: number; + month?: number; + second?: number; + }; /** @description Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds. */ billing_thresholds?: { amount_gte?: number; @@ -46924,7 +53253,7 @@ export interface operations { * @enum {string} */ 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. */ + /** @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). */ currency?: string; @@ -46940,13 +53269,37 @@ export interface operations { default_tax_rates?: string[] | ""; /** @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string; + /** @description The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer. */ + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** + * invoice_settings_param + * @description All invoices will be billed using the specified settings. + */ + invoice_settings?: { + account_tax_ids?: string[] | ""; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + }; /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: { usage_gte: number; } | ""; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; metadata?: { [key: string]: string | undefined; }; @@ -46981,15 +53334,15 @@ export interface operations { /** * @description Only applies to subscriptions with `collection_method=charge_automatically`. * - * Use `allow_incomplete` to create subscriptions with `status=incomplete` if the first invoice cannot be paid. Creating subscriptions with this status allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. + * Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. * - * Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the payment intent on the first invoice. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the payment intent is not confirmed within 23 hours subscriptions transition to `status=incomplete_expired`, which is a terminal state. + * Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription’s invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state. * - * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not create a subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. + * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. * - * `pending_if_incomplete` is only used with updates and cannot be passed when creating a subscription. + * `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription. * - * Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first invoice status. + * Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status. * @enum {string} */ payment_behavior?: "allow_incomplete" | "default_incomplete" | "error_if_incomplete" | "pending_if_incomplete"; @@ -47024,7 +53377,7 @@ export interface operations { /** @enum {string} */ network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; customer_balance?: { /** bank_transfer_param */ @@ -47038,17 +53391,18 @@ export interface operations { funding_type?: string; } | ""; konbini?: Record | ""; + sepa_debit?: Record | ""; us_bank_account?: { /** invoice_linked_account_options_param */ financial_connections?: { permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - prefetch?: "balances"[]; + prefetch?: ("balances" | "ownership" | "transactions")[]; }; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "paynow" | "paypal" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; @@ -47058,10 +53412,10 @@ export interface operations { interval: "day" | "month" | "week" | "year"; interval_count?: number; } | ""; - /** @description The API ID of a promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ + /** @description The ID of a promotion code to apply to this subscription. A promotion code 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. */ promotion_code?: string; /** - * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. + * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; @@ -47220,6 +53574,11 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items. */ add_invoice_items?: { + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[]; price?: string; /** one_time_price_data_with_negative_amounts */ price_data?: { @@ -47235,13 +53594,19 @@ export interface operations { tax_rates?: string[] | ""; }[]; /** @description A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). */ - application_fee_percent?: number; + application_fee_percent?: number | ""; /** * automatic_tax_config * @description Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed. */ automatic_tax?: { enabled: boolean; + /** param */ + liability?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; }; /** * @description Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle). @@ -47271,7 +53636,7 @@ export interface operations { * @enum {string} */ 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. */ + /** @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 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; @@ -47283,8 +53648,27 @@ export interface operations { default_tax_rates?: string[] | ""; /** @description The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. */ description?: string | ""; + /** @description The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer. */ + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** + * invoice_settings_param + * @description All invoices will be billed using the specified settings. + */ + invoice_settings?: { + account_tax_ids?: string[] | ""; + /** param */ + issuer?: { + account?: string; + /** @enum {string} */ + type: "account" | "self"; + }; + }; /** @description A list of up to 20 subscription items, each with an attached price. */ items?: { billing_thresholds?: { @@ -47292,6 +53676,11 @@ export interface operations { } | ""; clear_usage?: boolean; deleted?: boolean; + discounts?: { + coupon?: string; + discount?: string; + promotion_code?: string; + }[] | ""; id?: string; metadata?: { [key: string]: string | undefined; @@ -47324,7 +53713,7 @@ export interface operations { off_session?: boolean; /** @description The account on behalf of which to charge, for each of the subscription's invoices. */ on_behalf_of?: string | ""; - /** @description If specified, payment collection for this subscription will be paused. */ + /** @description If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment). */ pause_collection?: { /** @enum {string} */ behavior: "keep_as_draft" | "mark_uncollectible" | "void"; @@ -47373,7 +53762,7 @@ export interface operations { /** @enum {string} */ network?: "amex" | "cartes_bancaires" | "diners" | "discover" | "eftpos_au" | "interac" | "jcb" | "mastercard" | "unionpay" | "unknown" | "visa"; /** @enum {string} */ - request_three_d_secure?: "any" | "automatic"; + request_three_d_secure?: "any" | "automatic" | "challenge"; } | ""; customer_balance?: { /** bank_transfer_param */ @@ -47387,17 +53776,18 @@ export interface operations { funding_type?: string; } | ""; konbini?: Record | ""; + sepa_debit?: Record | ""; us_bank_account?: { /** invoice_linked_account_options_param */ financial_connections?: { permissions?: ("balances" | "ownership" | "payment_method" | "transactions")[]; - prefetch?: "balances"[]; + prefetch?: ("balances" | "ownership" | "transactions")[]; }; /** @enum {string} */ verification_method?: "automatic" | "instant" | "microdeposits"; } | ""; }; - payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "paynow" | "paypal" | "promptpay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | ""; + payment_method_types?: ("ach_credit_transfer" | "ach_debit" | "acss_debit" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "boleto" | "card" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "konbini" | "link" | "p24" | "paynow" | "paypal" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "us_bank_account" | "wechat_pay")[] | ""; /** @enum {string} */ save_default_payment_method?: "off" | "on_subscription"; }; @@ -47410,7 +53800,7 @@ export interface operations { /** @description The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. */ promotion_code?: string; /** - * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; @@ -47569,7 +53959,7 @@ export interface operations { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; /** - * @description Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + * @description Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. * @enum {string} */ proration_behavior?: "always_invoice" | "create_prorations" | "none"; @@ -47635,7 +54025,7 @@ export interface operations { ip_address?: string; tax_ids?: { /** @enum {string} */ - type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "li_uid" | "mx_rfc" | "my_frp" | "my_itn" | "my_sst" | "no_vat" | "nz_gst" | "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" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "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" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; value: string; }[]; /** @enum {string} */ @@ -47653,6 +54043,21 @@ export interface operations { tax_behavior?: "exclusive" | "inclusive"; tax_code?: string; }[]; + /** + * ship_from_details + * @description Details about the address from which the goods are being shipped. + */ + ship_from_details?: { + /** merchant_postal_address */ + address: { + city?: string | ""; + country: string; + line1?: string | ""; + line2?: string | ""; + postal_code?: string | ""; + state?: string | ""; + }; + }; /** * shipping_cost * @description Shipping cost details to be used for the calculation. @@ -48245,6 +54650,44 @@ export interface operations { }; }; }; + GetTaxRegistrationsId: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["tax.registration"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostTaxRegistrationsId: { parameters: { query?: never; @@ -48439,7 +54882,7 @@ export interface operations { "application/x-www-form-urlencoded": { /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; - /** @description A flat amount to reverse across the entire transaction, in negative integer cents. This value represents the total amount to refund from the transaction, including taxes. */ + /** @description A flat amount to reverse across the entire transaction, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) in negative. This value represents the total amount to refund from the transaction, including taxes. */ flat_amount?: number; /** @description The line item amounts to reverse. */ line_items?: { @@ -48682,6 +55125,193 @@ export interface operations { }; }; }; + GetTaxIds: { + parameters: { + query?: { + /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ + ending_before?: string; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. */ + limit?: number; + /** @description The account or customer the tax ID belongs to. Defaults to `owner[type]=self`. */ + owner?: { + account?: string; + customer?: string; + /** @enum {string} */ + type: "account" | "application" | "customer" | "self"; + }; + /** @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; + }; + header?: never; + path?: never; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": { + /** @description Details about each object. */ + data: components["schemas"]["tax_id"][]; + /** @description True if this list has another page of items after this one that can be fetched. */ + has_more: boolean; + /** + * @description String representing the object's type. Objects of the same type share the same value. Always has the value `list`. + * @enum {string} + */ + object: "list"; + /** @description The URL where this list can be accessed. */ + url: string; + }; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostTaxIds: { + parameters: { + query?: never; + header?: never; + path?: never; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * owner_params + * @description The account or customer the tax ID belongs to. Defaults to `owner[type]=self`. + */ + owner?: { + account?: string; + customer?: string; + /** @enum {string} */ + 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`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `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`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` + * @enum {string} + */ + type: "ad_nrt" | "ae_trn" | "ar_cuit" | "au_abn" | "au_arn" | "bg_uic" | "bh_vat" | "bo_tin" | "br_cnpj" | "br_cpf" | "ca_bn" | "ca_gst_hst" | "ca_pst_bc" | "ca_pst_mb" | "ca_pst_sk" | "ca_qst" | "ch_vat" | "cl_tin" | "cn_tin" | "co_nit" | "cr_tin" | "do_rcn" | "ec_ruc" | "eg_tin" | "es_cif" | "eu_oss_vat" | "eu_vat" | "gb_vat" | "ge_vat" | "hk_br" | "hu_tin" | "id_npwp" | "il_vat" | "in_gst" | "is_vat" | "jp_cn" | "jp_rn" | "jp_trn" | "ke_pin" | "kr_brn" | "kz_bin" | "li_uid" | "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" | "ua_vat" | "us_ein" | "uy_ruc" | "ve_rif" | "vn_tin" | "za_vat"; + /** @description Value of the tax ID. */ + value: string; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["tax_id"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + GetTaxIdsId: { + parameters: { + query?: { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["tax_id"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + DeleteTaxIdsId: { + parameters: { + query?: never; + header?: never; + path: { + id: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": Record; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["deleted_tax_id"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; GetTaxRates: { parameters: { query?: { @@ -48782,7 +55412,7 @@ export interface operations { * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string} */ - tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "service_tax" | "vat"; + tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; }; }; }; @@ -48879,7 +55509,7 @@ export interface operations { * @description The high-level tax type, such as `vat` or `sales_tax`. * @enum {string} */ - tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "service_tax" | "vat"; + tax_type?: "amusement_tax" | "communications_tax" | "gst" | "hst" | "igst" | "jct" | "lease_tax" | "pst" | "qst" | "rst" | "sales_tax" | "vat"; }; }; }; @@ -48978,6 +55608,8 @@ export interface operations { }; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @description Name of the configuration */ + name?: string; /** @description Configurations for collecting transactions offline. */ offline?: { enabled: boolean; @@ -49156,6 +55788,8 @@ export interface operations { } | ""; /** @description Specifies which fields in the response should be expanded. */ expand?: string[]; + /** @description Name of the configuration */ + name?: string; /** @description Configurations for collecting transactions offline. */ offline?: { enabled: boolean; @@ -49592,7 +56226,7 @@ export interface operations { parameters: { query?: { /** @description Filters readers by device type */ - device_type?: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "simulated_wisepos_e" | "stripe_m2" | "verifone_P400"; + device_type?: "bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "mobile_phone_reader" | "simulated_wisepos_e" | "stripe_m2" | "verifone_P400"; /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ ending_before?: string; /** @description Specifies which fields in the response should be expanded. */ @@ -49872,6 +56506,7 @@ export interface operations { * @description Configuration overrides */ process_config?: { + enable_customer_cancellation?: boolean; skip_tipping?: boolean; /** tipping_config */ tipping?: { @@ -49922,7 +56557,9 @@ export interface operations { * process_setup_config * @description Configuration overrides */ - process_config?: Record; + process_config?: { + enable_customer_cancellation?: boolean; + }; /** @description SetupIntent ID */ setup_intent: string; }; @@ -49975,6 +56612,13 @@ export interface operations { payment_intent?: string; /** @description Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge. */ refund_application_fee?: boolean; + /** + * refund_payment_config + * @description Configuration overrides + */ + refund_payment_config?: { + enable_customer_cancellation?: boolean; + }; /** @description Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge. */ reverse_transfer?: boolean; }; @@ -50001,39 +56645,248 @@ export interface operations { }; }; }; - PostTerminalReadersReaderSetReaderDisplay: { + PostTerminalReadersReaderSetReaderDisplay: { + parameters: { + query?: never; + header?: never; + path: { + reader: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** + * cart + * @description Cart + */ + cart?: { + currency: string; + line_items: { + amount: number; + description: string; + quantity: number; + }[]; + tax?: number; + total: number; + }; + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * @description Type + * @enum {string} + */ + type: "cart"; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["terminal.reader"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostTestHelpersConfirmationTokens: { parameters: { query?: never; header?: never; - path: { - reader: string; - }; + path?: never; cookie?: never; }; - requestBody: { + requestBody?: { content: { "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** @description ID of an existing PaymentMethod. */ + payment_method?: string; /** - * cart - * @description Cart + * payment_method_data_params + * @description If provided, this hash will be used to create a PaymentMethod. */ - cart?: { - currency: string; - line_items: { - amount: number; - description: string; - quantity: number; - }[]; - tax?: number; - total: number; + payment_method_data?: { + /** payment_method_param */ + acss_debit?: { + account_number: string; + institution_number: string; + transit_number: string; + }; + /** param */ + affirm?: Record; + /** param */ + afterpay_clearpay?: Record; + /** param */ + alipay?: Record; + /** @enum {string} */ + allow_redisplay?: "always" | "limited" | "unspecified"; + /** param */ + amazon_pay?: Record; + /** param */ + au_becs_debit?: { + account_number: string; + bsb_number: string; + }; + /** param */ + bacs_debit?: { + account_number?: string; + sort_code?: string; + }; + /** param */ + bancontact?: Record; + /** billing_details_inner_params */ + billing_details?: { + address?: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + } | ""; + email?: string | ""; + name?: string | ""; + phone?: string | ""; + }; + /** param */ + blik?: Record; + /** param */ + boleto?: { + tax_id: string; + }; + /** param */ + cashapp?: Record; + /** param */ + customer_balance?: Record; + /** param */ + eps?: { + /** @enum {string} */ + bank?: "arzte_und_apotheker_bank" | "austrian_anadi_bank_ag" | "bank_austria" | "bankhaus_carl_spangler" | "bankhaus_schelhammer_und_schattera_ag" | "bawag_psk_ag" | "bks_bank_ag" | "brull_kallmus_bank_ag" | "btv_vier_lander_bank" | "capital_bank_grawe_gruppe_ag" | "deutsche_bank_ag" | "dolomitenbank" | "easybank_ag" | "erste_bank_und_sparkassen" | "hypo_alpeadriabank_international_ag" | "hypo_bank_burgenland_aktiengesellschaft" | "hypo_noe_lb_fur_niederosterreich_u_wien" | "hypo_oberosterreich_salzburg_steiermark" | "hypo_tirol_bank_ag" | "hypo_vorarlberg_bank_ag" | "marchfelder_bank" | "oberbank_ag" | "raiffeisen_bankengruppe_osterreich" | "schoellerbank_ag" | "sparda_bank_wien" | "volksbank_gruppe" | "volkskreditbank_ag" | "vr_bank_braunau"; + }; + /** param */ + fpx?: { + /** @enum {string} */ + bank: "affin_bank" | "agrobank" | "alliance_bank" | "ambank" | "bank_islam" | "bank_muamalat" | "bank_of_china" | "bank_rakyat" | "bsn" | "cimb" | "deutsche_bank" | "hong_leong_bank" | "hsbc" | "kfh" | "maybank2e" | "maybank2u" | "ocbc" | "pb_enterprise" | "public_bank" | "rhb" | "standard_chartered" | "uob"; + }; + /** param */ + giropay?: Record; + /** param */ + grabpay?: Record; + /** param */ + ideal?: { + /** @enum {string} */ + bank?: "abn_amro" | "asn_bank" | "bunq" | "handelsbanken" | "ing" | "knab" | "moneyou" | "n26" | "nn" | "rabobank" | "regiobank" | "revolut" | "sns_bank" | "triodos_bank" | "van_lanschot" | "yoursafe"; + }; + /** param */ + interac_present?: Record; + /** param */ + klarna?: { + /** date_of_birth */ + dob?: { + day: number; + month: number; + year: number; + }; + }; + /** param */ + konbini?: Record; + /** param */ + link?: Record; + metadata?: { + [key: string]: string | undefined; + }; + /** param */ + mobilepay?: Record; + /** param */ + oxxo?: Record; + /** param */ + p24?: { + /** @enum {string} */ + bank?: "alior_bank" | "bank_millennium" | "bank_nowy_bfg_sa" | "bank_pekao_sa" | "banki_spbdzielcze" | "blik" | "bnp_paribas" | "boz" | "citi_handlowy" | "credit_agricole" | "envelobank" | "etransfer_pocztowy24" | "getin_bank" | "ideabank" | "ing" | "inteligo" | "mbank_mtransfer" | "nest_przelew" | "noble_pay" | "pbac_z_ipko" | "plus_bank" | "santander_przelew24" | "tmobile_usbugi_bankowe" | "toyota_bank" | "velobank" | "volkswagen_bank"; + }; + /** param */ + paynow?: Record; + /** param */ + paypal?: Record; + /** param */ + pix?: Record; + /** param */ + promptpay?: Record; + /** radar_options_with_hidden_options */ + radar_options?: { + session?: string; + }; + /** param */ + revolut_pay?: Record; + /** param */ + sepa_debit?: { + iban: string; + }; + /** param */ + sofort?: { + /** @enum {string} */ + country: "AT" | "BE" | "DE" | "ES" | "IT" | "NL"; + }; + /** param */ + swish?: Record; + /** @enum {string} */ + type: "acss_debit" | "affirm" | "afterpay_clearpay" | "alipay" | "amazon_pay" | "au_becs_debit" | "bacs_debit" | "bancontact" | "blik" | "boleto" | "cashapp" | "customer_balance" | "eps" | "fpx" | "giropay" | "grabpay" | "ideal" | "klarna" | "konbini" | "link" | "mobilepay" | "oxxo" | "p24" | "paynow" | "paypal" | "pix" | "promptpay" | "revolut_pay" | "sepa_debit" | "sofort" | "swish" | "us_bank_account" | "wechat_pay" | "zip"; + /** payment_method_param */ + us_bank_account?: { + /** @enum {string} */ + account_holder_type?: "company" | "individual"; + account_number?: string; + /** @enum {string} */ + account_type?: "checking" | "savings"; + financial_connections_account?: string; + routing_number?: string; + }; + /** param */ + wechat_pay?: Record; + /** param */ + zip?: Record; }; - /** @description Specifies which fields in the response should be expanded. */ - expand?: string[]; + /** @description Return URL used to confirm the Intent. */ + return_url?: string; /** - * @description Type + * @description Indicates that you intend to make future payments with this ConfirmationToken's payment method. + * + * The presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. * @enum {string} */ - type: "cart"; + setup_future_usage?: "off_session" | "on_session"; + /** + * recipient_shipping_with_optional_fields_address + * @description Shipping information for this ConfirmationToken. + */ + shipping?: { + /** optional_fields_address */ + address: { + city?: string; + country?: string; + line1?: string; + line2?: string; + postal_code?: string; + state?: string; + }; + name: string; + phone?: string | ""; + }; }; }; }; @@ -50044,7 +56897,7 @@ export interface operations { [name: string]: unknown; }; content: { - "application/json": components["schemas"]["terminal.reader"]; + "application/json": components["schemas"]["confirmation_token"]; }; }; /** @description Error response. */ @@ -50112,7 +56965,7 @@ export interface operations { requestBody: { content: { "application/x-www-form-urlencoded": { - /** @description The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ + /** @description The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). */ amount: number; /** * amount_details_specs @@ -50172,7 +57025,7 @@ export interface operations { /** @enum {string} */ claimed_by: "acquirer" | "issuer"; /** @enum {string} */ - type: "low_value_transaction" | "transaction_risk_analysis"; + type: "low_value_transaction" | "transaction_risk_analysis" | "unknown"; }; /** @enum {string} */ cvc_check?: "match" | "mismatch" | "not_provided"; @@ -50257,7 +57110,7 @@ export interface operations { /** @enum {string} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; /** @enum {string} */ - unit?: "liter" | "us_gallon"; + unit?: "liter" | "other" | "us_gallon"; /** Format: decimal */ unit_cost_decimal?: string; /** Format: decimal */ @@ -50574,6 +57427,128 @@ export interface operations { }; }; }; + PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate: { + parameters: { + query?: never; + header?: never; + path: { + personalization_design: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issuing.personalization_design"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate: { + parameters: { + query?: never; + header?: never; + path: { + personalization_design: string; + }; + cookie?: never; + }; + requestBody?: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issuing.personalization_design"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; + PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject: { + parameters: { + query?: never; + header?: never; + path: { + personalization_design: string; + }; + cookie?: never; + }; + requestBody: { + content: { + "application/x-www-form-urlencoded": { + /** @description Specifies which fields in the response should be expanded. */ + expand?: string[]; + /** + * rejection_reasons_param + * @description The reason(s) the personalization design was rejected. + */ + rejection_reasons: { + card_logo?: ("geographic_location" | "inappropriate" | "network_name" | "non_binary_image" | "non_fiat_currency" | "other" | "other_entity" | "promotional_material")[]; + carrier_text?: ("geographic_location" | "inappropriate" | "network_name" | "non_fiat_currency" | "other" | "other_entity" | "promotional_material")[]; + }; + }; + }; + }; + responses: { + /** @description Successful response. */ + 200: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["issuing.personalization_design"]; + }; + }; + /** @description Error response. */ + default: { + headers: { + [name: string]: unknown; + }; + content: { + "application/json": components["schemas"]["error"]; + }; + }; + }; + }; PostTestHelpersIssuingTransactionsCreateForceCapture: { parameters: { query?: never; @@ -50634,7 +57609,7 @@ export interface operations { /** @enum {string} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; /** @enum {string} */ - unit?: "liter" | "us_gallon"; + unit?: "liter" | "other" | "us_gallon"; /** Format: decimal */ unit_cost_decimal?: string; /** Format: decimal */ @@ -50739,7 +57714,7 @@ export interface operations { /** @enum {string} */ type?: "diesel" | "other" | "unleaded_plus" | "unleaded_regular" | "unleaded_super"; /** @enum {string} */ - unit?: "liter" | "us_gallon"; + unit?: "liter" | "other" | "us_gallon"; /** Format: decimal */ unit_cost_decimal?: string; /** Format: decimal */ @@ -51534,7 +58509,7 @@ export interface operations { }; }; /** - * @description The rails used for the object. + * @description Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. * @enum {string} */ network: "ach" | "us_domestic_wire"; @@ -51597,7 +58572,7 @@ export interface operations { }; }; /** - * @description The rails used for the object. + * @description Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type. * @enum {string} */ network: "ach"; @@ -51692,7 +58667,7 @@ export interface operations { phone?: string; registration_number?: string; /** @enum {string} */ - structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; + structure?: "" | "free_zone_establishment" | "free_zone_llc" | "government_instrumentality" | "governmental_unit" | "incorporated_non_profit" | "incorporated_partnership" | "limited_liability_partnership" | "llc" | "multi_member_llc" | "private_company" | "private_corporation" | "private_partnership" | "public_company" | "public_corporation" | "public_partnership" | "registered_charity" | "single_member_llc" | "sole_establishment" | "sole_proprietorship" | "tax_exempt_government_instrumentality" | "unincorporated_association" | "unincorporated_non_profit" | "unincorporated_partnership"; tax_id?: string; tax_id_registrar?: string; vat_id?: string; @@ -51768,6 +58743,14 @@ export interface operations { postal_code?: string; state?: string; }; + /** individual_relationship_specs */ + relationship?: { + director?: boolean; + executive?: boolean; + owner?: boolean; + percent_ownership?: number | ""; + title?: string; + }; ssn_last_4?: string; /** person_verification_specs */ verification?: { @@ -51798,6 +58781,7 @@ export interface operations { account_type?: "checking" | "futsu" | "savings" | "toza"; country: string; currency?: string; + payment_method?: string; routing_number?: string; }; /** @description The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below. */ @@ -51813,6 +58797,11 @@ export interface operations { exp_month: string; exp_year: string; name?: string; + /** networks_param_specs */ + networks?: { + /** @enum {string} */ + preferred?: "cartes_bancaires" | "mastercard" | "visa"; + }; number: string; } | string; /** @description Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). Learn more about [cloning saved payment methods](https://stripe.com/docs/connect/cloning-saved-payment-methods). */ @@ -52255,6 +59244,7 @@ export interface operations { GetTransfers: { parameters: { query?: { + /** @description Only return transfers that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -52926,6 +59916,7 @@ export interface operations { GetTreasuryFinancialAccounts: { parameters: { query?: { + /** @description Only return FinancialAccounts that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -53566,6 +60557,13 @@ export interface operations { GetTreasuryOutboundPayments: { parameters: { query: { + /** @description Only return OutboundPayments that were created during the given date interval. */ + created?: { + gt?: number; + gte?: number; + lt?: number; + lte?: number; + } | number; /** @description Only return OutboundPayments sent to this customer. */ customer?: string; /** @description A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. */ @@ -53705,7 +60703,7 @@ export interface operations { metadata?: { [key: string]: string | undefined; }; - /** @description The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `wire` payments, or 500 characters for `stripe` network transfers. The default value is `payment`. */ + /** @description The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is "payment". */ statement_descriptor?: string; }; }; @@ -53901,7 +60899,7 @@ export interface operations { metadata?: { [key: string]: string | undefined; }; - /** @description Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `wire` transfers. The default value is `transfer`. */ + /** @description Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is "transfer". */ statement_descriptor?: string; }; }; @@ -54203,6 +61201,7 @@ export interface operations { GetTreasuryTransactionEntries: { parameters: { query: { + /** @description Only return TransactionEntries that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -54313,6 +61312,7 @@ export interface operations { GetTreasuryTransactions: { parameters: { query: { + /** @description Only return Transactions that were created during the given date interval. */ created?: { gt?: number; gte?: number; @@ -54490,13 +61490,13 @@ 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"; + 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"; /** @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. */ description?: string | ""; /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ - enabled_events: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_token.created" | "issuing_token.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; + enabled_events: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "climate.order.canceled" | "climate.order.created" | "climate.order.delayed" | "climate.order.delivered" | "climate.order.product_substituted" | "climate.product.created" | "climate.product.pricing_updated" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "entitlements.active_entitlement_summary.updated" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "financial_connections.account.refreshed_ownership" | "financial_connections.account.refreshed_transactions" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_token.created" | "issuing_token.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; /** @description Specifies which fields in the response should be expanded. */ expand?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ @@ -54584,7 +61584,7 @@ export interface operations { /** @description Disable the webhook endpoint if set to true. */ disabled?: boolean; /** @description The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection. */ - enabled_events?: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_token.created" | "issuing_token.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; + enabled_events?: ("*" | "account.application.authorized" | "account.application.deauthorized" | "account.external_account.created" | "account.external_account.deleted" | "account.external_account.updated" | "account.updated" | "application_fee.created" | "application_fee.refund.updated" | "application_fee.refunded" | "balance.available" | "billing_portal.configuration.created" | "billing_portal.configuration.updated" | "billing_portal.session.created" | "capability.updated" | "cash_balance.funds_available" | "charge.captured" | "charge.dispute.closed" | "charge.dispute.created" | "charge.dispute.funds_reinstated" | "charge.dispute.funds_withdrawn" | "charge.dispute.updated" | "charge.expired" | "charge.failed" | "charge.pending" | "charge.refund.updated" | "charge.refunded" | "charge.succeeded" | "charge.updated" | "checkout.session.async_payment_failed" | "checkout.session.async_payment_succeeded" | "checkout.session.completed" | "checkout.session.expired" | "climate.order.canceled" | "climate.order.created" | "climate.order.delayed" | "climate.order.delivered" | "climate.order.product_substituted" | "climate.product.created" | "climate.product.pricing_updated" | "coupon.created" | "coupon.deleted" | "coupon.updated" | "credit_note.created" | "credit_note.updated" | "credit_note.voided" | "customer.created" | "customer.deleted" | "customer.discount.created" | "customer.discount.deleted" | "customer.discount.updated" | "customer.source.created" | "customer.source.deleted" | "customer.source.expiring" | "customer.source.updated" | "customer.subscription.created" | "customer.subscription.deleted" | "customer.subscription.paused" | "customer.subscription.pending_update_applied" | "customer.subscription.pending_update_expired" | "customer.subscription.resumed" | "customer.subscription.trial_will_end" | "customer.subscription.updated" | "customer.tax_id.created" | "customer.tax_id.deleted" | "customer.tax_id.updated" | "customer.updated" | "customer_cash_balance_transaction.created" | "entitlements.active_entitlement_summary.updated" | "file.created" | "financial_connections.account.created" | "financial_connections.account.deactivated" | "financial_connections.account.disconnected" | "financial_connections.account.reactivated" | "financial_connections.account.refreshed_balance" | "financial_connections.account.refreshed_ownership" | "financial_connections.account.refreshed_transactions" | "identity.verification_session.canceled" | "identity.verification_session.created" | "identity.verification_session.processing" | "identity.verification_session.redacted" | "identity.verification_session.requires_input" | "identity.verification_session.verified" | "invoice.created" | "invoice.deleted" | "invoice.finalization_failed" | "invoice.finalized" | "invoice.marked_uncollectible" | "invoice.paid" | "invoice.payment_action_required" | "invoice.payment_failed" | "invoice.payment_succeeded" | "invoice.sent" | "invoice.upcoming" | "invoice.updated" | "invoice.voided" | "invoiceitem.created" | "invoiceitem.deleted" | "issuing_authorization.created" | "issuing_authorization.request" | "issuing_authorization.updated" | "issuing_card.created" | "issuing_card.updated" | "issuing_cardholder.created" | "issuing_cardholder.updated" | "issuing_dispute.closed" | "issuing_dispute.created" | "issuing_dispute.funds_reinstated" | "issuing_dispute.submitted" | "issuing_dispute.updated" | "issuing_token.created" | "issuing_token.updated" | "issuing_transaction.created" | "issuing_transaction.updated" | "mandate.updated" | "payment_intent.amount_capturable_updated" | "payment_intent.canceled" | "payment_intent.created" | "payment_intent.partially_funded" | "payment_intent.payment_failed" | "payment_intent.processing" | "payment_intent.requires_action" | "payment_intent.succeeded" | "payment_link.created" | "payment_link.updated" | "payment_method.attached" | "payment_method.automatically_updated" | "payment_method.detached" | "payment_method.updated" | "payout.canceled" | "payout.created" | "payout.failed" | "payout.paid" | "payout.reconciliation_completed" | "payout.updated" | "person.created" | "person.deleted" | "person.updated" | "plan.created" | "plan.deleted" | "plan.updated" | "price.created" | "price.deleted" | "price.updated" | "product.created" | "product.deleted" | "product.updated" | "promotion_code.created" | "promotion_code.updated" | "quote.accepted" | "quote.canceled" | "quote.created" | "quote.finalized" | "radar.early_fraud_warning.created" | "radar.early_fraud_warning.updated" | "refund.created" | "refund.updated" | "reporting.report_run.failed" | "reporting.report_run.succeeded" | "reporting.report_type.updated" | "review.closed" | "review.opened" | "setup_intent.canceled" | "setup_intent.created" | "setup_intent.requires_action" | "setup_intent.setup_failed" | "setup_intent.succeeded" | "sigma.scheduled_query_run.created" | "source.canceled" | "source.chargeable" | "source.failed" | "source.mandate_notification" | "source.refund_attributes_required" | "source.transaction.created" | "source.transaction.updated" | "subscription_schedule.aborted" | "subscription_schedule.canceled" | "subscription_schedule.completed" | "subscription_schedule.created" | "subscription_schedule.expiring" | "subscription_schedule.released" | "subscription_schedule.updated" | "tax.settings.updated" | "tax_rate.created" | "tax_rate.updated" | "terminal.reader.action_failed" | "terminal.reader.action_succeeded" | "test_helpers.test_clock.advancing" | "test_helpers.test_clock.created" | "test_helpers.test_clock.deleted" | "test_helpers.test_clock.internal_failure" | "test_helpers.test_clock.ready" | "topup.canceled" | "topup.created" | "topup.failed" | "topup.reversed" | "topup.succeeded" | "transfer.created" | "transfer.reversed" | "transfer.updated" | "treasury.credit_reversal.created" | "treasury.credit_reversal.posted" | "treasury.debit_reversal.completed" | "treasury.debit_reversal.created" | "treasury.debit_reversal.initial_credit_granted" | "treasury.financial_account.closed" | "treasury.financial_account.created" | "treasury.financial_account.features_status_updated" | "treasury.inbound_transfer.canceled" | "treasury.inbound_transfer.created" | "treasury.inbound_transfer.failed" | "treasury.inbound_transfer.succeeded" | "treasury.outbound_payment.canceled" | "treasury.outbound_payment.created" | "treasury.outbound_payment.expected_arrival_date_updated" | "treasury.outbound_payment.failed" | "treasury.outbound_payment.posted" | "treasury.outbound_payment.returned" | "treasury.outbound_transfer.canceled" | "treasury.outbound_transfer.created" | "treasury.outbound_transfer.expected_arrival_date_updated" | "treasury.outbound_transfer.failed" | "treasury.outbound_transfer.posted" | "treasury.outbound_transfer.returned" | "treasury.received_credit.created" | "treasury.received_credit.failed" | "treasury.received_credit.succeeded" | "treasury.received_debit.created")[]; /** @description Specifies which fields in the response should be expanded. */ expand?: 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. */ diff --git a/packages/openapi-typescript/examples/stripe-api.yaml b/packages/openapi-typescript/examples/stripe-api.yaml index 9da338aad..7246768b7 100644 --- a/packages/openapi-typescript/examples/stripe-api.yaml +++ b/packages/openapi-typescript/examples/stripe-api.yaml @@ -11,17 +11,26 @@ components: enabled to make live charges or receive payouts. - For Custom accounts, the properties below are always returned. For other - accounts, some properties are returned until that + For accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) - account has started to go through Connect Onboarding. Once you create an - [Account Link](https://stripe.com/docs/api/account_links) + is `application`, which includes Custom accounts, the properties below + are always - for a Standard or Express account, some parameters are no longer - returned. These are marked as **Custom Only** or **Custom and Express** + returned. - below. Learn about the differences [between - accounts](https://stripe.com/docs/connect/accounts). + + For accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + + is `stripe`, which includes Standard and Express accounts, some + properties are only returned + + until you create an [Account Link](/api/account_links) or [Account + Session](/api/account_sessions) + + to start Connect Onboarding. Learn about the [differences between + accounts](/connect/accounts). properties: business_profile: anyOf: @@ -29,7 +38,13 @@ components: description: Business information about the account. nullable: true business_type: - description: The business type. + description: >- + The business type. After you create an [Account + Link](/api/account_links) or [Account + Session](/api/account_sessions), this property is only returned for + accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `application`, which includes Custom accounts. enum: - company - government_entity @@ -66,8 +81,9 @@ components: type: string details_submitted: description: >- - Whether account details have been submitted. Standard accounts - cannot receive payouts before this is true. + Whether account details have been submitted. Accounts with Stripe + Dashboard access, which includes Standard accounts, cannot receive + payouts before this is true. type: boolean email: description: >- @@ -80,7 +96,8 @@ components: external_accounts: description: >- External accounts (bank accounts and debit cards) currently attached - to this account + to this account. External accounts are only returned for requests + where `controller[is_controller]` is true. properties: data: description: >- @@ -155,10 +172,13 @@ components: tos_acceptance: $ref: '#/components/schemas/account_tos_acceptance' type: - description: 'The Stripe account type. Can be `standard`, `express`, or `custom`.' + description: >- + The Stripe account type. Can be `standard`, `express`, `custom`, or + `none`. enum: - custom - express + - none - standard type: string required: @@ -178,6 +198,33 @@ components: - settings - tos_acceptance x-resourceId: account + account_annual_revenue: + description: '' + properties: + amount: + description: >- + A non-negative integer representing the amount in the [smallest + currency unit](https://docs.stripe.com/currencies#zero-decimal). + nullable: true + type: integer + 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). + nullable: true + type: string + fiscal_year_end: + 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. + maxLength: 5000 + nullable: true + type: string + title: AccountAnnualRevenue + type: object + x-expandableFields: [] account_bacs_debit_payments_settings: description: '' properties: @@ -258,6 +305,17 @@ components: account_business_profile: description: '' properties: + annual_revenue: + anyOf: + - $ref: '#/components/schemas/account_annual_revenue' + description: The applicant's gross annual revenue for its preceding fiscal year. + nullable: true + estimated_worker_count: + description: >- + An estimated upper bound of employees, contractors, vendors, etc. + currently working for the business. + nullable: true + type: integer mcc: description: >- [The merchant category code for the @@ -309,6 +367,7 @@ components: title: AccountBusinessProfile type: object x-expandableFields: + - annual_revenue - monthly_estimated_revenue - support_address account_capabilities: @@ -342,6 +401,15 @@ components: - inactive - pending type: string + amazon_pay_payments: + description: >- + The status of the AmazonPay capability of the account, or whether + the account can directly process AmazonPay payments. + enum: + - active + - inactive + - pending + type: string au_becs_debit_payments: description: >- The status of the BECS Direct Debit (AU) payments capability of the @@ -536,6 +604,15 @@ components: - inactive - pending type: string + mobilepay_payments: + description: >- + The status of the MobilepPay capability of the account, or whether + the account can directly process MobilePay charges. + enum: + - active + - inactive + - pending + type: string oxxo_payments: description: >- The status of the OXXO payments capability of the account, or @@ -600,6 +677,15 @@ components: - inactive - pending type: string + swish_payments: + description: >- + The status of the Swish capability of the account, or whether the + account can directly process Swish payments. + enum: + - active + - inactive + - pending + type: string tax_reporting_us_1099_k: description: >- The status of the tax reporting 1099-K (US) capability of the @@ -727,10 +813,12 @@ components: type: array pending_verification: description: >- - Fields that may become required depending on the results of - verification or review. Will be an empty array unless an - asynchronous verification is pending. If verification fails, these - fields move to `eventually_due` or `currently_due`. + Fields that might become required depending on the results of + verification or review. It's an empty array unless an asynchronous + verification is pending. If verification fails, these fields move to + `eventually_due` or `currently_due`. Fields might appear in + `eventually_due` or `currently_due` and in `pending_verification` if + verification fails but another verification is still pending. items: maxLength: 5000 type: string @@ -778,23 +866,28 @@ components: disabled_reason: description: >- If the capability is disabled, this string describes why. Can be - `requirements.past_due`, `requirements.pending_verification`, - `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, - `rejected.terms_of_service`, `rejected.other`, `under_review`, or - `other`. + `requirements.fields_needed`, `pending.onboarding`, + `pending.review`, `rejected.fraud`, `rejected.other`, + `platform_paused`, `action_required.requested_capabilities`, + `rejected.inactivty`, or `rejected.unsupported_business`. `rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may - restrict the businesses they support in their terms of service: + restrict the businesses they support in their terms of service, such + as in [Afterpay Clearpay's terms of + service](/afterpay-clearpay/legal#restricted-businesses). - - [Afterpay Clearpay's terms of - service](/afterpay-clearpay/legal#restricted-businesses) + `rejected.inactivity` means that the capability has been paused for + inactivity. This disabled reason currently only applies to the + Issuing capability. See [Issuing: Managing Inactive + Connects](https://support.stripe.com/questions/issuing-managing-inactive-connect-accounts) + for more details. - If you believe that the rejection is in error, please contact - support at https://support.stripe.com/contact/ for assistance. + If you believe that a rejection is in error, please contact support + at https://support.stripe.com/contact/ for assistance. maxLength: 5000 nullable: true type: string @@ -824,10 +917,13 @@ components: type: array pending_verification: description: >- - Fields that may become required depending on the results of - verification or review. Will be an empty array unless an - asynchronous verification is pending. If verification fails, these - fields move to `eventually_due`, `currently_due`, or `past_due`. + Fields that might become required depending on the results of + verification or review. It's an empty array unless an asynchronous + verification is pending. If verification fails, these fields move to + `eventually_due`, `currently_due`, or `past_due`. Fields might + appear in `eventually_due`, `currently_due`, or `past_due` and in + `pending_verification` if verification fails but another + verification is still pending. items: maxLength: 5000 type: string @@ -1003,10 +1099,12 @@ components: type: array pending_verification: description: >- - Fields that may become required depending on the results of - verification or review. Will be an empty array unless an - asynchronous verification is pending. If verification fails, these - fields move to `eventually_due` or `currently_due`. + Fields that might become required depending on the results of + verification or review. It's an empty array unless an asynchronous + verification is pending. If verification fails, these fields move to + `eventually_due` or `currently_due`. Fields might appear in + `eventually_due` or `currently_due` and in `pending_verification` if + verification fails but another verification is still pending. items: maxLength: 5000 type: string @@ -1017,6 +1115,27 @@ components: x-expandableFields: - alternatives - errors + account_invoices_settings: + description: '' + properties: + default_account_tax_ids: + description: >- + The list of default Account Tax IDs to automatically include on + invoices. Account Tax IDs get added when an invoice is finalized. + items: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/tax_id' + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/tax_id' + nullable: true + type: array + title: AccountInvoicesSettings + type: object + x-expandableFields: + - default_account_tax_ids account_link: description: >- Account Links are the means by which a Connect platform grants a @@ -1065,7 +1184,7 @@ components: description: >- A non-negative integer representing how much to charge in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + unit](https://docs.stripe.com/currencies#zero-decimal). type: integer currency: description: >- @@ -1134,11 +1253,11 @@ components: debit_negative_balances: description: >- A Boolean indicating if Stripe should try to reclaim negative - balances from an attached bank account. See our [Understanding - Connect Account - Balances](https://stripe.com/docs/connect/account-balances) - documentation for details. Default value is `false` for Custom - accounts, otherwise `true`. + balances from an attached bank account. See [Understanding Connect + account balances](/connect/account-balances) for details. The + default value is `false` when + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `application`, which includes Custom accounts, otherwise `true`. type: boolean schedule: $ref: '#/components/schemas/transfer_schedule' @@ -1229,10 +1348,13 @@ components: type: array pending_verification: description: >- - Fields that may become required depending on the results of - verification or review. Will be an empty array unless an - asynchronous verification is pending. If verification fails, these - fields move to `eventually_due`, `currently_due`, or `past_due`. + Fields that might become required depending on the results of + verification or review. It's an empty array unless an asynchronous + verification is pending. If verification fails, these fields move to + `eventually_due`, `currently_due`, or `past_due`. Fields might + appear in `eventually_due`, `currently_due`, or `past_due` and in + `pending_verification` if verification fails but another + verification is still pending. items: maxLength: 5000 type: string @@ -1353,6 +1475,7 @@ components: - verification_failed_keyed_match - verification_failed_name_match - verification_failed_other + - verification_failed_representative_authority - verification_failed_residential_address - verification_failed_tax_id_match - verification_failed_tax_id_not_issued @@ -1476,6 +1599,8 @@ components: $ref: '#/components/schemas/account_card_payments_settings' dashboard: $ref: '#/components/schemas/account_dashboard_settings' + invoices: + $ref: '#/components/schemas/account_invoices_settings' payments: $ref: '#/components/schemas/account_payments_settings' payouts: @@ -1497,6 +1622,7 @@ components: - card_issuing - card_payments - dashboard + - invoices - payments - payouts - sepa_debit_payments @@ -1569,6 +1695,8 @@ components: account_unification_account_controller: description: '' properties: + fees: + $ref: '#/components/schemas/account_unification_account_controller_fees' is_controller: description: >- `true` if the Connect application retrieving the resource controls @@ -1576,6 +1704,20 @@ components: controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null. type: boolean + losses: + $ref: '#/components/schemas/account_unification_account_controller_losses' + requirement_collection: + description: >- + A value indicating responsibility for collecting requirements on + this account. Only returned when the Connect application retrieving + the resource controls the account. + enum: + - application + - stripe + type: string + stripe_dashboard: + $ref: >- + #/components/schemas/account_unification_account_controller_stripe_dashboard type: description: >- The controller type. Can be `application`, if a Connect application @@ -1588,6 +1730,63 @@ components: - type title: AccountUnificationAccountController type: object + x-expandableFields: + - fees + - losses + - stripe_dashboard + account_unification_account_controller_fees: + description: '' + properties: + payer: + description: >- + A value indicating the responsible payer of a bundle of Stripe fees + for pricing-control eligible products on this account. Learn more + about [fee behavior on connected + accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior). + enum: + - account + - application + - application_custom + - application_express + type: string + x-stripeBypassValidation: true + required: + - payer + title: AccountUnificationAccountControllerFees + type: object + x-expandableFields: [] + account_unification_account_controller_losses: + description: '' + properties: + payments: + description: >- + A value indicating who is liable when this account can't pay back + negative balances from payments. + enum: + - application + - stripe + type: string + required: + - payments + title: AccountUnificationAccountControllerLosses + type: object + x-expandableFields: [] + account_unification_account_controller_stripe_dashboard: + description: '' + properties: + type: + description: >- + A value indicating the Stripe dashboard this account has access to + independent of the Connect application. + enum: + - express + - full + - none + type: string + required: + - type + title: AccountUnificationAccountControllerStripeDashboard + type: object x-expandableFields: [] address: description: '' @@ -2017,6 +2216,15 @@ components: amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices. type: boolean + liability: + anyOf: + - $ref: '#/components/schemas/connect_account_reference' + 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. + nullable: true status: description: >- The status of the most recent automated tax calculation for this @@ -2031,7 +2239,8 @@ components: - enabled title: AutomaticTax type: object - x-expandableFields: [] + x-expandableFields: + - liability balance: description: >- This is an object representing your Stripe balance. You can retrieve it @@ -2070,9 +2279,11 @@ components: type: array connect_reserved: description: >- - Funds held due to negative balances on connected Custom accounts. - You can find the connect reserve balance for each currency and - payment type in the `source_types` property. + Funds held due to negative balances on connected accounts where + [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `application`, which includes Custom accounts. You can find the + connect reserve balance for each currency and payment type in the + `source_types` property. items: $ref: '#/components/schemas/balance_amount' type: array @@ -2336,15 +2547,16 @@ components: description: >- Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, - `application_fee_refund`, `charge`, `connect_collection_transfer`, + `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_inbound`, `obligation_outbound`, - `obligation_reversal_inbound`, `obligation_reversal_outbound`, - `obligation_payout`, `obligation_payout_failure`, `payment`, - `payment_failure_refund`, `payment_refund`, `payment_reversal`, - `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, - `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, + `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 @@ -2360,20 +2572,20 @@ components: - 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_inbound - obligation_outbound - - obligation_payout - - obligation_payout_failure - obligation_reversal_inbound - - obligation_reversal_outbound - payment - payment_failure_refund + - payment_network_reserve_hold + - payment_network_reserve_release - payment_refund - payment_reversal - payment_unreconciled @@ -2418,18 +2630,21 @@ components: These bank accounts are payment methods on `Customer` objects. - On the other hand [External - Accounts](https://stripe.com/docs/api#external_accounts) are transfer + On the other hand [External Accounts](/api#external_accounts) are + transfer + + destinations on `Account` objects for accounts where + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) - destinations on `Account` objects for [Custom - accounts](https://stripe.com/docs/connect/custom-accounts). + is `application`, which includes [Custom + accounts](/connect/custom-accounts). They can be bank accounts or debit cards as well, and are documented in the links above. Related guide: [Bank debits and - transfers](https://stripe.com/docs/payments/bank-debits-transfers) + transfers](/payments/bank-debits-transfers) properties: account: anyOf: @@ -2579,9 +2794,10 @@ components: For external accounts, possible values are `new`, `errored` and - `verification_failed`. If a payouts fails, the status is set to + `verification_failed`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details - are updated. In India, if we can't [verify the owner of the bank + are updated. In the US and India, if we can't [verify the owner of + the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for @@ -2745,6 +2961,14 @@ components: in seconds since the Unix epoch. format: unix-time type: integer + next_refresh_available_at: + description: >- + Time at which the next balance refresh can be initiated. This value + will be `null` when `status` is `pending`. Measured in seconds since + the Unix epoch. + format: unix-time + nullable: true + type: integer status: description: The status of the last refresh attempt. enum: @@ -2780,6 +3004,14 @@ components: in seconds since the Unix epoch. format: unix-time type: integer + next_refresh_available_at: + description: >- + Time at which the next ownership refresh can be initiated. This + value will be `null` when `status` is `pending`. Measured in seconds + since the Unix epoch. + format: unix-time + nullable: true + type: integer status: description: The status of the last refresh attempt. enum: @@ -2793,6 +3025,325 @@ components: title: BankConnectionsResourceOwnershipRefresh type: object x-expandableFields: [] + bank_connections_resource_transaction_refresh: + description: '' + properties: + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + last_attempted_at: + description: >- + The time at which the last refresh attempt was initiated. Measured + in seconds since the Unix epoch. + format: unix-time + type: integer + next_refresh_available_at: + description: >- + Time at which the next transaction refresh can be initiated. This + value will be `null` when `status` is `pending`. Measured in seconds + since the Unix epoch. + format: unix-time + nullable: true + type: integer + status: + description: The status of the last refresh attempt. + enum: + - failed + - pending + - succeeded + type: string + required: + - id + - last_attempted_at + - status + title: BankConnectionsResourceTransactionRefresh + type: object + x-expandableFields: [] + bank_connections_resource_transaction_resource_status_transitions: + description: '' + properties: + posted_at: + description: >- + Time at which this transaction posted. Measured in seconds since the + Unix epoch. + format: unix-time + nullable: true + type: integer + void_at: + description: >- + Time at which this transaction was voided. Measured in seconds since + the Unix epoch. + format: unix-time + nullable: true + type: integer + title: BankConnectionsResourceTransactionResourceStatusTransitions + type: object + x-expandableFields: [] + 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. + properties: + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + customer_mapping: + $ref: >- + #/components/schemas/billing_meter_resource_customer_mapping_settings + default_aggregation: + $ref: '#/components/schemas/billing_meter_resource_aggregation_settings' + display_name: + description: The meter's name. + maxLength: 5000 + type: string + event_name: + description: >- + The name of the meter event to record usage for. Corresponds with + the `event_name` field on meter events. + maxLength: 5000 + type: string + event_time_window: + description: 'The time window to pre-aggregate meter events for, if any.' + enum: + - day + - hour + nullable: true + type: string + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - billing.meter + type: string + status: + description: The meter's status. + enum: + - active + - inactive + type: string + status_transitions: + $ref: >- + #/components/schemas/billing_meter_resource_billing_meter_status_transitions + updated: + description: >- + Time at which the object was last updated. Measured in seconds since + the Unix epoch. + format: unix-time + type: integer + value_settings: + $ref: '#/components/schemas/billing_meter_resource_billing_meter_value' + required: + - created + - customer_mapping + - default_aggregation + - display_name + - event_name + - id + - livemode + - object + - status + - status_transitions + - updated + - value_settings + title: BillingMeter + type: object + x-expandableFields: + - customer_mapping + - default_aggregation + - status_transitions + - value_settings + 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. + properties: + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + event_name: + description: >- + The name of the meter event. Corresponds with the `event_name` field + on a meter. + maxLength: 100 + type: string + identifier: + description: A unique identifier for the event. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - billing.meter_event + type: string + payload: + additionalProperties: + maxLength: 100 + type: string + description: >- + The payload of the event. This contains 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://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides). + type: object + timestamp: + description: >- + The timestamp passed in when creating the event. Measured in seconds + since the Unix epoch. + format: unix-time + type: integer + required: + - created + - event_name + - identifier + - livemode + - object + - payload + - timestamp + title: BillingMeterEvent + type: object + x-expandableFields: [] + x-resourceId: billing.meter_event + billing.meter_event_adjustment: + description: >- + A billing meter event adjustment is a resource that allows you to cancel + a meter event. For example, you might create a billing meter event + adjustment to cancel a meter event that was created in error or attached + to the wrong customer. + properties: + cancel: + anyOf: + - $ref: >- + #/components/schemas/billing_meter_resource_billing_meter_event_adjustment_cancel + description: Specifies which event to cancel. + nullable: true + event_name: + description: >- + The name of the meter event. Corresponds with the `event_name` field + on a meter. + maxLength: 100 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - billing.meter_event_adjustment + type: string + status: + description: The meter event adjustment's status. + enum: + - complete + - pending + type: string + type: + description: >- + Specifies whether to cancel a single event or a range of events for + a time period. Time period cancellation is not supported yet. + enum: + - cancel + type: string + required: + - event_name + - livemode + - object + - status + - type + title: BillingMeterEventAdjustment + type: object + x-expandableFields: + - cancel + x-resourceId: billing.meter_event_adjustment + billing.meter_event_summary: + description: >- + A billing meter event summary represents an aggregated view of a + customer's billing meter events within a specified timeframe. It + indicates how much + + usage was accrued by a customer for that period. + properties: + aggregated_value: + description: >- + Aggregated value of all the events within `start_time` (inclusive) + and `end_time` (inclusive). The aggregation strategy is defined on + meter via `default_aggregation`. + type: number + end_time: + description: End timestamp for this event summary (inclusive). + format: unix-time + type: integer + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + meter: + description: The meter associated with this event summary. + maxLength: 5000 + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - billing.meter_event_summary + type: string + start_time: + description: Start timestamp for this event summary (inclusive). + format: unix-time + type: integer + required: + - aggregated_value + - end_time + - id + - livemode + - meter + - object + - start_time + title: BillingMeterEventSummary + type: object + x-expandableFields: [] + x-resourceId: billing.meter_event_summary billing_details: description: '' properties: @@ -2820,6 +3371,78 @@ components: type: object x-expandableFields: - address + billing_meter_resource_aggregation_settings: + description: '' + properties: + formula: + description: Specifies how events are aggregated. + enum: + - count + - sum + type: string + required: + - formula + title: BillingMeterResourceAggregationSettings + type: object + x-expandableFields: [] + billing_meter_resource_billing_meter_event_adjustment_cancel: + description: '' + properties: + identifier: + description: Unique identifier for the event. + maxLength: 100 + nullable: true + type: string + title: BillingMeterResourceBillingMeterEventAdjustmentCancel + type: object + x-expandableFields: [] + billing_meter_resource_billing_meter_status_transitions: + description: '' + properties: + deactivated_at: + description: >- + The time the meter was deactivated, if any. Measured in seconds + since Unix epoch. + format: unix-time + nullable: true + type: integer + title: BillingMeterResourceBillingMeterStatusTransitions + type: object + x-expandableFields: [] + billing_meter_resource_billing_meter_value: + description: '' + properties: + event_payload_key: + description: >- + The key in the meter event payload to use as the value for this + meter. + maxLength: 5000 + type: string + required: + - event_payload_key + title: BillingMeterResourceBillingMeterValue + type: object + x-expandableFields: [] + billing_meter_resource_customer_mapping_settings: + description: '' + properties: + event_payload_key: + description: >- + The key in the meter event payload to use for mapping the event to a + customer. + maxLength: 5000 + type: string + type: + description: The method for mapping a meter event to a customer. + enum: + - by_id + type: string + required: + - event_payload_key + - type + title: BillingMeterResourceCustomerMappingSettings + type: object + x-expandableFields: [] billing_portal.configuration: description: >- A portal configuration describes the functionality and behavior of a @@ -3058,7 +3681,7 @@ components: The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the - [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). + [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the @@ -3217,6 +3840,9 @@ components: description: >- The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. + 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. nullable: true x-expansionResources: oneOf: @@ -3296,7 +3922,10 @@ components: Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a - transfer destination for funds in this currency. + 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. nullable: true type: string customer: @@ -3327,7 +3956,11 @@ components: nullable: true type: string default_for_currency: - description: Whether this card is the default external account for its currency. + description: >- + Whether this card is the default external account for its 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. nullable: true type: boolean dynamic_last4: @@ -3388,6 +4021,8 @@ components: maxLength: 5000 nullable: true type: string + networks: + $ref: '#/components/schemas/token_card_networks' object: description: >- String representing the object's type. Objects of the same type @@ -3425,6 +4060,7 @@ components: x-expandableFields: - account - customer + - networks x-resourceId: card card_generated_from_payment_method_details: description: '' @@ -3571,7 +4207,7 @@ components: - $ref: '#/components/schemas/application_fee' description: >- The application fee (if any) for the charge. [See the Connect - documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) + documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. nullable: true x-expansionResources: @@ -3581,7 +4217,7 @@ components: description: >- The amount of the application fee (if any) requested for the charge. [See the Connect - documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees) + documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details. nullable: true type: integer @@ -4129,7 +4765,7 @@ components: billing_address_collection: description: >- Describes whether Checkout should collect the customer's billing - address. + address. Defaults to `auto`. enum: - auto - required @@ -4196,7 +4832,7 @@ components: custom_fields: description: >- Collect additional information from your customer using custom - fields. Up to 2 fields are supported. + fields. Up to 3 fields are supported. items: $ref: '#/components/schemas/payment_pages_checkout_session_custom_fields' type: array @@ -4240,8 +4876,8 @@ components: #/components/schemas/payment_pages_checkout_session_customer_details description: >- The customer details including the customer's tax exempt status and - the customer's tax IDs. Only the customer's email is present on - Sessions in `setup` mode. + the customer's tax IDs. Customer's address details are not present + on Sessions in `setup` mode. nullable: true customer_email: description: >- @@ -4419,7 +5055,7 @@ components: payment_method_collection: description: >- Configure whether a Checkout Session should collect a payment - method. + method. Defaults to `always`. enum: - always - if_required @@ -4472,11 +5108,10 @@ components: type: string redirect_on_completion: description: >- - Applies to Checkout Sessions with `ui_mode: embedded`. By default, - Stripe will always redirect to your return_url after a successful - confirmation. If you set `redirect_on_completion: 'if_required'`, - then we will only redirect if your user chooses a redirect-based - payment method. + This parameter applies to `ui_mode: embedded`. Learn more about the + [redirect + behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) + of embedded sessions. Defaults to `always`. enum: - always - if_required @@ -4489,6 +5124,14 @@ components: their payment on the payment method's app or site. maxLength: 5000 type: string + saved_payment_method_options: + anyOf: + - $ref: >- + #/components/schemas/payment_pages_checkout_session_saved_payment_method_options + description: >- + Controls saved payment method settings for the session. Only + available in `payment` and `subscription` mode. + nullable: true setup_intent: anyOf: - maxLength: 5000 @@ -4544,10 +5187,8 @@ components: relevant text on the page, such as the submit button. `submit_type` can only be - specified on Checkout Sessions in `payment` mode, but not Checkout - Sessions - - in `subscription` or `setup` mode. + specified on Checkout Sessions in `payment` mode. If blank or + `auto`, `pay` is used. enum: - auto - book @@ -4584,7 +5225,7 @@ components: description: Tax and discount details for the computed total amount. nullable: true ui_mode: - description: The UI mode of the Session. Can be `hosted` (default) or `embedded`. + description: The UI mode of the Session. Defaults to `hosted`. enum: - embedded - hosted @@ -4636,6 +5277,7 @@ components: - payment_method_configuration_details - payment_method_options - phone_number_collection + - saved_payment_method_options - setup_intent - shipping_address_collection - shipping_cost @@ -4820,6 +5462,35 @@ components: title: CheckoutAlipayPaymentMethodOptions type: object x-expandableFields: [] + checkout_amazon_pay_payment_method_options: + description: '' + properties: + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + Providing this parameter will [attach the payment + method](https://stripe.com/docs/payments/save-during-payment) to the + PaymentIntent's Customer, if present, after the PaymentIntent is + confirmed and any required actions from the user are complete. If no + Customer was provided, the payment method can still be + [attached](https://stripe.com/docs/api/payment_methods/attach) to a + Customer after the transaction completes. + + + When processing card payments, Stripe also uses `setup_future_usage` + to dynamically optimize your payment flow and comply with regional + legislation and network rules, such as + [SCA](https://stripe.com/docs/strong-customer-authentication). + enum: + - none + - off_session + type: string + title: CheckoutAmazonPayPaymentMethodOptions + type: object + x-expandableFields: [] checkout_au_becs_debit_payment_method_options: description: '' properties: @@ -4959,6 +5630,24 @@ components: properties: installments: $ref: '#/components/schemas/checkout_card_installments_options' + request_three_d_secure: + description: >- + We strongly recommend that you rely on our SCA Engine to + automatically prompt your customers for authentication based on risk + level and [other + requirements](https://stripe.com/docs/strong-customer-authentication). + However, if you wish to request 3D Secure based on logic from your + own fraud engine, provide this option. If not provided, this value + defaults to `automatic`. Read our guide on [manually requesting 3D + Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) + for more information on how this configuration interacts with Radar + and our SCA Engine. + enum: + - any + - automatic + - challenge + type: string + x-stripeBypassValidation: true setup_future_usage: description: >- Indicates that you intend to make future payments with this @@ -5004,6 +5693,8 @@ components: characters. maxLength: 5000 type: string + required: + - request_three_d_secure title: CheckoutCardPaymentMethodOptions type: object x-expandableFields: @@ -5356,72 +6047,7 @@ components: title: CheckoutLinkPaymentMethodOptions type: object x-expandableFields: [] - checkout_oxxo_payment_method_options: - description: '' - properties: - expires_after_days: - description: >- - The number of calendar days before an OXXO invoice expires. For - example, if you create an OXXO invoice on Monday and you set - expires_after_days to 2, the OXXO invoice will expire on Wednesday - at 23:59 America/Mexico_City time. - type: integer - setup_future_usage: - description: >- - Indicates that you intend to make future payments with this - PaymentIntent's payment method. - - - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a - Customer after the transaction completes. - - - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). - enum: - - none - type: string - required: - - expires_after_days - title: CheckoutOxxoPaymentMethodOptions - type: object - x-expandableFields: [] - checkout_p24_payment_method_options: - description: '' - properties: - setup_future_usage: - description: >- - Indicates that you intend to make future payments with this - PaymentIntent's payment method. - - - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a - Customer after the transaction completes. - - - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). - enum: - - none - type: string - title: CheckoutP24PaymentMethodOptions - type: object - x-expandableFields: [] - checkout_paynow_payment_method_options: + checkout_mobilepay_payment_method_options: description: '' properties: setup_future_usage: @@ -5446,80 +6072,19 @@ components: enum: - none type: string - title: CheckoutPaynowPaymentMethodOptions + title: CheckoutMobilepayPaymentMethodOptions type: object x-expandableFields: [] - checkout_paypal_payment_method_options: + checkout_oxxo_payment_method_options: description: '' properties: - capture_method: - description: >- - Controls when the funds will be captured from the customer's - account. - enum: - - manual - type: string - preferred_locale: - description: >- - Preferred locale of the PayPal checkout page that the customer is - redirected to. - maxLength: 5000 - nullable: true - type: string - reference: - description: >- - A reference of the PayPal transaction visible to customer which is - mapped to PayPal's invoice ID. This must be a globally unique ID if - you have configured in your PayPal settings to block multiple - payments per invoice ID. - maxLength: 5000 - nullable: true - type: string - setup_future_usage: + expires_after_days: description: >- - Indicates that you intend to make future payments with this - PaymentIntent's payment method. - - - Providing this parameter will [attach the payment - method](https://stripe.com/docs/payments/save-during-payment) to the - PaymentIntent's Customer, if present, after the PaymentIntent is - confirmed and any required actions from the user are complete. If no - Customer was provided, the payment method can still be - [attached](https://stripe.com/docs/api/payment_methods/attach) to a - Customer after the transaction completes. - - - When processing card payments, Stripe also uses `setup_future_usage` - to dynamically optimize your payment flow and comply with regional - legislation and network rules, such as - [SCA](https://stripe.com/docs/strong-customer-authentication). - enum: - - none - - off_session - type: string - title: CheckoutPaypalPaymentMethodOptions - type: object - x-expandableFields: [] - checkout_pix_payment_method_options: - description: '' - properties: - expires_after_seconds: - description: The number of seconds after which Pix payment will expire. - nullable: true + The number of calendar days before an OXXO invoice expires. For + example, if you create an OXXO invoice on Monday and you set + expires_after_days to 2, the OXXO invoice will expire on Wednesday + at 23:59 America/Mexico_City time. type: integer - title: CheckoutPixPaymentMethodOptions - type: object - x-expandableFields: [] - checkout_revolut_pay_payment_method_options: - description: '' - properties: {} - title: CheckoutRevolutPayPaymentMethodOptions - type: object - x-expandableFields: [] - checkout_sepa_debit_payment_method_options: - description: '' - properties: setup_future_usage: description: >- Indicates that you intend to make future payments with this @@ -5541,105 +6106,291 @@ components: [SCA](https://stripe.com/docs/strong-customer-authentication). enum: - none - - off_session - - on_session type: string - title: CheckoutSepaDebitPaymentMethodOptions + required: + - expires_after_days + title: CheckoutOxxoPaymentMethodOptions type: object x-expandableFields: [] - checkout_session_payment_method_options: - description: '' - properties: - acss_debit: - $ref: '#/components/schemas/checkout_acss_debit_payment_method_options' - affirm: - $ref: '#/components/schemas/checkout_affirm_payment_method_options' - afterpay_clearpay: - $ref: >- - #/components/schemas/checkout_afterpay_clearpay_payment_method_options - alipay: - $ref: '#/components/schemas/checkout_alipay_payment_method_options' - au_becs_debit: - $ref: '#/components/schemas/checkout_au_becs_debit_payment_method_options' - bacs_debit: - $ref: '#/components/schemas/checkout_bacs_debit_payment_method_options' - bancontact: - $ref: '#/components/schemas/checkout_bancontact_payment_method_options' - boleto: - $ref: '#/components/schemas/checkout_boleto_payment_method_options' - card: - $ref: '#/components/schemas/checkout_card_payment_method_options' - cashapp: - $ref: '#/components/schemas/checkout_cashapp_payment_method_options' - customer_balance: - $ref: >- - #/components/schemas/checkout_customer_balance_payment_method_options - eps: - $ref: '#/components/schemas/checkout_eps_payment_method_options' - fpx: - $ref: '#/components/schemas/checkout_fpx_payment_method_options' - giropay: - $ref: '#/components/schemas/checkout_giropay_payment_method_options' - grabpay: - $ref: '#/components/schemas/checkout_grab_pay_payment_method_options' - ideal: - $ref: '#/components/schemas/checkout_ideal_payment_method_options' - klarna: - $ref: '#/components/schemas/checkout_klarna_payment_method_options' - konbini: - $ref: '#/components/schemas/checkout_konbini_payment_method_options' - link: - $ref: '#/components/schemas/checkout_link_payment_method_options' - oxxo: - $ref: '#/components/schemas/checkout_oxxo_payment_method_options' - p24: - $ref: '#/components/schemas/checkout_p24_payment_method_options' - paynow: - $ref: '#/components/schemas/checkout_paynow_payment_method_options' - paypal: - $ref: '#/components/schemas/checkout_paypal_payment_method_options' - pix: - $ref: '#/components/schemas/checkout_pix_payment_method_options' - revolut_pay: - $ref: '#/components/schemas/checkout_revolut_pay_payment_method_options' - sepa_debit: - $ref: '#/components/schemas/checkout_sepa_debit_payment_method_options' - sofort: - $ref: '#/components/schemas/checkout_sofort_payment_method_options' - us_bank_account: - $ref: '#/components/schemas/checkout_us_bank_account_payment_method_options' - title: CheckoutSessionPaymentMethodOptions - type: object - x-expandableFields: - - acss_debit - - affirm - - afterpay_clearpay - - alipay - - au_becs_debit - - bacs_debit - - bancontact - - boleto - - card - - cashapp - - customer_balance - - eps - - fpx - - giropay - - grabpay - - ideal - - klarna - - konbini - - link - - oxxo - - p24 - - paynow - - paypal - - pix - - revolut_pay - - sepa_debit - - sofort - - us_bank_account - checkout_sofort_payment_method_options: + checkout_p24_payment_method_options: + description: '' + properties: + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + Providing this parameter will [attach the payment + method](https://stripe.com/docs/payments/save-during-payment) to the + PaymentIntent's Customer, if present, after the PaymentIntent is + confirmed and any required actions from the user are complete. If no + Customer was provided, the payment method can still be + [attached](https://stripe.com/docs/api/payment_methods/attach) to a + Customer after the transaction completes. + + + When processing card payments, Stripe also uses `setup_future_usage` + to dynamically optimize your payment flow and comply with regional + legislation and network rules, such as + [SCA](https://stripe.com/docs/strong-customer-authentication). + enum: + - none + type: string + title: CheckoutP24PaymentMethodOptions + type: object + x-expandableFields: [] + checkout_paynow_payment_method_options: + description: '' + properties: + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + Providing this parameter will [attach the payment + method](https://stripe.com/docs/payments/save-during-payment) to the + PaymentIntent's Customer, if present, after the PaymentIntent is + confirmed and any required actions from the user are complete. If no + Customer was provided, the payment method can still be + [attached](https://stripe.com/docs/api/payment_methods/attach) to a + Customer after the transaction completes. + + + When processing card payments, Stripe also uses `setup_future_usage` + to dynamically optimize your payment flow and comply with regional + legislation and network rules, such as + [SCA](https://stripe.com/docs/strong-customer-authentication). + enum: + - none + type: string + title: CheckoutPaynowPaymentMethodOptions + type: object + x-expandableFields: [] + checkout_paypal_payment_method_options: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + preferred_locale: + description: >- + Preferred locale of the PayPal checkout page that the customer is + redirected to. + maxLength: 5000 + nullable: true + type: string + reference: + description: >- + A reference of the PayPal transaction visible to customer which is + mapped to PayPal's invoice ID. This must be a globally unique ID if + you have configured in your PayPal settings to block multiple + payments per invoice ID. + maxLength: 5000 + nullable: true + type: string + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + Providing this parameter will [attach the payment + method](https://stripe.com/docs/payments/save-during-payment) to the + PaymentIntent's Customer, if present, after the PaymentIntent is + confirmed and any required actions from the user are complete. If no + Customer was provided, the payment method can still be + [attached](https://stripe.com/docs/api/payment_methods/attach) to a + Customer after the transaction completes. + + + When processing card payments, Stripe also uses `setup_future_usage` + to dynamically optimize your payment flow and comply with regional + legislation and network rules, such as + [SCA](https://stripe.com/docs/strong-customer-authentication). + enum: + - none + - off_session + type: string + title: CheckoutPaypalPaymentMethodOptions + type: object + x-expandableFields: [] + checkout_pix_payment_method_options: + description: '' + properties: + expires_after_seconds: + description: The number of seconds after which Pix payment will expire. + nullable: true + type: integer + title: CheckoutPixPaymentMethodOptions + type: object + x-expandableFields: [] + checkout_revolut_pay_payment_method_options: + description: '' + properties: + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + Providing this parameter will [attach the payment + method](https://stripe.com/docs/payments/save-during-payment) to the + PaymentIntent's Customer, if present, after the PaymentIntent is + confirmed and any required actions from the user are complete. If no + Customer was provided, the payment method can still be + [attached](https://stripe.com/docs/api/payment_methods/attach) to a + Customer after the transaction completes. + + + When processing card payments, Stripe also uses `setup_future_usage` + to dynamically optimize your payment flow and comply with regional + legislation and network rules, such as + [SCA](https://stripe.com/docs/strong-customer-authentication). + enum: + - none + - off_session + type: string + title: CheckoutRevolutPayPaymentMethodOptions + type: object + x-expandableFields: [] + checkout_sepa_debit_payment_method_options: + description: '' + properties: + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + Providing this parameter will [attach the payment + method](https://stripe.com/docs/payments/save-during-payment) to the + PaymentIntent's Customer, if present, after the PaymentIntent is + confirmed and any required actions from the user are complete. If no + Customer was provided, the payment method can still be + [attached](https://stripe.com/docs/api/payment_methods/attach) to a + Customer after the transaction completes. + + + When processing card payments, Stripe also uses `setup_future_usage` + to dynamically optimize your payment flow and comply with regional + legislation and network rules, such as + [SCA](https://stripe.com/docs/strong-customer-authentication). + enum: + - none + - off_session + - on_session + type: string + title: CheckoutSepaDebitPaymentMethodOptions + type: object + x-expandableFields: [] + checkout_session_payment_method_options: + description: '' + properties: + acss_debit: + $ref: '#/components/schemas/checkout_acss_debit_payment_method_options' + affirm: + $ref: '#/components/schemas/checkout_affirm_payment_method_options' + afterpay_clearpay: + $ref: >- + #/components/schemas/checkout_afterpay_clearpay_payment_method_options + alipay: + $ref: '#/components/schemas/checkout_alipay_payment_method_options' + amazon_pay: + $ref: '#/components/schemas/checkout_amazon_pay_payment_method_options' + au_becs_debit: + $ref: '#/components/schemas/checkout_au_becs_debit_payment_method_options' + bacs_debit: + $ref: '#/components/schemas/checkout_bacs_debit_payment_method_options' + bancontact: + $ref: '#/components/schemas/checkout_bancontact_payment_method_options' + boleto: + $ref: '#/components/schemas/checkout_boleto_payment_method_options' + card: + $ref: '#/components/schemas/checkout_card_payment_method_options' + cashapp: + $ref: '#/components/schemas/checkout_cashapp_payment_method_options' + customer_balance: + $ref: >- + #/components/schemas/checkout_customer_balance_payment_method_options + eps: + $ref: '#/components/schemas/checkout_eps_payment_method_options' + fpx: + $ref: '#/components/schemas/checkout_fpx_payment_method_options' + giropay: + $ref: '#/components/schemas/checkout_giropay_payment_method_options' + grabpay: + $ref: '#/components/schemas/checkout_grab_pay_payment_method_options' + ideal: + $ref: '#/components/schemas/checkout_ideal_payment_method_options' + klarna: + $ref: '#/components/schemas/checkout_klarna_payment_method_options' + konbini: + $ref: '#/components/schemas/checkout_konbini_payment_method_options' + link: + $ref: '#/components/schemas/checkout_link_payment_method_options' + mobilepay: + $ref: '#/components/schemas/checkout_mobilepay_payment_method_options' + oxxo: + $ref: '#/components/schemas/checkout_oxxo_payment_method_options' + p24: + $ref: '#/components/schemas/checkout_p24_payment_method_options' + paynow: + $ref: '#/components/schemas/checkout_paynow_payment_method_options' + paypal: + $ref: '#/components/schemas/checkout_paypal_payment_method_options' + pix: + $ref: '#/components/schemas/checkout_pix_payment_method_options' + revolut_pay: + $ref: '#/components/schemas/checkout_revolut_pay_payment_method_options' + sepa_debit: + $ref: '#/components/schemas/checkout_sepa_debit_payment_method_options' + sofort: + $ref: '#/components/schemas/checkout_sofort_payment_method_options' + swish: + $ref: '#/components/schemas/checkout_swish_payment_method_options' + us_bank_account: + $ref: '#/components/schemas/checkout_us_bank_account_payment_method_options' + title: CheckoutSessionPaymentMethodOptions + type: object + x-expandableFields: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - boleto + - card + - cashapp + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - klarna + - konbini + - link + - mobilepay + - oxxo + - p24 + - paynow + - paypal + - pix + - revolut_pay + - sepa_debit + - sofort + - swish + - us_bank_account + checkout_sofort_payment_method_options: description: '' properties: setup_future_usage: @@ -5667,6 +6418,19 @@ components: title: CheckoutSofortPaymentMethodOptions type: object x-expandableFields: [] + checkout_swish_payment_method_options: + description: '' + properties: + reference: + description: >- + The order reference that will be displayed to customers in the Swish + application. Defaults to the `id` of the Payment Intent. + maxLength: 5000 + nullable: true + type: string + title: CheckoutSwishPaymentMethodOptions + type: object + x-expandableFields: [] checkout_us_bank_account_payment_method_options: description: '' properties: @@ -5707,28 +6471,91 @@ components: type: object x-expandableFields: - financial_connections - connect_collection_transfer: - description: '' + climate.order: + description: >- + Orders represent your intent to purchase a particular Climate product. + When you create an order, the + + payment is deducted from your merchant balance. properties: - amount: - description: 'Amount transferred, in cents (or local equivalent).' + amount_fees: + description: >- + Total amount of [Frontier](https://frontierclimate.com/)'s service + fees in the currency's smallest unit. + type: integer + amount_subtotal: + description: Total amount of the carbon removal in the currency's smallest unit. + type: integer + amount_total: + description: >- + Total amount of the order including fees in the currency's smallest + unit. + type: integer + beneficiary: + $ref: '#/components/schemas/climate_removals_beneficiary' + canceled_at: + description: >- + Time at which the order was canceled. Measured in seconds since the + Unix epoch. + format: unix-time + nullable: true + type: integer + cancellation_reason: + description: Reason for the cancellation of this order. + enum: + - expired + - product_unavailable + - requested + nullable: true + type: string + x-stripeBypassValidation: true + certificate: + description: 'For delivered orders, a URL to a delivery certificate for the order.' + maxLength: 5000 + nullable: true + type: string + confirmed_at: + description: >- + Time at which the order was confirmed. Measured in seconds since the + Unix epoch. + format: unix-time + nullable: true + type: integer + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time type: integer 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). + lowercase, representing the currency for this order. + maxLength: 5000 type: string - destination: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/account' - description: ID of the account that funds are being collected for. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/account' + delayed_at: + description: >- + Time at which the order's expected_delivery_year was delayed. + Measured in seconds since the Unix epoch. + format: unix-time + nullable: true + type: integer + delivered_at: + description: >- + Time at which the order was delivered. Measured in seconds since the + Unix epoch. + format: unix-time + nullable: true + type: integer + delivery_details: + description: Details about the delivery of carbon removal for this order. + items: + $ref: '#/components/schemas/climate_removals_order_deliveries' + type: array + expected_delivery_year: + description: The year this order is expected to be delivered. + type: integer id: description: Unique identifier for the object. maxLength: 5000 @@ -5738,70 +6565,119 @@ components: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean + metadata: + additionalProperties: + maxLength: 500 + type: 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. + type: object + metric_tons: + description: Quantity of carbon removal that is included in this order. + format: decimal + type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - connect_collection_transfer + - climate.order + type: string + product: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/climate.product' + description: Unique ID for the Climate `Product` this order is purchasing. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/climate.product' + product_substituted_at: + description: >- + Time at which the order's product was substituted for a different + product. Measured in seconds since the Unix epoch. + format: unix-time + nullable: true + type: integer + status: + description: The current status of this order. + enum: + - awaiting_funds + - canceled + - confirmed + - delivered + - open type: string required: - - amount + - amount_fees + - amount_subtotal + - amount_total + - created - currency - - destination + - delivery_details + - expected_delivery_year - id - livemode + - metadata + - metric_tons - object - title: ConnectCollectionTransfer - type: object - x-expandableFields: - - destination - connect_embedded_account_session_create_components: - description: '' - properties: - account_onboarding: - $ref: '#/components/schemas/connect_embedded_base_config_claim' - required: - - account_onboarding - title: ConnectEmbeddedAccountSessionCreateComponents + - product + - status + title: ClimateRemovalsOrders type: object x-expandableFields: - - account_onboarding - connect_embedded_base_config_claim: - description: '' - properties: - enabled: - description: Whether the embedded component is enabled. - type: boolean - required: - - enabled - title: ConnectEmbeddedBaseConfigClaim - type: object - x-expandableFields: [] - country_spec: + - beneficiary + - delivery_details + - product + x-resourceId: climate.order + climate.product: description: >- - Stripe needs to collect certain pieces of information about each account - - created. These requirements can differ depending on the account's - country. The + A Climate product represents a type of carbon removal unit available for + reservation. - Country Specs API makes these rules available to your integration. - - - You can also view the information from this API call as [an online - - guide](/docs/connect/required-verification-information). + You can retrieve it to see the current price and availability. properties: - default_currency: + created: description: >- - The default currency for this country. This applies to both payment - methods and bank accounts. + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + current_prices_per_metric_ton: + additionalProperties: + $ref: '#/components/schemas/climate_removals_products_price' + description: >- + Current prices for a metric ton of carbon removal in a currency's + smallest unit. + type: object + delivery_year: + description: The year in which the carbon removal is expected to be delivered. + nullable: true + type: integer + id: + description: >- + Unique identifier for the object. For convenience, Climate product + IDs are human-readable strings + + that start with `climsku_`. See [carbon removal + inventory](https://stripe.com/docs/climate/orders/carbon-removal-inventory) + + for a list of available carbon removal products. maxLength: 5000 type: string - id: + livemode: description: >- - Unique identifier for the object. Represented as the ISO country - code for this country. + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + metric_tons_available: + description: The quantity of metric tons available for reservation. + format: decimal + type: string + name: + description: The Climate product's name. maxLength: 5000 type: string object: @@ -5809,324 +6685,218 @@ components: String representing the object's type. Objects of the same type share the same value. enum: - - country_spec + - climate.product type: string - supported_bank_account_currencies: - additionalProperties: - items: - maxLength: 5000 - type: string - type: array + suppliers: description: >- - Currencies that can be accepted in the specific country (for - transfers). - type: object - supported_payment_currencies: - description: >- - Currencies that can be accepted in the specified country (for - payments). - items: - maxLength: 5000 - type: string - type: array - supported_payment_methods: - description: >- - Payment methods available in the specified country. You may need to - enable some payment methods (e.g., - [ACH](https://stripe.com/docs/ach)) on your account before they - appear in this list. The `stripe` payment method refers to [charging - through your - platform](https://stripe.com/docs/connect/destination-charges). - items: - maxLength: 5000 - type: string - type: array - supported_transfer_countries: - description: Countries that can accept transfers from the specified country. + The carbon removal suppliers that fulfill orders for this Climate + product. items: - maxLength: 5000 - type: string + $ref: '#/components/schemas/climate.supplier' type: array - verification_fields: - $ref: '#/components/schemas/country_spec_verification_fields' required: - - default_currency + - created + - current_prices_per_metric_ton - id + - livemode + - metric_tons_available + - name - object - - supported_bank_account_currencies - - supported_payment_currencies - - supported_payment_methods - - supported_transfer_countries - - verification_fields - title: CountrySpec + - suppliers + title: ClimateRemovalsProducts type: object x-expandableFields: - - verification_fields - x-resourceId: country_spec - country_spec_verification_field_details: - description: '' + - current_prices_per_metric_ton + - suppliers + x-resourceId: climate.product + climate.supplier: + description: A supplier of carbon removal. properties: - additional: - description: Additional fields which are only required for some users. - items: - maxLength: 5000 - type: string - type: array - minimum: - description: Fields which every account must eventually provide. + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + info_url: + description: Link to a webpage to learn more about the supplier. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + locations: + description: The locations in which this supplier operates. items: - maxLength: 5000 - type: string + $ref: '#/components/schemas/climate_removals_location' type: array + name: + description: Name of this carbon removal supplier. + maxLength: 5000 + type: string + object: + description: >- + String representing the object’s type. Objects of the same type + share the same value. + enum: + - climate.supplier + type: string + removal_pathway: + description: The scientific pathway used for carbon removal. + enum: + - biomass_carbon_removal_and_storage + - direct_air_capture + - enhanced_weathering + type: string required: - - additional - - minimum - title: CountrySpecVerificationFieldDetails + - id + - info_url + - livemode + - locations + - name + - object + - removal_pathway + title: ClimateRemovalsSuppliers type: object - x-expandableFields: [] - country_spec_verification_fields: + x-expandableFields: + - locations + x-resourceId: climate.supplier + climate_removals_beneficiary: description: '' properties: - company: - $ref: '#/components/schemas/country_spec_verification_field_details' - individual: - $ref: '#/components/schemas/country_spec_verification_field_details' + public_name: + description: Publicly displayable name for the end beneficiary of carbon removal. + maxLength: 5000 + type: string required: - - company - - individual - title: CountrySpecVerificationFields + - public_name + title: ClimateRemovalsBeneficiary type: object - x-expandableFields: - - company - - individual - coupon: - description: >- - A coupon contains information about a percent-off or amount-off discount - you - - might want to apply to a customer. Coupons may be applied to - [subscriptions](https://stripe.com/docs/api#subscriptions), - [invoices](https://stripe.com/docs/api#invoices), - - [checkout sessions](https://stripe.com/docs/api/checkout/sessions), - [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not - work with conventional one-off - [charges](https://stripe.com/docs/api#create_charge) or [payment - intents](https://stripe.com/docs/api/payment_intents). + x-expandableFields: [] + climate_removals_location: + description: '' properties: - amount_off: - description: >- - Amount (in the `currency` specified) that will be taken off the - subtotal of any invoices for this customer. - nullable: true - type: integer - applies_to: - $ref: '#/components/schemas/coupon_applies_to' - created: - description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time - type: integer - 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. + city: + description: The city where the supplier is located. + maxLength: 5000 nullable: true type: string - currency_options: - additionalProperties: - $ref: '#/components/schemas/coupon_currency_option' - 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). - type: object - duration: - description: >- - One of `forever`, `once`, and `repeating`. Describes how long a - customer who applies this coupon will get the discount. - enum: - - forever - - once - - repeating - type: string - x-stripeBypassValidation: true - duration_in_months: + country: description: >- - If `duration` is `repeating`, the number of months the coupon - applies. Null if coupon `duration` is `forever` or `once`. - nullable: true - type: integer - id: - description: Unique identifier for the object. + Two-letter ISO code representing the country where the supplier is + located. maxLength: 5000 type: string - livemode: - description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. - type: boolean - max_redemptions: - description: >- - Maximum number of times this coupon can be redeemed, in total, - across all customers, before it is no longer valid. + latitude: + description: The geographic latitude where the supplier is located. nullable: true - type: integer - metadata: - additionalProperties: - maxLength: 500 - type: 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. + type: number + longitude: + description: The geographic longitude where the supplier is located. nullable: true - type: object - name: - description: >- - Name of the coupon displayed to customers on for instance invoices - or receipts. + type: number + region: + description: The state/county/province/region where the supplier is located. maxLength: 5000 nullable: true type: string - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - coupon - type: string - percent_off: + required: + - country + title: ClimateRemovalsLocation + type: object + x-expandableFields: [] + climate_removals_order_deliveries: + description: The delivery of a specified quantity of carbon for an order. + properties: + delivered_at: description: >- - Percent that will be taken off the subtotal of any invoices for this - customer for the duration of the coupon. For example, a coupon with - percent_off of 50 will make a $ (or local equivalent)100 invoice $ - (or local equivalent)50 instead. - nullable: true - type: number - redeem_by: - description: Date after which the coupon can no longer be redeemed. + Time at which the delivery occurred. Measured in seconds since the + Unix epoch. format: unix-time - nullable: true - type: integer - times_redeemed: - description: Number of times this coupon has been applied to a customer. type: integer - valid: + location: + anyOf: + - $ref: '#/components/schemas/climate_removals_location' + description: Specific location of this delivery. + nullable: true + metric_tons: + description: Quantity of carbon removal supplied by this delivery. + maxLength: 5000 + type: string + registry_url: description: >- - Taking account of the above properties, whether this coupon can - still be applied to a customer. - type: boolean + Once retired, a URL to the registry entry for the tons from this + delivery. + maxLength: 5000 + nullable: true + type: string + supplier: + $ref: '#/components/schemas/climate.supplier' required: - - created - - duration - - id - - livemode - - object - - times_redeemed - - valid - title: Coupon + - delivered_at + - metric_tons + - supplier + title: ClimateRemovalsOrderDeliveries type: object x-expandableFields: - - applies_to - - currency_options - x-resourceId: coupon - coupon_applies_to: - description: '' - properties: - products: - description: A list of product IDs this coupon applies to - items: - maxLength: 5000 - type: string - type: array - required: - - products - title: CouponAppliesTo - type: object - x-expandableFields: [] - coupon_currency_option: + - location + - supplier + climate_removals_products_price: description: '' properties: - amount_off: + amount_fees: description: >- - Amount (in the `currency` specified) that will be taken off the - subtotal of any invoices for this customer. + Fees for one metric ton of carbon removal in the currency's smallest + unit. + type: integer + amount_subtotal: + description: >- + Subtotal for one metric ton of carbon removal (excluding fees) in + the currency's smallest unit. + type: integer + amount_total: + description: >- + Total for one metric ton of carbon removal (including fees) in the + currency's smallest unit. type: integer required: - - amount_off - title: CouponCurrencyOption + - amount_fees + - amount_subtotal + - amount_total + title: ClimateRemovalsProductsPrice type: object x-expandableFields: [] - credit_note: + confirmation_token: description: >- - Issue a credit note to adjust an invoice's amount after the invoice is - finalized. + ConfirmationTokens help transport client side data collected by Stripe + JS over + to your server for confirming a PaymentIntent or SetupIntent. If the + confirmation - Related guide: [Credit - notes](https://stripe.com/docs/billing/invoices/credit-notes) + is successful, values present on the ConfirmationToken are written onto + the Intent. + + + To learn more about how to use ConfirmationToken, visit the related + guides: + + - [Finalize payments on the + server](https://stripe.com/docs/payments/finalize-payments-on-the-server) + + - [Build two-step + confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation). properties: - amount: - description: >- - The integer amount in cents (or local equivalent) representing the - total amount of the credit note, including tax. - type: integer - amount_shipping: - description: This is the sum of all the shipping amounts. - type: integer created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer - 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). - type: string - customer: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/customer' - - $ref: '#/components/schemas/deleted_customer' - description: ID of the customer. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/customer' - - $ref: '#/components/schemas/deleted_customer' - customer_balance_transaction: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/customer_balance_transaction' - description: Customer balance transaction related to this credit note. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/customer_balance_transaction' - discount_amount: - description: >- - The integer amount in cents (or local equivalent) representing the - total amount of discount that was credited. - type: integer - discount_amounts: - description: The aggregate amounts calculated per discount for all line items. - items: - $ref: '#/components/schemas/discounts_resource_discount_amount' - type: array - effective_at: + expires_at: description: >- - The date when this credit note is in effect. Same as `created` - unless overwritten. When defined, this value replaces the - system-generated 'Date of issue' printed on the credit note PDF. + Time at which this ConfirmationToken expires and can no longer be + used to confirm a PaymentIntent or SetupIntent. format: unix-time nullable: true type: integer @@ -6134,1156 +6904,781 @@ components: description: Unique identifier for the object. maxLength: 5000 type: string - invoice: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/invoice' - description: ID of the invoice. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/invoice' - lines: - description: Line items that make up the credit note - properties: - data: - description: Details about each object. - items: - $ref: '#/components/schemas/credit_note_line_item' - type: array - has_more: - description: >- - True if this list has another page of items after this one that - can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - type: string - required: - - data - - has_more - - object - - url - title: CreditNoteLinesList - type: object - x-expandableFields: - - data livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean - memo: - description: Customer-facing text that appears on the credit note PDF. - maxLength: 5000 - nullable: true - type: string - metadata: - additionalProperties: - maxLength: 500 - type: 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. + mandate_data: + anyOf: + - $ref: '#/components/schemas/confirmation_tokens_resource_mandate_data' + description: Data used for generating a Mandate. nullable: true - type: object - number: - description: >- - A unique number that identifies this particular credit note and - appears on the PDF of the credit note and its associated invoice. - maxLength: 5000 - type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - credit_note - type: string - out_of_band_amount: - description: Amount that was credited outside of Stripe. - nullable: true - type: integer - pdf: - description: The link to download the PDF of the credit note. - maxLength: 5000 + - confirmation_token type: string - reason: + payment_intent: description: >- - Reason for issuing this credit note, one of `duplicate`, - `fraudulent`, `order_change`, or `product_unsatisfactory` - enum: - - duplicate - - fraudulent - - order_change - - product_unsatisfactory + ID of the PaymentIntent that this ConfirmationToken was used to + confirm, or null if this ConfirmationToken has not yet been used. + maxLength: 5000 nullable: true type: string - refund: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/refund' - description: Refund related to this credit note. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/refund' - shipping_cost: + payment_method_preview: anyOf: - - $ref: '#/components/schemas/invoices_shipping_cost' + - $ref: >- + #/components/schemas/confirmation_tokens_resource_payment_method_preview description: >- - The details of the cost of shipping, including the ShippingRate - applied to the invoice. + Payment details collected by the Payment Element, used to create a + PaymentMethod when a PaymentIntent or SetupIntent is confirmed with + this ConfirmationToken. + nullable: true + return_url: + description: Return URL used to confirm the Intent. + maxLength: 5000 nullable: true - status: - description: >- - Status of this credit note, one of `issued` or `void`. Learn more - about [voiding credit - notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). - enum: - - issued - - void type: string - subtotal: - description: >- - The integer amount in cents (or local equivalent) representing the - amount of the credit note, excluding exclusive tax and invoice level - discounts. - type: integer - subtotal_excluding_tax: + setup_future_usage: description: >- - The integer amount in cents (or local equivalent) representing the - amount of the credit note, excluding all tax and invoice level - discounts. + Indicates that you intend to make future payments with this + ConfirmationToken's payment method. + + + The presence of this property will [attach the payment + method](https://stripe.com/docs/payments/save-during-payment) to the + PaymentIntent's Customer, if present, after the PaymentIntent is + confirmed and any required actions from the user are complete. + enum: + - off_session + - on_session nullable: true - type: integer - tax_amounts: - description: The aggregate amounts calculated per tax rate for all line items. - items: - $ref: '#/components/schemas/credit_note_tax_amount' - type: array - total: - description: >- - The integer amount in cents (or local equivalent) representing the - total amount of the credit note, including tax and all discount. - type: integer - total_excluding_tax: + type: string + setup_intent: description: >- - The integer amount in cents (or local equivalent) representing the - total amount of the credit note, excluding tax, but including - discounts. + ID of the SetupIntent that this ConfirmationToken was used to + confirm, or null if this ConfirmationToken has not yet been used. + maxLength: 5000 nullable: true - type: integer - type: - description: >- - Type of this credit note, one of `pre_payment` or `post_payment`. A - `pre_payment` credit note means it was issued when the invoice was - open. A `post_payment` credit note means it was issued when the - invoice was paid. - enum: - - post_payment - - pre_payment type: string - voided_at: - description: The time that the credit note was voided. - format: unix-time + shipping: + anyOf: + - $ref: '#/components/schemas/confirmation_tokens_resource_shipping' + description: Shipping information collected on this ConfirmationToken. nullable: true - type: integer + use_stripe_sdk: + description: >- + Indicates whether the Stripe SDK is used to handle confirmation + flow. Defaults to `true` on ConfirmationToken. + type: boolean required: - - amount - - amount_shipping - created - - currency - - customer - - discount_amount - - discount_amounts - id - - invoice - - lines - livemode - - number - object - - pdf - - status - - subtotal - - tax_amounts - - total - - type - title: CreditNote + - use_stripe_sdk + title: ConfirmationTokensResourceConfirmationToken type: object x-expandableFields: - - customer - - customer_balance_transaction - - discount_amounts - - invoice - - lines - - refund - - shipping_cost - - tax_amounts - x-resourceId: credit_note - credit_note_line_item: - description: The credit note line item object + - mandate_data + - payment_method_preview + - shipping + x-resourceId: confirmation_token + confirmation_tokens_resource_mandate_data: + description: Data used for generating a Mandate. properties: - amount: - description: >- - The integer amount in cents (or local equivalent) representing the - gross amount being credited for this line item, excluding - (exclusive) tax and discounts. - type: integer - amount_excluding_tax: + customer_acceptance: + $ref: >- + #/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance + required: + - customer_acceptance + title: ConfirmationTokensResourceMandateData + type: object + x-expandableFields: + - customer_acceptance + confirmation_tokens_resource_mandate_data_resource_customer_acceptance: + description: This hash contains details about the customer acceptance of the Mandate. + properties: + online: + anyOf: + - $ref: >- + #/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online description: >- - The integer amount in cents (or local equivalent) representing the - amount being credited for this line item, excluding all tax and - discounts. - nullable: true - type: integer - description: - description: Description of the item being credited. - maxLength: 5000 + If this is a Mandate accepted online, this hash contains details + about the online acceptance. nullable: true - type: string - discount_amount: + type: description: >- - The integer amount in cents (or local equivalent) representing the - discount being credited for this line item. - type: integer - discount_amounts: - description: The amount of discount calculated per discount for this line item - items: - $ref: '#/components/schemas/discounts_resource_discount_amount' - type: array - id: - description: Unique identifier for the object. + The type of customer acceptance information included with the + Mandate. maxLength: 5000 type: string - invoice_line_item: - description: ID of the invoice line item being credited + required: + - type + title: ConfirmationTokensResourceMandateDataResourceCustomerAcceptance + type: object + x-expandableFields: + - online + confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online: + description: This hash contains details about the online acceptance. + properties: + ip_address: + description: The IP address from which the Mandate was accepted by the customer. maxLength: 5000 + nullable: true type: string - livemode: - description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. - type: boolean - object: + user_agent: description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - credit_note_line_item - type: string - quantity: - description: The number of units of product being credited. + The user agent of the browser from which the Mandate was accepted by + the customer. + maxLength: 5000 nullable: true - type: integer - tax_amounts: - description: The amount of tax calculated per tax rate for this line item - items: - $ref: '#/components/schemas/credit_note_tax_amount' - type: array - tax_rates: - description: The tax rates which apply to the line item. - items: - $ref: '#/components/schemas/tax_rate' - type: array + type: string + title: >- + ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline + type: object + x-expandableFields: [] + confirmation_tokens_resource_payment_method_preview: + description: Details of the PaymentMethod collected by Payment Element + properties: + acss_debit: + $ref: '#/components/schemas/payment_method_acss_debit' + affirm: + $ref: '#/components/schemas/payment_method_affirm' + afterpay_clearpay: + $ref: '#/components/schemas/payment_method_afterpay_clearpay' + alipay: + $ref: '#/components/schemas/payment_flows_private_payment_methods_alipay' + amazon_pay: + $ref: '#/components/schemas/payment_method_amazon_pay' + au_becs_debit: + $ref: '#/components/schemas/payment_method_au_becs_debit' + bacs_debit: + $ref: '#/components/schemas/payment_method_bacs_debit' + bancontact: + $ref: '#/components/schemas/payment_method_bancontact' + billing_details: + $ref: '#/components/schemas/billing_details' + blik: + $ref: '#/components/schemas/payment_method_blik' + boleto: + $ref: '#/components/schemas/payment_method_boleto' + card: + $ref: '#/components/schemas/payment_method_card' + card_present: + $ref: '#/components/schemas/payment_method_card_present' + cashapp: + $ref: '#/components/schemas/payment_method_cashapp' + customer_balance: + $ref: '#/components/schemas/payment_method_customer_balance' + eps: + $ref: '#/components/schemas/payment_method_eps' + fpx: + $ref: '#/components/schemas/payment_method_fpx' + giropay: + $ref: '#/components/schemas/payment_method_giropay' + grabpay: + $ref: '#/components/schemas/payment_method_grabpay' + ideal: + $ref: '#/components/schemas/payment_method_ideal' + interac_present: + $ref: '#/components/schemas/payment_method_interac_present' + klarna: + $ref: '#/components/schemas/payment_method_klarna' + konbini: + $ref: '#/components/schemas/payment_method_konbini' + link: + $ref: '#/components/schemas/payment_method_link' + mobilepay: + $ref: '#/components/schemas/payment_method_mobilepay' + oxxo: + $ref: '#/components/schemas/payment_method_oxxo' + p24: + $ref: '#/components/schemas/payment_method_p24' + paynow: + $ref: '#/components/schemas/payment_method_paynow' + paypal: + $ref: '#/components/schemas/payment_method_paypal' + pix: + $ref: '#/components/schemas/payment_method_pix' + promptpay: + $ref: '#/components/schemas/payment_method_promptpay' + revolut_pay: + $ref: '#/components/schemas/payment_method_revolut_pay' + sepa_debit: + $ref: '#/components/schemas/payment_method_sepa_debit' + sofort: + $ref: '#/components/schemas/payment_method_sofort' + swish: + $ref: '#/components/schemas/payment_method_swish' type: description: >- - The type of the credit note line item, one of `invoice_line_item` or - `custom_line_item`. When the type is `invoice_line_item` there is an - additional `invoice_line_item` property on the resource the value of - which is the id of the credited line item on the invoice. + The type of the PaymentMethod. An additional hash is included on the + PaymentMethod with a name matching this value. It contains + additional information specific to the PaymentMethod type. enum: - - custom_line_item - - invoice_line_item - type: string - unit_amount: - description: The cost of each unit of product being credited. - nullable: true - type: integer - unit_amount_decimal: - description: >- - Same as `unit_amount`, but contains a decimal value with at most 12 - decimal places. - format: decimal - nullable: true - type: string - unit_amount_excluding_tax: - description: >- - The amount in cents (or local equivalent) representing the unit - amount being credited for this line item, excluding all tax and - discounts. - format: decimal - nullable: true + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - blik + - boleto + - card + - card_present + - cashapp + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - interac_present + - klarna + - konbini + - link + - mobilepay + - oxxo + - p24 + - paynow + - paypal + - pix + - promptpay + - revolut_pay + - sepa_debit + - sofort + - swish + - us_bank_account + - wechat_pay + - zip type: string + x-stripeBypassValidation: true + us_bank_account: + $ref: '#/components/schemas/payment_method_us_bank_account' + wechat_pay: + $ref: '#/components/schemas/payment_method_wechat_pay' + zip: + $ref: '#/components/schemas/payment_method_zip' required: - - amount - - discount_amount - - discount_amounts - - id - - livemode - - object - - tax_amounts - - tax_rates + - billing_details - type - title: CreditNoteLineItem + title: ConfirmationTokensResourcePaymentMethodPreview type: object x-expandableFields: - - discount_amounts - - tax_amounts - - tax_rates - x-resourceId: credit_note_line_item - credit_note_tax_amount: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - billing_details + - blik + - boleto + - card + - card_present + - cashapp + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - interac_present + - klarna + - konbini + - link + - mobilepay + - oxxo + - p24 + - paynow + - paypal + - pix + - promptpay + - revolut_pay + - sepa_debit + - sofort + - swish + - us_bank_account + - wechat_pay + - zip + confirmation_tokens_resource_shipping: description: '' properties: - amount: - description: 'The amount, in cents (or local equivalent), of the tax.' - type: integer - inclusive: - description: Whether this tax amount is inclusive or exclusive. - type: boolean - tax_rate: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/tax_rate' - description: The tax rate that was applied to get this tax amount. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/tax_rate' - taxability_reason: - description: >- - The reasoning behind this tax, for example, if the product is tax - exempt. The possible values for this field may be extended as new - tax rules are supported. - enum: - - customer_exempt - - not_collecting - - not_subject_to_tax - - not_supported - - portion_product_exempt - - portion_reduced_rated - - portion_standard_rated - - product_exempt - - product_exempt_holiday - - proportionally_rated - - reduced_rated - - reverse_charge - - standard_rated - - taxable_basis_reduced - - zero_rated - nullable: true + address: + $ref: '#/components/schemas/address' + name: + description: Recipient name. + maxLength: 5000 type: string - x-stripeBypassValidation: true - taxable_amount: - description: >- - The amount on which tax is calculated, in cents (or local - equivalent). + phone: + description: Recipient phone (including extension). + maxLength: 5000 nullable: true - type: integer + type: string required: - - amount - - inclusive - - tax_rate - title: CreditNoteTaxAmount + - address + - name + title: ConfirmationTokensResourceShipping type: object x-expandableFields: - - tax_rate - currency_option: + - address + connect_account_reference: description: '' properties: - custom_unit_amount: + account: anyOf: - - $ref: '#/components/schemas/custom_unit_amount' - description: >- - When set, provides configuration for the amount to be adjusted by - the customer during Checkout Sessions and Payment Links. - nullable: true - tax_behavior: - description: >- - Only required if a [default tax - behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) - was not provided in the Stripe Tax settings. Specifies whether the - price is considered inclusive of taxes or exclusive of taxes. One of - `inclusive`, `exclusive`, or `unspecified`. Once specified as either - `inclusive` or `exclusive`, it cannot be changed. + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/account' + description: The connected account being referenced when `type` is `account`. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/account' + type: + description: Type of the account referenced. enum: - - exclusive - - inclusive - - unspecified - nullable: true - type: string - tiers: - description: >- - Each element represents a pricing tier. This parameter requires - `billing_scheme` to be set to `tiered`. See also the documentation - for `billing_scheme`. - items: - $ref: '#/components/schemas/price_tier' - type: array - unit_amount: - description: >- - The unit amount in cents (or local equivalent) to be charged, - represented as a whole integer if possible. Only set if - `billing_scheme=per_unit`. - nullable: true - type: integer - unit_amount_decimal: - description: >- - The unit amount in cents (or local equivalent) to be charged, - represented as a decimal string with at most 12 decimal places. Only - set if `billing_scheme=per_unit`. - format: decimal - nullable: true + - account + - self type: string - title: CurrencyOption + required: + - type + title: ConnectAccountReference type: object x-expandableFields: - - custom_unit_amount - - tiers - custom_unit_amount: + - account + connect_collection_transfer: description: '' properties: - maximum: - description: The maximum unit amount the customer can specify for this item. - nullable: true - type: integer - minimum: - description: >- - The minimum unit amount the customer can specify for this item. Must - be at least the minimum charge amount. - nullable: true - type: integer - preset: - description: The starting unit amount which can be updated by the customer. - nullable: true - type: integer - title: CustomUnitAmount - type: object - x-expandableFields: [] - customer: - description: >- - This object represents a customer of your business. Use it to create - recurring charges and track payments that belong to the same customer. - - - Related guide: [Save a card during - payment](https://stripe.com/docs/payments/save-during-payment) - properties: - address: - anyOf: - - $ref: '#/components/schemas/address' - description: The customer's address. - nullable: true - balance: - description: >- - The current balance, if any, that's stored on the customer. If - negative, the customer has credit to apply to their next invoice. If - positive, the customer has an amount owed that's added to their next - invoice. The balance only considers amounts that Stripe hasn't - successfully applied to any invoice. It doesn't reflect unpaid - invoices. This balance is only taken into account after invoices - finalize. - type: integer - cash_balance: - anyOf: - - $ref: '#/components/schemas/cash_balance' - description: >- - The current funds being held by Stripe on behalf of the customer. - You can apply these funds towards payment intents when the source is - "cash_balance". The `settings[reconciliation_mode]` field describes - if these funds apply to these payment intents manually or - automatically. - nullable: true - created: - description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time + amount: + description: 'Amount transferred, in cents (or local equivalent).' type: integer currency: description: >- - Three-letter [ISO code for the - currency](https://stripe.com/docs/currencies) the customer can be - charged in for recurring billing purposes. - maxLength: 5000 - nullable: true + Three-letter [ISO currency + code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). type: string - default_source: + destination: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/bank_account' - - $ref: '#/components/schemas/card' - - $ref: '#/components/schemas/source' - description: >- - ID of the default payment source for the customer. - - - If you use payment methods created through the PaymentMethods API, - see the - [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) - field instead. - nullable: true + - $ref: '#/components/schemas/account' + description: ID of the account that funds are being collected for. x-expansionResources: oneOf: - - $ref: '#/components/schemas/bank_account' - - $ref: '#/components/schemas/card' - - $ref: '#/components/schemas/source' - x-stripeBypassValidation: true - delinquent: - description: >- - Tracks the most recent state change on any invoice belonging to the - customer. Paying an invoice or marking it uncollectible via the API - will set this field to false. An automatic payment failure or - passing the `invoice.due_date` will set this field to `true`. - - - If an invoice becomes uncollectible by - [dunning](https://stripe.com/docs/billing/automatic-collection), - `delinquent` doesn't reset to `false`. - - - If you care whether the customer has paid their most recent - subscription invoice, use `subscription.status` instead. Paying or - marking uncollectible any customer invoice regardless of whether it - is the latest invoice for a subscription will always set this field - to `false`. - nullable: true - type: boolean - description: - description: >- - An arbitrary string attached to the object. Often useful for - displaying to users. - maxLength: 5000 - nullable: true - type: string - discount: - anyOf: - - $ref: '#/components/schemas/discount' - description: >- - Describes the current discount active on the customer, if there is - one. - nullable: true - email: - description: The customer's email address. - maxLength: 5000 - nullable: true - type: string + - $ref: '#/components/schemas/account' id: description: Unique identifier for the object. maxLength: 5000 type: string - invoice_credit_balance: - additionalProperties: - type: integer - description: >- - The current multi-currency balances, if any, that's stored on the - customer. If positive in a currency, the customer has a credit to - apply to their next invoice denominated in that currency. If - negative, the customer has an amount owed that's added to their next - invoice denominated in that currency. These balances don't apply to - unpaid invoices. They solely track amounts that Stripe hasn't - successfully applied to any invoice. Stripe only applies a balance - in a specific currency to an invoice after that invoice (which is in - the same currency) finalizes. - type: object - invoice_prefix: - description: The prefix for the customer used to generate unique invoice numbers. - maxLength: 5000 - nullable: true - type: string - invoice_settings: - $ref: '#/components/schemas/invoice_setting_customer_setting' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean - metadata: - additionalProperties: - maxLength: 500 - type: 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. - type: object - name: - description: The customer's full name or business name. - maxLength: 5000 - nullable: true - type: string - next_invoice_sequence: - description: >- - The suffix of the customer's next invoice number (for example, - 0001). - type: integer object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - customer - type: string - phone: - description: The customer's phone number. - maxLength: 5000 - nullable: true + - connect_collection_transfer type: string - preferred_locales: - description: 'The customer''s preferred locales (languages), ordered by preference.' - items: - maxLength: 5000 - type: string - nullable: true - type: array - shipping: - anyOf: - - $ref: '#/components/schemas/shipping' - description: >- - Mailing and shipping address for the customer. Appears on invoices - emailed to this customer. - nullable: true - sources: - description: 'The customer''s payment sources, if any.' - properties: - data: - description: Details about each object. - items: - anyOf: - - $ref: '#/components/schemas/bank_account' - - $ref: '#/components/schemas/card' - - $ref: '#/components/schemas/source' - title: Polymorphic - x-stripeBypassValidation: true - type: array - has_more: - description: >- - True if this list has another page of items after this one that - can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - type: string - required: - - data - - has_more - - object - - url - title: ApmsSourcesSourceList - type: object - x-expandableFields: - - data - subscriptions: - description: 'The customer''s current subscriptions, if any.' - properties: - data: - description: Details about each object. - items: - $ref: '#/components/schemas/subscription' - type: array - has_more: - description: >- - True if this list has another page of items after this one that - can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - type: string - required: - - data - - has_more - - object - - url - title: SubscriptionList - type: object - x-expandableFields: - - data - tax: - $ref: '#/components/schemas/customer_tax' - tax_exempt: - description: >- - Describes the customer's tax exemption status, which is `none`, - `exempt`, or `reverse`. When set to `reverse`, invoice and receipt - PDFs include the following text: **"Reverse charge"**. - enum: - - exempt - - none - - reverse - nullable: true - type: string - tax_ids: - description: The customer's tax IDs. - properties: - data: - description: Details about each object. - items: - $ref: '#/components/schemas/tax_id' - type: array - has_more: - description: >- - True if this list has another page of items after this one that - can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - type: string - required: - - data - - has_more - - object - - url - title: TaxIDsList - type: object - x-expandableFields: - - data - test_clock: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/test_helpers.test_clock' - description: ID of the test clock that this customer belongs to. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/test_helpers.test_clock' required: - - created + - amount + - currency + - destination - id - livemode - object - title: Customer + title: ConnectCollectionTransfer type: object x-expandableFields: - - address - - cash_balance - - default_source - - discount - - invoice_settings - - shipping - - sources - - subscriptions - - tax - - tax_ids - - test_clock - x-resourceId: customer - customer_acceptance: + - destination + connect_embedded_account_config_claim: description: '' properties: - accepted_at: - description: The time that the customer accepts the mandate. - format: unix-time - nullable: true - type: integer - offline: - $ref: '#/components/schemas/offline_acceptance' - online: - $ref: '#/components/schemas/online_acceptance' - type: - description: >- - The mandate includes the type of customer acceptance information, - such as: `online` or `offline`. - enum: - - offline - - online - type: string + enabled: + description: Whether the embedded component is enabled. + type: boolean + features: + $ref: '#/components/schemas/connect_embedded_account_features_claim' required: - - type - title: customer_acceptance + - enabled + - features + title: ConnectEmbeddedAccountConfigClaim type: object x-expandableFields: - - offline - - online - customer_balance_customer_balance_settings: + - features + connect_embedded_account_features_claim: description: '' properties: - reconciliation_mode: + external_account_collection: description: >- - The configuration for how funds that land in the customer cash - balance are reconciled. - enum: - - automatic - - manual - type: string - using_merchant_default: - description: >- - A flag to indicate if reconciliation mode returned is the user's - default or is specific to this customer cash balance + Whether to allow platforms to control bank account collection for + their connected accounts. This feature can only be false for custom + accounts (or accounts where the platform is compliance owner). + Otherwise, bank account collection is determined by compliance + requirements. type: boolean required: - - reconciliation_mode - - using_merchant_default - title: CustomerBalanceCustomerBalanceSettings + - external_account_collection + title: ConnectEmbeddedAccountFeaturesClaim type: object x-expandableFields: [] - customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft: + connect_embedded_account_session_create_components: description: '' properties: - balance_transaction: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/balance_transaction' - description: >- - The [Balance - Transaction](https://stripe.com/docs/api/balance_transactions/object) - that corresponds to funds taken out of your Stripe balance. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/balance_transaction' - linked_transaction: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/customer_cash_balance_transaction' - description: >- - The [Cash Balance - Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) - that brought the customer balance negative, triggering the clawback - of funds. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/customer_cash_balance_transaction' + account_management: + $ref: '#/components/schemas/connect_embedded_account_config_claim' + account_onboarding: + $ref: '#/components/schemas/connect_embedded_account_config_claim' + balances: + $ref: '#/components/schemas/connect_embedded_payouts_config_claim' + documents: + $ref: '#/components/schemas/connect_embedded_base_config_claim' + notification_banner: + $ref: '#/components/schemas/connect_embedded_account_config_claim' + payment_details: + $ref: '#/components/schemas/connect_embedded_payments_config_claim' + payments: + $ref: '#/components/schemas/connect_embedded_payments_config_claim' + payouts: + $ref: '#/components/schemas/connect_embedded_payouts_config_claim' + payouts_list: + $ref: '#/components/schemas/connect_embedded_base_config_claim' required: - - balance_transaction - - linked_transaction - title: >- - CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft + - account_management + - account_onboarding + - balances + - documents + - notification_banner + - payment_details + - payments + - payouts + - payouts_list + title: ConnectEmbeddedAccountSessionCreateComponents type: object x-expandableFields: - - balance_transaction - - linked_transaction - customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction: + - account_management + - account_onboarding + - balances + - documents + - notification_banner + - payment_details + - payments + - payouts + - payouts_list + connect_embedded_base_config_claim: description: '' properties: - payment_intent: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/payment_intent' - description: >- - The [Payment - Intent](https://stripe.com/docs/api/payment_intents/object) that - funds were applied to. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/payment_intent' + enabled: + description: Whether the embedded component is enabled. + type: boolean + features: + $ref: '#/components/schemas/connect_embedded_base_features' required: - - payment_intent - title: >- - CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction + - enabled + - features + title: ConnectEmbeddedBaseConfigClaim type: object x-expandableFields: - - payment_intent - customer_balance_resource_cash_balance_transaction_resource_funded_transaction: + - features + connect_embedded_base_features: description: '' - properties: - bank_transfer: - $ref: >- - #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer - required: - - bank_transfer - title: CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction + properties: {} + title: ConnectEmbeddedBaseFeatures type: object - x-expandableFields: - - bank_transfer - customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer: + x-expandableFields: [] + connect_embedded_payments_config_claim: description: '' properties: - eu_bank_transfer: - $ref: >- - #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer - gb_bank_transfer: - $ref: >- - #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer - jp_bank_transfer: - $ref: >- - #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer - reference: - description: The user-supplied reference field on the bank transfer. - maxLength: 5000 - nullable: true - type: string - type: - description: >- - The funding method type used to fund the customer balance. Permitted - values include: `eu_bank_transfer`, `gb_bank_transfer`, - `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. - enum: - - eu_bank_transfer - - gb_bank_transfer - - jp_bank_transfer - - mx_bank_transfer - - us_bank_transfer - type: string - x-stripeBypassValidation: true - us_bank_transfer: - $ref: >- - #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer + enabled: + description: Whether the embedded component is enabled. + type: boolean + features: + $ref: '#/components/schemas/connect_embedded_payments_features' required: - - type - title: >- - CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransfer + - enabled + - features + title: ConnectEmbeddedPaymentsConfigClaim type: object x-expandableFields: - - eu_bank_transfer - - gb_bank_transfer - - jp_bank_transfer - - us_bank_transfer - customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer: - description: '' - properties: - bic: - description: The BIC of the bank of the sender of the funding. - maxLength: 5000 - nullable: true - type: string - iban_last4: - description: The last 4 digits of the IBAN of the sender of the funding. - maxLength: 5000 - nullable: true - type: string - sender_name: - description: 'The full name of the sender, as supplied by the sending bank.' - maxLength: 5000 - nullable: true - type: string - title: >- - CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer - type: object - x-expandableFields: [] - customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer: + - features + connect_embedded_payments_features: description: '' properties: - account_number_last4: + capture_payments: description: >- - The last 4 digits of the account number of the sender of the - funding. - maxLength: 5000 - nullable: true - type: string - sender_name: - description: 'The full name of the sender, as supplied by the sending bank.' - maxLength: 5000 - nullable: true - type: string - sort_code: - description: The sort code of the bank of the sender of the funding - maxLength: 5000 - nullable: true - type: string - title: >- - CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer - type: object - x-expandableFields: [] - customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer: - description: '' - properties: - sender_bank: - description: The name of the bank of the sender of the funding. - maxLength: 5000 - nullable: true - type: string - sender_branch: - description: The name of the bank branch of the sender of the funding. - maxLength: 5000 - nullable: true - type: string - sender_name: - description: 'The full name of the sender, as supplied by the sending bank.' - maxLength: 5000 - nullable: true - type: string - title: >- - CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer - type: object - x-expandableFields: [] - customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer: - description: '' - properties: - network: - description: The banking network used for this funding. - enum: - - ach - - domestic_wire_us - - swift - type: string - sender_name: - description: 'The full name of the sender, as supplied by the sending bank.' - maxLength: 5000 - nullable: true - type: string - title: >- - CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer + Whether to allow capturing and cancelling payment intents. This is + `true` by default. + type: boolean + destination_on_behalf_of_charge_management: + description: >- + Whether to allow connected accounts to manage destination charges + that are created on behalf of them. This is `false` by default. + type: boolean + dispute_management: + description: >- + Whether to allow responding to disputes, including submitting + evidence and accepting disputes. This is `true` by default. + type: boolean + refund_management: + description: Whether to allow sending refunds. This is `true` by default. + type: boolean + required: + - capture_payments + - destination_on_behalf_of_charge_management + - dispute_management + - refund_management + title: ConnectEmbeddedPaymentsFeatures type: object x-expandableFields: [] - customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction: + connect_embedded_payouts_config_claim: description: '' properties: - refund: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/refund' - description: >- - The [Refund](https://stripe.com/docs/api/refunds/object) that moved - these funds into the customer's cash balance. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/refund' + enabled: + description: Whether the embedded component is enabled. + type: boolean + features: + $ref: '#/components/schemas/connect_embedded_payouts_features' required: - - refund - title: >- - CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction + - enabled + - features + title: ConnectEmbeddedPayoutsConfigClaim type: object x-expandableFields: - - refund - customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction: + - features + connect_embedded_payouts_features: description: '' properties: - payment_intent: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/payment_intent' + edit_payout_schedule: description: >- - The [Payment - Intent](https://stripe.com/docs/api/payment_intents/object) that - funds were unapplied from. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/payment_intent' + Whether to allow payout schedule to be changed. Default `true` when + Stripe owns Loss Liability, default `false` otherwise. + type: boolean + instant_payouts: + description: >- + Whether to allow creation of instant payouts. Default `true` when + Stripe owns Loss Liability, default `false` otherwise. + type: boolean + standard_payouts: + description: >- + Whether to allow creation of standard payouts. Default `true` when + Stripe owns Loss Liability, default `false` otherwise. + type: boolean required: - - payment_intent - title: >- - CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction + - edit_payout_schedule + - instant_payouts + - standard_payouts + title: ConnectEmbeddedPayoutsFeatures type: object - x-expandableFields: - - payment_intent - customer_balance_transaction: + x-expandableFields: [] + country_spec: description: >- - Each customer has a - [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) - value, + Stripe needs to collect certain pieces of information about each account - which denotes a debit or credit that's automatically applied to their - next invoice upon finalization. + created. These requirements can differ depending on the account's + country. The - You may modify the value directly by using the [update customer - API](https://stripe.com/docs/api/customers/update), + Country Specs API makes these rules available to your integration. - or by creating a Customer Balance Transaction, which increments or - decrements the customer's `balance` by the specified `amount`. + You can also view the information from this API call as [an online - Related guide: [Customer - balance](https://stripe.com/docs/billing/customer/balance) + guide](/docs/connect/required-verification-information). properties: - amount: + default_currency: description: >- - The amount of the transaction. A negative value is a credit for the - customer's balance, and a positive value is a debit to the - customer's `balance`. - type: integer - created: + The default currency for this country. This applies to both payment + methods and bank accounts. + maxLength: 5000 + type: string + id: description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time - type: integer - credit_note: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/credit_note' - description: The ID of the credit note (if any) related to the transaction. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/credit_note' - currency: + Unique identifier for the object. Represented as the ISO country + code for this country. + maxLength: 5000 + type: string + object: description: >- - Three-letter [ISO currency - code](https://www.iso.org/iso-4217-currency-codes.html), in - lowercase. Must be a [supported - currency](https://stripe.com/docs/currencies). + String representing the object's type. Objects of the same type + share the same value. + enum: + - country_spec type: string - customer: - anyOf: - - maxLength: 5000 + supported_bank_account_currencies: + additionalProperties: + items: + maxLength: 5000 type: string - - $ref: '#/components/schemas/customer' - description: The ID of the customer the transaction belongs to. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/customer' - description: + type: array description: >- - An arbitrary string attached to the object. Often useful for - displaying to users. - maxLength: 5000 + Currencies that can be accepted in the specific country (for + transfers). + type: object + supported_payment_currencies: + description: >- + Currencies that can be accepted in the specified country (for + payments). + items: + maxLength: 5000 + type: string + type: array + supported_payment_methods: + description: >- + Payment methods available in the specified country. You may need to + enable some payment methods (e.g., + [ACH](https://stripe.com/docs/ach)) on your account before they + appear in this list. The `stripe` payment method refers to [charging + through your + platform](https://stripe.com/docs/connect/destination-charges). + items: + maxLength: 5000 + type: string + type: array + supported_transfer_countries: + description: Countries that can accept transfers from the specified country. + items: + maxLength: 5000 + type: string + type: array + verification_fields: + $ref: '#/components/schemas/country_spec_verification_fields' + required: + - default_currency + - id + - object + - supported_bank_account_currencies + - supported_payment_currencies + - supported_payment_methods + - supported_transfer_countries + - verification_fields + title: CountrySpec + type: object + x-expandableFields: + - verification_fields + x-resourceId: country_spec + country_spec_verification_field_details: + description: '' + properties: + additional: + description: Additional fields which are only required for some users. + items: + maxLength: 5000 + type: string + type: array + minimum: + description: Fields which every account must eventually provide. + items: + maxLength: 5000 + type: string + type: array + required: + - additional + - minimum + title: CountrySpecVerificationFieldDetails + type: object + x-expandableFields: [] + country_spec_verification_fields: + description: '' + properties: + company: + $ref: '#/components/schemas/country_spec_verification_field_details' + individual: + $ref: '#/components/schemas/country_spec_verification_field_details' + required: + - company + - individual + title: CountrySpecVerificationFields + type: object + x-expandableFields: + - company + - individual + coupon: + description: >- + A coupon contains information about a percent-off or amount-off discount + you + + might want to apply to a customer. Coupons may be applied to + [subscriptions](https://stripe.com/docs/api#subscriptions), + [invoices](https://stripe.com/docs/api#invoices), + + [checkout sessions](https://stripe.com/docs/api/checkout/sessions), + [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not + work with conventional one-off + [charges](https://stripe.com/docs/api#create_charge) or [payment + intents](https://stripe.com/docs/api/payment_intents). + properties: + amount_off: + description: >- + Amount (in the `currency` specified) that will be taken off the + subtotal of any invoices for this customer. + nullable: true + type: integer + applies_to: + $ref: '#/components/schemas/coupon_applies_to' + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + 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. nullable: true type: string - ending_balance: + currency_options: + additionalProperties: + $ref: '#/components/schemas/coupon_currency_option' description: >- - The customer's `balance` after the transaction was applied. A - negative value decreases the amount due on the customer's next - invoice. A positive value increases the amount due on the customer's - next invoice. + 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). + type: object + duration: + description: >- + One of `forever`, `once`, and `repeating`. Describes how long a + customer who applies this coupon will get the discount. + enum: + - forever + - once + - repeating + type: string + x-stripeBypassValidation: true + duration_in_months: + description: >- + If `duration` is `repeating`, the number of months the coupon + applies. Null if coupon `duration` is `forever` or `once`. + nullable: true type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string - invoice: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/invoice' - description: The ID of the invoice (if any) related to the transaction. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/invoice' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean + max_redemptions: + description: >- + Maximum number of times this coupon can be redeemed, in total, + across all customers, before it is no longer valid. + nullable: true + type: integer metadata: additionalProperties: maxLength: 500 @@ -7294,69 +7689,99 @@ components: additional information about the object in a structured format. nullable: true type: object + name: + description: >- + Name of the coupon displayed to customers on for instance invoices + or receipts. + maxLength: 5000 + nullable: true + type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - customer_balance_transaction + - coupon type: string - type: + percent_off: description: >- - Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, - `initial`, `invoice_overpaid`, `invoice_too_large`, - `invoice_too_small`, `unspent_receiver_credit`, or - `unapplied_from_invoice`. See the [Customer Balance - page](https://stripe.com/docs/billing/customer/balance#types) to - learn more about transaction types. - enum: - - adjustment - - applied_to_invoice - - credit_note - - initial - - invoice_overpaid - - invoice_too_large - - invoice_too_small - - migration - - unapplied_from_invoice - - unspent_receiver_credit - type: string + Percent that will be taken off the subtotal of any invoices for this + customer for the duration of the coupon. For example, a coupon with + percent_off of 50 will make a $ (or local equivalent)100 invoice $ + (or local equivalent)50 instead. + nullable: true + type: number + redeem_by: + description: Date after which the coupon can no longer be redeemed. + format: unix-time + nullable: true + type: integer + times_redeemed: + description: Number of times this coupon has been applied to a customer. + type: integer + valid: + description: >- + Taking account of the above properties, whether this coupon can + still be applied to a customer. + type: boolean required: - - amount - created - - currency - - customer - - ending_balance + - duration - id - livemode - object - - type - title: CustomerBalanceTransaction + - times_redeemed + - valid + title: Coupon type: object x-expandableFields: - - credit_note - - customer - - invoice - x-resourceId: customer_balance_transaction - customer_cash_balance_transaction: + - applies_to + - currency_options + x-resourceId: coupon + coupon_applies_to: + description: '' + properties: + products: + description: A list of product IDs this coupon applies to + items: + maxLength: 5000 + type: string + type: array + required: + - products + title: CouponAppliesTo + type: object + x-expandableFields: [] + coupon_currency_option: + description: '' + properties: + amount_off: + description: >- + Amount (in the `currency` specified) that will be taken off the + subtotal of any invoices for this customer. + type: integer + required: + - amount_off + title: CouponCurrencyOption + type: object + x-expandableFields: [] + credit_note: description: >- - Customers with certain payments enabled have a cash balance, - representing funds that were paid - - by the customer to a merchant, but have not yet been allocated to a - payment. Cash Balance Transactions + Issue a credit note to adjust an invoice's amount after the invoice is + finalized. - represent when funds are moved into or out of this balance. This - includes funding by the customer, allocation - to payments, and refunds to the customer. + Related guide: [Credit + notes](https://stripe.com/docs/billing/invoices/credit-notes) properties: - adjusted_for_overdraft: - $ref: >- - #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft - applied_to_payment: - $ref: >- - #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction + amount: + description: >- + The integer amount in cents (or local equivalent) representing the + total amount of the credit note, including tax. + type: integer + amount_shipping: + description: This is the sum of all the shipping amounts. + type: integer created: description: >- Time at which the object was created. Measured in seconds since the @@ -7369,1045 +7794,1174 @@ components: code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). - maxLength: 5000 type: string customer: anyOf: - maxLength: 5000 type: string - $ref: '#/components/schemas/customer' - description: >- - The customer whose available cash balance changed as a result of - this transaction. + - $ref: '#/components/schemas/deleted_customer' + description: ID of the customer. x-expansionResources: oneOf: - $ref: '#/components/schemas/customer' - ending_balance: + - $ref: '#/components/schemas/deleted_customer' + customer_balance_transaction: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/customer_balance_transaction' + description: Customer balance transaction related to this credit note. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/customer_balance_transaction' + discount_amount: description: >- - The total available cash balance for the specified currency after - this transaction was applied. Represented in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + The integer amount in cents (or local equivalent) representing the + total amount of discount that was credited. + type: integer + discount_amounts: + description: The aggregate amounts calculated per discount for all line items. + items: + $ref: '#/components/schemas/discounts_resource_discount_amount' + type: array + effective_at: + description: >- + The date when this credit note is in effect. Same as `created` + unless overwritten. When defined, this value replaces the + system-generated 'Date of issue' printed on the credit note PDF. + format: unix-time + nullable: true type: integer - funded: - $ref: >- - #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction id: description: Unique identifier for the object. maxLength: 5000 type: string + invoice: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/invoice' + description: ID of the invoice. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/invoice' + lines: + description: Line items that make up the credit note + properties: + data: + description: Details about each object. + items: + $ref: '#/components/schemas/credit_note_line_item' + type: array + has_more: + description: >- + True if this list has another page of items after this one that + can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: CreditNoteLinesList + type: object + x-expandableFields: + - data livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean - net_amount: + memo: + description: Customer-facing text that appears on the credit note PDF. + maxLength: 5000 + nullable: true + type: string + metadata: + additionalProperties: + maxLength: 500 + type: string description: >- - The amount by which the cash balance changed, represented in the - [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). A positive - value represents funds being added to the cash balance, a negative - value represents funds being removed from the cash balance. - type: integer + 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. + nullable: true + type: object + number: + description: >- + A unique number that identifies this particular credit note and + appears on the PDF of the credit note and its associated invoice. + maxLength: 5000 + type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - customer_cash_balance_transaction + - credit_note type: string - refunded_from_payment: - $ref: >- - #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction - type: + out_of_band_amount: + description: Amount that was credited outside of Stripe. + nullable: true + type: integer + pdf: + description: The link to download the PDF of the credit note. + maxLength: 5000 + type: string + reason: description: >- - The type of the cash balance transaction. New types may be added in - future. See [Customer - Balance](https://stripe.com/docs/payments/customer-balance#types) to - learn more about these types. + Reason for issuing this credit note, one of `duplicate`, + `fraudulent`, `order_change`, or `product_unsatisfactory` enum: - - adjusted_for_overdraft - - applied_to_payment - - funded - - funding_reversed - - refunded_from_payment - - return_canceled - - return_initiated - - transferred_to_balance - - unapplied_from_payment + - duplicate + - fraudulent + - order_change + - product_unsatisfactory + nullable: true type: string - unapplied_from_payment: - $ref: >- - #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction - required: - - created - - currency - - customer - - ending_balance - - id - - livemode - - net_amount - - object - - type - title: CustomerCashBalanceTransaction - type: object - x-expandableFields: - - adjusted_for_overdraft - - applied_to_payment - - customer - - funded - - refunded_from_payment - - unapplied_from_payment - x-resourceId: customer_cash_balance_transaction - customer_tax: - description: '' - properties: - automatic_tax: + refund: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/refund' + description: Refund related to this credit note. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/refund' + shipping_cost: + anyOf: + - $ref: '#/components/schemas/invoices_resource_shipping_cost' description: >- - Surfaces if automatic tax computation is possible given the current - customer location information. + The details of the cost of shipping, including the ShippingRate + applied to the invoice. + nullable: true + status: + description: >- + Status of this credit note, one of `issued` or `void`. Learn more + about [voiding credit + notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding). enum: - - failed - - not_collecting - - supported - - unrecognized_location + - issued + - void type: string - ip_address: + x-stripeBypassValidation: true + subtotal: description: >- - A recent IP address of the customer used for tax reporting and tax - location inference. - maxLength: 5000 + The integer amount in cents (or local equivalent) representing the + amount of the credit note, excluding exclusive tax and invoice level + discounts. + type: integer + subtotal_excluding_tax: + description: >- + The integer amount in cents (or local equivalent) representing the + amount of the credit note, excluding all tax and invoice level + discounts. nullable: true - type: string - location: - anyOf: - - $ref: '#/components/schemas/customer_tax_location' - description: The customer's location as identified by Stripe Tax. - nullable: true - required: - - automatic_tax - title: CustomerTax - type: object - x-expandableFields: - - location - customer_tax_location: - description: '' - properties: - country: - description: The customer's country as identified by Stripe Tax. - maxLength: 5000 - type: string - source: - description: The data source used to infer the customer's location. - enum: - - billing_address - - ip_address - - payment_method - - shipping_destination - type: string - state: + type: integer + tax_amounts: + description: The aggregate amounts calculated per tax rate for all line items. + items: + $ref: '#/components/schemas/credit_note_tax_amount' + type: array + total: description: >- - The customer's state, county, province, or region as identified by - Stripe Tax. - maxLength: 5000 + The integer amount in cents (or local equivalent) representing the + total amount of the credit note, including tax and all discount. + type: integer + total_excluding_tax: + description: >- + The integer amount in cents (or local equivalent) representing the + total amount of the credit note, excluding tax, but including + discounts. nullable: true - type: string - required: - - country - - source - title: CustomerTaxLocation - type: object - x-expandableFields: [] - deleted_account: - description: '' - properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - object: + type: integer + type: description: >- - String representing the object's type. Objects of the same type - share the same value. + Type of this credit note, one of `pre_payment` or `post_payment`. A + `pre_payment` credit note means it was issued when the invoice was + open. A `post_payment` credit note means it was issued when the + invoice was paid. enum: - - account + - post_payment + - pre_payment type: string + voided_at: + description: The time that the credit note was voided. + format: unix-time + nullable: true + type: integer required: - - deleted + - amount + - amount_shipping + - created + - currency + - customer + - discount_amount + - discount_amounts - id + - invoice + - lines + - livemode + - number - object - title: DeletedAccount + - pdf + - status + - subtotal + - tax_amounts + - total + - type + title: CreditNote type: object - x-expandableFields: [] - x-resourceId: deleted_account - deleted_apple_pay_domain: - description: '' + x-expandableFields: + - customer + - customer_balance_transaction + - discount_amounts + - invoice + - lines + - refund + - shipping_cost + - tax_amounts + x-resourceId: credit_note + credit_note_line_item: + description: The credit note line item object properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. + amount: + description: >- + The integer amount in cents (or local equivalent) representing the + gross amount being credited for this line item, excluding + (exclusive) tax and discounts. + type: integer + amount_excluding_tax: + description: >- + The integer amount in cents (or local equivalent) representing the + amount being credited for this line item, excluding all tax and + discounts. + nullable: true + type: integer + description: + description: Description of the item being credited. maxLength: 5000 + nullable: true type: string - object: + discount_amount: description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - apple_pay_domain - type: string - required: - - deleted - - id - - object - title: DeletedApplePayDomain - type: object - x-expandableFields: [] - x-resourceId: deleted_apple_pay_domain - deleted_application: - description: '' - properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean + The integer amount in cents (or local equivalent) representing the + discount being credited for this line item. + type: integer + discount_amounts: + description: The amount of discount calculated per discount for this line item + items: + $ref: '#/components/schemas/discounts_resource_discount_amount' + type: array id: description: Unique identifier for the object. maxLength: 5000 type: string - name: - description: The name of the application. + invoice_line_item: + description: ID of the invoice line item being credited maxLength: 5000 - nullable: true type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - application + - credit_note_line_item type: string - required: - - deleted - - id - - object - title: DeletedApplication - type: object - x-expandableFields: [] - deleted_bank_account: - description: '' - properties: - currency: - description: >- - Three-letter [ISO code for the - currency](https://stripe.com/docs/payouts) paid out to the bank - account. - maxLength: 5000 + quantity: + description: The number of units of product being credited. nullable: true - type: string - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - object: + type: integer + tax_amounts: + description: The amount of tax calculated per tax rate for this line item + items: + $ref: '#/components/schemas/credit_note_tax_amount' + type: array + tax_rates: + description: The tax rates which apply to the line item. + items: + $ref: '#/components/schemas/tax_rate' + type: array + type: description: >- - String representing the object's type. Objects of the same type - share the same value. + The type of the credit note line item, one of `invoice_line_item` or + `custom_line_item`. When the type is `invoice_line_item` there is an + additional `invoice_line_item` property on the resource the value of + which is the id of the credited line item on the invoice. enum: - - bank_account + - custom_line_item + - invoice_line_item type: string - required: - - deleted - - id - - object - title: DeletedBankAccount - type: object - x-expandableFields: [] - deleted_card: - description: '' - properties: - currency: + unit_amount: + description: The cost of each unit of product being credited. + nullable: true + type: integer + unit_amount_decimal: description: >- - Three-letter [ISO code for the - currency](https://stripe.com/docs/payouts) paid out to the bank - account. - maxLength: 5000 + Same as `unit_amount`, but contains a decimal value with at most 12 + decimal places. + format: decimal nullable: true type: string - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - object: + unit_amount_excluding_tax: description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - card + The amount in cents (or local equivalent) representing the unit + amount being credited for this line item, excluding all tax and + discounts. + format: decimal + nullable: true type: string required: - - deleted + - amount + - discount_amount + - discount_amounts - id + - livemode - object - title: DeletedCard + - tax_amounts + - tax_rates + - type + title: CreditNoteLineItem type: object - x-expandableFields: [] - deleted_coupon: + x-expandableFields: + - discount_amounts + - tax_amounts + - tax_rates + x-resourceId: credit_note_line_item + credit_note_tax_amount: description: '' properties: - deleted: - description: Always true for a deleted object - enum: - - true + amount: + description: 'The amount, in cents (or local equivalent), of the tax.' + type: integer + inclusive: + description: Whether this tax amount is inclusive or exclusive. type: boolean - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - object: + tax_rate: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/tax_rate' + description: The tax rate that was applied to get this tax amount. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/tax_rate' + taxability_reason: description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - coupon - type: string - required: - - deleted - - id - - object - title: DeletedCoupon - type: object - x-expandableFields: [] - x-resourceId: deleted_coupon - deleted_customer: - description: '' - properties: - deleted: - description: Always true for a deleted object + The reasoning behind this tax, for example, if the product is tax + exempt. The possible values for this field may be extended as new + tax rules are supported. enum: - - true - type: boolean - id: - description: Unique identifier for the object. - maxLength: 5000 + - customer_exempt + - not_collecting + - not_subject_to_tax + - not_supported + - portion_product_exempt + - portion_reduced_rated + - portion_standard_rated + - product_exempt + - product_exempt_holiday + - proportionally_rated + - reduced_rated + - reverse_charge + - standard_rated + - taxable_basis_reduced + - zero_rated + nullable: true type: string - object: + x-stripeBypassValidation: true + taxable_amount: description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - customer - type: string + The amount on which tax is calculated, in cents (or local + equivalent). + nullable: true + type: integer required: - - deleted - - id - - object - title: DeletedCustomer + - amount + - inclusive + - tax_rate + title: CreditNoteTaxAmount type: object - x-expandableFields: [] - x-resourceId: deleted_customer - deleted_discount: + x-expandableFields: + - tax_rate + currency_option: description: '' properties: - checkout_session: - description: >- - The Checkout session that this coupon is applied to, if it is - applied to a particular session in payment mode. Will not be present - for subscription mode. - maxLength: 5000 - nullable: true - type: string - coupon: - $ref: '#/components/schemas/coupon' - customer: + custom_unit_amount: anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/customer' - - $ref: '#/components/schemas/deleted_customer' - description: The ID of the customer associated with this discount. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/customer' - - $ref: '#/components/schemas/deleted_customer' - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: >- - The ID of the discount object. Discounts cannot be fetched by ID. - Use `expand[]=discounts` in API calls to expand discount IDs in an - array. - maxLength: 5000 - type: string - invoice: + - $ref: '#/components/schemas/custom_unit_amount' description: >- - The invoice that the discount's coupon was applied to, if it was - applied directly to a particular invoice. - maxLength: 5000 + When set, provides configuration for the amount to be adjusted by + the customer during Checkout Sessions and Payment Links. nullable: true - type: string - invoice_item: + tax_behavior: description: >- - The invoice item `id` (or invoice line item `id` for invoice line - items of type='subscription') that the discount's coupon was applied - to, if it was applied directly to a particular invoice item or - invoice line item. - maxLength: 5000 + Only required if a [default tax + behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) + was not provided in the Stripe Tax settings. Specifies whether the + price is considered inclusive of taxes or exclusive of taxes. One of + `inclusive`, `exclusive`, or `unspecified`. Once specified as either + `inclusive` or `exclusive`, it cannot be changed. + enum: + - exclusive + - inclusive + - unspecified nullable: true type: string - object: + tiers: description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - discount - type: string - promotion_code: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/promotion_code' - description: The promotion code applied to create this discount. + Each element represents a pricing tier. This parameter requires + `billing_scheme` to be set to `tiered`. See also the documentation + for `billing_scheme`. + items: + $ref: '#/components/schemas/price_tier' + type: array + unit_amount: + description: >- + The unit amount in cents (or local equivalent) to be charged, + represented as a whole integer if possible. Only set if + `billing_scheme=per_unit`. nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/promotion_code' - start: - description: Date that the coupon was applied. - format: unix-time type: integer - subscription: + unit_amount_decimal: description: >- - The subscription that this coupon is applied to, if it is applied to - a particular subscription. - maxLength: 5000 + The unit amount in cents (or local equivalent) to be charged, + represented as a decimal string with at most 12 decimal places. Only + set if `billing_scheme=per_unit`. + format: decimal nullable: true type: string - required: - - coupon - - deleted - - id - - object - - start - title: DeletedDiscount + title: CurrencyOption type: object x-expandableFields: - - coupon - - customer - - promotion_code - x-resourceId: deleted_discount - deleted_external_account: - anyOf: - - $ref: '#/components/schemas/deleted_bank_account' - - $ref: '#/components/schemas/deleted_card' - title: Polymorphic - x-resourceId: deleted_external_account - x-stripeBypassValidation: true - deleted_invoice: + - custom_unit_amount + - tiers + custom_unit_amount: description: '' properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - object: + maximum: + description: The maximum unit amount the customer can specify for this item. + nullable: true + type: integer + minimum: description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - invoice - type: string - required: - - deleted - - id - - object - title: DeletedInvoice + The minimum unit amount the customer can specify for this item. Must + be at least the minimum charge amount. + nullable: true + type: integer + preset: + description: The starting unit amount which can be updated by the customer. + nullable: true + type: integer + title: CustomUnitAmount type: object x-expandableFields: [] - x-resourceId: deleted_invoice - deleted_invoiceitem: - description: '' + customer: + description: >- + This object represents a customer of your business. Use it to create + recurring charges and track payments that belong to the same customer. + + + Related guide: [Save a card during + payment](https://stripe.com/docs/payments/save-during-payment) properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. + address: + anyOf: + - $ref: '#/components/schemas/address' + description: The customer's address. + nullable: true + balance: + description: >- + The current balance, if any, that's stored on the customer. If + negative, the customer has credit to apply to their next invoice. If + positive, the customer has an amount owed that's added to their next + invoice. The balance only considers amounts that Stripe hasn't + successfully applied to any invoice. It doesn't reflect unpaid + invoices. This balance is only taken into account after invoices + finalize. + type: integer + cash_balance: + anyOf: + - $ref: '#/components/schemas/cash_balance' + description: >- + The current funds being held by Stripe on behalf of the customer. + You can apply these funds towards payment intents when the source is + "cash_balance". The `settings[reconciliation_mode]` field describes + if these funds apply to these payment intents manually or + automatically. + nullable: true + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + currency: + description: >- + Three-letter [ISO code for the + currency](https://stripe.com/docs/currencies) the customer can be + charged in for recurring billing purposes. maxLength: 5000 + nullable: true type: string - object: + default_source: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/bank_account' + - $ref: '#/components/schemas/card' + - $ref: '#/components/schemas/source' description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - invoiceitem - type: string - required: - - deleted - - id - - object - title: DeletedInvoiceItem - type: object - x-expandableFields: [] - x-resourceId: deleted_invoiceitem - deleted_payment_source: - anyOf: - - $ref: '#/components/schemas/deleted_bank_account' - - $ref: '#/components/schemas/deleted_card' - title: Polymorphic - x-resourceId: deleted_payment_source - x-stripeBypassValidation: true - deleted_person: - description: '' - properties: - deleted: - description: Always true for a deleted object - enum: - - true + ID of the default payment source for the customer. + + + If you use payment methods created through the PaymentMethods API, + see the + [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) + field instead. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/bank_account' + - $ref: '#/components/schemas/card' + - $ref: '#/components/schemas/source' + x-stripeBypassValidation: true + delinquent: + description: >- + Tracks the most recent state change on any invoice belonging to the + customer. Paying an invoice or marking it uncollectible via the API + will set this field to false. An automatic payment failure or + passing the `invoice.due_date` will set this field to `true`. + + + If an invoice becomes uncollectible by + [dunning](https://stripe.com/docs/billing/automatic-collection), + `delinquent` doesn't reset to `false`. + + + If you care whether the customer has paid their most recent + subscription invoice, use `subscription.status` instead. Paying or + marking uncollectible any customer invoice regardless of whether it + is the latest invoice for a subscription will always set this field + to `false`. + nullable: true type: boolean - id: - description: Unique identifier for the object. + description: + description: >- + An arbitrary string attached to the object. Often useful for + displaying to users. maxLength: 5000 + nullable: true type: string - object: + discount: + anyOf: + - $ref: '#/components/schemas/discount' description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - person + Describes the current discount active on the customer, if there is + one. + nullable: true + email: + description: The customer's email address. + maxLength: 5000 + nullable: true type: string - required: - - deleted - - id - - object - title: DeletedPerson - type: object - x-expandableFields: [] - x-resourceId: deleted_person - deleted_plan: - description: '' - properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string - object: + invoice_credit_balance: + additionalProperties: + type: integer description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - plan + The current multi-currency balances, if any, that's stored on the + customer. If positive in a currency, the customer has a credit to + apply to their next invoice denominated in that currency. If + negative, the customer has an amount owed that's added to their next + invoice denominated in that currency. These balances don't apply to + unpaid invoices. They solely track amounts that Stripe hasn't + successfully applied to any invoice. Stripe only applies a balance + in a specific currency to an invoice after that invoice (which is in + the same currency) finalizes. + type: object + invoice_prefix: + description: The prefix for the customer used to generate unique invoice numbers. + maxLength: 5000 + nullable: true type: string - required: - - deleted - - id - - object - title: DeletedPlan - type: object - x-expandableFields: [] - x-resourceId: deleted_plan - deleted_price: - description: '' - properties: - deleted: - description: Always true for a deleted object - enum: - - true + invoice_settings: + $ref: '#/components/schemas/invoice_setting_customer_setting' + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. type: boolean - id: - description: Unique identifier for the object. + metadata: + additionalProperties: + maxLength: 500 + type: 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. + type: object + name: + description: The customer's full name or business name. maxLength: 5000 + nullable: true type: string + next_invoice_sequence: + description: >- + The suffix of the customer's next invoice number (for example, + 0001). + type: integer object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - price + - customer type: string - required: - - deleted - - id - - object - title: DeletedPrice - type: object - x-expandableFields: [] - deleted_product: - description: '' - properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. + phone: + description: The customer's phone number. maxLength: 5000 + nullable: true type: string - object: + preferred_locales: + description: 'The customer''s preferred locales (languages), ordered by preference.' + items: + maxLength: 5000 + type: string + nullable: true + type: array + shipping: + anyOf: + - $ref: '#/components/schemas/shipping' description: >- - String representing the object's type. Objects of the same type - share the same value. + Mailing and shipping address for the customer. Appears on invoices + emailed to this customer. + nullable: true + sources: + description: 'The customer''s payment sources, if any.' + properties: + data: + description: Details about each object. + items: + anyOf: + - $ref: '#/components/schemas/bank_account' + - $ref: '#/components/schemas/card' + - $ref: '#/components/schemas/source' + title: Polymorphic + x-stripeBypassValidation: true + type: array + has_more: + description: >- + True if this list has another page of items after this one that + can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: ApmsSourcesSourceList + type: object + x-expandableFields: + - data + subscriptions: + description: 'The customer''s current subscriptions, if any.' + properties: + data: + description: Details about each object. + items: + $ref: '#/components/schemas/subscription' + type: array + has_more: + description: >- + True if this list has another page of items after this one that + can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: SubscriptionList + type: object + x-expandableFields: + - data + tax: + $ref: '#/components/schemas/customer_tax' + tax_exempt: + description: >- + Describes the customer's tax exemption status, which is `none`, + `exempt`, or `reverse`. When set to `reverse`, invoice and receipt + PDFs include the following text: **"Reverse charge"**. enum: - - product + - exempt + - none + - reverse + nullable: true type: string + tax_ids: + description: The customer's tax IDs. + properties: + data: + description: Details about each object. + items: + $ref: '#/components/schemas/tax_id' + type: array + has_more: + description: >- + True if this list has another page of items after this one that + can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: TaxIDsList + type: object + x-expandableFields: + - data + test_clock: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/test_helpers.test_clock' + description: ID of the test clock that this customer belongs to. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/test_helpers.test_clock' required: - - deleted + - created - id + - livemode - object - title: DeletedProduct + title: Customer type: object - x-expandableFields: [] - x-resourceId: deleted_product - deleted_radar.value_list: + x-expandableFields: + - address + - cash_balance + - default_source + - discount + - invoice_settings + - shipping + - sources + - subscriptions + - tax + - tax_ids + - test_clock + x-resourceId: customer + customer_acceptance: description: '' properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - object: + accepted_at: + description: The time that the customer accepts the mandate. + format: unix-time + nullable: true + type: integer + offline: + $ref: '#/components/schemas/offline_acceptance' + online: + $ref: '#/components/schemas/online_acceptance' + type: description: >- - String representing the object's type. Objects of the same type - share the same value. + The mandate includes the type of customer acceptance information, + such as: `online` or `offline`. enum: - - radar.value_list + - offline + - online type: string required: - - deleted - - id - - object - title: RadarListDeletedList + - type + title: customer_acceptance type: object - x-expandableFields: [] - x-resourceId: deleted_radar.value_list - deleted_radar.value_list_item: + x-expandableFields: + - offline + - online + customer_balance_customer_balance_settings: description: '' properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - object: + reconciliation_mode: description: >- - String representing the object's type. Objects of the same type - share the same value. + The configuration for how funds that land in the customer cash + balance are reconciled. enum: - - radar.value_list_item + - automatic + - manual type: string + using_merchant_default: + description: >- + A flag to indicate if reconciliation mode returned is the user's + default or is specific to this customer cash balance + type: boolean required: - - deleted - - id - - object - title: RadarListDeletedListItem + - reconciliation_mode + - using_merchant_default + title: CustomerBalanceCustomerBalanceSettings type: object x-expandableFields: [] - x-resourceId: deleted_radar.value_list_item - deleted_subscription_item: + customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft: description: '' properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - object: + balance_transaction: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/balance_transaction' description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - subscription_item - type: string + The [Balance + Transaction](https://stripe.com/docs/api/balance_transactions/object) + that corresponds to funds taken out of your Stripe balance. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/balance_transaction' + linked_transaction: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/customer_cash_balance_transaction' + description: >- + The [Cash Balance + Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) + that brought the customer balance negative, triggering the clawback + of funds. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/customer_cash_balance_transaction' required: - - deleted - - id - - object - title: DeletedSubscriptionItem + - balance_transaction + - linked_transaction + title: >- + CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft type: object - x-expandableFields: [] - x-resourceId: deleted_subscription_item - deleted_tax_id: + x-expandableFields: + - balance_transaction + - linked_transaction + customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction: description: '' properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - object: + payment_intent: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/payment_intent' description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - tax_id - type: string + The [Payment + Intent](https://stripe.com/docs/api/payment_intents/object) that + funds were applied to. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/payment_intent' required: - - deleted - - id - - object - title: deleted_tax_id + - payment_intent + title: >- + CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction type: object - x-expandableFields: [] - x-resourceId: deleted_tax_id - deleted_terminal.configuration: + x-expandableFields: + - payment_intent + customer_balance_resource_cash_balance_transaction_resource_funded_transaction: description: '' properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - terminal.configuration - type: string + bank_transfer: + $ref: >- + #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer required: - - deleted - - id - - object - title: TerminalConfigurationDeletedConfiguration + - bank_transfer + title: CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction type: object - x-expandableFields: [] - x-resourceId: deleted_terminal.configuration - deleted_terminal.location: + x-expandableFields: + - bank_transfer + customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer: description: '' properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. + eu_bank_transfer: + $ref: >- + #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer + gb_bank_transfer: + $ref: >- + #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer + jp_bank_transfer: + $ref: >- + #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer + reference: + description: The user-supplied reference field on the bank transfer. maxLength: 5000 + nullable: true type: string - object: + type: description: >- - String representing the object's type. Objects of the same type - share the same value. + The funding method type used to fund the customer balance. Permitted + values include: `eu_bank_transfer`, `gb_bank_transfer`, + `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. enum: - - terminal.location + - eu_bank_transfer + - gb_bank_transfer + - jp_bank_transfer + - mx_bank_transfer + - us_bank_transfer type: string + x-stripeBypassValidation: true + us_bank_transfer: + $ref: >- + #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer required: - - deleted - - id - - object - title: TerminalLocationDeletedLocation + - type + title: >- + CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransfer type: object - x-expandableFields: [] - x-resourceId: deleted_terminal.location - deleted_terminal.reader: + x-expandableFields: + - eu_bank_transfer + - gb_bank_transfer + - jp_bank_transfer + - us_bank_transfer + customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer: description: '' properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. + bic: + description: The BIC of the bank of the sender of the funding. maxLength: 5000 + nullable: true type: string - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - terminal.reader + iban_last4: + description: The last 4 digits of the IBAN of the sender of the funding. + maxLength: 5000 + nullable: true type: string - required: - - deleted - - id - - object - title: TerminalReaderDeletedReader + sender_name: + description: 'The full name of the sender, as supplied by the sending bank.' + maxLength: 5000 + nullable: true + type: string + title: >- + CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer type: object x-expandableFields: [] - x-resourceId: deleted_terminal.reader - deleted_test_helpers.test_clock: + customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer: description: '' properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. + account_number_last4: + description: >- + The last 4 digits of the account number of the sender of the + funding. maxLength: 5000 + nullable: true type: string - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - test_helpers.test_clock + sender_name: + description: 'The full name of the sender, as supplied by the sending bank.' + maxLength: 5000 + nullable: true type: string - required: - - deleted - - id - - object - title: DeletedTestClock + sort_code: + description: The sort code of the bank of the sender of the funding + maxLength: 5000 + nullable: true + type: string + title: >- + CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer type: object x-expandableFields: [] - x-resourceId: deleted_test_helpers.test_clock - deleted_webhook_endpoint: + customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer: description: '' properties: - deleted: - description: Always true for a deleted object - enum: - - true - type: boolean - id: - description: Unique identifier for the object. + sender_bank: + description: The name of the bank of the sender of the funding. maxLength: 5000 + nullable: true type: string - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - webhook_endpoint + sender_branch: + description: The name of the bank branch of the sender of the funding. + maxLength: 5000 + nullable: true type: string - required: - - deleted - - id - - object - title: NotificationWebhookEndpointDeleted + sender_name: + description: 'The full name of the sender, as supplied by the sending bank.' + maxLength: 5000 + nullable: true + type: string + title: >- + CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer type: object x-expandableFields: [] - x-resourceId: deleted_webhook_endpoint - discount: - description: >- - A discount represents the actual application of a - [coupon](https://stripe.com/docs/api#coupons) or [promotion - code](https://stripe.com/docs/api#promotion_codes). - - It contains information about when the discount began, when it will end, - and what it is applied to. - - - Related guide: [Applying discounts to - subscriptions](https://stripe.com/docs/billing/subscriptions/discounts) + customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer: + description: '' properties: - checkout_session: - description: >- - The Checkout session that this coupon is applied to, if it is - applied to a particular session in payment mode. Will not be present - for subscription mode. + network: + description: The banking network used for this funding. + enum: + - ach + - domestic_wire_us + - swift + type: string + sender_name: + description: 'The full name of the sender, as supplied by the sending bank.' maxLength: 5000 nullable: true type: string - coupon: - $ref: '#/components/schemas/coupon' - customer: + title: >- + CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer + type: object + x-expandableFields: [] + customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction: + description: '' + properties: + refund: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/customer' - - $ref: '#/components/schemas/deleted_customer' - description: The ID of the customer associated with this discount. - nullable: true + - $ref: '#/components/schemas/refund' + description: >- + The [Refund](https://stripe.com/docs/api/refunds/object) that moved + these funds into the customer's cash balance. x-expansionResources: oneOf: - - $ref: '#/components/schemas/customer' - - $ref: '#/components/schemas/deleted_customer' - end: - description: >- - If the coupon has a duration of `repeating`, the date that this - discount will end. If the coupon has a duration of `once` or - `forever`, this attribute will be null. - format: unix-time - nullable: true - type: integer - id: - description: >- - The ID of the discount object. Discounts cannot be fetched by ID. - Use `expand[]=discounts` in API calls to expand discount IDs in an - array. - maxLength: 5000 - type: string - invoice: - description: >- - The invoice that the discount's coupon was applied to, if it was - applied directly to a particular invoice. - maxLength: 5000 - nullable: true - type: string - invoice_item: - description: >- - The invoice item `id` (or invoice line item `id` for invoice line - items of type='subscription') that the discount's coupon was applied - to, if it was applied directly to a particular invoice item or - invoice line item. - maxLength: 5000 - nullable: true - type: string - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - discount - type: string - promotion_code: + - $ref: '#/components/schemas/refund' + required: + - refund + title: >- + CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction + type: object + x-expandableFields: + - refund + customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance: + description: '' + properties: + balance_transaction: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/promotion_code' - description: The promotion code applied to create this discount. - nullable: true + - $ref: '#/components/schemas/balance_transaction' + description: >- + The [Balance + Transaction](https://stripe.com/docs/api/balance_transactions/object) + that corresponds to funds transferred to your Stripe balance. x-expansionResources: oneOf: - - $ref: '#/components/schemas/promotion_code' - start: - description: Date that the coupon was applied. - format: unix-time - type: integer - subscription: - description: >- - The subscription that this coupon is applied to, if it is applied to - a particular subscription. - maxLength: 5000 - nullable: true - type: string + - $ref: '#/components/schemas/balance_transaction' required: - - coupon - - id - - object - - start - title: Discount + - balance_transaction + title: >- + CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance type: object x-expandableFields: - - coupon - - customer - - promotion_code - x-resourceId: discount - discounts_resource_discount_amount: + - balance_transaction + customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction: description: '' properties: - amount: - description: 'The amount, in cents (or local equivalent), of the discount.' - type: integer - discount: + payment_intent: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/discount' - - $ref: '#/components/schemas/deleted_discount' - description: The discount that was applied to get this discount amount. + - $ref: '#/components/schemas/payment_intent' + description: >- + The [Payment + Intent](https://stripe.com/docs/api/payment_intents/object) that + funds were unapplied from. x-expansionResources: oneOf: - - $ref: '#/components/schemas/discount' - - $ref: '#/components/schemas/deleted_discount' + - $ref: '#/components/schemas/payment_intent' required: - - amount - - discount - title: DiscountsResourceDiscountAmount + - payment_intent + title: >- + CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction type: object x-expandableFields: - - discount - dispute: + - payment_intent + customer_balance_transaction: description: >- - A dispute occurs when a customer questions your charge with their card - issuer. + Each customer has a + [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) + value, - When this happens, you have the opportunity to respond to the dispute - with + which denotes a debit or credit that's automatically applied to their + next invoice upon finalization. - evidence that shows that the charge is legitimate. + You may modify the value directly by using the [update customer + API](https://stripe.com/docs/api/customers/update), + or by creating a Customer Balance Transaction, which increments or + decrements the customer's `balance` by the specified `amount`. - Related guide: [Disputes and fraud](https://stripe.com/docs/disputes) + + Related guide: [Customer + balance](https://stripe.com/docs/billing/customer/balance) properties: amount: description: >- - Disputed amount. Usually the amount of the charge, but it can differ - (usually because of currency fluctuation or because only part of the - order is disputed). + The amount of the transaction. A negative value is a credit for the + customer's balance, and a positive value is a debit to the + customer's `balance`. type: integer - balance_transactions: - description: >- - List of zero, one, or two balance transactions that show funds - withdrawn and reinstated to your Stripe account as a result of this - dispute. - items: - $ref: '#/components/schemas/balance_transaction' - type: array - charge: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/charge' - description: ID of the charge that's disputed. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/charge' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer + credit_note: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/credit_note' + description: The ID of the credit note (if any) related to the transaction. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/credit_note' currency: description: >- Three-letter [ISO currency @@ -8415,20 +8969,43 @@ components: lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). type: string - evidence: - $ref: '#/components/schemas/dispute_evidence' - evidence_details: - $ref: '#/components/schemas/dispute_evidence_details' - id: - description: Unique identifier for the object. + customer: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/customer' + description: The ID of the customer the transaction belongs to. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/customer' + description: + description: >- + An arbitrary string attached to the object. Often useful for + displaying to users. maxLength: 5000 + nullable: true type: string - is_charge_refundable: + ending_balance: description: >- - If true, it's still possible to refund the disputed payment. After - the payment has been fully refunded, no further funds are withdrawn - from your Stripe account as a result of this dispute. - type: boolean + The customer's `balance` after the transaction was applied. A + negative value decreases the amount due on the customer's next + invoice. A positive value increases the amount due on the customer's + next invoice. + type: integer + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + invoice: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/invoice' + description: The ID of the invoice (if any) related to the transaction. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/invoice' livemode: description: >- Has the value `true` if the object exists in live mode or the value @@ -8442,673 +9019,665 @@ components: 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. + nullable: true type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - dispute - type: string - payment_intent: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/payment_intent' - description: ID of the PaymentIntent that's disputed. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/payment_intent' - payment_method_details: - $ref: '#/components/schemas/dispute_payment_method_details' - reason: - description: >- - Reason given by cardholder for dispute. Possible values are - `bank_cannot_process`, `check_returned`, `credit_not_processed`, - `customer_initiated`, `debit_not_authorized`, `duplicate`, - `fraudulent`, `general`, `incorrect_account_details`, - `insufficient_funds`, `product_not_received`, - `product_unacceptable`, `subscription_canceled`, or `unrecognized`. - Learn more about [dispute - reasons](https://stripe.com/docs/disputes/categories). - maxLength: 5000 + - customer_balance_transaction type: string - status: + type: description: >- - Current status of dispute. Possible values are - `warning_needs_response`, `warning_under_review`, `warning_closed`, - `needs_response`, `under_review`, `won`, or `lost`. + Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, + `initial`, `invoice_overpaid`, `invoice_too_large`, + `invoice_too_small`, `unspent_receiver_credit`, or + `unapplied_from_invoice`. See the [Customer Balance + page](https://stripe.com/docs/billing/customer/balance#types) to + learn more about transaction types. enum: - - lost - - needs_response - - under_review - - warning_closed - - warning_needs_response - - warning_under_review - - won + - adjustment + - applied_to_invoice + - credit_note + - initial + - invoice_overpaid + - invoice_too_large + - invoice_too_small + - migration + - unapplied_from_invoice + - unspent_receiver_credit type: string + x-stripeBypassValidation: true required: - amount - - balance_transactions - - charge - created - currency - - evidence - - evidence_details + - customer + - ending_balance - id - - is_charge_refundable - livemode - - metadata - object - - reason - - status - title: Dispute + - type + title: CustomerBalanceTransaction type: object x-expandableFields: - - balance_transactions - - charge - - evidence - - evidence_details - - payment_intent - - payment_method_details - x-resourceId: dispute - dispute_evidence: - description: '' + - credit_note + - customer + - invoice + x-resourceId: customer_balance_transaction + customer_cash_balance_transaction: + description: >- + Customers with certain payments enabled have a cash balance, + representing funds that were paid + + by the customer to a merchant, but have not yet been allocated to a + payment. Cash Balance Transactions + + represent when funds are moved into or out of this balance. This + includes funding by the customer, allocation + + to payments, and refunds to the customer. properties: - access_activity_log: + adjusted_for_overdraft: + $ref: >- + #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft + applied_to_payment: + $ref: >- + #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction + created: 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. - maxLength: 150000 - nullable: true - type: string - billing_address: - description: The billing address provided by the customer. + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + 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). maxLength: 5000 - nullable: true type: string - cancellation_policy: + customer: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/file' + - $ref: '#/components/schemas/customer' description: >- - (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) - Your subscription cancellation policy, as shown to the customer. - nullable: true + The customer whose available cash balance changed as a result of + this transaction. x-expansionResources: oneOf: - - $ref: '#/components/schemas/file' - cancellation_policy_disclosure: - description: >- - An explanation of how and when the customer was shown your refund - policy prior to purchase. - maxLength: 150000 - nullable: true - type: string - cancellation_rebuttal: - description: >- - A justification for why the customer's subscription was not - canceled. - maxLength: 150000 - nullable: true - type: string - customer_communication: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/file' + - $ref: '#/components/schemas/customer' + ending_balance: description: >- - (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) - Any communication with the customer that you feel is relevant to - your case. Examples include emails proving that the customer - received the product or service, or demonstrating their use of or - satisfaction with the product or service. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/file' - customer_email_address: - description: The email address of the customer. - maxLength: 5000 - nullable: true - type: string - customer_name: - description: The name of the customer. - maxLength: 5000 - nullable: true - type: string - customer_purchase_ip: - description: The IP address that the customer used when making the purchase. + The total available cash balance for the specified currency after + this transaction was applied. Represented in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). + type: integer + funded: + $ref: >- + #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction + id: + description: Unique identifier for the object. maxLength: 5000 - nullable: true type: string - customer_signature: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/file' + livemode: description: >- - (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) - A relevant document or contract showing the customer's signature. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/file' - duplicate_charge_documentation: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/file' + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + net_amount: description: >- - (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) - Documentation for the prior charge that can uniquely identify the - charge, such as a receipt, shipping label, work order, etc. This - document should be paired with a similar document from the disputed - payment that proves the two payments are separate. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/file' - duplicate_charge_explanation: + The amount by which the cash balance changed, represented in the + [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). A positive + value represents funds being added to the cash balance, a negative + value represents funds being removed from the cash balance. + type: integer + object: description: >- - An explanation of the difference between the disputed charge versus - the prior charge that appears to be a duplicate. - maxLength: 150000 - nullable: true + String representing the object's type. Objects of the same type + share the same value. + enum: + - customer_cash_balance_transaction type: string - duplicate_charge_id: + refunded_from_payment: + $ref: >- + #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction + transferred_to_balance: + $ref: >- + #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance + type: description: >- - The Stripe ID for the prior charge which appears to be a duplicate - of the disputed charge. - maxLength: 5000 - nullable: true + The type of the cash balance transaction. New types may be added in + future. See [Customer + Balance](https://stripe.com/docs/payments/customer-balance#types) to + learn more about these types. + enum: + - adjusted_for_overdraft + - applied_to_payment + - funded + - funding_reversed + - refunded_from_payment + - return_canceled + - return_initiated + - transferred_to_balance + - unapplied_from_payment type: string - product_description: - description: A description of the product or service that was sold. - maxLength: 150000 - nullable: true + unapplied_from_payment: + $ref: >- + #/components/schemas/customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction + required: + - created + - currency + - customer + - ending_balance + - id + - livemode + - net_amount + - object + - type + title: CustomerCashBalanceTransaction + type: object + x-expandableFields: + - adjusted_for_overdraft + - applied_to_payment + - customer + - funded + - refunded_from_payment + - transferred_to_balance + - unapplied_from_payment + x-resourceId: customer_cash_balance_transaction + customer_session: + description: >- + A customer session allows you to grant client access to Stripe's + frontend SDKs (like StripeJs) + + control over a customer. + properties: + client_secret: + description: >- + The client secret of this customer session. Used on the client to + set up secure access to the given `customer`. + + + The client secret can be used to provide access to `customer` from + your frontend. It should not be stored, logged, or exposed to anyone + other than the relevant customer. Make sure that you have TLS + enabled on any page that includes the client secret. + maxLength: 5000 type: string - receipt: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/file' + components: + $ref: '#/components/schemas/customer_session_resource_components' + created: description: >- - (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) - Any receipt or message sent to the customer notifying them of the - charge. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/file' - refund_policy: + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + customer: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/file' - description: >- - (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) - Your refund policy, as shown to the customer. - nullable: true + - $ref: '#/components/schemas/customer' + description: The customer the customer session was created for. x-expansionResources: oneOf: - - $ref: '#/components/schemas/file' - refund_policy_disclosure: + - $ref: '#/components/schemas/customer' + expires_at: + description: The timestamp at which this customer session will expire. + format: unix-time + type: integer + livemode: description: >- - Documentation demonstrating that the customer was shown your refund - policy prior to purchase. - maxLength: 150000 - nullable: true + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - customer_session type: string - refund_refusal_explanation: - description: A justification for why the customer is not entitled to a refund. - maxLength: 150000 - nullable: true + required: + - client_secret + - created + - customer + - expires_at + - livemode + - object + title: CustomerSessionResourceCustomerSession + type: object + x-expandableFields: + - components + - customer + x-resourceId: customer_session + customer_session_resource_components: + description: Configuration for the components supported by this customer session. + properties: + buy_button: + $ref: >- + #/components/schemas/customer_session_resource_components_resource_buy_button + pricing_table: + $ref: >- + #/components/schemas/customer_session_resource_components_resource_pricing_table + required: + - buy_button + - pricing_table + title: CustomerSessionResourceComponents + type: object + x-expandableFields: + - buy_button + - pricing_table + customer_session_resource_components_resource_buy_button: + description: This hash contains whether the buy button is enabled. + properties: + enabled: + description: Whether the buy button is enabled. + type: boolean + required: + - enabled + title: CustomerSessionResourceComponentsResourceBuyButton + type: object + x-expandableFields: [] + customer_session_resource_components_resource_pricing_table: + description: This hash contains whether the pricing table is enabled. + properties: + enabled: + description: Whether the pricing table is enabled. + type: boolean + required: + - enabled + title: CustomerSessionResourceComponentsResourcePricingTable + type: object + x-expandableFields: [] + customer_tax: + description: '' + properties: + automatic_tax: + description: >- + Surfaces if automatic tax computation is possible given the current + customer location information. + enum: + - failed + - not_collecting + - supported + - unrecognized_location type: string - service_date: + ip_address: description: >- - The date on which the customer received or began receiving the - purchased service, in a clear human-readable format. + A recent IP address of the customer used for tax reporting and tax + location inference. maxLength: 5000 nullable: true type: string - service_documentation: + location: anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/file' - description: >- - (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) - Documentation showing proof that a service was provided to the - customer. This could include a copy of a signed contract, work - order, or other form of written agreement. + - $ref: '#/components/schemas/customer_tax_location' + description: The customer's location as identified by Stripe Tax. nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/file' - shipping_address: - description: >- - The address to which a physical product was shipped. You should try - to include as complete address information as possible. + required: + - automatic_tax + title: CustomerTax + type: object + x-expandableFields: + - location + customer_tax_location: + description: '' + properties: + country: + description: The customer's country as identified by Stripe Tax. maxLength: 5000 - nullable: true type: string - shipping_carrier: - description: >- - The delivery service that shipped a physical product, such as Fedex, - UPS, USPS, etc. If multiple carriers were used for this purchase, - please separate them with commas. - maxLength: 5000 - nullable: true + source: + description: The data source used to infer the customer's location. + enum: + - billing_address + - ip_address + - payment_method + - shipping_destination type: string - shipping_date: + state: description: >- - The date on which a physical product began its route to the shipping - address, in a clear human-readable format. + The customer's state, county, province, or region as identified by + Stripe Tax. maxLength: 5000 nullable: true type: string - shipping_documentation: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/file' - description: >- - (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) - Documentation showing proof that a product was shipped to the - customer at the same address the customer provided to you. This - could include a copy of the shipment receipt, shipping label, etc. - It should show the customer's full shipping address, if possible. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/file' - shipping_tracking_number: - description: >- - The tracking number for a physical product, obtained from the - delivery service. If multiple tracking numbers were generated for - this purchase, please separate them with commas. + required: + - country + - source + title: CustomerTaxLocation + type: object + x-expandableFields: [] + deleted_account: + description: '' + properties: + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean + id: + description: Unique identifier for the object. maxLength: 5000 - nullable: true type: string - uncategorized_file: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/file' + object: description: >- - (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) - Any additional evidence or statements. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/file' - uncategorized_text: - description: Any additional evidence or statements. - maxLength: 150000 - nullable: true + String representing the object's type. Objects of the same type + share the same value. + enum: + - account type: string - title: DisputeEvidence + required: + - deleted + - id + - object + title: DeletedAccount type: object - x-expandableFields: - - cancellation_policy - - customer_communication - - customer_signature - - duplicate_charge_documentation - - receipt - - refund_policy - - service_documentation - - shipping_documentation - - uncategorized_file - dispute_evidence_details: + x-expandableFields: [] + x-resourceId: deleted_account + deleted_apple_pay_domain: description: '' properties: - due_by: - description: >- - Date by which evidence must be submitted in order to successfully - challenge dispute. Will be 0 if the customer's bank or credit card - company doesn't allow a response for this particular dispute. - format: unix-time - nullable: true - type: integer - has_evidence: - description: Whether evidence has been staged for this dispute. - type: boolean - past_due: - description: >- - Whether the last evidence submission was submitted past the due - date. Defaults to `false` if no evidence submissions have occurred. - If `true`, then delivery of the latest evidence is *not* guaranteed. + deleted: + description: Always true for a deleted object + enum: + - true type: boolean - submission_count: + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + object: description: >- - The number of times evidence has been submitted. Typically, you may - only submit evidence once. - type: integer + String representing the object's type. Objects of the same type + share the same value. + enum: + - apple_pay_domain + type: string required: - - has_evidence - - past_due - - submission_count - title: DisputeEvidenceDetails + - deleted + - id + - object + title: DeletedApplePayDomain type: object x-expandableFields: [] - dispute_payment_method_details: + x-resourceId: deleted_apple_pay_domain + deleted_application: description: '' properties: - card: - anyOf: - - $ref: '#/components/schemas/dispute_payment_method_details_card' - description: Card specific dispute details. + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + name: + description: The name of the application. + maxLength: 5000 nullable: true - type: - description: Payment method type. + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. enum: - - card + - application type: string required: - - type - title: DisputePaymentMethodDetails + - deleted + - id + - object + title: DeletedApplication type: object - x-expandableFields: - - card - dispute_payment_method_details_card: + x-expandableFields: [] + deleted_bank_account: description: '' properties: - brand: + currency: description: >- - Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, - `mastercard`, `unionpay`, `visa`, or `unknown`. + Three-letter [ISO code for the + currency](https://stripe.com/docs/payouts) paid out to the bank + account. maxLength: 5000 + nullable: true type: string - network_reason_code: - description: >- - The card network's specific dispute reason code, which maps to one - of Stripe's primary dispute categories to simplify response - guidance. The [Network code - map](https://stripe.com/docs/disputes/categories#network-code-map) - lists all available dispute reason codes by network. + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean + id: + description: Unique identifier for the object. maxLength: 5000 - nullable: true + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - bank_account type: string required: - - brand - title: DisputePaymentMethodDetailsCard + - deleted + - id + - object + title: DeletedBankAccount type: object x-expandableFields: [] - email_sent: + deleted_card: description: '' properties: - email_sent_at: - description: The timestamp when the email was sent. - format: unix-time - type: integer - email_sent_to: - description: The recipient's email address. + currency: + description: >- + Three-letter [ISO code for the + currency](https://stripe.com/docs/payouts) paid out to the bank + account. + maxLength: 5000 + nullable: true + type: string + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean + id: + description: Unique identifier for the object. maxLength: 5000 type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - card + type: string required: - - email_sent_at - - email_sent_to - title: EmailSent + - deleted + - id + - object + title: DeletedCard type: object x-expandableFields: [] - ephemeral_key: + deleted_coupon: description: '' properties: - created: - description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time - type: integer - expires: - description: >- - Time at which the key will expire. Measured in seconds since the - Unix epoch. - format: unix-time - type: integer + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string - livemode: - description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. - type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - ephemeral_key - type: string - secret: - description: >- - The key's secret. You can use this value to make authorized requests - to the Stripe API. - maxLength: 5000 + - coupon type: string required: - - created - - expires + - deleted - id - - livemode - object - title: EphemeralKey + title: DeletedCoupon type: object x-expandableFields: [] - x-resourceId: ephemeral_key - error: - description: An error response from the Stripe API + x-resourceId: deleted_coupon + deleted_customer: + description: '' properties: - error: - $ref: '#/components/schemas/api_errors' + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - customer + type: string required: - - error + - deleted + - id + - object + title: DeletedCustomer type: object - event: - description: >- - Events are our way of letting you know when something interesting - happens in - - your account. When an interesting event occurs, we create a new `Event` - - object. For example, when a charge succeeds, we create a - `charge.succeeded` - - event, and when an invoice payment attempt fails, we create an - - `invoice.payment_failed` event. Certain API requests might create - multiple - - events. For example, if you create a new subscription for a - - customer, you receive both a `customer.subscription.created` event and a - - `charge.succeeded` event. - - - Events occur when the state of another API resource changes. The event's - data - - field embeds the resource's state at the time of the change. For - - example, a `charge.succeeded` event contains a charge, and an - - `invoice.payment_failed` event contains an invoice. - - - As with other API resources, you can use endpoints to retrieve an - - [individual event](https://stripe.com/docs/api#retrieve_event) or a - [list of events](https://stripe.com/docs/api#list_events) - - from the API. We also have a separate - - [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the - - `Event` objects directly to an endpoint on your server. You can manage - - webhooks in your - - [account settings](https://dashboard.stripe.com/account/webhooks). Learn - how - - to [listen for events](https://stripe.com/docs/webhooks) - - so that your integration can automatically trigger reactions. - - - When using [Connect](https://stripe.com/docs/connect), you can also - receive event notifications - - that occur in connected accounts. For these events, there's an - - additional `account` attribute in the received `Event` object. - - - We only guarantee access to events through the [Retrieve Event - API](https://stripe.com/docs/api#retrieve_event) - - for 30 days. + x-expandableFields: [] + x-resourceId: deleted_customer + deleted_discount: + description: '' properties: - account: - description: The connected account that originates the event. + checkout_session: + description: >- + The Checkout session that this coupon is applied to, if it is + applied to a particular session in payment mode. Will not be present + for subscription mode. + maxLength: 5000 + nullable: true + type: string + coupon: + $ref: '#/components/schemas/coupon' + customer: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/customer' + - $ref: '#/components/schemas/deleted_customer' + description: The ID of the customer associated with this discount. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/customer' + - $ref: '#/components/schemas/deleted_customer' + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean + id: + description: >- + The ID of the discount object. Discounts cannot be fetched by ID. + Use `expand[]=discounts` in API calls to expand discount IDs in an + array. maxLength: 5000 type: string - api_version: + invoice: description: >- - The Stripe API version used to render `data`. This property is - populated only for events on or after October 31, 2014. + The invoice that the discount's coupon was applied to, if it was + applied directly to a particular invoice. maxLength: 5000 nullable: true type: string - created: + invoice_item: description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time - type: integer - data: - $ref: '#/components/schemas/notification_event_data' - id: - description: Unique identifier for the object. + The invoice item `id` (or invoice line item `id` for invoice line + items of type='subscription') that the discount's coupon was applied + to, if it was applied directly to a particular invoice item or + invoice line item. maxLength: 5000 + nullable: true type: string - livemode: - description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. - type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - event + - discount type: string - pending_webhooks: - description: >- - Number of webhooks that haven't been successfully delivered (for - example, to return a 20x response) to the URLs you specify. - type: integer - request: + promotion_code: anyOf: - - $ref: '#/components/schemas/notification_event_request' - description: Information on the API request that triggers the event. + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/promotion_code' + description: The promotion code applied to create this discount. nullable: true - type: + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/promotion_code' + start: + description: Date that the coupon was applied. + format: unix-time + type: integer + subscription: description: >- - Description of the event (for example, `invoice.created` or - `charge.refunded`). + The subscription that this coupon is applied to, if it is applied to + a particular subscription. maxLength: 5000 + nullable: true + type: string + subscription_item: + description: >- + The subscription item that this coupon is applied to, if it is + applied to a particular subscription item. + maxLength: 5000 + nullable: true type: string required: - - created - - data + - coupon + - deleted - id - - livemode - object - - pending_webhooks - - type - title: NotificationEvent + - start + title: DeletedDiscount type: object x-expandableFields: - - data - - request - x-resourceId: event - exchange_rate: - description: >- - `ExchangeRate` objects allow you to determine the rates that Stripe is - currently - - using to convert from one currency to another. Since this number is - variable - - throughout the day, there are various reasons why you might want to know - the current - - rate (for example, to dynamically price an item for a user with a - default - - payment in a foreign currency). - - - Please refer to our [Exchange Rates - API](https://stripe.com/docs/fx-rates) guide for more details. - - - *[Note: this integration path is supported but no longer recommended]* - Additionally, - - you can guarantee that a charge is made with an exchange rate that you - expect is - - current. To do so, you must pass in the exchange_rate to charges - endpoints. If the - - value is no longer up to date, the charge won't go through. Please refer - to our - - [Using with charges](https://stripe.com/docs/exchange-rates) guide for - more details. - - - ----- - - -   - - - *This Exchange Rates API is a Beta Service and is subject to Stripe's - terms of service. You may use the API solely for the purpose of - transacting on Stripe. For example, the API may be queried in order to:* - - - - *localize prices for processing payments on Stripe* - - - *reconcile Stripe transactions* - - - *determine how much money to send to a connected account* - - - *determine app fees to charge a connected account* - - - *Using this Exchange Rates API beta for any purpose other than to - transact on Stripe is strictly prohibited and constitutes a violation of - Stripe's terms of service.* + - coupon + - customer + - promotion_code + x-resourceId: deleted_discount + deleted_external_account: + anyOf: + - $ref: '#/components/schemas/deleted_bank_account' + - $ref: '#/components/schemas/deleted_card' + title: Polymorphic + x-resourceId: deleted_external_account + x-stripeBypassValidation: true + deleted_invoice: + description: '' properties: + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean id: - description: >- - Unique identifier for the object. Represented as the three-letter - [ISO currency - code](https://www.iso.org/iso-4217-currency-codes.html) in - lowercase. + description: Unique identifier for the object. maxLength: 5000 type: string object: @@ -9116,620 +9685,273 @@ components: String representing the object's type. Objects of the same type share the same value. enum: - - exchange_rate + - invoice type: string - rates: - additionalProperties: - type: number - description: >- - Hash where the keys are supported currencies and the values are the - exchange rate at which the base id currency converts to the key - currency. - type: object required: + - deleted - id - object - - rates - title: ExchangeRate + title: DeletedInvoice type: object x-expandableFields: [] - x-resourceId: exchange_rate - external_account: - anyOf: - - $ref: '#/components/schemas/bank_account' - - $ref: '#/components/schemas/card' - title: Polymorphic - x-resourceId: external_account - x-stripeBypassValidation: true - external_account_requirements: + x-resourceId: deleted_invoice + deleted_invoiceitem: description: '' properties: - currently_due: - description: >- - Fields that need to be collected to keep the external account - enabled. If not collected by `current_deadline`, these fields appear - in `past_due` as well, and the account is disabled. - items: - maxLength: 5000 - type: string - nullable: true - type: array - errors: - description: >- - Fields that are `currently_due` and need to be collected again - because validation or verification failed. - items: - $ref: '#/components/schemas/account_requirements_error' - nullable: true - type: array - past_due: - description: >- - Fields that weren't collected by `current_deadline`. These fields - need to be collected to enable the external account. - items: - maxLength: 5000 - type: string - nullable: true - type: array - pending_verification: + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + object: description: >- - Fields that may become required depending on the results of - verification or review. Will be an empty array unless an - asynchronous verification is pending. If verification fails, these - fields move to `eventually_due`, `currently_due`, or `past_due`. - items: - maxLength: 5000 - type: string - nullable: true - type: array - title: ExternalAccountRequirements + String representing the object's type. Objects of the same type + share the same value. + enum: + - invoiceitem + type: string + required: + - deleted + - id + - object + title: DeletedInvoiceItem type: object - x-expandableFields: - - errors - fee: + x-expandableFields: [] + x-resourceId: deleted_invoiceitem + deleted_payment_source: + anyOf: + - $ref: '#/components/schemas/deleted_bank_account' + - $ref: '#/components/schemas/deleted_card' + title: Polymorphic + x-resourceId: deleted_payment_source + x-stripeBypassValidation: true + deleted_person: description: '' properties: - amount: - description: 'Amount of the fee, in cents.' - type: integer - application: - description: ID of the Connect application that earned the fee. + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean + id: + description: Unique identifier for the object. maxLength: 5000 - nullable: true type: string - 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). - type: string - description: + object: description: >- - An arbitrary string attached to the object. Often useful for - displaying to users. - maxLength: 5000 - nullable: true - type: string - type: - description: 'Type of the fee, one of: `application_fee`, `stripe_fee` or `tax`.' - maxLength: 5000 + String representing the object's type. Objects of the same type + share the same value. + enum: + - person type: string required: - - amount - - currency - - type - title: Fee + - deleted + - id + - object + title: DeletedPerson type: object x-expandableFields: [] - fee_refund: - description: >- - `Application Fee Refund` objects allow you to refund an application fee - that - - has previously been created but not yet refunded. Funds will be refunded - to - - the Stripe account from which the fee was originally collected. - - - Related guide: [Refunding application - fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee) + x-resourceId: deleted_person + deleted_plan: + description: '' properties: - amount: - description: 'Amount, in cents (or local equivalent).' - type: integer - balance_transaction: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/balance_transaction' - description: >- - Balance transaction that describes the impact on your account - balance. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/balance_transaction' - created: - description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time - type: integer - 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). - type: string - fee: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/application_fee' - description: ID of the application fee that was refunded. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/application_fee' + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string - metadata: - additionalProperties: - maxLength: 500 - type: 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. - nullable: true - type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - fee_refund + - plan type: string required: - - amount - - created - - currency - - fee + - deleted - id - object - title: FeeRefund + title: DeletedPlan type: object - x-expandableFields: - - balance_transaction - - fee - x-resourceId: fee_refund - file: - description: >- - This object represents files hosted on Stripe's servers. You can upload - - files with the [create file](https://stripe.com/docs/api#create_file) - request - - (for example, when uploading dispute evidence). Stripe also - - creates files independetly (for example, the results of a [Sigma - scheduled - - query](#scheduled_queries)). - - - Related guide: [File upload guide](https://stripe.com/docs/file-upload) + x-expandableFields: [] + x-resourceId: deleted_plan + deleted_price: + description: '' properties: - created: - description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time - type: integer - expires_at: - description: The file expires and isn't available at this time in epoch seconds. - format: unix-time - nullable: true - type: integer - filename: - description: The suitable name for saving the file to a filesystem. - maxLength: 5000 - nullable: true - type: string + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string - links: - description: >- - A list of [file links](https://stripe.com/docs/api#file_links) that - point at this file. - nullable: true - properties: - data: - description: Details about each object. - items: - $ref: '#/components/schemas/file_link' - type: array - has_more: - description: >- - True if this list has another page of items after this one that - can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - pattern: ^/v1/file_links - type: string - required: - - data - - has_more - - object - - url - title: FileResourceFileLinkList - type: object - x-expandableFields: - - data object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - file + - price type: string - purpose: - description: >- - The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) - of the uploaded file. + required: + - deleted + - id + - object + title: DeletedPrice + type: object + x-expandableFields: [] + deleted_product: + description: '' + properties: + deleted: + description: Always true for a deleted object enum: - - account_requirement - - additional_verification - - business_icon - - business_logo - - customer_signature - - dispute_evidence - - document_provider_identity_document - - finance_report_run - - identity_document - - identity_document_downloadable - - pci_document - - selfie - - sigma_scheduled_query - - tax_document_user_upload - - terminal_reader_splashscreen - type: string - x-stripeBypassValidation: true - size: - description: The size of the file object in bytes. - type: integer - title: - description: A suitable title for the document. - maxLength: 5000 - nullable: true - type: string - type: - description: 'The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).' + - true + type: boolean + id: + description: Unique identifier for the object. maxLength: 5000 - nullable: true type: string - url: - description: Use your live secret API key to download the file from this URL. - maxLength: 5000 - nullable: true + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - product type: string required: - - created + - deleted - id - object - - purpose - - size - title: File + title: DeletedProduct type: object - x-expandableFields: - - links - x-resourceId: file - file_link: - description: |- - To share the contents of a `File` object with non-Stripe users, you can - create a `FileLink`. `FileLink`s contain a URL that you can use to - retrieve the contents of the file without authentication. + x-expandableFields: [] + x-resourceId: deleted_product + deleted_product_feature: + description: '' properties: - created: - description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time - type: integer - expired: - description: Returns if the link is already expired. + deleted: + description: Always true for a deleted object + enum: + - true type: boolean - expires_at: - description: Time that the link expires. - format: unix-time - nullable: true - type: integer - file: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/file' - description: The file object this link points to. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/file' id: description: Unique identifier for the object. maxLength: 5000 type: string - livemode: - description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. - type: boolean - metadata: - additionalProperties: - maxLength: 500 - type: 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. - type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - file_link - type: string - url: - description: The publicly accessible URL to download the file. - maxLength: 5000 - nullable: true + - product_feature type: string required: - - created - - expired - - file + - deleted - id - - livemode - - metadata - object - title: FileLink + title: DeletedProductFeature type: object - x-expandableFields: - - file - x-resourceId: file_link - financial_connections.account: - description: >- - A Financial Connections Account represents an account that exists - outside of Stripe, to which you have been granted some degree of access. + x-expandableFields: [] + x-resourceId: deleted_product_feature + deleted_radar.value_list: + description: '' properties: - account_holder: - anyOf: - - $ref: '#/components/schemas/bank_connections_resource_accountholder' - description: The account holder that this account belongs to. - nullable: true - balance: - anyOf: - - $ref: '#/components/schemas/bank_connections_resource_balance' - description: The most recent information about the account's balance. - nullable: true - balance_refresh: - anyOf: - - $ref: '#/components/schemas/bank_connections_resource_balance_refresh' - description: The state of the most recent attempt to refresh the account balance. - nullable: true - category: - description: >- - The type of the account. Account category is further divided in - `subcategory`. + deleted: + description: Always true for a deleted object enum: - - cash - - credit - - investment - - other - type: string - created: - description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time - type: integer - display_name: - description: >- - A human-readable name that has been assigned to this account, either - by the account holder or by the institution. - maxLength: 5000 - nullable: true - type: string + - true + type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string - institution_name: - description: The name of the institution that holds this account. - maxLength: 5000 - type: string - last4: + object: description: >- - The last 4 digits of the account number. If present, this will be 4 - numeric characters. - maxLength: 5000 - nullable: true + String representing the object's type. Objects of the same type + share the same value. + enum: + - radar.value_list type: string - livemode: - description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. + required: + - deleted + - id + - object + title: RadarListDeletedList + type: object + x-expandableFields: [] + x-resourceId: deleted_radar.value_list + deleted_radar.value_list_item: + description: '' + properties: + deleted: + description: Always true for a deleted object + enum: + - true type: boolean + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - financial_connections.account + - radar.value_list_item type: string - ownership: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/financial_connections.account_ownership' - description: The most recent information about the account's owners. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/financial_connections.account_ownership' - ownership_refresh: - anyOf: - - $ref: '#/components/schemas/bank_connections_resource_ownership_refresh' - description: The state of the most recent attempt to refresh the account owners. - nullable: true - permissions: - description: The list of permissions granted by this account. - items: - enum: - - balances - - ownership - - payment_method - - transactions - type: string - nullable: true - type: array - status: - description: The status of the link to the account. - enum: - - active - - disconnected - - inactive - type: string - subcategory: - description: |- - If `category` is `cash`, one of: - - - `checking` - - `savings` - - `other` - - If `category` is `credit`, one of: - - - `mortgage` - - `line_of_credit` - - `credit_card` - - `other` - - If `category` is `investment` or `other`, this will be `other`. - enum: - - checking - - credit_card - - line_of_credit - - mortgage - - other - - savings - type: string - supported_payment_method_types: - description: >- - The [PaymentMethod - type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) - that can be created from this account. - items: - enum: - - link - - us_bank_account - type: string - type: array required: - - category - - created + - deleted - id - - institution_name - - livemode - object - - status - - subcategory - - supported_payment_method_types - title: BankConnectionsResourceLinkedAccount + title: RadarListDeletedListItem type: object - x-expandableFields: - - account_holder - - balance - - balance_refresh - - ownership - - ownership_refresh - x-resourceId: financial_connections.account - financial_connections.account_owner: - description: Describes an owner of an account. + x-expandableFields: [] + x-resourceId: deleted_radar.value_list_item + deleted_subscription_item: + description: '' properties: - email: - description: The email address of the owner. - maxLength: 5000 - nullable: true - type: string + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string - name: - description: The full name of the owner. - maxLength: 5000 - type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - financial_connections.account_owner - type: string - ownership: - description: The ownership object that this owner belongs to. - maxLength: 5000 - type: string - phone: - description: The raw phone number of the owner. - maxLength: 5000 - nullable: true - type: string - raw_address: - description: The raw physical address of the owner. - maxLength: 5000 - nullable: true + - subscription_item type: string - refreshed_at: - description: The timestamp of the refresh that updated this owner. - format: unix-time - nullable: true - type: integer required: + - deleted - id - - name - object - - ownership - title: BankConnectionsResourceOwner + title: DeletedSubscriptionItem type: object x-expandableFields: [] - x-resourceId: financial_connections.account_owner - financial_connections.account_ownership: - description: >- - Describes a snapshot of the owners of an account at a particular point - in time. + x-resourceId: deleted_subscription_item + deleted_tax_id: + description: '' properties: - created: - description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time - type: integer + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean id: description: Unique identifier for the object. maxLength: 5000 @@ -9739,1061 +9961,935 @@ components: String representing the object's type. Objects of the same type share the same value. enum: - - financial_connections.account_ownership + - tax_id type: string - owners: - description: A paginated list of owners for this account. - properties: - data: - description: Details about each object. - items: - $ref: '#/components/schemas/financial_connections.account_owner' - type: array - has_more: - description: >- - True if this list has another page of items after this one that - can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - type: string - required: - - data - - has_more - - object - - url - title: BankConnectionsResourceOwnerList - type: object - x-expandableFields: - - data required: - - created + - deleted - id - object - - owners - title: BankConnectionsResourceOwnership + title: deleted_tax_id type: object - x-expandableFields: - - owners - financial_connections.session: - description: >- - A Financial Connections Session is the secure way to programmatically - launch the client-side Stripe.js modal that lets your users link their - accounts. + x-expandableFields: [] + x-resourceId: deleted_tax_id + deleted_terminal.configuration: + description: '' properties: - account_holder: - anyOf: - - $ref: '#/components/schemas/bank_connections_resource_accountholder' - description: The account holder for whom accounts are collected in this session. - nullable: true - accounts: - description: The accounts that were collected as part of this Session. - properties: - data: - description: Details about each object. - items: - $ref: '#/components/schemas/financial_connections.account' - type: array - has_more: - description: >- - True if this list has another page of items after this one that - can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - pattern: ^/v1/financial_connections/accounts - type: string - required: - - data - - has_more - - object - - url - title: BankConnectionsResourceLinkedAccountList - type: object - x-expandableFields: - - data - client_secret: - description: >- - A value that will be passed to the client to launch the - authentication flow. - maxLength: 5000 - type: string - filters: - $ref: >- - #/components/schemas/bank_connections_resource_link_account_session_filters + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean id: description: Unique identifier for the object. maxLength: 5000 type: string - livemode: - description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. - type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - financial_connections.session - type: string - permissions: - description: Permissions requested for accounts collected during this session. - items: - enum: - - balances - - ownership - - payment_method - - transactions - type: string - x-stripeBypassValidation: true - type: array - prefetch: - description: Data features requested to be retrieved upon account creation. - items: - enum: - - balances - - ownership - type: string - x-stripeBypassValidation: true - nullable: true - type: array - return_url: - description: >- - For webview integrations only. Upon completing OAuth login in the - native browser, the user will be redirected to this URL to return to - your app. - maxLength: 5000 + - terminal.configuration type: string required: - - accounts - - client_secret + - deleted - id - - livemode - object - - permissions - title: BankConnectionsResourceLinkAccountSession + title: TerminalConfigurationDeletedConfiguration type: object - x-expandableFields: - - account_holder - - accounts - - filters - x-resourceId: financial_connections.session - financial_reporting_finance_report_run_run_parameters: + x-expandableFields: [] + x-resourceId: deleted_terminal.configuration + deleted_terminal.location: description: '' properties: - columns: - description: The set of output columns requested for inclusion in the report run. - items: - maxLength: 5000 - type: string - type: array - connected_account: - description: Connected account ID by which to filter the report run. - maxLength: 5000 - type: string - currency: - description: Currency of objects to be included in the report run. - type: string - interval_end: - description: >- - Ending timestamp of data to be included in the report run. Can be - any UTC timestamp between 1 second after the user specified - `interval_start` and 1 second before this report's last - `data_available_end` value. - format: unix-time - type: integer - interval_start: - description: >- - Starting timestamp of data to be included in the report run. Can be - any UTC timestamp between 1 second after this report's - `data_available_start` and 1 second before the user specified - `interval_end` value. - format: unix-time - type: integer - payout: - description: Payout ID by which to filter the report run. - maxLength: 5000 - type: string - reporting_category: - description: Category of balance transactions to be included in the report run. + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean + id: + description: Unique identifier for the object. maxLength: 5000 type: string - timezone: + object: description: >- - Defaults to `Etc/UTC`. The output timezone for all timestamps in the - report. A list of possible time zone values is maintained at the - [IANA Time Zone Database](http://www.iana.org/time-zones). Has no - effect on `interval_start` or `interval_end`. - maxLength: 5000 + String representing the object's type. Objects of the same type + share the same value. + enum: + - terminal.location type: string - title: FinancialReportingFinanceReportRunRunParameters + required: + - deleted + - id + - object + title: TerminalLocationDeletedLocation type: object x-expandableFields: [] - funding_instructions: - description: >- - Each customer has a - [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) - that is - - automatically applied to future invoices and payments using the - `customer_balance` payment method. - - Customers can fund this balance by initiating a bank transfer to any - account in the - - `financial_addresses` field. - - Related guide: [Customer balance funding - instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions) + x-resourceId: deleted_terminal.location + deleted_terminal.reader: + description: '' properties: - bank_transfer: - $ref: '#/components/schemas/funding_instructions_bank_transfer' - 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). - maxLength: 5000 - type: string - funding_type: - description: The `funding_type` of the returned instructions + deleted: + description: Always true for a deleted object enum: - - bank_transfer - type: string - livemode: - description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. + - true type: boolean + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - funding_instructions + - terminal.reader type: string required: - - bank_transfer - - currency - - funding_type - - livemode + - deleted + - id - object - title: CustomerBalanceFundingInstructionsCustomerBalanceFundingInstructions + title: TerminalReaderDeletedReader type: object - x-expandableFields: - - bank_transfer - x-resourceId: funding_instructions - funding_instructions_bank_transfer: + x-expandableFields: [] + x-resourceId: deleted_terminal.reader + deleted_test_helpers.test_clock: description: '' properties: - country: - description: The country of the bank account to fund + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean + id: + description: Unique identifier for the object. maxLength: 5000 type: string - financial_addresses: + object: description: >- - A list of financial addresses that can be used to fund a particular - balance - items: - $ref: >- - #/components/schemas/funding_instructions_bank_transfer_financial_address - type: array - type: - description: The bank_transfer type + String representing the object's type. Objects of the same type + share the same value. enum: - - eu_bank_transfer - - jp_bank_transfer + - test_helpers.test_clock type: string - x-stripeBypassValidation: true required: - - country - - financial_addresses - - type - title: FundingInstructionsBankTransfer + - deleted + - id + - object + title: DeletedTestClock type: object - x-expandableFields: - - financial_addresses - funding_instructions_bank_transfer_aba_record: - description: ABA Records contain U.S. bank account details per the ABA format. + x-expandableFields: [] + x-resourceId: deleted_test_helpers.test_clock + deleted_webhook_endpoint: + description: '' properties: - account_number: - description: The ABA account number - maxLength: 5000 - type: string - bank_name: - description: The bank name + deleted: + description: Always true for a deleted object + enum: + - true + type: boolean + id: + description: Unique identifier for the object. maxLength: 5000 type: string - routing_number: - description: The ABA routing number - maxLength: 5000 + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - webhook_endpoint type: string required: - - account_number - - bank_name - - routing_number - title: FundingInstructionsBankTransferABARecord + - deleted + - id + - object + title: NotificationWebhookEndpointDeleted type: object x-expandableFields: [] - funding_instructions_bank_transfer_financial_address: + x-resourceId: deleted_webhook_endpoint + destination_details_unimplemented: + description: '' + properties: {} + title: destination_details_unimplemented + type: object + x-expandableFields: [] + discount: description: >- - FinancialAddresses contain identifying information that resolves to a - FinancialAccount. + A discount represents the actual application of a + [coupon](https://stripe.com/docs/api#coupons) or [promotion + code](https://stripe.com/docs/api#promotion_codes). + + It contains information about when the discount began, when it will end, + and what it is applied to. + + + Related guide: [Applying discounts to + subscriptions](https://stripe.com/docs/billing/subscriptions/discounts) properties: - aba: - $ref: '#/components/schemas/funding_instructions_bank_transfer_aba_record' - iban: - $ref: '#/components/schemas/funding_instructions_bank_transfer_iban_record' - sort_code: - $ref: >- - #/components/schemas/funding_instructions_bank_transfer_sort_code_record - spei: - $ref: '#/components/schemas/funding_instructions_bank_transfer_spei_record' - supported_networks: - description: The payment networks supported by this FinancialAddress - items: - enum: - - ach - - bacs - - domestic_wire_us - - fps - - sepa - - spei - - swift - - zengin - type: string - x-stripeBypassValidation: true - type: array - swift: - $ref: '#/components/schemas/funding_instructions_bank_transfer_swift_record' - type: - description: The type of financial address - enum: - - aba - - iban - - sort_code - - spei - - swift - - zengin - type: string - x-stripeBypassValidation: true - zengin: - $ref: >- - #/components/schemas/funding_instructions_bank_transfer_zengin_record - required: - - type - title: FundingInstructionsBankTransferFinancialAddress - type: object - x-expandableFields: - - aba - - iban - - sort_code - - spei - - swift - - zengin - funding_instructions_bank_transfer_iban_record: - description: Iban Records contain E.U. bank account details per the SEPA format. - properties: - account_holder_name: - description: The name of the person or business that owns the bank account + checkout_session: + description: >- + The Checkout session that this coupon is applied to, if it is + applied to a particular session in payment mode. Will not be present + for subscription mode. maxLength: 5000 + nullable: true type: string - bic: - description: The BIC/SWIFT code of the account. + coupon: + $ref: '#/components/schemas/coupon' + customer: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/customer' + - $ref: '#/components/schemas/deleted_customer' + description: The ID of the customer associated with this discount. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/customer' + - $ref: '#/components/schemas/deleted_customer' + end: + description: >- + If the coupon has a duration of `repeating`, the date that this + discount will end. If the coupon has a duration of `once` or + `forever`, this attribute will be null. + format: unix-time + nullable: true + type: integer + id: + description: >- + The ID of the discount object. Discounts cannot be fetched by ID. + Use `expand[]=discounts` in API calls to expand discount IDs in an + array. maxLength: 5000 type: string - country: + invoice: description: >- - Two-letter country code ([ISO 3166-1 - alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + The invoice that the discount's coupon was applied to, if it was + applied directly to a particular invoice. maxLength: 5000 + nullable: true type: string - iban: - description: The IBAN of the account. + invoice_item: + description: >- + The invoice item `id` (or invoice line item `id` for invoice line + items of type='subscription') that the discount's coupon was applied + to, if it was applied directly to a particular invoice item or + invoice line item. maxLength: 5000 + nullable: true type: string - required: - - account_holder_name - - bic - - country - - iban - title: FundingInstructionsBankTransferIbanRecord - type: object - x-expandableFields: [] - 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_name: - description: The name of the person or business that owns the bank account - maxLength: 5000 + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - discount type: string - account_number: - description: The account number + promotion_code: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/promotion_code' + description: The promotion code applied to create this discount. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/promotion_code' + start: + description: Date that the coupon was applied. + format: unix-time + type: integer + subscription: + description: >- + The subscription that this coupon is applied to, if it is applied to + a particular subscription. maxLength: 5000 + nullable: true type: string - sort_code: - description: The six-digit sort code + subscription_item: + description: >- + The subscription item that this coupon is applied to, if it is + applied to a particular subscription item. maxLength: 5000 + nullable: true type: string required: - - account_holder_name - - account_number - - sort_code - title: FundingInstructionsBankTransferSortCodeRecord + - coupon + - id + - object + - start + title: Discount type: object - x-expandableFields: [] - funding_instructions_bank_transfer_spei_record: - description: SPEI Records contain Mexico bank account details per the SPEI format. + x-expandableFields: + - coupon + - customer + - promotion_code + x-resourceId: discount + discounts_resource_discount_amount: + description: '' properties: - bank_code: - description: The three-digit bank code - maxLength: 5000 - type: string - bank_name: - description: The short banking institution name - maxLength: 5000 - type: string - clabe: - description: The CLABE number - maxLength: 5000 - type: string + amount: + description: 'The amount, in cents (or local equivalent), of the discount.' + type: integer + discount: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/discount' + - $ref: '#/components/schemas/deleted_discount' + description: The discount that was applied to get this discount amount. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/discount' + - $ref: '#/components/schemas/deleted_discount' required: - - bank_code - - bank_name - - clabe - title: FundingInstructionsBankTransferSpeiRecord + - amount + - discount + title: DiscountsResourceDiscountAmount type: object - x-expandableFields: [] - funding_instructions_bank_transfer_swift_record: - description: SWIFT Records contain U.S. bank account details per the SWIFT format. + x-expandableFields: + - discount + discounts_resource_stackable_discount: + description: '' properties: - account_number: - description: The account number - maxLength: 5000 + coupon: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/coupon' + description: ID of the coupon to create a new discount for. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/coupon' + discount: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/discount' + description: >- + ID of an existing discount on the object (or one of its ancestors) + to reuse. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/discount' + promotion_code: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/promotion_code' + description: ID of the promotion code to create a new discount for. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/promotion_code' + title: DiscountsResourceStackableDiscount + type: object + x-expandableFields: + - coupon + - discount + - promotion_code + dispute: + description: >- + A dispute occurs when a customer questions your charge with their card + issuer. + + When this happens, you have the opportunity to respond to the dispute + with + + evidence that shows that the charge is legitimate. + + + Related guide: [Disputes and fraud](https://stripe.com/docs/disputes) + properties: + amount: + description: >- + Disputed amount. Usually the amount of the charge, but it can differ + (usually because of currency fluctuation or because only part of the + order is disputed). + type: integer + balance_transactions: + description: >- + List of zero, one, or two balance transactions that show funds + withdrawn and reinstated to your Stripe account as a result of this + dispute. + items: + $ref: '#/components/schemas/balance_transaction' + type: array + charge: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/charge' + description: ID of the charge that's disputed. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/charge' + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + 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). type: string - bank_name: - description: The bank name + evidence: + $ref: '#/components/schemas/dispute_evidence' + evidence_details: + $ref: '#/components/schemas/dispute_evidence_details' + id: + description: Unique identifier for the object. maxLength: 5000 type: string - swift_code: - description: The SWIFT code + is_charge_refundable: + description: >- + If true, it's still possible to refund the disputed payment. After + the payment has been fully refunded, no further funds are withdrawn + from your Stripe account as a result of this dispute. + type: boolean + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + metadata: + additionalProperties: + maxLength: 500 + type: 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. + type: object + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - dispute + type: string + payment_intent: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/payment_intent' + description: ID of the PaymentIntent that's disputed. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/payment_intent' + payment_method_details: + $ref: '#/components/schemas/dispute_payment_method_details' + reason: + description: >- + Reason given by cardholder for dispute. Possible values are + `bank_cannot_process`, `check_returned`, `credit_not_processed`, + `customer_initiated`, `debit_not_authorized`, `duplicate`, + `fraudulent`, `general`, `incorrect_account_details`, + `insufficient_funds`, `product_not_received`, + `product_unacceptable`, `subscription_canceled`, or `unrecognized`. + Learn more about [dispute + reasons](https://stripe.com/docs/disputes/categories). maxLength: 5000 type: string + status: + description: >- + Current status of dispute. Possible values are + `warning_needs_response`, `warning_under_review`, `warning_closed`, + `needs_response`, `under_review`, `won`, or `lost`. + enum: + - lost + - needs_response + - under_review + - warning_closed + - warning_needs_response + - warning_under_review + - won + type: string required: - - account_number - - bank_name - - swift_code - title: FundingInstructionsBankTransferSwiftRecord + - amount + - balance_transactions + - charge + - created + - currency + - evidence + - evidence_details + - id + - is_charge_refundable + - livemode + - metadata + - object + - reason + - status + title: Dispute type: object - x-expandableFields: [] - funding_instructions_bank_transfer_zengin_record: - description: Zengin Records contain Japan bank account details per the Zengin format. + x-expandableFields: + - balance_transactions + - charge + - evidence + - evidence_details + - payment_intent + - payment_method_details + x-resourceId: dispute + dispute_evidence: + description: '' properties: - account_holder_name: - description: The account holder name - maxLength: 5000 + access_activity_log: + 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. + maxLength: 150000 nullable: true type: string - account_number: - description: The account number + billing_address: + description: The billing address provided by the customer. maxLength: 5000 nullable: true type: string - account_type: - description: 'The bank account type. In Japan, this can only be `futsu` or `toza`.' - maxLength: 5000 + cancellation_policy: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/file' + description: >- + (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) + Your subscription cancellation policy, as shown to the customer. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/file' + cancellation_policy_disclosure: + description: >- + An explanation of how and when the customer was shown your refund + policy prior to purchase. + maxLength: 150000 nullable: true type: string - bank_code: - description: The bank code of the account - maxLength: 5000 + cancellation_rebuttal: + description: >- + A justification for why the customer's subscription was not + canceled. + maxLength: 150000 nullable: true type: string - bank_name: - description: The bank name of the account + customer_communication: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/file' + description: >- + (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) + Any communication with the customer that you feel is relevant to + your case. Examples include emails proving that the customer + received the product or service, or demonstrating their use of or + satisfaction with the product or service. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/file' + customer_email_address: + description: The email address of the customer. maxLength: 5000 nullable: true type: string - branch_code: - description: The branch code of the account + customer_name: + description: The name of the customer. maxLength: 5000 nullable: true type: string - branch_name: - description: The branch name of the account + customer_purchase_ip: + description: The IP address that the customer used when making the purchase. maxLength: 5000 nullable: true type: string - title: FundingInstructionsBankTransferZenginRecord - type: object - x-expandableFields: [] - gelato_data_document_report_date_of_birth: - description: Point in Time - properties: - day: - description: Numerical day between 1 and 31. + customer_signature: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/file' + description: >- + (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) + A relevant document or contract showing the customer's signature. nullable: true - type: integer - month: - description: Numerical month between 1 and 12. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/file' + duplicate_charge_documentation: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/file' + description: >- + (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) + Documentation for the prior charge that can uniquely identify the + charge, such as a receipt, shipping label, work order, etc. This + document should be paired with a similar document from the disputed + payment that proves the two payments are separate. nullable: true - type: integer - year: - description: The four-digit year. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/file' + duplicate_charge_explanation: + description: >- + An explanation of the difference between the disputed charge versus + the prior charge that appears to be a duplicate. + maxLength: 150000 nullable: true - type: integer - title: GelatoDataDocumentReportDateOfBirth - type: object - x-expandableFields: [] - gelato_data_document_report_expiration_date: - description: Point in Time - properties: - day: - description: Numerical day between 1 and 31. - nullable: true - type: integer - month: - description: Numerical month between 1 and 12. - nullable: true - type: integer - year: - description: The four-digit year. - nullable: true - type: integer - title: GelatoDataDocumentReportExpirationDate - type: object - x-expandableFields: [] - gelato_data_document_report_issued_date: - description: Point in Time - properties: - day: - description: Numerical day between 1 and 31. - nullable: true - type: integer - month: - description: Numerical month between 1 and 12. - nullable: true - type: integer - year: - description: The four-digit year. - nullable: true - type: integer - title: GelatoDataDocumentReportIssuedDate - type: object - x-expandableFields: [] - gelato_data_id_number_report_date: - description: Point in Time - properties: - day: - description: Numerical day between 1 and 31. - nullable: true - type: integer - month: - description: Numerical month between 1 and 12. - nullable: true - type: integer - year: - description: The four-digit year. - nullable: true - type: integer - title: GelatoDataIdNumberReportDate - type: object - x-expandableFields: [] - gelato_data_verified_outputs_date: - description: Point in Time - properties: - day: - description: Numerical day between 1 and 31. - nullable: true - type: integer - month: - description: Numerical month between 1 and 12. + type: string + duplicate_charge_id: + description: >- + The Stripe ID for the prior charge which appears to be a duplicate + of the disputed charge. + maxLength: 5000 nullable: true - type: integer - year: - description: The four-digit year. + type: string + product_description: + description: A description of the product or service that was sold. + maxLength: 150000 nullable: true - type: integer - title: GelatoDataVerifiedOutputsDate - type: object - x-expandableFields: [] - gelato_document_report: - description: Result from a document check - properties: - address: + type: string + receipt: anyOf: - - $ref: '#/components/schemas/address' - description: Address as it appears in the document. + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/file' + description: >- + (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) + Any receipt or message sent to the customer notifying them of the + charge. nullable: true - dob: + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/file' + refund_policy: anyOf: - - $ref: '#/components/schemas/gelato_data_document_report_date_of_birth' - description: Date of birth as it appears in the document. + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/file' + description: >- + (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) + Your refund policy, as shown to the customer. nullable: true - error: - anyOf: - - $ref: '#/components/schemas/gelato_document_report_error' + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/file' + refund_policy_disclosure: description: >- - Details on the verification error. Present when status is - `unverified`. + Documentation demonstrating that the customer was shown your refund + policy prior to purchase. + maxLength: 150000 nullable: true - expiration_date: - anyOf: - - $ref: '#/components/schemas/gelato_data_document_report_expiration_date' - description: Expiration date of the document. + type: string + refund_refusal_explanation: + description: A justification for why the customer is not entitled to a refund. + maxLength: 150000 nullable: true - files: + type: string + service_date: description: >- - Array of [File](https://stripe.com/docs/api/files) ids containing - images for this document. - items: - maxLength: 5000 - type: string - nullable: true - type: array - first_name: - description: First name as it appears in the document. + The date on which the customer received or began receiving the + purchased service, in a clear human-readable format. maxLength: 5000 nullable: true type: string - issued_date: + service_documentation: anyOf: - - $ref: '#/components/schemas/gelato_data_document_report_issued_date' - description: Issued date of the document. + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/file' + description: >- + (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) + Documentation showing proof that a service was provided to the + customer. This could include a copy of a signed contract, work + order, or other form of written agreement. nullable: true - issuing_country: - description: Issuing country of the document. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/file' + shipping_address: + description: >- + The address to which a physical product was shipped. You should try + to include as complete address information as possible. maxLength: 5000 nullable: true type: string - last_name: - description: Last name as it appears in the document. + shipping_carrier: + description: >- + The delivery service that shipped a physical product, such as Fedex, + UPS, USPS, etc. If multiple carriers were used for this purchase, + please separate them with commas. maxLength: 5000 nullable: true type: string - number: - description: Document ID number. + shipping_date: + description: >- + The date on which a physical product began its route to the shipping + address, in a clear human-readable format. maxLength: 5000 nullable: true type: string - status: - description: Status of this `document` check. - enum: - - unverified - - verified + shipping_documentation: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/file' + description: >- + (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) + Documentation showing proof that a product was shipped to the + customer at the same address the customer provided to you. This + could include a copy of the shipment receipt, shipping label, etc. + It should show the customer's full shipping address, if possible. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/file' + shipping_tracking_number: + description: >- + The tracking number for a physical product, obtained from the + delivery service. If multiple tracking numbers were generated for + this purchase, please separate them with commas. + maxLength: 5000 + nullable: true type: string - x-stripeBypassValidation: true - type: - description: Type of the document. - enum: - - driving_license - - id_card - - passport + uncategorized_file: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/file' + description: >- + (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) + Any additional evidence or statements. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/file' + uncategorized_text: + description: Any additional evidence or statements. + maxLength: 150000 nullable: true type: string - required: - - status - title: GelatoDocumentReport + title: DisputeEvidence type: object x-expandableFields: - - address - - dob - - error - - expiration_date - - issued_date - gelato_document_report_error: + - cancellation_policy + - customer_communication + - customer_signature + - duplicate_charge_documentation + - receipt + - refund_policy + - service_documentation + - shipping_documentation + - uncategorized_file + dispute_evidence_details: description: '' properties: - code: + due_by: description: >- - A short machine-readable string giving the reason for the - verification failure. - enum: - - document_expired - - document_type_not_supported - - document_unverified_other + Date by which evidence must be submitted in order to successfully + challenge dispute. Will be 0 if the customer's bank or credit card + company doesn't allow a response for this particular dispute. + format: unix-time nullable: true - type: string - x-stripeBypassValidation: true - reason: + type: integer + has_evidence: + description: Whether evidence has been staged for this dispute. + type: boolean + past_due: description: >- - A human-readable message giving the reason for the failure. These - messages can be shown to your users. - maxLength: 5000 - nullable: true - type: string - title: GelatoDocumentReportError + Whether the last evidence submission was submitted past the due + date. Defaults to `false` if no evidence submissions have occurred. + If `true`, then delivery of the latest evidence is *not* guaranteed. + type: boolean + submission_count: + description: >- + The number of times evidence has been submitted. Typically, you may + only submit evidence once. + type: integer + required: + - has_evidence + - past_due + - submission_count + title: DisputeEvidenceDetails type: object x-expandableFields: [] - gelato_id_number_report: - description: Result from an id_number check + dispute_payment_method_details: + description: '' properties: - dob: - anyOf: - - $ref: '#/components/schemas/gelato_data_id_number_report_date' - description: Date of birth. - nullable: true - error: - anyOf: - - $ref: '#/components/schemas/gelato_id_number_report_error' - description: >- - Details on the verification error. Present when status is - `unverified`. - nullable: true - first_name: - description: First name. - maxLength: 5000 - nullable: true - type: string - id_number: - description: ID number. - maxLength: 5000 - nullable: true - type: string - id_number_type: - description: Type of ID number. - enum: - - br_cpf - - sg_nric - - us_ssn - nullable: true - type: string - last_name: - description: Last name. - maxLength: 5000 - nullable: true - type: string - status: - description: Status of this `id_number` check. + card: + $ref: '#/components/schemas/dispute_payment_method_details_card' + type: + description: Payment method type. enum: - - unverified - - verified + - card type: string x-stripeBypassValidation: true required: - - status - title: GelatoIdNumberReport + - type + title: DisputePaymentMethodDetails type: object x-expandableFields: - - dob - - error - gelato_id_number_report_error: + - card + dispute_payment_method_details_card: description: '' properties: - code: + brand: description: >- - A short machine-readable string giving the reason for the - verification failure. - enum: - - id_number_insufficient_document_data - - id_number_mismatch - - id_number_unverified_other - nullable: true + Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, + `mastercard`, `unionpay`, `visa`, or `unknown`. + maxLength: 5000 type: string - reason: + network_reason_code: description: >- - A human-readable message giving the reason for the failure. These - messages can be shown to your users. + The card network's specific dispute reason code, which maps to one + of Stripe's primary dispute categories to simplify response + guidance. The [Network code + map](https://stripe.com/docs/disputes/categories#network-code-map) + lists all available dispute reason codes by network. maxLength: 5000 nullable: true type: string - title: GelatoIdNumberReportError + required: + - brand + title: DisputePaymentMethodDetailsCard type: object x-expandableFields: [] - gelato_report_document_options: + email_sent: description: '' properties: - allowed_types: - description: >- - Array of strings of allowed identity document types. If the provided - identity document isn’t one of the allowed types, the verification - check will fail with a document_type_not_allowed error code. - items: - enum: - - driving_license - - id_card - - passport - type: string - type: array - require_id_number: - description: >- - Collect an ID number and perform an [ID number - check](https://stripe.com/docs/identity/verification-checks?type=id-number) - with the document’s extracted name and date of birth. - type: boolean - require_live_capture: - description: >- - Disable image uploads, identity document images have to be captured - using the device’s camera. - type: boolean - require_matching_selfie: - description: >- - Capture a face image and perform a [selfie - check](https://stripe.com/docs/identity/verification-checks?type=selfie) - comparing a photo ID and a picture of your user’s face. [Learn - more](https://stripe.com/docs/identity/selfie). - type: boolean - title: GelatoReportDocumentOptions - type: object - x-expandableFields: [] - gelato_report_id_number_options: - description: '' - properties: {} - title: GelatoReportIdNumberOptions + email_sent_at: + description: The timestamp when the email was sent. + format: unix-time + type: integer + email_sent_to: + description: The recipient's email address. + maxLength: 5000 + type: string + required: + - email_sent_at + - email_sent_to + title: EmailSent type: object x-expandableFields: [] - gelato_selfie_report: - description: Result from a selfie check + entitlements.active_entitlement: + description: An active entitlement describes access to a feature for a customer. properties: - document: + feature: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/entitlements.feature' description: >- - ID of the [File](https://stripe.com/docs/api/files) holding the - image of the identity document used in this check. + The [Feature](https://stripe.com/docs/api/entitlements/feature) that + the customer is entitled to. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/entitlements.feature' + id: + description: Unique identifier for the object. maxLength: 5000 - nullable: true type: string - error: - anyOf: - - $ref: '#/components/schemas/gelato_selfie_report_error' + livemode: description: >- - Details on the verification error. Present when status is - `unverified`. - nullable: true - selfie: + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + lookup_key: description: >- - ID of the [File](https://stripe.com/docs/api/files) holding the - image of the selfie used in this check. + A unique key you provide as your own system identifier. This may be + up to 80 characters. maxLength: 5000 - nullable: true type: string - status: - description: Status of this `selfie` check. + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. enum: - - unverified - - verified + - entitlements.active_entitlement type: string - x-stripeBypassValidation: true required: - - status - title: GelatoSelfieReport + - feature + - id + - livemode + - lookup_key + - object + title: ActiveEntitlement type: object x-expandableFields: - - error - gelato_selfie_report_error: - description: '' + - feature + x-resourceId: entitlements.active_entitlement + entitlements.feature: + description: >- + A feature represents a monetizable ability or functionality in your + system. + + Features can be assigned to products, and when those products are + purchased, Stripe will create an entitlement to the feature for the + purchasing customer. properties: - code: + active: description: >- - A short machine-readable string giving the reason for the - verification failure. - enum: - - selfie_document_missing_photo - - selfie_face_mismatch - - selfie_manipulated - - selfie_unverified_other - nullable: true + Inactive features cannot be attached to new products and will not be + returned from the features list endpoint. + type: boolean + id: + description: Unique identifier for the object. + maxLength: 5000 type: string - reason: + livemode: description: >- - A human-readable message giving the reason for the failure. These - messages can be shown to your users. + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + lookup_key: + description: >- + A unique key you provide as your own system identifier. This may be + up to 80 characters. maxLength: 5000 - nullable: true type: string - title: GelatoSelfieReportError - type: object - x-expandableFields: [] - gelato_session_document_options: - description: '' - properties: - allowed_types: - description: >- - Array of strings of allowed identity document types. If the provided - identity document isn’t one of the allowed types, the verification - check will fail with a document_type_not_allowed error code. - items: - enum: - - driving_license - - id_card - - passport + metadata: + additionalProperties: + maxLength: 500 type: string - type: array - require_id_number: description: >- - Collect an ID number and perform an [ID number - check](https://stripe.com/docs/identity/verification-checks?type=id-number) - with the document’s extracted name and date of birth. - type: boolean - require_live_capture: - description: >- - Disable image uploads, identity document images have to be captured - using the device’s camera. - type: boolean - require_matching_selfie: - description: >- - Capture a face image and perform a [selfie - check](https://stripe.com/docs/identity/verification-checks?type=selfie) - comparing a photo ID and a picture of your user’s face. [Learn - more](https://stripe.com/docs/identity/selfie). - type: boolean - title: GelatoSessionDocumentOptions - type: object - x-expandableFields: [] - gelato_session_id_number_options: - description: '' - properties: {} - title: GelatoSessionIdNumberOptions - type: object - x-expandableFields: [] - gelato_session_last_error: - description: Shows last VerificationSession error - properties: - code: + Set of key-value pairs that you can attach to an object. This can be + useful for storing additional information about the object in a + structured format. + type: object + name: description: >- - A short machine-readable string giving the reason for the - verification or user-session failure. - enum: - - abandoned - - consent_declined - - country_not_supported - - device_not_supported - - document_expired - - document_type_not_supported - - document_unverified_other - - id_number_insufficient_document_data - - id_number_mismatch - - id_number_unverified_other - - selfie_document_missing_photo - - selfie_face_mismatch - - selfie_manipulated - - selfie_unverified_other - - under_supported_age - nullable: true + The feature's name, for your own purpose, not meant to be + displayable to the customer. + maxLength: 80 type: string - x-stripeBypassValidation: true - reason: + object: description: >- - A message that explains the reason for verification or user-session - failure. - maxLength: 5000 - nullable: true + String representing the object's type. Objects of the same type + share the same value. + enum: + - entitlements.feature type: string - title: GelatoSessionLastError + required: + - active + - id + - livemode + - lookup_key + - metadata + - name + - object + title: Feature type: object x-expandableFields: [] - gelato_verification_report_options: - description: '' - properties: - document: - $ref: '#/components/schemas/gelato_report_document_options' - id_number: - $ref: '#/components/schemas/gelato_report_id_number_options' - title: GelatoVerificationReportOptions - type: object - x-expandableFields: - - document - - id_number - gelato_verification_session_options: - description: '' - properties: - document: - $ref: '#/components/schemas/gelato_session_document_options' - id_number: - $ref: '#/components/schemas/gelato_session_id_number_options' - title: GelatoVerificationSessionOptions - type: object - x-expandableFields: - - document - - id_number - gelato_verified_outputs: + x-resourceId: entitlements.feature + ephemeral_key: description: '' - properties: - address: - anyOf: - - $ref: '#/components/schemas/address' - description: The user's verified address. - nullable: true - dob: - anyOf: - - $ref: '#/components/schemas/gelato_data_verified_outputs_date' - description: The user’s verified date of birth. - nullable: true - first_name: - description: The user's verified first name. - maxLength: 5000 - nullable: true - type: string - id_number: - description: The user's verified id number. - maxLength: 5000 - nullable: true - type: string - id_number_type: - description: The user's verified id number type. - enum: - - br_cpf - - sg_nric - - us_ssn - nullable: true - type: string - last_name: - description: The user's verified last name. - maxLength: 5000 - nullable: true - type: string - title: GelatoVerifiedOutputs - type: object - x-expandableFields: - - address - - dob - identity.verification_report: - description: >- - A VerificationReport is the result of an attempt to collect and verify - data from a user. - - The collection of verification checks performed is determined from the - `type` and `options` - - parameters used. You can find the result of each verification check - performed in the - - appropriate sub-resource: `document`, `id_number`, `selfie`. - - - Each VerificationReport contains a copy of any data collected by the - user as well as - - reference IDs which can be used to access collected images through the - [FileUpload](https://stripe.com/docs/api/files) - - API. To configure and create VerificationReports, use the - - [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) - API. - - - Related guides: [Accessing verification - results](https://stripe.com/docs/identity/verification-sessions#results). properties: created: description: >- @@ -10801,14 +10897,16 @@ components: Unix epoch. format: unix-time type: integer - document: - $ref: '#/components/schemas/gelato_document_report' + expires: + description: >- + Time at which the key will expire. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer id: description: Unique identifier for the object. maxLength: 5000 type: string - id_number: - $ref: '#/components/schemas/gelato_id_number_report' livemode: description: >- Has the value `true` if the object exists in live mode or the value @@ -10819,76 +10917,106 @@ components: String representing the object's type. Objects of the same type share the same value. enum: - - identity.verification_report - type: string - options: - $ref: '#/components/schemas/gelato_verification_report_options' - selfie: - $ref: '#/components/schemas/gelato_selfie_report' - type: - description: Type of report. - enum: - - document - - id_number + - ephemeral_key type: string - x-stripeBypassValidation: true - verification_session: - description: ID of the VerificationSession that created this report. + secret: + description: >- + The key's secret. You can use this value to make authorized requests + to the Stripe API. maxLength: 5000 - nullable: true type: string required: - created + - expires - id - livemode - object - title: GelatoVerificationReport + title: EphemeralKey type: object - x-expandableFields: - - document - - id_number - - options - - selfie - x-resourceId: identity.verification_report - identity.verification_session: + x-expandableFields: [] + x-resourceId: ephemeral_key + error: + description: An error response from the Stripe API + properties: + error: + $ref: '#/components/schemas/api_errors' + required: + - error + type: object + event: description: >- - A VerificationSession guides you through the process of collecting and - verifying the identities + Events are our way of letting you know when something interesting + happens in - of your users. It contains details about the type of verification, such - as what [verification + your account. When an interesting event occurs, we create a new `Event` - check](/docs/identity/verification-checks) to perform. Only create one - VerificationSession for + object. For example, when a charge succeeds, we create a + `charge.succeeded` - each verification in your system. + event, and when an invoice payment attempt fails, we create an + + `invoice.payment_failed` event. Certain API requests might create + multiple + events. For example, if you create a new subscription for a - A VerificationSession transitions through [multiple + customer, you receive both a `customer.subscription.created` event and a - statuses](/docs/identity/how-sessions-work) throughout its lifetime as - it progresses through + `charge.succeeded` event. - the verification flow. The VerificationSession contains the user's - verified data after - verification checks are complete. + Events occur when the state of another API resource changes. The event's + data + field embeds the resource's state at the time of the change. For - Related guide: [The Verification Sessions - API](https://stripe.com/docs/identity/verification-sessions) + example, a `charge.succeeded` event contains a charge, and an + + `invoice.payment_failed` event contains an invoice. + + + As with other API resources, you can use endpoints to retrieve an + + [individual event](https://stripe.com/docs/api#retrieve_event) or a + [list of events](https://stripe.com/docs/api#list_events) + + from the API. We also have a separate + + [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the + + `Event` objects directly to an endpoint on your server. You can manage + + webhooks in your + + [account settings](https://dashboard.stripe.com/account/webhooks). Learn + how + + to [listen for events](https://docs.stripe.com/webhooks) + + so that your integration can automatically trigger reactions. + + + When using [Connect](https://docs.stripe.com/connect), you can also + receive event notifications + + that occur in connected accounts. For these events, there's an + + additional `account` attribute in the received `Event` object. + + + We only guarantee access to events through the [Retrieve Event + API](https://stripe.com/docs/api#retrieve_event) + + for 30 days. properties: - client_secret: + account: + description: The connected account that originates the event. + maxLength: 5000 + type: string + api_version: description: >- - The short-lived client secret used by Stripe.js to [show a - verification modal](https://stripe.com/docs/js/identity/modal) - inside your app. This client secret expires after 24 hours and can - only be used once. Don’t store it, log it, embed it in a URL, or - expose it to anyone other than the user. Make sure that you have TLS - enabled on any page that includes the client secret. Refer to our - docs on [passing the client secret to the - frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) - to learn more. + The Stripe API version used to render `data`. This property is + populated only for events on or after October 31, 2014. maxLength: 5000 nullable: true type: string @@ -10898,405 +11026,268 @@ components: Unix epoch. format: unix-time type: integer + data: + $ref: '#/components/schemas/notification_event_data' id: description: Unique identifier for the object. maxLength: 5000 type: string - last_error: - anyOf: - - $ref: '#/components/schemas/gelato_session_last_error' - description: >- - If present, this property tells you the last error encountered when - processing the verification. - nullable: true - last_verification_report: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/identity.verification_report' - description: >- - ID of the most recent VerificationReport. [Learn more about - accessing detailed verification - results.](https://stripe.com/docs/identity/verification-sessions#results) - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/identity.verification_report' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean - metadata: - additionalProperties: - maxLength: 500 - type: 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. - type: object object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - identity.verification_session + - event type: string - options: - anyOf: - - $ref: '#/components/schemas/gelato_verification_session_options' - description: A set of options for the session’s verification checks. - nullable: true - redaction: - anyOf: - - $ref: '#/components/schemas/verification_session_redaction' + pending_webhooks: description: >- - Redaction status of this VerificationSession. If the - VerificationSession is not redacted, this field will be null. + Number of webhooks that haven't been successfully delivered (for + example, to return a 20x response) to the URLs you specify. + type: integer + request: + anyOf: + - $ref: '#/components/schemas/notification_event_request' + description: Information on the API request that triggers the event. nullable: true - status: - description: >- - Status of this VerificationSession. [Learn more about the lifecycle - of sessions](https://stripe.com/docs/identity/how-sessions-work). - enum: - - canceled - - processing - - requires_input - - verified - type: string type: description: >- - The type of [verification - check](https://stripe.com/docs/identity/verification-checks) to be - performed. - enum: - - document - - id_number - nullable: true - type: string - x-stripeBypassValidation: true - url: - description: >- - The short-lived URL that you use to redirect a user to Stripe to - submit their identity information. This URL expires after 48 hours - and can only be used once. Don’t store it, log it, send it in emails - or expose it to anyone other than the user. Refer to our docs on - [verifying identity - documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) - to learn how to redirect users to Stripe. + Description of the event (for example, `invoice.created` or + `charge.refunded`). maxLength: 5000 - nullable: true type: string - verified_outputs: - anyOf: - - $ref: '#/components/schemas/gelato_verified_outputs' - description: The user’s verified data. - nullable: true required: - created + - data - id - livemode - - metadata - object - - status - title: GelatoVerificationSession - type: object - x-expandableFields: - - last_error - - last_verification_report - - options - - redaction - - verified_outputs - x-resourceId: identity.verification_session - inbound_transfers: - description: '' - properties: - billing_details: - $ref: '#/components/schemas/treasury_shared_resource_billing_details' - type: - description: The type of the payment method used in the InboundTransfer. - enum: - - us_bank_account - type: string - x-stripeBypassValidation: true - us_bank_account: - $ref: >- - #/components/schemas/inbound_transfers_payment_method_details_us_bank_account - required: - - billing_details + - pending_webhooks - type - title: InboundTransfers + title: NotificationEvent type: object x-expandableFields: - - billing_details - - us_bank_account - inbound_transfers_payment_method_details_us_bank_account: - description: '' - properties: - account_holder_type: - description: 'Account holder type: individual or company.' - enum: - - company - - individual - nullable: true - type: string - account_type: - description: 'Account type: checkings or savings. Defaults to checking if omitted.' - enum: - - checking - - savings - nullable: true - type: string - bank_name: - description: Name of the bank associated with the bank account. - maxLength: 5000 - nullable: true - type: string - fingerprint: - description: >- - Uniquely identifies this particular bank account. You can use this - attribute to check whether two bank accounts are the same. - maxLength: 5000 - nullable: true - type: string - last4: - description: Last four digits of the bank account number. - maxLength: 5000 - nullable: true - type: string - network: - description: The US bank account network used to debit funds. - enum: - - ach - type: string - routing_number: - description: Routing number of the bank account. - maxLength: 5000 - nullable: true - type: string - required: - - network - title: inbound_transfers_payment_method_details_us_bank_account - type: object - x-expandableFields: [] - invoice: + - data + - request + x-resourceId: event + exchange_rate: description: >- - Invoices are statements of amounts owed by a customer, and are either - - generated one-off, or generated periodically from a subscription. + `ExchangeRate` objects allow you to determine the rates that Stripe is + currently + using to convert from one currency to another. Since this number is + variable - They contain [invoice items](https://stripe.com/docs/api#invoiceitems), - and proration adjustments + throughout the day, there are various reasons why you might want to know + the current - that may be caused by subscription upgrades/downgrades (if necessary). + rate (for example, to dynamically price an item for a user with a + default + payment in a foreign currency). - If your invoice is configured to be billed through automatic charges, - Stripe automatically finalizes your invoice and attempts payment. Note + Please refer to our [Exchange Rates + API](https://stripe.com/docs/fx-rates) guide for more details. - that finalizing the invoice, - [when - automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), - does + *[Note: this integration path is supported but no longer recommended]* + Additionally, - not happen immediately as the invoice is created. Stripe waits + you can guarantee that a charge is made with an exchange rate that you + expect is - until one hour after the last webhook was successfully sent (or the last + current. To do so, you must pass in the exchange_rate to charges + endpoints. If the - webhook timed out after failing). If you (and the platforms you may have + value is no longer up to date, the charge won't go through. Please refer + to our - connected to) have no webhooks configured, Stripe waits one hour after + [Using with charges](https://stripe.com/docs/exchange-rates) guide for + more details. - creation to finalize the invoice. + ----- - If your invoice is configured to be billed by sending an email, then - based on your - [email - settings](https://dashboard.stripe.com/account/billing/automatic), +   - Stripe will email the invoice to your customer and await payment. These - emails can contain a link to a hosted page to pay the invoice. - - - Stripe applies any customer credit on the account before determining the - - amount due for the invoice (i.e., the amount that will be actually - - charged). If the amount due for the invoice is less than Stripe's - [minimum allowed charge - - per currency](/docs/currencies#minimum-and-maximum-charge-amounts), the + *This Exchange Rates API is a Beta Service and is subject to Stripe's + terms of service. You may use the API solely for the purpose of + transacting on Stripe. For example, the API may be queried in order to:* - invoice is automatically marked paid, and we add the amount due to the - customer's credit balance which is applied to the next invoice. + - *localize prices for processing payments on Stripe* + - *reconcile Stripe transactions* - More details on the customer's credit balance are + - *determine how much money to send to a connected account* - [here](https://stripe.com/docs/billing/customer/balance). + - *determine app fees to charge a connected account* - Related guide: [Send invoices to - customers](https://stripe.com/docs/billing/invoices/sending) + *Using this Exchange Rates API beta for any purpose other than to + transact on Stripe is strictly prohibited and constitutes a violation of + Stripe's terms of service.* properties: - account_country: + id: description: >- - The country of the business associated with this invoice, most often - the business creating the invoice. + Unique identifier for the object. Represented as the three-letter + [ISO currency + code](https://www.iso.org/iso-4217-currency-codes.html) in + lowercase. maxLength: 5000 - nullable: true type: string - account_name: + object: description: >- - The public name of the business associated with this invoice, most - often the business creating the invoice. - maxLength: 5000 - nullable: true + String representing the object's type. Objects of the same type + share the same value. + enum: + - exchange_rate type: string - account_tax_ids: + rates: + additionalProperties: + type: number description: >- - The account tax IDs associated with the invoice. Only editable when - the invoice is a draft. + Hash where the keys are supported currencies and the values are the + exchange rate at which the base id currency converts to the key + currency. + type: object + required: + - id + - object + - rates + title: ExchangeRate + type: object + x-expandableFields: [] + x-resourceId: exchange_rate + external_account: + anyOf: + - $ref: '#/components/schemas/bank_account' + - $ref: '#/components/schemas/card' + title: Polymorphic + x-resourceId: external_account + x-stripeBypassValidation: true + external_account_requirements: + description: '' + properties: + currently_due: + description: >- + Fields that need to be collected to keep the external account + enabled. If not collected by `current_deadline`, these fields appear + in `past_due` as well, and the account is disabled. items: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/tax_id' - - $ref: '#/components/schemas/deleted_tax_id' - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/tax_id' - - $ref: '#/components/schemas/deleted_tax_id' + maxLength: 5000 + type: string nullable: true type: array - amount_due: - description: >- - Final amount due at this time for this invoice. If the invoice's - total is smaller than the minimum charge amount, for example, or if - there is account credit that can be applied to the invoice, the - `amount_due` may be 0. If there is a positive `starting_balance` for - the invoice (the customer owes money), the `amount_due` will also - take that into account. The charge that gets generated for the - invoice will be for the amount specified in `amount_due`. - type: integer - amount_paid: - description: 'The amount, in cents (or local equivalent), that was paid.' - type: integer - amount_remaining: + errors: description: >- - The difference between amount_due and amount_paid, in cents (or - local equivalent). - type: integer - amount_shipping: - description: This is the sum of all the shipping amounts. - type: integer - application: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/application' - - $ref: '#/components/schemas/deleted_application' - description: ID of the Connect Application that created the invoice. + Fields that are `currently_due` and need to be collected again + because validation or verification failed. + items: + $ref: '#/components/schemas/account_requirements_error' nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/application' - - $ref: '#/components/schemas/deleted_application' - application_fee_amount: + type: array + past_due: description: >- - The fee in cents (or local equivalent) that will be applied to the - invoice and transferred to the application owner's Stripe account - when the invoice is paid. + Fields that weren't collected by `current_deadline`. These fields + need to be collected to enable the external account. + items: + maxLength: 5000 + type: string nullable: true - type: integer - attempt_count: + type: array + pending_verification: description: >- - Number of payment attempts made for this invoice, from the - perspective of the payment retry schedule. Any payment attempt - counts as the first attempt, and subsequently only automatic retries - increment the attempt count. In other words, manual payment attempts - after the first attempt do not affect the retry schedule. + Fields that might become required depending on the results of + verification or review. It's an empty array unless an asynchronous + verification is pending. If verification fails, these fields move to + `eventually_due`, `currently_due`, or `past_due`. Fields might + appear in `eventually_due`, `currently_due`, or `past_due` and in + `pending_verification` if verification fails but another + verification is still pending. + items: + maxLength: 5000 + type: string + nullable: true + type: array + title: ExternalAccountRequirements + type: object + x-expandableFields: + - errors + fee: + description: '' + properties: + amount: + description: 'Amount of the fee, in cents.' type: integer - attempted: + application: + description: ID of the Connect application that earned the fee. + maxLength: 5000 + nullable: true + type: string + currency: description: >- - Whether an attempt has been made to pay the invoice. An invoice is - not attempted until 1 hour after the `invoice.created` webhook, for - example, so you might not want to display that invoice as unpaid to - your users. - type: boolean - auto_advance: + Three-letter [ISO currency + code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). + type: string + description: description: >- - Controls whether Stripe performs [automatic - collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) - of the invoice. If `false`, the invoice's state doesn't - automatically advance without an explicit action. - type: boolean - automatic_tax: - $ref: '#/components/schemas/automatic_tax' - billing_reason: + An arbitrary string attached to the object. Often useful for + displaying to users. + maxLength: 5000 + nullable: true + type: string + type: description: >- - Indicates the reason why the invoice was created. - - - * `manual`: Unrelated to a subscription, for example, created via - the invoice editor. - - * `subscription`: No longer in use. Applies to subscriptions from - before May 2018 where no distinction was made between updates, - cycles, and thresholds. - - * `subscription_create`: A new subscription was created. + Type of the fee, one of: `application_fee`, + `payment_method_passthrough_fee`, `stripe_fee` or `tax`. + maxLength: 5000 + type: string + required: + - amount + - currency + - type + title: Fee + type: object + x-expandableFields: [] + fee_refund: + description: >- + `Application Fee Refund` objects allow you to refund an application fee + that - * `subscription_cycle`: A subscription advanced into a new period. + has previously been created but not yet refunded. Funds will be refunded + to - * `subscription_threshold`: A subscription reached a billing - threshold. + the Stripe account from which the fee was originally collected. - * `subscription_update`: A subscription was updated. - * `upcoming`: Reserved for simulated invoices, per the upcoming - invoice endpoint. - enum: - - automatic_pending_invoice_item_invoice - - manual - - quote_accept - - subscription - - subscription_create - - subscription_cycle - - subscription_threshold - - subscription_update - - upcoming - nullable: true - type: string - charge: + Related guide: [Refunding application + fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee) + properties: + amount: + description: 'Amount, in cents (or local equivalent).' + type: integer + balance_transaction: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/charge' - description: 'ID of the latest charge generated for this invoice, if any.' + - $ref: '#/components/schemas/balance_transaction' + description: >- + Balance transaction that describes the impact on your account + balance. nullable: true x-expansionResources: oneOf: - - $ref: '#/components/schemas/charge' - collection_method: - description: >- - Either `charge_automatically`, or `send_invoice`. When charging - automatically, Stripe will attempt to pay this invoice using the - default source attached to the customer. When sending an invoice, - Stripe will email this invoice to the customer with payment - instructions. - enum: - - charge_automatically - - send_invoice - type: string + - $ref: '#/components/schemas/balance_transaction' created: description: >- Time at which the object was created. Measured in seconds since the @@ -11310,244 +11301,508 @@ components: lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). type: string - custom_fields: - description: Custom fields displayed on the invoice. - items: - $ref: '#/components/schemas/invoice_setting_custom_field' - nullable: true - type: array - customer: + fee: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/customer' - - $ref: '#/components/schemas/deleted_customer' - description: The ID of the customer who will be billed. - nullable: true + - $ref: '#/components/schemas/application_fee' + description: ID of the application fee that was refunded. x-expansionResources: oneOf: - - $ref: '#/components/schemas/customer' - - $ref: '#/components/schemas/deleted_customer' - customer_address: - anyOf: - - $ref: '#/components/schemas/address' + - $ref: '#/components/schemas/application_fee' + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + metadata: + additionalProperties: + maxLength: 500 + type: string description: >- - The customer's address. Until the invoice is finalized, this field - will equal `customer.address`. Once the invoice is finalized, this - field will no longer be updated. + 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. nullable: true - customer_email: + type: object + object: description: >- - The customer's email. Until the invoice is finalized, this field - will equal `customer.email`. Once the invoice is finalized, this - field will no longer be updated. - maxLength: 5000 - nullable: true + String representing the object's type. Objects of the same type + share the same value. + enum: + - fee_refund type: string - customer_name: + required: + - amount + - created + - currency + - fee + - id + - object + title: FeeRefund + type: object + x-expandableFields: + - balance_transaction + - fee + x-resourceId: fee_refund + file: + description: >- + This object represents files hosted on Stripe's servers. You can upload + + files with the [create file](https://stripe.com/docs/api#create_file) + request + + (for example, when uploading dispute evidence). Stripe also + + creates files independently (for example, the results of a [Sigma + scheduled + + query](#scheduled_queries)). + + + Related guide: [File upload guide](https://stripe.com/docs/file-upload) + properties: + created: description: >- - The customer's name. Until the invoice is finalized, this field will - equal `customer.name`. Once the invoice is finalized, this field - will no longer be updated. + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + expires_at: + description: The file expires and isn't available at this time in epoch seconds. + format: unix-time + nullable: true + type: integer + filename: + description: The suitable name for saving the file to a filesystem. maxLength: 5000 nullable: true type: string - customer_phone: - description: >- - The customer's phone number. Until the invoice is finalized, this - field will equal `customer.phone`. Once the invoice is finalized, - this field will no longer be updated. + id: + description: Unique identifier for the object. maxLength: 5000 - nullable: true type: string - customer_shipping: - anyOf: - - $ref: '#/components/schemas/shipping' + links: description: >- - The customer's shipping information. Until the invoice is finalized, - this field will equal `customer.shipping`. Once the invoice is - finalized, this field will no longer be updated. + A list of [file links](https://stripe.com/docs/api#file_links) that + point at this file. nullable: true - customer_tax_exempt: + properties: + data: + description: Details about each object. + items: + $ref: '#/components/schemas/file_link' + type: array + has_more: + description: >- + True if this list has another page of items after this one that + can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/file_links + type: string + required: + - data + - has_more + - object + - url + title: FileResourceFileLinkList + type: object + x-expandableFields: + - data + object: description: >- - The customer's tax exempt status. Until the invoice is finalized, - this field will equal `customer.tax_exempt`. Once the invoice is - finalized, this field will no longer be updated. + String representing the object's type. Objects of the same type + share the same value. enum: - - exempt - - none - - reverse + - file + type: string + purpose: + description: >- + The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) + of the uploaded file. + enum: + - account_requirement + - additional_verification + - business_icon + - business_logo + - customer_signature + - dispute_evidence + - document_provider_identity_document + - finance_report_run + - identity_document + - identity_document_downloadable + - pci_document + - selfie + - sigma_scheduled_query + - tax_document_user_upload + - terminal_reader_splashscreen + type: string + x-stripeBypassValidation: true + size: + description: The size of the file object in bytes. + type: integer + title: + description: A suitable title for the document. + maxLength: 5000 nullable: true type: string - customer_tax_ids: + type: + description: 'The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).' + maxLength: 5000 + nullable: true + type: string + url: + description: Use your live secret API key to download the file from this URL. + maxLength: 5000 + nullable: true + type: string + required: + - created + - id + - object + - purpose + - size + title: File + type: object + x-expandableFields: + - links + x-resourceId: file + file_link: + description: |- + To share the contents of a `File` object with non-Stripe users, you can + create a `FileLink`. `FileLink`s contain a URL that you can use to + retrieve the contents of the file without authentication. + properties: + created: description: >- - The customer's tax IDs. Until the invoice is finalized, this field - will contain the same tax IDs as `customer.tax_ids`. Once the - invoice is finalized, this field will no longer be updated. - items: - $ref: '#/components/schemas/invoices_resource_invoice_tax_id' + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + expired: + description: Returns if the link is already expired. + type: boolean + expires_at: + description: Time that the link expires. + format: unix-time nullable: true - type: array - default_payment_method: + type: integer + file: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/payment_method' - description: >- - ID of the default payment method for the invoice. It must belong to - the customer associated with the invoice. If not set, defaults to - the subscription's default payment method, if any, or to the default - payment method in the customer's invoice settings. - nullable: true + - $ref: '#/components/schemas/file' + description: The file object this link points to. x-expansionResources: oneOf: - - $ref: '#/components/schemas/payment_method' - default_source: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/bank_account' - - $ref: '#/components/schemas/card' - - $ref: '#/components/schemas/source' - description: >- - ID of the default payment source for the invoice. It must belong to - the customer associated with the invoice and be in a chargeable - state. If not set, defaults to the subscription's default source, if - any, or to the customer's default source. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/bank_account' - - $ref: '#/components/schemas/card' - - $ref: '#/components/schemas/source' - x-stripeBypassValidation: true - default_tax_rates: - description: 'The tax rates applied to this invoice, if any.' - items: - $ref: '#/components/schemas/tax_rate' - type: array - description: + - $ref: '#/components/schemas/file' + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: description: >- - An arbitrary string attached to the object. Often useful for - displaying to users. Referenced as 'memo' in the Dashboard. + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + metadata: + additionalProperties: + maxLength: 500 + type: 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. + type: object + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - file_link + type: string + url: + description: The publicly accessible URL to download the file. maxLength: 5000 nullable: true type: string - discount: + required: + - created + - expired + - file + - id + - livemode + - metadata + - object + title: FileLink + type: object + x-expandableFields: + - file + x-resourceId: file_link + financial_connections.account: + description: >- + A Financial Connections Account represents an account that exists + outside of Stripe, to which you have been granted some degree of access. + properties: + account_holder: anyOf: - - $ref: '#/components/schemas/discount' - description: >- - Describes the current discount applied to this invoice, if there is - one. Not populated if there are multiple discounts. + - $ref: '#/components/schemas/bank_connections_resource_accountholder' + description: The account holder that this account belongs to. nullable: true - discounts: - description: >- - The discounts applied to the invoice. Line item discounts are - applied before invoice discounts. Use `expand[]=discounts` to expand - each discount. - items: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/discount' - - $ref: '#/components/schemas/deleted_discount' - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/discount' - - $ref: '#/components/schemas/deleted_discount' + balance: + anyOf: + - $ref: '#/components/schemas/bank_connections_resource_balance' + description: The most recent information about the account's balance. nullable: true - type: array - due_date: - description: >- - The date on which payment for this invoice is due. This value will - be `null` for invoices where - `collection_method=charge_automatically`. - format: unix-time + balance_refresh: + anyOf: + - $ref: '#/components/schemas/bank_connections_resource_balance_refresh' + description: The state of the most recent attempt to refresh the account balance. nullable: true - type: integer - effective_at: + category: description: >- - The date when this invoice is in effect. Same as `finalized_at` - unless overwritten. When defined, this value replaces the - system-generated 'Date of issue' printed on the invoice PDF and - receipt. + The type of the account. Account category is further divided in + `subcategory`. + enum: + - cash + - credit + - investment + - other + type: string + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. format: unix-time - nullable: true type: integer - ending_balance: + display_name: description: >- - Ending customer balance after the invoice is finalized. Invoices are - finalized approximately an hour after successful webhook delivery or - when payment collection is attempted for the invoice. If the invoice - has not been finalized yet, this will be null. + A human-readable name that has been assigned to this account, either + by the account holder or by the institution. + maxLength: 5000 nullable: true - type: integer - footer: - description: Footer displayed on the invoice. + type: string + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + institution_name: + description: The name of the institution that holds this account. + maxLength: 5000 + type: string + last4: + description: >- + The last 4 digits of the account number. If present, this will be 4 + numeric characters. maxLength: 5000 nullable: true type: string - from_invoice: - anyOf: - - $ref: '#/components/schemas/invoices_from_invoice' + livemode: description: >- - Details of the invoice that was cloned. See the [revision - documentation](https://stripe.com/docs/invoicing/invoice-revisions) - for more details. + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - financial_connections.account + type: string + ownership: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/financial_connections.account_ownership' + description: The most recent information about the account's owners. nullable: true - hosted_invoice_url: + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/financial_connections.account_ownership' + ownership_refresh: + anyOf: + - $ref: '#/components/schemas/bank_connections_resource_ownership_refresh' + description: The state of the most recent attempt to refresh the account owners. + nullable: true + permissions: + description: The list of permissions granted by this account. + items: + enum: + - balances + - ownership + - payment_method + - transactions + type: string + nullable: true + type: array + status: + description: The status of the link to the account. + enum: + - active + - disconnected + - inactive + type: string + subcategory: + description: |- + If `category` is `cash`, one of: + + - `checking` + - `savings` + - `other` + + If `category` is `credit`, one of: + + - `mortgage` + - `line_of_credit` + - `credit_card` + - `other` + + If `category` is `investment` or `other`, this will be `other`. + enum: + - checking + - credit_card + - line_of_credit + - mortgage + - other + - savings + type: string + subscriptions: + description: The list of data refresh subscriptions requested on this account. + items: + enum: + - transactions + type: string + x-stripeBypassValidation: true + nullable: true + type: array + supported_payment_method_types: description: >- - The URL for the hosted invoice page, which allows customers to view - and pay an invoice. If the invoice has not been finalized yet, this - will be null. + The [PaymentMethod + type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) + that can be created from this account. + items: + enum: + - link + - us_bank_account + type: string + type: array + transaction_refresh: + anyOf: + - $ref: >- + #/components/schemas/bank_connections_resource_transaction_refresh + description: >- + The state of the most recent attempt to refresh the account + transactions. + nullable: true + required: + - category + - created + - id + - institution_name + - livemode + - object + - status + - subcategory + - supported_payment_method_types + title: BankConnectionsResourceLinkedAccount + type: object + x-expandableFields: + - account_holder + - balance + - balance_refresh + - ownership + - ownership_refresh + - transaction_refresh + x-resourceId: financial_connections.account + financial_connections.account_owner: + description: Describes an owner of an account. + properties: + email: + description: The email address of the owner. maxLength: 5000 nullable: true type: string id: - description: >- - Unique identifier for the object. This property is always present - unless the invoice is an upcoming invoice. See [Retrieve an upcoming - invoice](https://stripe.com/docs/api/invoices/upcoming) for more - details. + description: Unique identifier for the object. maxLength: 5000 type: string - invoice_pdf: + name: + description: The full name of the owner. + maxLength: 5000 + type: string + object: description: >- - The link to download the PDF for the invoice. If the invoice has not - been finalized yet, this will be null. + String representing the object's type. Objects of the same type + share the same value. + enum: + - financial_connections.account_owner + type: string + ownership: + description: The ownership object that this owner belongs to. + maxLength: 5000 + type: string + phone: + description: The raw phone number of the owner. maxLength: 5000 nullable: true type: string - last_finalization_error: - anyOf: - - $ref: '#/components/schemas/api_errors' - description: >- - The error encountered during the previous attempt to finalize the - invoice. This field is cleared when the invoice is successfully - finalized. + raw_address: + description: The raw physical address of the owner. + maxLength: 5000 nullable: true - latest_revision: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/invoice' - description: The ID of the most recent non-draft revision of this invoice + type: string + refreshed_at: + description: The timestamp of the refresh that updated this owner. + format: unix-time nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/invoice' - lines: + type: integer + required: + - id + - name + - object + - ownership + title: BankConnectionsResourceOwner + type: object + x-expandableFields: [] + x-resourceId: financial_connections.account_owner + financial_connections.account_ownership: + description: >- + Describes a snapshot of the owners of an account at a particular point + in time. + properties: + created: description: >- - The individual line items that make up the invoice. `lines` is - sorted as follows: (1) pending invoice items (including prorations) - in reverse chronological order, (2) subscription items in reverse - chronological order, and (3) invoice items added after invoice - creation in chronological order. + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - financial_connections.account_ownership + type: string + owners: + description: A paginated list of owners for this account. properties: data: description: Details about each object. items: - $ref: '#/components/schemas/line_item' + $ref: '#/components/schemas/financial_connections.account_owner' type: array has_more: description: >- @@ -11570,1683 +11825,1634 @@ components: - has_more - object - url - title: InvoiceLinesList + title: BankConnectionsResourceOwnerList type: object x-expandableFields: - data - livemode: - description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. - type: boolean - metadata: - additionalProperties: - maxLength: 500 - type: 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. + required: + - created + - id + - object + - owners + title: BankConnectionsResourceOwnership + type: object + x-expandableFields: + - owners + financial_connections.session: + description: >- + A Financial Connections Session is the secure way to programmatically + launch the client-side Stripe.js modal that lets your users link their + accounts. + properties: + account_holder: + anyOf: + - $ref: '#/components/schemas/bank_connections_resource_accountholder' + description: The account holder for whom accounts are collected in this session. nullable: true + accounts: + description: The accounts that were collected as part of this Session. + properties: + data: + description: Details about each object. + items: + $ref: '#/components/schemas/financial_connections.account' + type: array + has_more: + description: >- + True if this list has another page of items after this one that + can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/financial_connections/accounts + type: string + required: + - data + - has_more + - object + - url + title: BankConnectionsResourceLinkedAccountList type: object - next_payment_attempt: - description: >- - The time at which payment will next be attempted. This value will be - `null` for invoices where `collection_method=send_invoice`. - format: unix-time - nullable: true - type: integer - number: + x-expandableFields: + - data + client_secret: description: >- - A unique, identifying string that appears on emails sent to the - customer for this invoice. This starts with the customer's unique - invoice_prefix if it is specified. + A value that will be passed to the client to launch the + authentication flow. + maxLength: 5000 + type: string + filters: + $ref: >- + #/components/schemas/bank_connections_resource_link_account_session_filters + id: + description: Unique identifier for the object. maxLength: 5000 - nullable: true type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - invoice + - financial_connections.session type: string - on_behalf_of: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/account' - description: >- - The account (if any) for which the funds of the invoice payment are - intended. If set, the invoice will be presented with the branding - and support information of the specified account. See the [Invoices - with Connect](https://stripe.com/docs/billing/invoices/connect) - documentation for details. + permissions: + description: Permissions requested for accounts collected during this session. + items: + enum: + - balances + - ownership + - payment_method + - transactions + type: string + x-stripeBypassValidation: true + type: array + prefetch: + description: Data features requested to be retrieved upon account creation. + items: + enum: + - balances + - ownership + - transactions + type: string + x-stripeBypassValidation: true nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/account' - paid: - description: >- - Whether payment was successfully collected for this invoice. An - invoice can be paid (most commonly) with a charge or with credit - from the customer's account balance. - type: boolean - paid_out_of_band: - description: >- - Returns true if the invoice was manually marked paid, returns false - if the invoice hasn't been paid yet or was paid on Stripe. - type: boolean - payment_intent: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/payment_intent' + type: array + return_url: description: >- - The PaymentIntent associated with this invoice. The PaymentIntent is - generated when the invoice is finalized, and can then be used to pay - the invoice. Note that voiding an invoice will cancel the - PaymentIntent. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/payment_intent' - payment_settings: - $ref: '#/components/schemas/invoices_payment_settings' - period_end: - description: >- - End of the usage period during which invoice items were added to - this invoice. - format: unix-time - type: integer - period_start: - description: >- - Start of the usage period during which invoice items were added to - this invoice. - format: unix-time - type: integer - post_payment_credit_notes_amount: - description: >- - Total amount of all post-payment credit notes issued for this - invoice. - type: integer - pre_payment_credit_notes_amount: + For webview integrations only. Upon completing OAuth login in the + native browser, the user will be redirected to this URL to return to + your app. + maxLength: 5000 + type: string + required: + - accounts + - client_secret + - id + - livemode + - object + - permissions + title: BankConnectionsResourceLinkAccountSession + type: object + x-expandableFields: + - account_holder + - accounts + - filters + x-resourceId: financial_connections.session + financial_connections.transaction: + description: >- + A Transaction represents a real transaction that affects a Financial + Connections Account balance. + properties: + account: description: >- - Total amount of all pre-payment credit notes issued for this - invoice. + The ID of the Financial Connections Account this transaction belongs + to. + maxLength: 5000 + type: string + amount: + description: 'The amount of this transaction, in cents (or local equivalent).' type: integer - quote: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/quote' - description: The quote this invoice was generated from. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/quote' - receipt_number: + currency: description: >- - This is the transaction number that appears on email receipts sent - for this invoice. + Three-letter [ISO currency + code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). maxLength: 5000 - nullable: true type: string - rendering: - anyOf: - - $ref: '#/components/schemas/invoices_invoice_rendering' - description: >- - The rendering-related settings that control how the invoice is - displayed on customer-facing surfaces such as PDF and Hosted Invoice - Page. - nullable: true - shipping_cost: - anyOf: - - $ref: '#/components/schemas/invoices_shipping_cost' - description: >- - The details of the cost of shipping, including the ShippingRate - applied on the invoice. - nullable: true - shipping_details: - anyOf: - - $ref: '#/components/schemas/shipping' - description: >- - Shipping details for the invoice. The Invoice PDF will use the - `shipping_details` value if it is set, otherwise the PDF will render - the shipping address from the customer. - nullable: true - starting_balance: + description: + description: The description of this transaction. + maxLength: 5000 + type: string + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: description: >- - Starting customer balance before the invoice is finalized. If the - invoice has not been finalized yet, this will be the current - customer balance. For revision invoices, this also includes any - customer balance that was applied to the original invoice. - type: integer - statement_descriptor: + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: description: >- - Extra information about an invoice for the customer's credit card - statement. - maxLength: 5000 - nullable: true + String representing the object's type. Objects of the same type + share the same value. + enum: + - financial_connections.transaction type: string status: - description: >- - The status of the invoice, one of `draft`, `open`, `paid`, - `uncollectible`, or `void`. [Learn - more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) + description: The status of the transaction. enum: - - draft - - open - - paid - - uncollectible + - pending + - posted - void - nullable: true type: string - x-stripeBypassValidation: true status_transitions: - $ref: '#/components/schemas/invoices_status_transitions' - subscription: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/subscription' - description: 'The subscription that this invoice was prepared for, if any.' - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/subscription' - subscription_details: - anyOf: - - $ref: '#/components/schemas/subscription_details_data' - description: Details about the subscription that created this invoice. - nullable: true - subscription_proration_date: - description: >- - Only set for upcoming invoices that preview prorations. The time - used to calculate prorations. - type: integer - subtotal: - description: >- - Total of all subscriptions, invoice items, and prorations on the - invoice before any invoice level discount or exclusive tax is - applied. Item discounts are already incorporated - type: integer - subtotal_excluding_tax: - description: >- - The integer amount in cents (or local equivalent) representing the - subtotal of the invoice before any invoice level discount or tax is - applied. Item discounts are already incorporated - nullable: true - type: integer - tax: - description: >- - The amount of tax on this invoice. This is the sum of all the tax - amounts on this invoice. - nullable: true - type: integer - test_clock: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/test_helpers.test_clock' - description: ID of the test clock this invoice belongs to. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/test_helpers.test_clock' - threshold_reason: - $ref: '#/components/schemas/invoice_threshold_reason' - total: - description: Total after discounts and taxes. - type: integer - total_discount_amounts: - description: The aggregate amounts calculated per discount across all line items. - items: - $ref: '#/components/schemas/discounts_resource_discount_amount' - nullable: true - type: array - total_excluding_tax: + $ref: >- + #/components/schemas/bank_connections_resource_transaction_resource_status_transitions + transacted_at: description: >- - The integer amount in cents (or local equivalent) representing the - total amount of the invoice including all discounts but excluding - all tax. - nullable: true + Time at which the transaction was transacted. Measured in seconds + since the Unix epoch. + format: unix-time type: integer - total_tax_amounts: - description: The aggregate amounts calculated per tax rate for all line items. - items: - $ref: '#/components/schemas/invoice_tax_amount' - type: array - transfer_data: - anyOf: - - $ref: '#/components/schemas/invoice_transfer_data' + transaction_refresh: description: >- - The account (if any) the payment will be attributed to for tax - reporting, and where funds from the payment will be transferred to - for the invoice. - nullable: true - webhooks_delivered_at: + The token of the transaction refresh that last updated or created + this transaction. + maxLength: 5000 + type: string + updated: description: >- - Invoices are automatically paid or sent 1 hour after webhooks are - delivered, or until all webhook delivery attempts have [been - exhausted](https://stripe.com/docs/billing/webhooks#understand). - This field tracks the time when webhooks for this invoice were - successfully delivered. If the invoice had no webhooks to deliver, - this will be set while the invoice is being created. + Time at which the object was last updated. Measured in seconds since + the Unix epoch. format: unix-time - nullable: true type: integer required: - - amount_due - - amount_paid - - amount_remaining - - amount_shipping - - attempt_count - - attempted - - automatic_tax - - collection_method - - created + - account + - amount - currency - - default_tax_rates - - lines + - description + - id - livemode - object - - paid - - paid_out_of_band - - payment_settings - - period_end - - period_start - - post_payment_credit_notes_amount - - pre_payment_credit_notes_amount - - starting_balance + - status - status_transitions - - subtotal - - total - - total_tax_amounts - title: Invoice + - transacted_at + - transaction_refresh + - updated + title: BankConnectionsResourceTransaction type: object x-expandableFields: - - account_tax_ids - - application - - automatic_tax - - charge - - custom_fields - - customer - - customer_address - - customer_shipping - - customer_tax_ids - - default_payment_method - - default_source - - default_tax_rates - - discount - - discounts - - from_invoice - - last_finalization_error - - latest_revision - - lines - - on_behalf_of - - payment_intent - - payment_settings - - quote - - rendering - - shipping_cost - - shipping_details - status_transitions - - subscription - - subscription_details - - test_clock - - threshold_reason - - total_discount_amounts - - total_tax_amounts - - transfer_data - x-resourceId: invoice - invoice_installments_card: - description: '' - properties: - enabled: - description: Whether Installments are enabled for this Invoice. - nullable: true - type: boolean - title: invoice_installments_card - type: object - x-expandableFields: [] - invoice_item_threshold_reason: + x-resourceId: financial_connections.transaction + financial_reporting_finance_report_run_run_parameters: description: '' properties: - line_item_ids: - description: The IDs of the line items that triggered the threshold invoice. + columns: + description: The set of output columns requested for inclusion in the report run. items: maxLength: 5000 type: string type: array - usage_gte: - description: The quantity threshold boundary that applied to the given line item. - type: integer - required: - - line_item_ids - - usage_gte - title: InvoiceItemThresholdReason - type: object - x-expandableFields: [] - invoice_line_item_period: - description: '' - properties: - end: + connected_account: + description: Connected account ID by which to filter the report run. + maxLength: 5000 + type: string + currency: + description: Currency of objects to be included in the report run. + type: string + interval_end: description: >- - The end of the period, which must be greater than or equal to the - start. This value is inclusive. + Ending timestamp of data to be included in the report run. Can be + any UTC timestamp between 1 second after the user specified + `interval_start` and 1 second before this report's last + `data_available_end` value. format: unix-time type: integer - start: - description: The start of the period. This value is inclusive. + interval_start: + description: >- + Starting timestamp of data to be included in the report run. Can be + any UTC timestamp between 1 second after this report's + `data_available_start` and 1 second before the user specified + `interval_end` value. format: unix-time type: integer - required: - - end - - start - title: InvoiceLineItemPeriod - type: object - x-expandableFields: [] - invoice_mandate_options_card: - description: '' - properties: - amount: - description: Amount to be charged for future payments. - nullable: true - type: integer - amount_type: - description: >- - One of `fixed` or `maximum`. If `fixed`, the `amount` param refers - to the exact amount to be charged in future payments. If `maximum`, - the amount charged can be up to the value passed for the `amount` - param. - enum: - - fixed - - maximum - nullable: true - type: string - description: - description: >- - A description of the mandate or subscription that is meant to be - displayed to the customer. - maxLength: 200 - nullable: true + payout: + description: Payout ID by which to filter the report run. + maxLength: 5000 type: string - title: invoice_mandate_options_card - type: object - x-expandableFields: [] - invoice_payment_method_options_acss_debit: - description: '' - properties: - mandate_options: - $ref: >- - #/components/schemas/invoice_payment_method_options_acss_debit_mandate_options - verification_method: - description: Bank account verification method. - enum: - - automatic - - instant - - microdeposits + reporting_category: + description: Category of balance transactions to be included in the report run. + maxLength: 5000 type: string - x-stripeBypassValidation: true - title: invoice_payment_method_options_acss_debit - type: object - x-expandableFields: - - mandate_options - invoice_payment_method_options_acss_debit_mandate_options: - description: '' - properties: - transaction_type: - description: Transaction type of the mandate. - enum: - - business - - personal - nullable: true + timezone: + description: >- + Defaults to `Etc/UTC`. The output timezone for all timestamps in the + report. A list of possible time zone values is maintained at the + [IANA Time Zone Database](http://www.iana.org/time-zones). Has no + effect on `interval_start` or `interval_end`. + maxLength: 5000 type: string - title: invoice_payment_method_options_acss_debit_mandate_options + title: FinancialReportingFinanceReportRunRunParameters type: object x-expandableFields: [] - invoice_payment_method_options_bancontact: - description: '' + forwarded_request_context: + description: Metadata about the forwarded request. properties: - preferred_language: + destination_duration: description: >- - Preferred language of the Bancontact authorization page that the - customer is redirected to. - enum: - - de - - en - - fr - - nl + The time it took in milliseconds for the destination endpoint to + respond. + type: integer + destination_ip_address: + description: The IP address of the destination. + maxLength: 5000 type: string required: - - preferred_language - title: invoice_payment_method_options_bancontact + - destination_duration + - destination_ip_address + title: ForwardedRequestContext type: object x-expandableFields: [] - invoice_payment_method_options_card: - description: '' + forwarded_request_details: + description: Details about the request forwarded to the destination endpoint. properties: - installments: - $ref: '#/components/schemas/invoice_installments_card' - request_three_d_secure: + body: + description: The body payload to send to the destination endpoint. + maxLength: 5000 + type: string + headers: description: >- - We strongly recommend that you rely on our SCA Engine to - automatically prompt your customers for authentication based on risk - level and [other - requirements](https://stripe.com/docs/strong-customer-authentication). - However, if you wish to request 3D Secure based on logic from your - own fraud engine, provide this option. Read our guide on [manually - requesting 3D - Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) - for more information on how this configuration interacts with Radar - and our SCA Engine. + The headers to include in the forwarded request. Can be omitted if + no additional headers (excluding Stripe-generated ones such as the + Content-Type header) should be included. + items: + $ref: '#/components/schemas/forwarded_request_header' + type: array + http_method: + description: The HTTP method used to call the destination endpoint. enum: - - any - - automatic - nullable: true + - POST type: string - title: invoice_payment_method_options_card + required: + - body + - headers + - http_method + title: ForwardedRequestDetails type: object x-expandableFields: - - installments - invoice_payment_method_options_customer_balance: - description: '' + - headers + forwarded_request_header: + description: Header data. properties: - bank_transfer: - $ref: >- - #/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer - funding_type: - description: >- - The funding method type to be used when there are not enough funds - in the customer balance. Permitted values include: `bank_transfer`. - enum: - - bank_transfer - nullable: true + name: + description: The header name. + maxLength: 5000 type: string - title: invoice_payment_method_options_customer_balance + value: + description: The header value. + maxLength: 5000 + type: string + required: + - name + - value + title: ForwardedRequestHeader type: object - x-expandableFields: - - bank_transfer - invoice_payment_method_options_customer_balance_bank_transfer: - description: '' + x-expandableFields: [] + forwarded_response_details: + description: Details about the response from the destination endpoint. properties: - eu_bank_transfer: - $ref: >- - #/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer - type: - description: >- - The bank transfer type that can be used for funding. Permitted - values include: `eu_bank_transfer`, `gb_bank_transfer`, - `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. - nullable: true + body: + description: The response body from the destination endpoint to Stripe. + maxLength: 5000 type: string - title: invoice_payment_method_options_customer_balance_bank_transfer + headers: + description: HTTP headers that the destination endpoint returned. + items: + $ref: '#/components/schemas/forwarded_request_header' + type: array + status: + description: The HTTP status code that the destination endpoint returned. + type: integer + required: + - body + - headers + - status + title: ForwardedResponseDetails type: object x-expandableFields: - - eu_bank_transfer - invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer: - description: '' + - headers + forwarding.request: + description: >- + Instructs Stripe to make a request on your behalf using the destination + URL. The destination URL + + is activated by Stripe at the time of onboarding. Stripe verifies + requests with your credentials + + provided during onboarding, and injects card details from the + payment_method into the request. + + + Stripe redacts all sensitive fields and headers, including + authentication credentials and card numbers, + + before storing the request and response data in the forwarding Request + object, which are subject to a + + 30-day retention period. + + + You can provide a Stripe idempotency key to make sure that requests with + the same key result in only one + + outbound request. The Stripe idempotency key provided should be unique + and different from any idempotency + + keys provided on the underlying third-party request. + + + Forwarding Requests are synchronous requests that return a response or + time out according to + + Stripe’s limits. + + + Related guide: [Forward card details to third-party API + endpoints](https://docs.stripe.com/payments/forwarding). properties: - country: + created: description: >- - The desired country code of the bank account information. Permitted - values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. - enum: - - BE - - DE - - ES - - FR - - IE - - NL + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - forwarding.request + type: string + payment_method: + description: >- + The PaymentMethod to insert into the forwarded request. Forwarding + previously consumed PaymentMethods is allowed. + maxLength: 5000 + type: string + replacements: + description: The field kinds to be replaced in the forwarded request. + items: + enum: + - card_cvc + - card_expiry + - card_number + - cardholder_name + type: string + type: array + request_context: + anyOf: + - $ref: '#/components/schemas/forwarded_request_context' + description: >- + Context about the request from Stripe's servers to the destination + endpoint. + nullable: true + request_details: + anyOf: + - $ref: '#/components/schemas/forwarded_request_details' + description: >- + The request that was sent to the destination endpoint. We redact any + sensitive fields. + nullable: true + response_details: + anyOf: + - $ref: '#/components/schemas/forwarded_response_details' + description: >- + The response that the destination endpoint returned to us. We redact + any sensitive fields. + nullable: true + url: + description: >- + The destination URL for the forwarded request. Must be supported by + the config. + maxLength: 5000 + nullable: true type: string required: - - country - title: >- - invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer - type: object - x-expandableFields: [] - invoice_payment_method_options_konbini: - description: '' - properties: {} - title: invoice_payment_method_options_konbini + - created + - id + - livemode + - object + - payment_method + - replacements + title: ForwardingRequest type: object - x-expandableFields: [] - invoice_payment_method_options_us_bank_account: - description: '' + x-expandableFields: + - request_context + - request_details + - response_details + x-resourceId: forwarding.request + funding_instructions: + description: >- + Each customer has a + [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) + that is + + automatically applied to future invoices and payments using the + `customer_balance` payment method. + + Customers can fund this balance by initiating a bank transfer to any + account in the + + `financial_addresses` field. + + Related guide: [Customer balance funding + instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions) properties: - financial_connections: - $ref: >- - #/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options - verification_method: - description: Bank account verification method. + bank_transfer: + $ref: '#/components/schemas/funding_instructions_bank_transfer' + 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). + maxLength: 5000 + type: string + funding_type: + description: The `funding_type` of the returned instructions enum: - - automatic - - instant - - microdeposits + - bank_transfer type: string - x-stripeBypassValidation: true - title: invoice_payment_method_options_us_bank_account + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - funding_instructions + type: string + required: + - bank_transfer + - currency + - funding_type + - livemode + - object + title: CustomerBalanceFundingInstructionsCustomerBalanceFundingInstructions type: object x-expandableFields: - - financial_connections - invoice_payment_method_options_us_bank_account_linked_account_options: + - bank_transfer + x-resourceId: funding_instructions + funding_instructions_bank_transfer: description: '' properties: - permissions: + country: + description: The country of the bank account to fund + maxLength: 5000 + type: string + financial_addresses: description: >- - The list of permissions to request. The `payment_method` permission - must be included. + A list of financial addresses that can be used to fund a particular + balance items: - enum: - - balances - - payment_method - - transactions - type: string - x-stripeBypassValidation: true + $ref: >- + #/components/schemas/funding_instructions_bank_transfer_financial_address type: array - prefetch: - description: Data features requested to be retrieved upon account creation. + type: + description: The bank_transfer type + enum: + - eu_bank_transfer + - jp_bank_transfer + type: string + x-stripeBypassValidation: true + required: + - country + - financial_addresses + - type + title: FundingInstructionsBankTransfer + type: object + x-expandableFields: + - financial_addresses + funding_instructions_bank_transfer_aba_record: + description: ABA Records contain U.S. bank account details per the ABA format. + properties: + account_number: + description: The ABA account number + maxLength: 5000 + type: string + bank_name: + description: The bank name + maxLength: 5000 + type: string + routing_number: + description: The ABA routing number + maxLength: 5000 + type: string + required: + - account_number + - bank_name + - routing_number + title: FundingInstructionsBankTransferABARecord + type: object + x-expandableFields: [] + funding_instructions_bank_transfer_financial_address: + description: >- + FinancialAddresses contain identifying information that resolves to a + FinancialAccount. + properties: + aba: + $ref: '#/components/schemas/funding_instructions_bank_transfer_aba_record' + iban: + $ref: '#/components/schemas/funding_instructions_bank_transfer_iban_record' + sort_code: + $ref: >- + #/components/schemas/funding_instructions_bank_transfer_sort_code_record + spei: + $ref: '#/components/schemas/funding_instructions_bank_transfer_spei_record' + supported_networks: + description: The payment networks supported by this FinancialAddress items: enum: - - balances + - ach + - bacs + - domestic_wire_us + - fps + - sepa + - spei + - swift + - zengin type: string x-stripeBypassValidation: true - nullable: true type: array - title: invoice_payment_method_options_us_bank_account_linked_account_options + swift: + $ref: '#/components/schemas/funding_instructions_bank_transfer_swift_record' + type: + description: The type of financial address + enum: + - aba + - iban + - sort_code + - spei + - swift + - zengin + type: string + x-stripeBypassValidation: true + zengin: + $ref: >- + #/components/schemas/funding_instructions_bank_transfer_zengin_record + required: + - type + title: FundingInstructionsBankTransferFinancialAddress type: object - x-expandableFields: [] - invoice_rendering_pdf: - description: '' + x-expandableFields: + - aba + - iban + - sort_code + - spei + - swift + - zengin + funding_instructions_bank_transfer_iban_record: + description: Iban Records contain E.U. bank account details per the SEPA format. properties: - page_size: + account_holder_name: + description: The name of the person or business that owns the bank account + maxLength: 5000 + type: string + bic: + description: The BIC/SWIFT code of the account. + maxLength: 5000 + type: string + country: description: >- - Page size of invoice pdf. Options include a4, letter, and auto. If - set to auto, page size will be switched to a4 or letter based on - customer locale. - enum: - - a4 - - auto - - letter - nullable: true + Two-letter country code ([ISO 3166-1 + alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)). + maxLength: 5000 type: string - title: InvoiceRenderingPdf + iban: + description: The IBAN of the account. + maxLength: 5000 + type: string + required: + - account_holder_name + - bic + - country + - iban + title: FundingInstructionsBankTransferIbanRecord type: object x-expandableFields: [] - invoice_setting_custom_field: - description: '' + funding_instructions_bank_transfer_sort_code_record: + description: >- + Sort Code Records contain U.K. bank account details per the sort code + format. properties: - name: - description: The name of the custom field. + account_holder_name: + description: The name of the person or business that owns the bank account maxLength: 5000 type: string - value: - description: The value of the custom field. + account_number: + description: The account number + maxLength: 5000 + type: string + sort_code: + description: The six-digit sort code maxLength: 5000 type: string required: - - name - - value - title: InvoiceSettingCustomField + - account_holder_name + - account_number + - sort_code + title: FundingInstructionsBankTransferSortCodeRecord type: object x-expandableFields: [] - invoice_setting_customer_setting: - description: '' + funding_instructions_bank_transfer_spei_record: + description: SPEI Records contain Mexico bank account details per the SPEI format. properties: - custom_fields: - description: Default custom fields to be displayed on invoices for this customer. - items: - $ref: '#/components/schemas/invoice_setting_custom_field' + bank_code: + description: The three-digit bank code + maxLength: 5000 + type: string + bank_name: + description: The short banking institution name + maxLength: 5000 + type: string + clabe: + description: The CLABE number + maxLength: 5000 + type: string + required: + - bank_code + - bank_name + - clabe + title: FundingInstructionsBankTransferSpeiRecord + type: object + x-expandableFields: [] + funding_instructions_bank_transfer_swift_record: + description: SWIFT Records contain U.S. bank account details per the SWIFT format. + properties: + account_number: + description: The account number + maxLength: 5000 + type: string + bank_name: + description: The bank name + maxLength: 5000 + type: string + swift_code: + description: The SWIFT code + maxLength: 5000 + type: string + required: + - account_number + - bank_name + - swift_code + title: FundingInstructionsBankTransferSwiftRecord + type: object + x-expandableFields: [] + funding_instructions_bank_transfer_zengin_record: + description: Zengin Records contain Japan bank account details per the Zengin format. + properties: + account_holder_name: + description: The account holder name + maxLength: 5000 nullable: true - type: array - default_payment_method: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/payment_method' - description: >- - ID of a payment method that's attached to the customer, to be used - as the customer's default payment method for subscriptions and - invoices. + type: string + account_number: + description: The account number + maxLength: 5000 nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/payment_method' - footer: - description: Default footer to be displayed on invoices for this customer. + type: string + account_type: + description: 'The bank account type. In Japan, this can only be `futsu` or `toza`.' maxLength: 5000 nullable: true type: string - rendering_options: - anyOf: - - $ref: '#/components/schemas/invoice_setting_rendering_options' - description: Default options for invoice PDF rendering for this customer. + bank_code: + description: The bank code of the account + maxLength: 5000 nullable: true - title: InvoiceSettingCustomerSetting + type: string + bank_name: + description: The bank name of the account + maxLength: 5000 + nullable: true + type: string + branch_code: + description: The branch code of the account + maxLength: 5000 + nullable: true + type: string + branch_name: + description: The branch name of the account + maxLength: 5000 + nullable: true + type: string + title: FundingInstructionsBankTransferZenginRecord type: object - x-expandableFields: - - custom_fields - - default_payment_method - - rendering_options - invoice_setting_quote_setting: - description: '' + x-expandableFields: [] + gelato_data_document_report_date_of_birth: + description: Point in Time properties: - days_until_due: - description: >- - Number of days within which a customer must pay invoices generated - by this quote. This value will be `null` for quotes where - `collection_method=charge_automatically`. + day: + description: Numerical day between 1 and 31. nullable: true type: integer - title: InvoiceSettingQuoteSetting + month: + description: Numerical month between 1 and 12. + nullable: true + type: integer + year: + description: The four-digit year. + nullable: true + type: integer + title: GelatoDataDocumentReportDateOfBirth type: object x-expandableFields: [] - invoice_setting_rendering_options: - description: '' + gelato_data_document_report_expiration_date: + description: Point in Time properties: - amount_tax_display: - description: >- - How line-item prices and amounts will be displayed with respect to - tax on invoice PDFs. - maxLength: 5000 + day: + description: Numerical day between 1 and 31. nullable: true - type: string - title: InvoiceSettingRenderingOptions + type: integer + month: + description: Numerical month between 1 and 12. + nullable: true + type: integer + year: + description: The four-digit year. + nullable: true + type: integer + title: GelatoDataDocumentReportExpirationDate type: object x-expandableFields: [] - invoice_setting_subscription_schedule_phase_setting: - description: '' + gelato_data_document_report_issued_date: + description: Point in Time properties: - days_until_due: - description: >- - Number of days within which a customer must pay invoices generated - by this subscription schedule. This value will be `null` for - subscription schedules where `billing=charge_automatically`. + day: + description: Numerical day between 1 and 31. nullable: true type: integer - title: InvoiceSettingSubscriptionSchedulePhaseSetting + month: + description: Numerical month between 1 and 12. + nullable: true + type: integer + year: + description: The four-digit year. + nullable: true + type: integer + title: GelatoDataDocumentReportIssuedDate type: object x-expandableFields: [] - invoice_setting_subscription_schedule_setting: - description: '' + gelato_data_id_number_report_date: + description: Point in Time properties: - days_until_due: - description: >- - Number of days within which a customer must pay invoices generated - by this subscription schedule. This value will be `null` for - subscription schedules where `billing=charge_automatically`. + day: + description: Numerical day between 1 and 31. nullable: true type: integer - title: InvoiceSettingSubscriptionScheduleSetting + month: + description: Numerical month between 1 and 12. + nullable: true + type: integer + year: + description: The four-digit year. + nullable: true + type: integer + title: GelatoDataIdNumberReportDate type: object x-expandableFields: [] - invoice_tax_amount: - description: '' + gelato_data_verified_outputs_date: + description: Point in Time properties: - amount: - description: 'The amount, in cents (or local equivalent), of the tax.' + day: + description: Numerical day between 1 and 31. + nullable: true type: integer - inclusive: - description: Whether this tax amount is inclusive or exclusive. - type: boolean - tax_rate: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/tax_rate' - description: The tax rate that was applied to get this tax amount. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/tax_rate' - taxability_reason: - description: >- - The reasoning behind this tax, for example, if the product is tax - exempt. The possible values for this field may be extended as new - tax rules are supported. - enum: - - customer_exempt - - not_collecting - - not_subject_to_tax - - not_supported - - portion_product_exempt - - portion_reduced_rated - - portion_standard_rated - - product_exempt - - product_exempt_holiday - - proportionally_rated - - reduced_rated - - reverse_charge - - standard_rated - - taxable_basis_reduced - - zero_rated - nullable: true - type: string - x-stripeBypassValidation: true - taxable_amount: - description: >- - The amount on which tax is calculated, in cents (or local - equivalent). + month: + description: Numerical month between 1 and 12. nullable: true type: integer - required: - - amount - - inclusive - - tax_rate - title: InvoiceTaxAmount - type: object - x-expandableFields: - - tax_rate - invoice_threshold_reason: - description: '' - properties: - amount_gte: - description: >- - The total invoice amount threshold boundary if it triggered the - threshold invoice. + year: + description: The four-digit year. nullable: true type: integer - item_reasons: - description: Indicates which line items triggered a threshold invoice. - items: - $ref: '#/components/schemas/invoice_item_threshold_reason' - type: array - required: - - item_reasons - title: InvoiceThresholdReason + title: GelatoDataVerifiedOutputsDate type: object - x-expandableFields: - - item_reasons - invoice_transfer_data: - description: '' + x-expandableFields: [] + gelato_document_report: + description: Result from a document check properties: - amount: - description: >- - The amount in cents (or local equivalent) that will be transferred - to the destination account when the invoice is paid. By default, the - entire amount is transferred to the destination. + address: + anyOf: + - $ref: '#/components/schemas/address' + description: Address as it appears in the document. nullable: true - type: integer - destination: + dob: anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/account' - description: >- - The account where funds from the payment will be transferred to upon - payment success. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/account' - required: - - destination - title: InvoiceTransferData - type: object - x-expandableFields: - - destination - invoiceitem: - description: >- - Invoice Items represent the component lines of an - [invoice](https://stripe.com/docs/api/invoices). An invoice item is - added to an - - invoice by creating or updating it with an `invoice` field, at which - point it will be included as - - [an invoice line item](https://stripe.com/docs/api/invoices/line_item) - within - - [invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines). - - - Invoice Items can be created before you are ready to actually send the - invoice. This can be particularly useful when combined - - with a [subscription](https://stripe.com/docs/api/subscriptions). - Sometimes you want to add a charge or credit to a customer, but actually - charge - - or credit the customer’s card only at the end of a regular billing - cycle. This is useful for combining several charges - - (to minimize per-transaction fees), or for having Stripe tabulate your - usage-based billing totals. - - - Related guides: [Integrate with the Invoicing - API](https://stripe.com/docs/invoicing/integration), [Subscription - Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items). - properties: - amount: - description: >- - Amount (in the `currency` specified) of the invoice item. This - should always be equal to `unit_amount * quantity`. - type: integer - 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). - type: string - customer: + - $ref: '#/components/schemas/gelato_data_document_report_date_of_birth' + description: Date of birth as it appears in the document. + nullable: true + error: anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/customer' - - $ref: '#/components/schemas/deleted_customer' - description: >- - The ID of the customer who will be billed when this invoice item is - billed. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/customer' - - $ref: '#/components/schemas/deleted_customer' - date: - description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time - type: integer - description: + - $ref: '#/components/schemas/gelato_document_report_error' description: >- - An arbitrary string attached to the object. Often useful for - displaying to users. - maxLength: 5000 + Details on the verification error. Present when status is + `unverified`. nullable: true - type: string - discountable: - description: >- - If true, discounts will apply to this invoice item. Always false for - prorations. - type: boolean - discounts: + expiration_date: + anyOf: + - $ref: '#/components/schemas/gelato_data_document_report_expiration_date' + description: Expiration date of the document. + nullable: true + files: description: >- - The discounts which apply to the invoice item. Item discounts are - applied before invoice discounts. Use `expand[]=discounts` to expand - each discount. + Array of [File](https://stripe.com/docs/api/files) ids containing + images for this document. items: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/discount' - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/discount' + maxLength: 5000 + type: string nullable: true type: array - id: - description: Unique identifier for the object. + first_name: + description: First name as it appears in the document. maxLength: 5000 - type: string - invoice: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/invoice' - description: The ID of the invoice this invoice item belongs to. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/invoice' - livemode: - description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. - type: boolean - metadata: - additionalProperties: - maxLength: 500 - type: 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. nullable: true - type: object - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - invoiceitem type: string - period: - $ref: '#/components/schemas/invoice_line_item_period' - price: - anyOf: - - $ref: '#/components/schemas/price' - description: The price of the invoice item. - nullable: true - proration: - description: >- - Whether the invoice item was created automatically as a proration - adjustment when the customer switched plans. - type: boolean - quantity: - description: >- - Quantity of units for the invoice item. If the invoice item is a - proration, the quantity of the subscription that the proration was - computed for. - type: integer - subscription: + issued_date: anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/subscription' - description: >- - The subscription that this invoice item has been created for, if - any. + - $ref: '#/components/schemas/gelato_data_document_report_issued_date' + description: Issued date of the document. nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/subscription' - subscription_item: - description: >- - The subscription item that this invoice item has been created for, - if any. + issuing_country: + description: Issuing country of the document. maxLength: 5000 - type: string - tax_rates: - description: >- - The tax rates which apply to the invoice item. When set, the - `default_tax_rates` on the invoice do not apply to this invoice - item. - items: - $ref: '#/components/schemas/tax_rate' nullable: true - type: array - test_clock: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/test_helpers.test_clock' - description: ID of the test clock this invoice item belongs to. + type: string + last_name: + description: Last name as it appears in the document. + maxLength: 5000 nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/test_helpers.test_clock' - unit_amount: - description: Unit amount (in the `currency` specified) of the invoice item. + type: string + number: + description: Document ID number. + maxLength: 5000 nullable: true - type: integer - unit_amount_decimal: - description: >- - Same as `unit_amount`, but contains a decimal value with at most 12 - decimal places. - format: decimal + type: string + status: + description: Status of this `document` check. + enum: + - unverified + - verified + type: string + x-stripeBypassValidation: true + type: + description: Type of the document. + enum: + - driving_license + - id_card + - passport nullable: true type: string required: - - amount - - currency - - customer - - date - - discountable - - id - - livemode - - object - - period - - proration - - quantity - title: InvoiceItem + - status + title: GelatoDocumentReport type: object x-expandableFields: - - customer - - discounts - - invoice - - period - - price - - subscription - - tax_rates - - test_clock - x-resourceId: invoiceitem - invoices_from_invoice: + - address + - dob + - error + - expiration_date + - issued_date + gelato_document_report_error: description: '' properties: - action: - description: The relation between this invoice and the cloned invoice + code: + description: >- + A short machine-readable string giving the reason for the + verification failure. + enum: + - document_expired + - document_type_not_supported + - document_unverified_other + nullable: true + type: string + x-stripeBypassValidation: true + reason: + description: >- + A human-readable message giving the reason for the failure. These + messages can be shown to your users. maxLength: 5000 + nullable: true type: string - invoice: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/invoice' - description: The invoice that was cloned. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/invoice' - required: - - action - - invoice - title: InvoicesFromInvoice + title: GelatoDocumentReportError type: object - x-expandableFields: - - invoice - invoices_invoice_rendering: - description: '' + x-expandableFields: [] + gelato_email_report: + description: Result from a email check properties: - amount_tax_display: - description: >- - How line-item prices and amounts will be displayed with respect to - tax on invoice PDFs. + email: + description: Email to be verified. maxLength: 5000 nullable: true type: string - pdf: + error: anyOf: - - $ref: '#/components/schemas/invoice_rendering_pdf' - description: Invoice pdf rendering options + - $ref: '#/components/schemas/gelato_email_report_error' + description: >- + Details on the verification error. Present when status is + `unverified`. nullable: true - title: InvoicesInvoiceRendering + status: + description: Status of this `email` check. + enum: + - unverified + - verified + type: string + x-stripeBypassValidation: true + required: + - status + title: GelatoEmailReport type: object x-expandableFields: - - pdf - invoices_payment_method_options: + - error + gelato_email_report_error: description: '' properties: - acss_debit: - anyOf: - - $ref: '#/components/schemas/invoice_payment_method_options_acss_debit' + code: description: >- - If paying by `acss_debit`, this sub-hash contains details about the - Canadian pre-authorized debit payment method options to pass to the - invoice’s PaymentIntent. + A short machine-readable string giving the reason for the + verification failure. + enum: + - email_unverified_other + - email_verification_declined nullable: true - bancontact: - anyOf: - - $ref: '#/components/schemas/invoice_payment_method_options_bancontact' + type: string + reason: description: >- - If paying by `bancontact`, this sub-hash contains details about the - Bancontact payment method options to pass to the invoice’s - PaymentIntent. + A human-readable message giving the reason for the failure. These + messages can be shown to your users. + maxLength: 5000 nullable: true - card: + type: string + title: GelatoEmailReportError + type: object + x-expandableFields: [] + gelato_id_number_report: + description: Result from an id_number check + properties: + dob: anyOf: - - $ref: '#/components/schemas/invoice_payment_method_options_card' - description: >- - If paying by `card`, this sub-hash contains details about the Card - payment method options to pass to the invoice’s PaymentIntent. + - $ref: '#/components/schemas/gelato_data_id_number_report_date' + description: Date of birth. nullable: true - customer_balance: + error: anyOf: - - $ref: >- - #/components/schemas/invoice_payment_method_options_customer_balance + - $ref: '#/components/schemas/gelato_id_number_report_error' description: >- - If paying by `customer_balance`, this sub-hash contains details - about the Bank transfer payment method options to pass to the - invoice’s PaymentIntent. + Details on the verification error. Present when status is + `unverified`. nullable: true - konbini: - anyOf: - - $ref: '#/components/schemas/invoice_payment_method_options_konbini' - description: >- - If paying by `konbini`, this sub-hash contains details about the - Konbini payment method options to pass to the invoice’s - PaymentIntent. + first_name: + description: First name. + maxLength: 5000 nullable: true - us_bank_account: - anyOf: - - $ref: >- - #/components/schemas/invoice_payment_method_options_us_bank_account + type: string + id_number: description: >- - If paying by `us_bank_account`, this sub-hash contains details about - the ACH direct debit payment method options to pass to the invoice’s - PaymentIntent. + ID number. When `id_number_type` is `us_ssn`, only the last 4 digits + are present. + maxLength: 5000 nullable: true - title: InvoicesPaymentMethodOptions + type: string + id_number_type: + description: Type of ID number. + enum: + - br_cpf + - sg_nric + - us_ssn + nullable: true + type: string + last_name: + description: Last name. + maxLength: 5000 + nullable: true + type: string + status: + description: Status of this `id_number` check. + enum: + - unverified + - verified + type: string + x-stripeBypassValidation: true + required: + - status + title: GelatoIdNumberReport type: object x-expandableFields: - - acss_debit - - bancontact - - card - - customer_balance - - konbini - - us_bank_account - invoices_payment_settings: + - dob + - error + gelato_id_number_report_error: description: '' properties: - default_mandate: + code: description: >- - ID of the mandate to be used for this invoice. It must correspond to - the payment method used to pay the invoice, including the invoice's - default_payment_method or default_source, if set. - maxLength: 5000 + A short machine-readable string giving the reason for the + verification failure. + enum: + - id_number_insufficient_document_data + - id_number_mismatch + - id_number_unverified_other nullable: true type: string - payment_method_options: - anyOf: - - $ref: '#/components/schemas/invoices_payment_method_options' + reason: description: >- - Payment-method-specific configuration to provide to the invoice’s - PaymentIntent. + A human-readable message giving the reason for the failure. These + messages can be shown to your users. + maxLength: 5000 nullable: true - payment_method_types: + type: string + title: GelatoIdNumberReportError + type: object + x-expandableFields: [] + gelato_phone_report: + description: Result from a phone check + properties: + error: + anyOf: + - $ref: '#/components/schemas/gelato_phone_report_error' description: >- - The list of payment method types (e.g. card) to provide to the - invoice’s PaymentIntent. If not set, Stripe attempts to - automatically determine the types to use by looking at the invoice’s - default payment method, the subscription’s default payment method, - the customer’s default payment method, and your [invoice template - settings](https://dashboard.stripe.com/settings/billing/invoice). - items: - enum: - - ach_credit_transfer - - ach_debit - - acss_debit - - au_becs_debit - - bacs_debit - - bancontact - - boleto - - card - - cashapp - - customer_balance - - fpx - - giropay - - grabpay - - ideal - - konbini - - link - - paynow - - paypal - - promptpay - - sepa_debit - - sofort - - us_bank_account - - wechat_pay - type: string - x-stripeBypassValidation: true + Details on the verification error. Present when status is + `unverified`. nullable: true - type: array - title: InvoicesPaymentSettings + phone: + description: Phone to be verified. + maxLength: 5000 + nullable: true + type: string + status: + description: Status of this `phone` check. + enum: + - unverified + - verified + type: string + x-stripeBypassValidation: true + required: + - status + title: GelatoPhoneReport type: object x-expandableFields: - - payment_method_options - invoices_resource_invoice_tax_id: + - error + gelato_phone_report_error: description: '' properties: - type: + code: 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`, `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`, `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`, `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`, or `unknown` + A short machine-readable string giving the reason for the + verification failure. enum: - - ad_nrt - - ae_trn - - ar_cuit - - au_abn - - au_arn - - bg_uic - - bo_tin - - br_cnpj - - br_cpf - - ca_bn - - ca_gst_hst - - ca_pst_bc - - ca_pst_mb - - ca_pst_sk - - ca_qst - - ch_vat - - cl_tin - - cn_tin - - co_nit - - cr_tin - - do_rcn - - ec_ruc - - eg_tin - - es_cif - - eu_oss_vat - - eu_vat - - gb_vat - - ge_vat - - hk_br - - hu_tin - - id_npwp - - il_vat - - in_gst - - is_vat - - jp_cn - - jp_rn - - jp_trn - - ke_pin - - kr_brn - - li_uid - - mx_rfc - - my_frp - - my_itn - - my_sst - - no_vat - - nz_gst - - 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 - - ua_vat - - unknown - - us_ein - - uy_ruc - - ve_rif - - vn_tin - - za_vat + - phone_unverified_other + - phone_verification_declined + nullable: true type: string - value: - description: The value of the tax ID. + reason: + description: >- + A human-readable message giving the reason for the failure. These + messages can be shown to your users. maxLength: 5000 nullable: true type: string - required: - - type - title: InvoicesResourceInvoiceTaxID + title: GelatoPhoneReportError type: object x-expandableFields: [] - invoices_resource_line_items_credited_items: + gelato_provided_details: description: '' properties: - invoice: - description: Invoice containing the credited invoice line items + email: + description: Email of user being verified maxLength: 5000 type: string - invoice_line_items: - description: Credited invoice line items + phone: + description: Phone number of user being verified + maxLength: 5000 + type: string + title: GelatoProvidedDetails + type: object + x-expandableFields: [] + gelato_report_document_options: + description: '' + properties: + allowed_types: + description: >- + Array of strings of allowed identity document types. If the provided + identity document isn’t one of the allowed types, the verification + check will fail with a document_type_not_allowed error code. items: - maxLength: 5000 + enum: + - driving_license + - id_card + - passport type: string type: array - required: - - invoice - - invoice_line_items - title: InvoicesResourceLineItemsCreditedItems + require_id_number: + description: >- + Collect an ID number and perform an [ID number + check](https://stripe.com/docs/identity/verification-checks?type=id-number) + with the document’s extracted name and date of birth. + type: boolean + require_live_capture: + description: >- + Disable image uploads, identity document images have to be captured + using the device’s camera. + type: boolean + require_matching_selfie: + description: >- + Capture a face image and perform a [selfie + check](https://stripe.com/docs/identity/verification-checks?type=selfie) + comparing a photo ID and a picture of your user’s face. [Learn + more](https://stripe.com/docs/identity/selfie). + type: boolean + title: GelatoReportDocumentOptions type: object x-expandableFields: [] - invoices_resource_line_items_proration_details: + gelato_report_id_number_options: description: '' + properties: {} + title: GelatoReportIdNumberOptions + type: object + x-expandableFields: [] + gelato_selfie_report: + description: Result from a selfie check properties: - credited_items: + document: + description: >- + ID of the [File](https://stripe.com/docs/api/files) holding the + image of the identity document used in this check. + maxLength: 5000 + nullable: true + type: string + error: anyOf: - - $ref: '#/components/schemas/invoices_resource_line_items_credited_items' + - $ref: '#/components/schemas/gelato_selfie_report_error' description: >- - For a credit proration `line_item`, the original debit line_items to - which the credit proration applies. + Details on the verification error. Present when status is + `unverified`. nullable: true - title: InvoicesResourceLineItemsProrationDetails + selfie: + description: >- + ID of the [File](https://stripe.com/docs/api/files) holding the + image of the selfie used in this check. + maxLength: 5000 + nullable: true + type: string + status: + description: Status of this `selfie` check. + enum: + - unverified + - verified + type: string + x-stripeBypassValidation: true + required: + - status + title: GelatoSelfieReport type: object x-expandableFields: - - credited_items - invoices_shipping_cost: + - error + gelato_selfie_report_error: description: '' properties: - amount_subtotal: - description: Total shipping cost before any taxes are applied. - type: integer - amount_tax: + code: description: >- - Total tax amount applied due to shipping costs. If no tax was - applied, defaults to 0. - type: integer - amount_total: - description: Total shipping cost after taxes are applied. - type: integer - shipping_rate: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/shipping_rate' - description: The ID of the ShippingRate for this invoice. + A short machine-readable string giving the reason for the + verification failure. + enum: + - selfie_document_missing_photo + - selfie_face_mismatch + - selfie_manipulated + - selfie_unverified_other nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/shipping_rate' - taxes: - description: The taxes applied to the shipping rate. + type: string + reason: + description: >- + A human-readable message giving the reason for the failure. These + messages can be shown to your users. + maxLength: 5000 + nullable: true + type: string + title: GelatoSelfieReportError + type: object + x-expandableFields: [] + gelato_session_document_options: + description: '' + properties: + allowed_types: + description: >- + Array of strings of allowed identity document types. If the provided + identity document isn’t one of the allowed types, the verification + check will fail with a document_type_not_allowed error code. items: - $ref: '#/components/schemas/line_items_tax_amount' + enum: + - driving_license + - id_card + - passport + type: string type: array - required: - - amount_subtotal - - amount_tax - - amount_total - title: InvoicesShippingCost + require_id_number: + description: >- + Collect an ID number and perform an [ID number + check](https://stripe.com/docs/identity/verification-checks?type=id-number) + with the document’s extracted name and date of birth. + type: boolean + require_live_capture: + description: >- + Disable image uploads, identity document images have to be captured + using the device’s camera. + type: boolean + require_matching_selfie: + description: >- + Capture a face image and perform a [selfie + check](https://stripe.com/docs/identity/verification-checks?type=selfie) + comparing a photo ID and a picture of your user’s face. [Learn + more](https://stripe.com/docs/identity/selfie). + type: boolean + title: GelatoSessionDocumentOptions + type: object + x-expandableFields: [] + gelato_session_email_options: + description: '' + properties: + require_verification: + description: Request one time password verification of `provided_details.email`. + type: boolean + title: GelatoSessionEmailOptions + type: object + x-expandableFields: [] + gelato_session_id_number_options: + description: '' + properties: {} + title: GelatoSessionIdNumberOptions + type: object + x-expandableFields: [] + gelato_session_last_error: + description: Shows last VerificationSession error + properties: + code: + description: >- + A short machine-readable string giving the reason for the + verification or user-session failure. + enum: + - abandoned + - consent_declined + - country_not_supported + - device_not_supported + - document_expired + - document_type_not_supported + - document_unverified_other + - email_unverified_other + - email_verification_declined + - id_number_insufficient_document_data + - id_number_mismatch + - id_number_unverified_other + - phone_unverified_other + - phone_verification_declined + - selfie_document_missing_photo + - selfie_face_mismatch + - selfie_manipulated + - selfie_unverified_other + - under_supported_age + nullable: true + type: string + x-stripeBypassValidation: true + reason: + description: >- + A message that explains the reason for verification or user-session + failure. + maxLength: 5000 + nullable: true + type: string + title: GelatoSessionLastError + type: object + x-expandableFields: [] + gelato_session_phone_options: + description: '' + properties: + require_verification: + description: Request one time password verification of `provided_details.phone`. + type: boolean + title: GelatoSessionPhoneOptions + type: object + x-expandableFields: [] + gelato_verification_report_options: + description: '' + properties: + document: + $ref: '#/components/schemas/gelato_report_document_options' + id_number: + $ref: '#/components/schemas/gelato_report_id_number_options' + title: GelatoVerificationReportOptions type: object x-expandableFields: - - shipping_rate - - taxes - invoices_status_transitions: + - document + - id_number + gelato_verification_session_options: description: '' properties: - finalized_at: - description: The time that the invoice draft was finalized. - format: unix-time + document: + $ref: '#/components/schemas/gelato_session_document_options' + email: + $ref: '#/components/schemas/gelato_session_email_options' + id_number: + $ref: '#/components/schemas/gelato_session_id_number_options' + phone: + $ref: '#/components/schemas/gelato_session_phone_options' + title: GelatoVerificationSessionOptions + type: object + x-expandableFields: + - document + - email + - id_number + - phone + gelato_verified_outputs: + description: '' + properties: + address: + anyOf: + - $ref: '#/components/schemas/address' + description: The user's verified address. nullable: true - type: integer - marked_uncollectible_at: - description: The time that the invoice was marked uncollectible. - format: unix-time + dob: + anyOf: + - $ref: '#/components/schemas/gelato_data_verified_outputs_date' + description: The user’s verified date of birth. nullable: true - type: integer - paid_at: - description: The time that the invoice was paid. - format: unix-time + email: + description: The user's verified email address + maxLength: 5000 nullable: true - type: integer - voided_at: - description: The time that the invoice was voided. - format: unix-time + type: string + first_name: + description: The user's verified first name. + maxLength: 5000 nullable: true - type: integer - title: InvoicesStatusTransitions + type: string + id_number: + description: The user's verified id number. + maxLength: 5000 + nullable: true + type: string + id_number_type: + description: The user's verified id number type. + enum: + - br_cpf + - sg_nric + - us_ssn + nullable: true + type: string + last_name: + description: The user's verified last name. + maxLength: 5000 + nullable: true + type: string + phone: + description: The user's verified phone number + maxLength: 5000 + nullable: true + type: string + title: GelatoVerifiedOutputs type: object - x-expandableFields: [] - issuing.authorization: + x-expandableFields: + - address + - dob + identity.verification_report: description: >- - When an [issued card](https://stripe.com/docs/issuing) is used to make a - purchase, an Issuing `Authorization` + A VerificationReport is the result of an attempt to collect and verify + data from a user. - object is created. - [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) - must be approved for the + The collection of verification checks performed is determined from the + `type` and `options` - purchase to be completed successfully. + parameters used. You can find the result of each verification check + performed in the + appropriate sub-resource: `document`, `id_number`, `selfie`. - Related guide: [Issued card - authorizations](https://stripe.com/docs/issuing/purchases/authorizations) + + Each VerificationReport contains a copy of any data collected by the + user as well as + + reference IDs which can be used to access collected images through the + [FileUpload](https://stripe.com/docs/api/files) + + API. To configure and create VerificationReports, use the + + [VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) + API. + + + Related guides: [Accessing verification + results](https://stripe.com/docs/identity/verification-sessions#results). properties: - amount: - description: >- - The total amount that was authorized or rejected. This amount is in - `currency` and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). `amount` - should be the same as `merchant_amount`, unless `currency` and - `merchant_currency` are different. - type: integer - amount_details: - anyOf: - - $ref: '#/components/schemas/issuing_authorization_amount_details' + client_reference_id: 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). + A string to reference this user. This can be a customer ID, a + session ID, or similar, and can be used to reconcile this + verification with your internal systems. + maxLength: 5000 nullable: true - approved: - description: Whether the authorization has been approved. - type: boolean - authorization_method: - description: How the card details were provided. - enum: - - chip - - contactless - - keyed_in - - online - - swipe type: string - balance_transactions: - description: List of balance transactions associated with this authorization. - items: - $ref: '#/components/schemas/balance_transaction' - type: array - card: - $ref: '#/components/schemas/issuing.card' - cardholder: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/issuing.cardholder' - description: The cardholder to whom this authorization belongs. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/issuing.cardholder' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer - 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). - type: string + document: + $ref: '#/components/schemas/gelato_document_report' + email: + $ref: '#/components/schemas/gelato_email_report' id: description: Unique identifier for the object. maxLength: 5000 type: string + id_number: + $ref: '#/components/schemas/gelato_id_number_report' livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean - merchant_amount: - 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. - type: integer - merchant_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). - type: string - merchant_data: - $ref: '#/components/schemas/issuing_authorization_merchant_data' - metadata: - additionalProperties: - maxLength: 500 - type: 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. - type: object - network_data: - anyOf: - - $ref: '#/components/schemas/issuing_authorization_network_data' - description: >- - Details about the authorization, such as identifiers, set by the - card network. - nullable: true object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - issuing.authorization + - identity.verification_report type: string - pending_request: - anyOf: - - $ref: '#/components/schemas/issuing_authorization_pending_request' - description: >- - The pending authorization request. This field will only be non-null - during an `issuing_authorization.request` webhook. - nullable: true - request_history: - description: >- - History of every time a `pending_request` authorization was - approved/declined, either by you directly or by Stripe (e.g. based - on your spending_controls). If the merchant changes the - authorization by performing an incremental authorization, you can - look at this field to see the previous requests for the - authorization. This field can be helpful in determining why a given - authorization was approved/declined. - items: - $ref: '#/components/schemas/issuing_authorization_request' - type: array - status: - description: The current status of the authorization in its lifecycle. + options: + $ref: '#/components/schemas/gelato_verification_report_options' + phone: + $ref: '#/components/schemas/gelato_phone_report' + selfie: + $ref: '#/components/schemas/gelato_selfie_report' + type: + description: Type of report. enum: - - closed - - pending - - reversed + - document + - id_number + - verification_flow type: string - token: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/issuing.token' - description: >- - [Token](https://stripe.com/docs/api/issuing/tokens/object) object - used for this authorization. If a network token was not used for - this authorization, this field will be null. - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/issuing.token' - transactions: - description: >- - List of - [transactions](https://stripe.com/docs/api/issuing/transactions) - associated with this authorization. - items: - $ref: '#/components/schemas/issuing.transaction' - type: array - treasury: - anyOf: - - $ref: '#/components/schemas/issuing_authorization_treasury' - description: >- - [Treasury](https://stripe.com/docs/api/treasury) details related to - this authorization if it was created on a - [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts). - nullable: true - verification_data: - $ref: '#/components/schemas/issuing_authorization_verification_data' - wallet: - description: >- - The digital wallet used for this transaction. One of `apple_pay`, - `google_pay`, or `samsung_pay`. Will populate as `null` when no - digital wallet was utilized. + x-stripeBypassValidation: true + verification_flow: + description: The configuration token of a Verification Flow from the dashboard. + maxLength: 5000 + type: string + verification_session: + description: ID of the VerificationSession that created this report. maxLength: 5000 nullable: true type: string required: - - amount - - approved - - authorization_method - - balance_transactions - - card - created - - currency - id - livemode - - merchant_amount - - merchant_currency - - merchant_data - - metadata - object - - request_history - - status - - transactions - - verification_data - title: IssuingAuthorization + - type + title: GelatoVerificationReport type: object x-expandableFields: - - amount_details - - balance_transactions - - card - - cardholder - - merchant_data - - network_data - - pending_request - - request_history - - token - - transactions - - treasury - - verification_data - x-resourceId: issuing.authorization - issuing.card: + - document + - email + - id_number + - options + - phone + - selfie + x-resourceId: identity.verification_report + identity.verification_session: description: >- - You can [create physical or virtual - cards](https://stripe.com/docs/issuing/cards) that are issued to - cardholders. + A VerificationSession guides you through the process of collecting and + verifying the identities + + of your users. It contains details about the type of verification, such + as what [verification + + check](/docs/identity/verification-checks) to perform. Only create one + VerificationSession for + + each verification in your system. + + + A VerificationSession transitions through [multiple + + statuses](/docs/identity/how-sessions-work) throughout its lifetime as + it progresses through + + the verification flow. The VerificationSession contains the user's + verified data after + + verification checks are complete. + + + Related guide: [The Verification Sessions + API](https://stripe.com/docs/identity/verification-sessions) properties: - brand: - description: The brand of the card. + client_reference_id: + description: >- + A string to reference this user. This can be a customer ID, a + session ID, or similar, and can be used to reconcile this + verification with your internal systems. maxLength: 5000 + nullable: true type: string - cancellation_reason: - description: The reason why the card was canceled. - enum: - - design_rejected - - lost - - stolen + client_secret: + description: >- + The short-lived client secret used by Stripe.js to [show a + verification modal](https://stripe.com/docs/js/identity/modal) + inside your app. This client secret expires after 24 hours and can + only be used once. Don’t store it, log it, embed it in a URL, or + expose it to anyone other than the user. Make sure that you have TLS + enabled on any page that includes the client secret. Refer to our + docs on [passing the client secret to the + frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) + to learn more. + maxLength: 5000 nullable: true type: string - x-stripeBypassValidation: true - cardholder: - $ref: '#/components/schemas/issuing.cardholder' created: description: >- Time at which the object was created. Measured in seconds since the Unix epoch. format: unix-time type: integer - 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. - type: string - cvc: - 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. - maxLength: 5000 - type: string - exp_month: - description: The expiration month of the card. - type: integer - exp_year: - description: The expiration year of the card. - type: integer - financial_account: - description: The financial account this card is attached to. - maxLength: 5000 - nullable: true - type: string id: description: Unique identifier for the object. maxLength: 5000 type: string - last4: - description: The last 4 digits of the card number. - maxLength: 5000 - type: string + last_error: + anyOf: + - $ref: '#/components/schemas/gelato_session_last_error' + description: >- + If present, this property tells you the last error encountered when + processing the verification. + nullable: true + last_verification_report: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/identity.verification_report' + description: >- + ID of the most recent VerificationReport. [Learn more about + accessing detailed verification + results.](https://stripe.com/docs/identity/verification-sessions#results) + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/identity.verification_report' livemode: description: >- Has the value `true` if the object exists in live mode or the value @@ -13261,365 +13467,422 @@ components: you can attach to an object. This can be useful for storing additional information about the object in a structured format. type: object - number: - description: >- - The full unredacted card number. 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. - maxLength: 5000 - type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - issuing.card + - identity.verification_session type: string - replaced_by: + options: anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/issuing.card' - description: 'The latest card that replaces this card, if any.' + - $ref: '#/components/schemas/gelato_verification_session_options' + description: A set of options for the session’s verification checks. nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/issuing.card' - replacement_for: + provided_details: anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/issuing.card' - description: 'The card this card replaces, if any.' - nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/issuing.card' - replacement_reason: - description: The reason why the previous card needed to be replaced. - enum: - - damaged - - expired - - lost - - stolen + - $ref: '#/components/schemas/gelato_provided_details' + description: >- + Details provided about the user being verified. These details may be + shown to the user. nullable: true - type: string - x-stripeBypassValidation: true - shipping: + redaction: anyOf: - - $ref: '#/components/schemas/issuing_card_shipping' - description: Where and how the card will be shipped. + - $ref: '#/components/schemas/verification_session_redaction' + description: >- + Redaction status of this VerificationSession. If the + VerificationSession is not redacted, this field will be null. nullable: true - spending_controls: - $ref: '#/components/schemas/issuing_card_authorization_controls' status: description: >- - Whether authorizations can be approved on this card. May be blocked - from activating cards depending on past-due Cardholder requirements. - Defaults to `inactive`. + Status of this VerificationSession. [Learn more about the lifecycle + of sessions](https://stripe.com/docs/identity/how-sessions-work). enum: - - active - canceled - - inactive + - processing + - requires_input + - verified type: string - x-stripeBypassValidation: true type: - description: The type of the card. + description: >- + The type of [verification + check](https://stripe.com/docs/identity/verification-checks) to be + performed. enum: - - physical - - virtual + - document + - id_number + - verification_flow type: string - wallets: - anyOf: - - $ref: '#/components/schemas/issuing_card_wallets' + x-stripeBypassValidation: true + url: description: >- - Information relating to digital wallets (like Apple Pay and Google - Pay). + The short-lived URL that you use to redirect a user to Stripe to + submit their identity information. This URL expires after 48 hours + and can only be used once. Don’t store it, log it, send it in emails + or expose it to anyone other than the user. Refer to our docs on + [verifying identity + documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) + to learn how to redirect users to Stripe. + maxLength: 5000 + nullable: true + type: string + verification_flow: + description: The configuration token of a Verification Flow from the dashboard. + maxLength: 5000 + type: string + verified_outputs: + anyOf: + - $ref: '#/components/schemas/gelato_verified_outputs' + description: The user’s verified data. nullable: true required: - - brand - - cardholder - created - - currency - - exp_month - - exp_year - id - - last4 - livemode - metadata - object - - spending_controls - status - type - title: IssuingCard + title: GelatoVerificationSession type: object x-expandableFields: - - cardholder - - replaced_by - - replacement_for - - shipping - - spending_controls - - wallets - x-resourceId: issuing.card - issuing.cardholder: - description: >- - An Issuing `Cardholder` object represents an individual or business - entity who is [issued](https://stripe.com/docs/issuing) cards. - - - Related guide: [How to create a - cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) + - last_error + - last_verification_report + - options + - provided_details + - redaction + - verified_outputs + x-resourceId: identity.verification_session + inbound_transfers: + description: '' properties: - billing: - $ref: '#/components/schemas/issuing_cardholder_address' - company: - anyOf: - - $ref: '#/components/schemas/issuing_cardholder_company' - description: Additional information about a `company` cardholder. - nullable: true - created: - description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time - type: integer - email: - description: The cardholder's email address. - maxLength: 5000 - nullable: true - type: string - id: - description: Unique identifier for the object. - maxLength: 5000 + billing_details: + $ref: '#/components/schemas/treasury_shared_resource_billing_details' + type: + description: The type of the payment method used in the InboundTransfer. + enum: + - us_bank_account type: string - individual: - anyOf: - - $ref: '#/components/schemas/issuing_cardholder_individual' - description: Additional information about an `individual` cardholder. + x-stripeBypassValidation: true + us_bank_account: + $ref: >- + #/components/schemas/inbound_transfers_payment_method_details_us_bank_account + required: + - billing_details + - type + title: InboundTransfers + type: object + x-expandableFields: + - billing_details + - us_bank_account + inbound_transfers_payment_method_details_us_bank_account: + description: '' + properties: + account_holder_type: + description: 'Account holder type: individual or company.' + enum: + - company + - individual nullable: true - livemode: - description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. - type: boolean - metadata: - additionalProperties: - maxLength: 500 - type: 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. - type: object - name: - description: The cardholder's name. This will be printed on cards issued to them. - maxLength: 5000 type: string - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. + account_type: + description: 'Account type: checkings or savings. Defaults to checking if omitted.' enum: - - issuing.cardholder + - checking + - savings + nullable: true type: string - phone_number: - description: >- - The cardholder's phone number. This is required for all cardholders - who will be creating EU cards. See the [3D Secure - documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) - for more details. + bank_name: + description: Name of the bank associated with the bank account. maxLength: 5000 nullable: true type: string - preferred_locales: + fingerprint: description: >- - The cardholder’s preferred locales (languages), ordered by - preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. - This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. - items: - enum: - - de - - en - - es - - fr - - it - type: string + Uniquely identifies this particular bank account. You can use this + attribute to check whether two bank accounts are the same. + maxLength: 5000 nullable: true - type: array - requirements: - $ref: '#/components/schemas/issuing_cardholder_requirements' - spending_controls: - anyOf: - - $ref: '#/components/schemas/issuing_cardholder_authorization_controls' - description: >- - Rules that control spending across this cardholder's cards. Refer to - our - [documentation](https://stripe.com/docs/issuing/controls/spending-controls) - for more details. + type: string + last4: + description: Last four digits of the bank account number. + maxLength: 5000 nullable: true - status: - description: >- - Specifies whether to permit authorizations on this cardholder's - cards. - enum: - - active - - blocked - - inactive type: string - type: + mandate: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/mandate' + description: ID of the mandate used to make this payment. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/mandate' + network: description: >- - One of `individual` or `company`. See [Choose a cardholder - type](https://stripe.com/docs/issuing/other/choose-cardholder) for - more details. + The network rails used. See the + [docs](https://stripe.com/docs/treasury/money-movement/timelines) to + learn more about money movement timelines for each network type. enum: - - company - - individual + - ach + type: string + routing_number: + description: Routing number of the bank account. + maxLength: 5000 + nullable: true type: string - x-stripeBypassValidation: true required: - - billing - - created - - id - - livemode - - metadata - - name - - object - - requirements - - status - - type - title: IssuingCardholder + - network + title: inbound_transfers_payment_method_details_us_bank_account type: object x-expandableFields: - - billing - - company - - individual - - requirements - - spending_controls - x-resourceId: issuing.cardholder - issuing.dispute: + - mandate + internal_card: + description: '' + properties: + brand: + description: Brand of the card used in the transaction + maxLength: 5000 + nullable: true + type: string + country: + description: Two-letter ISO code representing the country of the card + 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: Two digit number representing the card's expiration year + nullable: true + type: integer + last4: + description: The last 4 digits of the card + maxLength: 5000 + nullable: true + type: string + title: internal_card + type: object + x-expandableFields: [] + invoice: description: >- - As a [card issuer](https://stripe.com/docs/issuing), you can dispute - transactions that the cardholder does not recognize, suspects to be - fraudulent, or has other issues with. + Invoices are statements of amounts owed by a customer, and are either + generated one-off, or generated periodically from a subscription. - Related guide: [Issuing - disputes](https://stripe.com/docs/issuing/purchases/disputes) + + They contain [invoice items](https://stripe.com/docs/api#invoiceitems), + and proration adjustments + + that may be caused by subscription upgrades/downgrades (if necessary). + + + If your invoice is configured to be billed through automatic charges, + + Stripe automatically finalizes your invoice and attempts payment. Note + + that finalizing the invoice, + + [when + automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), + does + + not happen immediately as the invoice is created. Stripe waits + + until one hour after the last webhook was successfully sent (or the last + + webhook timed out after failing). If you (and the platforms you may have + + connected to) have no webhooks configured, Stripe waits one hour after + + creation to finalize the invoice. + + + If your invoice is configured to be billed by sending an email, then + based on your + + [email + settings](https://dashboard.stripe.com/account/billing/automatic), + + Stripe will email the invoice to your customer and await payment. These + + emails can contain a link to a hosted page to pay the invoice. + + + Stripe applies any customer credit on the account before determining the + + amount due for the invoice (i.e., the amount that will be actually + + charged). If the amount due for the invoice is less than Stripe's + [minimum allowed charge + + per currency](/docs/currencies#minimum-and-maximum-charge-amounts), the + + invoice is automatically marked paid, and we add the amount due to the + + customer's credit balance which is applied to the next invoice. + + + More details on the customer's credit balance are + + [here](https://stripe.com/docs/billing/customer/balance). + + + Related guide: [Send invoices to + customers](https://stripe.com/docs/billing/invoices/sending) properties: - amount: + account_country: description: >- - Disputed amount in the card's currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). Usually the - amount of the `transaction`, but can differ (usually because of - currency fluctuation). - type: integer - balance_transactions: - description: List of balance transactions associated with the dispute. + The country of the business associated with this invoice, most often + the business creating the invoice. + maxLength: 5000 + nullable: true + type: string + account_name: + description: >- + The public name of the business associated with this invoice, most + often the business creating the invoice. + maxLength: 5000 + nullable: true + type: string + account_tax_ids: + description: >- + The account tax IDs associated with the invoice. Only editable when + the invoice is a draft. items: - $ref: '#/components/schemas/balance_transaction' + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/tax_id' + - $ref: '#/components/schemas/deleted_tax_id' + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/tax_id' + - $ref: '#/components/schemas/deleted_tax_id' nullable: true type: array - created: + amount_due: description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time + Final amount due at this time for this invoice. If the invoice's + total is smaller than the minimum charge amount, for example, or if + there is account credit that can be applied to the invoice, the + `amount_due` may be 0. If there is a positive `starting_balance` for + the invoice (the customer owes money), the `amount_due` will also + take that into account. The charge that gets generated for the + invoice will be for the amount specified in `amount_due`. type: integer - currency: - description: The currency the `transaction` was made in. - type: string - evidence: - $ref: '#/components/schemas/issuing_dispute_evidence' - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - livemode: + amount_paid: + description: 'The amount, in cents (or local equivalent), that was paid.' + type: integer + amount_remaining: description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. + The difference between amount_due and amount_paid, in cents (or + local equivalent). + type: integer + amount_shipping: + description: This is the sum of all the shipping amounts. + type: integer + application: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/application' + - $ref: '#/components/schemas/deleted_application' + description: ID of the Connect Application that created the invoice. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/application' + - $ref: '#/components/schemas/deleted_application' + application_fee_amount: + description: >- + The fee in cents (or local equivalent) that will be applied to the + invoice and transferred to the application owner's Stripe account + when the invoice is paid. + nullable: true + type: integer + attempt_count: + description: >- + Number of payment attempts made for this invoice, from the + perspective of the payment retry schedule. Any payment attempt + counts as the first attempt, and subsequently only automatic retries + increment the attempt count. In other words, manual payment attempts + after the first attempt do not affect the retry schedule. + type: integer + attempted: + description: >- + Whether an attempt has been made to pay the invoice. An invoice is + not attempted until 1 hour after the `invoice.created` webhook, for + example, so you might not want to display that invoice as unpaid to + your users. type: boolean - metadata: - additionalProperties: - maxLength: 500 - type: string + auto_advance: 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. - type: object - object: + Controls whether Stripe performs [automatic + collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) + of the invoice. If `false`, the invoice's state doesn't + automatically advance without an explicit action. + type: boolean + automatic_tax: + $ref: '#/components/schemas/automatic_tax' + billing_reason: description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - issuing.dispute - type: string - status: - description: Current status of the dispute. + Indicates the reason why the invoice was created. + + + * `manual`: Unrelated to a subscription, for example, created via + the invoice editor. + + * `subscription`: No longer in use. Applies to subscriptions from + before May 2018 where no distinction was made between updates, + cycles, and thresholds. + + * `subscription_create`: A new subscription was created. + + * `subscription_cycle`: A subscription advanced into a new period. + + * `subscription_threshold`: A subscription reached a billing + threshold. + + * `subscription_update`: A subscription was updated. + + * `upcoming`: Reserved for simulated invoices, per the upcoming + invoice endpoint. enum: - - expired - - lost - - submitted - - unsubmitted - - won + - automatic_pending_invoice_item_invoice + - manual + - quote_accept + - subscription + - subscription_create + - subscription_cycle + - subscription_threshold + - subscription_update + - upcoming + nullable: true type: string - transaction: + charge: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/issuing.transaction' - description: The transaction being disputed. + - $ref: '#/components/schemas/charge' + description: 'ID of the latest charge generated for this invoice, if any.' + nullable: true x-expansionResources: oneOf: - - $ref: '#/components/schemas/issuing.transaction' - treasury: - anyOf: - - $ref: '#/components/schemas/issuing_dispute_treasury' + - $ref: '#/components/schemas/charge' + collection_method: description: >- - [Treasury](https://stripe.com/docs/api/treasury) details related to - this dispute if it was created on a - [FinancialAccount](/docs/api/treasury/financial_accounts - nullable: true - required: - - amount - - created - - currency - - evidence - - id - - livemode - - metadata - - object - - status - - transaction - title: IssuingDispute - type: object - x-expandableFields: - - balance_transactions - - evidence - - transaction - - treasury - x-resourceId: issuing.dispute - issuing.settlement: - description: >- - When a non-stripe BIN is used, any use of an [issued - card](https://stripe.com/docs/issuing) must be settled directly with the - card network. The net amount owed is represented by an Issuing - `Settlement` object. - properties: - bin: - description: The Bank Identification Number reflecting this settlement record. - maxLength: 5000 + Either `charge_automatically`, or `send_invoice`. When charging + automatically, Stripe will attempt to pay this invoice using the + default source attached to the customer. When sending an invoice, + Stripe will email this invoice to the customer with payment + instructions. + enum: + - charge_automatically + - send_invoice type: string - clearing_date: - description: >- - The date that the transactions are cleared and posted to user's - accounts. - type: integer created: description: >- Time at which the object was created. Measured in seconds since the @@ -13633,291 +13896,276 @@ components: lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). type: string - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - interchange_fees: - description: >- - The total interchange received as reimbursement for the - transactions. - type: integer - livemode: - description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. - type: boolean - metadata: - additionalProperties: - maxLength: 500 - type: 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. - type: object - net_total: - description: The total net amount required to settle with the network. - type: integer - network: - description: 'The card network for this settlement report. One of ["visa"]' - enum: - - visa - type: string - network_fees: - description: The total amount of fees owed to the network. - type: integer - network_settlement_identifier: - description: The Settlement Identification Number assigned by the network. - maxLength: 5000 - type: string - object: - description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - issuing.settlement - type: string - settlement_service: - description: One of `international` or `uk_national_net`. - maxLength: 5000 - type: string - transaction_count: - description: The total number of transactions reflected in this settlement. - type: integer - transaction_volume: - description: The total transaction amount reflected in this settlement. - type: integer - required: - - bin - - clearing_date - - created - - currency - - id - - interchange_fees - - livemode - - metadata - - net_total - - network - - network_fees - - network_settlement_identifier - - object - - settlement_service - - transaction_count - - transaction_volume - title: IssuingSettlement - type: object - x-expandableFields: [] - x-resourceId: issuing.settlement - issuing.token: - description: >- - An issuing token object is created when an issued card is added to a - digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you - can [view and manage these - tokens](https://stripe.com/docs/issuing/controls/token-management) - through Stripe. - properties: - card: + custom_fields: + description: Custom fields displayed on the invoice. + items: + $ref: '#/components/schemas/invoice_setting_custom_field' + nullable: true + type: array + customer: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/issuing.card' - description: Card associated with this token. + - $ref: '#/components/schemas/customer' + - $ref: '#/components/schemas/deleted_customer' + description: The ID of the customer who will be billed. + nullable: true x-expansionResources: oneOf: - - $ref: '#/components/schemas/issuing.card' - created: + - $ref: '#/components/schemas/customer' + - $ref: '#/components/schemas/deleted_customer' + customer_address: + anyOf: + - $ref: '#/components/schemas/address' description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time - type: integer - device_fingerprint: + The customer's address. Until the invoice is finalized, this field + will equal `customer.address`. Once the invoice is finalized, this + field will no longer be updated. + nullable: true + customer_email: description: >- - The hashed ID derived from the device ID from the card network - associated with the token + The customer's email. Until the invoice is finalized, this field + will equal `customer.email`. Once the invoice is finalized, this + field will no longer be updated. maxLength: 5000 nullable: true type: string - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string - last4: - description: The last four digits of the token. + customer_name: + description: >- + The customer's name. Until the invoice is finalized, this field will + equal `customer.name`. Once the invoice is finalized, this field + will no longer be updated. maxLength: 5000 + nullable: true type: string - livemode: + customer_phone: description: >- - Has the value `true` if the object exists in live mode or the value - `false` if the object exists in test mode. - type: boolean - network: - description: The token service provider / card network associated with the token. - enum: - - mastercard - - visa + The customer's phone number. Until the invoice is finalized, this + field will equal `customer.phone`. Once the invoice is finalized, + this field will no longer be updated. + maxLength: 5000 + nullable: true type: string - network_data: - $ref: '#/components/schemas/issuing_network_token_network_data' - network_updated_at: + customer_shipping: + anyOf: + - $ref: '#/components/schemas/shipping' description: >- - Time at which the token was last updated by the card network. - Measured in seconds since the Unix epoch. - format: unix-time - type: integer - object: + The customer's shipping information. Until the invoice is finalized, + this field will equal `customer.shipping`. Once the invoice is + finalized, this field will no longer be updated. + nullable: true + customer_tax_exempt: description: >- - String representing the object's type. Objects of the same type - share the same value. - enum: - - issuing.token - type: string - status: - description: The usage state of the token. - enum: - - active - - deleted - - requested - - suspended - type: string - wallet_provider: - description: 'The digital wallet for this token, if one was used.' + The customer's tax exempt status. Until the invoice is finalized, + this field will equal `customer.tax_exempt`. Once the invoice is + finalized, this field will no longer be updated. enum: - - apple_pay - - google_pay - - samsung_pay + - exempt + - none + - reverse + nullable: true type: string - required: - - card - - created - - id - - livemode - - network - - network_updated_at - - object - - status - title: IssuingNetworkToken - type: object - x-expandableFields: - - card - - network_data - x-resourceId: issuing.token - issuing.transaction: - description: >- - Any use of an [issued card](https://stripe.com/docs/issuing) that - results in funds entering or leaving - - your Stripe account, such as a completed purchase or refund, is - represented by an Issuing - - `Transaction` object. - - - Related guide: [Issued card - transactions](https://stripe.com/docs/issuing/purchases/transactions) - properties: - amount: - description: >- - The transaction amount, which will be reflected in your balance. - This amount is in your currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). - type: integer - amount_details: - anyOf: - - $ref: '#/components/schemas/issuing_transaction_amount_details' + customer_tax_ids: 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). + The customer's tax IDs. Until the invoice is finalized, this field + will contain the same tax IDs as `customer.tax_ids`. Once the + invoice is finalized, this field will no longer be updated. + items: + $ref: '#/components/schemas/invoices_resource_invoice_tax_id' nullable: true - authorization: + type: array + default_payment_method: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/issuing.authorization' - description: The `Authorization` object that led to this transaction. + - $ref: '#/components/schemas/payment_method' + description: >- + ID of the default payment method for the invoice. It must belong to + the customer associated with the invoice. If not set, defaults to + the subscription's default payment method, if any, or to the default + payment method in the customer's invoice settings. nullable: true x-expansionResources: oneOf: - - $ref: '#/components/schemas/issuing.authorization' - balance_transaction: + - $ref: '#/components/schemas/payment_method' + default_source: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/balance_transaction' + - $ref: '#/components/schemas/bank_account' + - $ref: '#/components/schemas/card' + - $ref: '#/components/schemas/source' description: >- - ID of the [balance - transaction](https://stripe.com/docs/api/balance_transactions) - associated with this transaction. + ID of the default payment source for the invoice. It must belong to + the customer associated with the invoice and be in a chargeable + state. If not set, defaults to the subscription's default source, if + any, or to the customer's default source. nullable: true x-expansionResources: oneOf: - - $ref: '#/components/schemas/balance_transaction' - card: - anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/issuing.card' - description: The card used to make this transaction. - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/issuing.card' - cardholder: + - $ref: '#/components/schemas/bank_account' + - $ref: '#/components/schemas/card' + - $ref: '#/components/schemas/source' + x-stripeBypassValidation: true + default_tax_rates: + description: 'The tax rates applied to this invoice, if any.' + items: + $ref: '#/components/schemas/tax_rate' + type: array + description: + description: >- + An arbitrary string attached to the object. Often useful for + displaying to users. Referenced as 'memo' in the Dashboard. + maxLength: 5000 + nullable: true + type: string + discount: anyOf: - - maxLength: 5000 - type: string - - $ref: '#/components/schemas/issuing.cardholder' - description: The cardholder to whom this transaction belongs. + - $ref: '#/components/schemas/discount' + description: >- + Describes the current discount applied to this invoice, if there is + one. Not populated if there are multiple discounts. nullable: true - x-expansionResources: - oneOf: - - $ref: '#/components/schemas/issuing.cardholder' - created: + discounts: description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. + The discounts applied to the invoice. Line item discounts are + applied before invoice discounts. Use `expand[]=discounts` to expand + each discount. + items: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/discount' + - $ref: '#/components/schemas/deleted_discount' + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/discount' + - $ref: '#/components/schemas/deleted_discount' + type: array + due_date: + description: >- + The date on which payment for this invoice is due. This value will + be `null` for invoices where + `collection_method=charge_automatically`. format: unix-time + nullable: true type: integer - currency: + effective_at: description: >- - Three-letter [ISO currency - code](https://www.iso.org/iso-4217-currency-codes.html), in - lowercase. Must be a [supported - currency](https://stripe.com/docs/currencies). + The date when this invoice is in effect. Same as `finalized_at` + unless overwritten. When defined, this value replaces the + system-generated 'Date of issue' printed on the invoice PDF and + receipt. + format: unix-time + nullable: true + type: integer + ending_balance: + description: >- + Ending customer balance after the invoice is finalized. Invoices are + finalized approximately an hour after successful webhook delivery or + when payment collection is attempted for the invoice. If the invoice + has not been finalized yet, this will be null. + nullable: true + type: integer + footer: + description: Footer displayed on the invoice. + maxLength: 5000 + nullable: true type: string - dispute: + from_invoice: + anyOf: + - $ref: '#/components/schemas/invoices_resource_from_invoice' + description: >- + Details of the invoice that was cloned. See the [revision + documentation](https://stripe.com/docs/invoicing/invoice-revisions) + for more details. + nullable: true + hosted_invoice_url: + description: >- + The URL for the hosted invoice page, which allows customers to view + and pay an invoice. If the invoice has not been finalized yet, this + will be null. + maxLength: 5000 + nullable: true + type: string + id: + description: >- + Unique identifier for the object. This property is always present + unless the invoice is an upcoming invoice. See [Retrieve an upcoming + invoice](https://stripe.com/docs/api/invoices/upcoming) for more + details. + maxLength: 5000 + type: string + invoice_pdf: + description: >- + The link to download the PDF for the invoice. If the invoice has not + been finalized yet, this will be null. + maxLength: 5000 + nullable: true + type: string + issuer: + $ref: '#/components/schemas/connect_account_reference' + last_finalization_error: + anyOf: + - $ref: '#/components/schemas/api_errors' + description: >- + The error encountered during the previous attempt to finalize the + invoice. This field is cleared when the invoice is successfully + finalized. + nullable: true + latest_revision: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/issuing.dispute' - description: 'If you''ve disputed the transaction, the ID of the dispute.' + - $ref: '#/components/schemas/invoice' + description: The ID of the most recent non-draft revision of this invoice nullable: true x-expansionResources: oneOf: - - $ref: '#/components/schemas/issuing.dispute' - id: - description: Unique identifier for the object. - maxLength: 5000 - type: string + - $ref: '#/components/schemas/invoice' + lines: + description: >- + The individual line items that make up the invoice. `lines` is + sorted as follows: (1) pending invoice items (including prorations) + in reverse chronological order, (2) subscription items in reverse + chronological order, and (3) invoice items added after invoice + creation in chronological order. + properties: + data: + description: Details about each object. + items: + $ref: '#/components/schemas/line_item' + type: array + has_more: + description: >- + True if this list has another page of items after this one that + can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: InvoiceLinesList + type: object + x-expandableFields: + - data livemode: description: >- Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean - merchant_amount: - 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. - type: integer - merchant_currency: - description: The currency with which the merchant is taking payment. - type: string - merchant_data: - $ref: '#/components/schemas/issuing_authorization_merchant_data' metadata: additionalProperties: maxLength: 500 @@ -13926,1700 +14174,4343 @@ components: 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. + nullable: true type: object - network_data: - anyOf: - - $ref: '#/components/schemas/issuing_transaction_network_data' + next_payment_attempt: description: >- - Details about the transaction, such as processing dates, set by the - card network. + The time at which payment will next be attempted. This value will be + `null` for invoices where `collection_method=send_invoice`. + format: unix-time + nullable: true + type: integer + number: + description: >- + A unique, identifying string that appears on emails sent to the + customer for this invoice. This starts with the customer's unique + invoice_prefix if it is specified. + maxLength: 5000 nullable: true + type: string object: description: >- String representing the object's type. Objects of the same type share the same value. enum: - - issuing.transaction + - invoice type: string - purchase_details: + on_behalf_of: anyOf: - - $ref: '#/components/schemas/issuing_transaction_purchase_details' + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/account' description: >- - Additional purchase information that is optionally provided by the - merchant. + The account (if any) for which the funds of the invoice payment are + intended. If set, the invoice will be presented with the branding + and support information of the specified account. See the [Invoices + with Connect](https://stripe.com/docs/billing/invoices/connect) + documentation for details. nullable: true - token: + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/account' + paid: + description: >- + Whether payment was successfully collected for this invoice. An + invoice can be paid (most commonly) with a charge or with credit + from the customer's account balance. + type: boolean + paid_out_of_band: + description: >- + Returns true if the invoice was manually marked paid, returns false + if the invoice hasn't been paid yet or was paid on Stripe. + type: boolean + payment_intent: anyOf: - maxLength: 5000 type: string - - $ref: '#/components/schemas/issuing.token' + - $ref: '#/components/schemas/payment_intent' description: >- - [Token](https://stripe.com/docs/api/issuing/tokens/object) object - used for this transaction. If a network token was not used for this - transaction, this field will be null. + The PaymentIntent associated with this invoice. The PaymentIntent is + generated when the invoice is finalized, and can then be used to pay + the invoice. Note that voiding an invoice will cancel the + PaymentIntent. nullable: true x-expansionResources: oneOf: - - $ref: '#/components/schemas/issuing.token' - treasury: + - $ref: '#/components/schemas/payment_intent' + payment_settings: + $ref: '#/components/schemas/invoices_payment_settings' + period_end: + description: >- + End of the usage period during which invoice items were added to + this invoice. This looks back one period for a subscription invoice. + Use the [line item + period](/api/invoices/line_item#invoice_line_item_object-period) to + get the service period for each price. + format: unix-time + type: integer + period_start: + description: >- + Start of the usage period during which invoice items were added to + this invoice. This looks back one period for a subscription invoice. + Use the [line item + period](/api/invoices/line_item#invoice_line_item_object-period) to + get the service period for each price. + format: unix-time + type: integer + post_payment_credit_notes_amount: + description: >- + Total amount of all post-payment credit notes issued for this + invoice. + type: integer + pre_payment_credit_notes_amount: + description: >- + Total amount of all pre-payment credit notes issued for this + invoice. + type: integer + quote: anyOf: - - $ref: '#/components/schemas/issuing_transaction_treasury' + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/quote' + description: The quote this invoice was generated from. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/quote' + receipt_number: description: >- - [Treasury](https://stripe.com/docs/api/treasury) details related to - this transaction if it was created on a - [FinancialAccount](/docs/api/treasury/financial_accounts + This is the transaction number that appears on email receipts sent + for this invoice. + maxLength: 5000 nullable: true - type: - description: The nature of the transaction. - enum: - - capture - - refund type: string - x-stripeBypassValidation: true - wallet: + rendering: + anyOf: + - $ref: '#/components/schemas/invoices_resource_invoice_rendering' description: >- - The digital wallet used for this transaction. One of `apple_pay`, - `google_pay`, or `samsung_pay`. - enum: - - apple_pay - - google_pay - - samsung_pay + The rendering-related settings that control how the invoice is + displayed on customer-facing surfaces such as PDF and Hosted Invoice + Page. nullable: true - type: string - required: - - amount - - card - - created - - currency - - id - - livemode - - merchant_amount - - merchant_currency - - merchant_data - - metadata - - object - - type - title: IssuingTransaction - type: object - x-expandableFields: - - amount_details - - authorization - - balance_transaction - - card - - cardholder - - dispute - - merchant_data - - network_data - - purchase_details - - token - - treasury - x-resourceId: issuing.transaction - issuing_authorization_amount_details: - description: '' - properties: - atm_fee: - description: The fee charged by the ATM for the cash withdrawal. + shipping_cost: + anyOf: + - $ref: '#/components/schemas/invoices_resource_shipping_cost' + description: >- + The details of the cost of shipping, including the ShippingRate + applied on the invoice. nullable: true - type: integer - cashback_amount: - description: The amount of cash requested by the cardholder. + shipping_details: + anyOf: + - $ref: '#/components/schemas/shipping' + description: >- + Shipping details for the invoice. The Invoice PDF will use the + `shipping_details` value if it is set, otherwise the PDF will render + the shipping address from the customer. nullable: true + starting_balance: + description: >- + Starting customer balance before the invoice is finalized. If the + invoice has not been finalized yet, this will be the current + customer balance. For revision invoices, this also includes any + customer balance that was applied to the original invoice. type: integer - title: IssuingAuthorizationAmountDetails - type: object - x-expandableFields: [] - issuing_authorization_authentication_exemption: - description: '' - properties: - claimed_by: + statement_descriptor: description: >- - The entity that requested the exemption, either the acquiring - merchant or the Issuing user. - enum: - - acquirer - - issuer - type: string - type: - description: The specific exemption claimed for this authorization. - enum: - - low_value_transaction - - transaction_risk_analysis - type: string - x-stripeBypassValidation: true - required: - - claimed_by - - type - title: IssuingAuthorizationAuthenticationExemption - type: object - x-expandableFields: [] - issuing_authorization_merchant_data: - description: '' - properties: - category: - description: >- - A categorization of the seller's type of business. See our [merchant - categories - guide](https://stripe.com/docs/issuing/merchant-categories) for a - list of possible values. - maxLength: 5000 - type: string - category_code: - description: The merchant category code for the seller’s business - maxLength: 5000 - type: string - city: - description: City where the seller is located - maxLength: 5000 - nullable: true - type: string - country: - description: Country where the seller is located - maxLength: 5000 - nullable: true - type: string - name: - description: Name of the seller - maxLength: 5000 - nullable: true - type: string - network_id: - description: >- - Identifier assigned to the seller by the card network. Different - card networks may assign different network_id fields to the same - merchant. - maxLength: 5000 - type: string - postal_code: - description: Postal code where the seller is located - maxLength: 5000 - nullable: true - type: string - state: - description: State where the seller is located - maxLength: 5000 - nullable: true - type: string - terminal_id: - description: An ID assigned by the seller to the location of the sale. - maxLength: 5000 - nullable: true - type: string - url: - description: URL provided by the merchant on a 3DS request - maxLength: 5000 - nullable: true - type: string - required: - - category - - category_code - - network_id - title: IssuingAuthorizationMerchantData - type: object - x-expandableFields: [] - issuing_authorization_network_data: - description: '' - properties: - acquiring_institution_id: - description: >- - Identifier assigned to the acquirer by the card network. Sometimes - this value is not provided by the network; in this case, the value - will be `null`. + Extra information about an invoice for the customer's credit card + statement. maxLength: 5000 nullable: true type: string - system_trace_audit_number: + status: description: >- - The System Trace Audit Number (STAN) is a 6-digit identifier - assigned by the acquirer. Prefer `network_data.transaction_id` if - present, unless you have special requirements. - maxLength: 5000 + The status of the invoice, one of `draft`, `open`, `paid`, + `uncollectible`, or `void`. [Learn + more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) + enum: + - draft + - open + - paid + - uncollectible + - void nullable: true type: string - transaction_id: - description: >- - Unique identifier for the authorization assigned by the card network - used to match subsequent messages, disputes, and transactions. - maxLength: 5000 + x-stripeBypassValidation: true + status_transitions: + $ref: '#/components/schemas/invoices_resource_status_transitions' + subscription: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/subscription' + description: 'The subscription that this invoice was prepared for, if any.' nullable: true - type: string - title: IssuingAuthorizationNetworkData - type: object - x-expandableFields: [] - issuing_authorization_pending_request: - description: '' - properties: - amount: - description: >- - The additional amount Stripe will hold if the authorization is - approved, in the card's - [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) - and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). - type: integer - amount_details: + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/subscription' + subscription_details: anyOf: - - $ref: '#/components/schemas/issuing_authorization_amount_details' - 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). + - $ref: '#/components/schemas/subscription_details_data' + description: Details about the subscription that created this invoice. nullable: true - 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). - type: string - is_amount_controllable: + subscription_proration_date: 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. - type: boolean - merchant_amount: + Only set for upcoming invoices that preview prorations. The time + used to calculate prorations. + type: integer + subtotal: 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). + Total of all subscriptions, invoice items, and prorations on the + invoice before any invoice level discount or exclusive tax is + applied. Item discounts are already incorporated type: integer - merchant_currency: - description: The local currency the merchant is requesting to authorize. - type: string - network_risk_score: + subtotal_excluding_tax: description: >- - The card network's estimate of the likelihood that an authorization - is fraudulent. Takes on values between 1 and 99. + The integer amount in cents (or local equivalent) representing the + subtotal of the invoice before any invoice level discount or tax is + applied. Item discounts are already incorporated nullable: true type: integer - required: - - amount - - currency - - is_amount_controllable - - merchant_amount - - merchant_currency - title: IssuingAuthorizationPendingRequest - type: object - x-expandableFields: - - amount_details - issuing_authorization_request: - description: '' - properties: - amount: + tax: description: >- - The `pending_request.amount` at the time of the request, presented - in your card's currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held - this amount from your account to fund the authorization if the - request was approved. + The amount of tax on this invoice. This is the sum of all the tax + amounts on this invoice. + nullable: true type: integer - amount_details: + test_clock: anyOf: - - $ref: '#/components/schemas/issuing_authorization_amount_details' - 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). - nullable: true - approved: - description: Whether this request was approved. - type: boolean - authorization_code: - description: >- - A code created by Stripe which is shared with the merchant to - validate the authorization. This field will be populated if the - authorization message was approved. The code typically starts with - the letter "S", followed by a six-digit number. For example, - "S498162". Please note that the code is not guaranteed to be unique - across authorizations. - maxLength: 5000 + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/test_helpers.test_clock' + description: ID of the test clock this invoice belongs to. nullable: true - type: string - created: - description: >- - Time at which the object was created. Measured in seconds since the - Unix epoch. - format: unix-time - type: integer - 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). - maxLength: 5000 - type: string - merchant_amount: - description: >- - The `pending_request.merchant_amount` at the time of the request, - presented in the `merchant_currency` and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/test_helpers.test_clock' + threshold_reason: + $ref: '#/components/schemas/invoice_threshold_reason' + total: + description: Total after discounts and taxes. type: integer - merchant_currency: - description: >- - The currency that was collected by the merchant and presented to the - cardholder for the 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). - maxLength: 5000 - type: string - network_risk_score: + total_discount_amounts: + description: The aggregate amounts calculated per discount across all line items. + items: + $ref: '#/components/schemas/discounts_resource_discount_amount' + nullable: true + type: array + total_excluding_tax: description: >- - The card network's estimate of the likelihood that an authorization - is fraudulent. Takes on values between 1 and 99. + The integer amount in cents (or local equivalent) representing the + total amount of the invoice including all discounts but excluding + all tax. nullable: true type: integer - reason: - description: >- - When an authorization is approved or declined by you or by Stripe, - this field provides additional detail on the reason for the outcome. - enum: - - account_disabled - - card_active - - card_inactive - - cardholder_inactive - - cardholder_verification_required - - insufficient_funds - - not_allowed - - spending_controls - - suspected_fraud - - verification_failed - - webhook_approved - - webhook_declined - - webhook_error - - webhook_timeout - type: string - x-stripeBypassValidation: true - reason_message: + total_tax_amounts: + description: The aggregate amounts calculated per tax rate for all line items. + items: + $ref: '#/components/schemas/invoice_tax_amount' + type: array + transfer_data: + anyOf: + - $ref: '#/components/schemas/invoice_transfer_data' description: >- - If the `request_history.reason` is `webhook_error` because the - direct webhook response is invalid (for example, parsing errors or - missing parameters), we surface a more detailed error message via - this field. - maxLength: 5000 + The account (if any) the payment will be attributed to for tax + reporting, and where funds from the payment will be transferred to + for the invoice. nullable: true - type: string - requested_at: + webhooks_delivered_at: description: >- - Time when the card network received an authorization request from - the acquirer in UTC. Referred to by networks as transmission time. + Invoices are automatically paid or sent 1 hour after webhooks are + delivered, or until all webhook delivery attempts have [been + exhausted](https://stripe.com/docs/billing/webhooks#understand). + This field tracks the time when webhooks for this invoice were + successfully delivered. If the invoice had no webhooks to deliver, + this will be set while the invoice is being created. format: unix-time nullable: true type: integer required: - - amount - - approved + - amount_due + - amount_paid + - amount_remaining + - amount_shipping + - attempt_count + - attempted + - automatic_tax + - collection_method - created - currency - - merchant_amount - - merchant_currency - - reason - title: IssuingAuthorizationRequest + - default_tax_rates + - discounts + - issuer + - lines + - livemode + - object + - paid + - paid_out_of_band + - payment_settings + - period_end + - period_start + - post_payment_credit_notes_amount + - pre_payment_credit_notes_amount + - starting_balance + - status_transitions + - subtotal + - total + - total_tax_amounts + title: Invoice type: object x-expandableFields: - - amount_details - issuing_authorization_three_d_secure: + - account_tax_ids + - application + - automatic_tax + - charge + - custom_fields + - customer + - customer_address + - customer_shipping + - customer_tax_ids + - default_payment_method + - default_source + - default_tax_rates + - discount + - discounts + - from_invoice + - issuer + - last_finalization_error + - latest_revision + - lines + - on_behalf_of + - payment_intent + - payment_settings + - quote + - rendering + - shipping_cost + - shipping_details + - status_transitions + - subscription + - subscription_details + - test_clock + - threshold_reason + - total_discount_amounts + - total_tax_amounts + - transfer_data + x-resourceId: invoice + invoice_installments_card: description: '' properties: - result: - description: The outcome of the 3D Secure authentication request. - enum: - - attempt_acknowledged - - authenticated - - failed - - required - type: string - x-stripeBypassValidation: true - required: - - result - title: IssuingAuthorizationThreeDSecure + enabled: + description: Whether Installments are enabled for this Invoice. + nullable: true + type: boolean + title: invoice_installments_card type: object x-expandableFields: [] - issuing_authorization_treasury: + invoice_item_threshold_reason: description: '' properties: - received_credits: - description: >- - The array of - [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) - associated with this authorization - items: - maxLength: 5000 - type: string - type: array - received_debits: - description: >- - The array of - [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) - associated with this authorization + line_item_ids: + description: The IDs of the line items that triggered the threshold invoice. items: maxLength: 5000 type: string type: array - transaction: + usage_gte: + description: The quantity threshold boundary that applied to the given line item. + type: integer + required: + - line_item_ids + - usage_gte + title: InvoiceItemThresholdReason + type: object + x-expandableFields: [] + invoice_line_item_period: + description: '' + properties: + end: description: >- - The Treasury - [Transaction](https://stripe.com/docs/api/treasury/transactions) - associated with this authorization - maxLength: 5000 - nullable: true - type: string + The end of the period, which must be greater than or equal to the + start. This value is inclusive. + format: unix-time + type: integer + start: + description: The start of the period. This value is inclusive. + format: unix-time + type: integer required: - - received_credits - - received_debits - title: IssuingAuthorizationTreasury + - end + - start + title: InvoiceLineItemPeriod type: object x-expandableFields: [] - issuing_authorization_verification_data: + invoice_mandate_options_card: description: '' properties: - address_line1_check: + amount: + description: Amount to be charged for future payments. + nullable: true + type: integer + amount_type: description: >- - Whether the cardholder provided an address first line and if it - matched the cardholder’s `billing.address.line1`. + One of `fixed` or `maximum`. If `fixed`, the `amount` param refers + to the exact amount to be charged in future payments. If `maximum`, + the amount charged can be up to the value passed for the `amount` + param. enum: - - match - - mismatch - - not_provided + - fixed + - maximum + nullable: true type: string - address_postal_code_check: + description: description: >- - Whether the cardholder provided a postal code and if it matched the - cardholder’s `billing.address.postal_code`. - enum: - - match - - mismatch - - not_provided - type: string - authentication_exemption: - anyOf: - - $ref: >- - #/components/schemas/issuing_authorization_authentication_exemption - description: The exemption applied to this authorization. + A description of the mandate or subscription that is meant to be + displayed to the customer. + maxLength: 200 nullable: true - cvc_check: - description: >- - Whether the cardholder provided a CVC and if it matched Stripe’s - record. - enum: - - match - - mismatch - - not_provided type: string - expiry_check: - description: >- - Whether the cardholder provided an expiry date and if it matched - Stripe’s record. + title: invoice_mandate_options_card + type: object + x-expandableFields: [] + invoice_payment_method_options_acss_debit: + description: '' + properties: + mandate_options: + $ref: >- + #/components/schemas/invoice_payment_method_options_acss_debit_mandate_options + verification_method: + description: Bank account verification method. enum: - - match - - mismatch - - not_provided + - automatic + - instant + - microdeposits type: string - postal_code: - description: >- - The postal code submitted as part of the authorization used for - postal code verification. - maxLength: 5000 + x-stripeBypassValidation: true + title: invoice_payment_method_options_acss_debit + type: object + x-expandableFields: + - mandate_options + invoice_payment_method_options_acss_debit_mandate_options: + description: '' + properties: + transaction_type: + description: Transaction type of the mandate. + enum: + - business + - personal nullable: true type: string - three_d_secure: - anyOf: - - $ref: '#/components/schemas/issuing_authorization_three_d_secure' - description: 3D Secure details. - nullable: true + title: invoice_payment_method_options_acss_debit_mandate_options + type: object + x-expandableFields: [] + invoice_payment_method_options_bancontact: + description: '' + properties: + preferred_language: + description: >- + Preferred language of the Bancontact authorization page that the + customer is redirected to. + enum: + - de + - en + - fr + - nl + type: string required: - - address_line1_check - - address_postal_code_check - - cvc_check - - expiry_check - title: IssuingAuthorizationVerificationData + - preferred_language + title: invoice_payment_method_options_bancontact + type: object + x-expandableFields: [] + invoice_payment_method_options_card: + description: '' + properties: + installments: + $ref: '#/components/schemas/invoice_installments_card' + request_three_d_secure: + description: >- + We strongly recommend that you rely on our SCA Engine to + automatically prompt your customers for authentication based on risk + level and [other + requirements](https://stripe.com/docs/strong-customer-authentication). + However, if you wish to request 3D Secure based on logic from your + own fraud engine, provide this option. Read our guide on [manually + requesting 3D + Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) + for more information on how this configuration interacts with Radar + and our SCA Engine. + enum: + - any + - automatic + - challenge + nullable: true + type: string + title: invoice_payment_method_options_card type: object x-expandableFields: - - authentication_exemption - - three_d_secure - issuing_card_apple_pay: + - installments + invoice_payment_method_options_customer_balance: description: '' properties: - eligible: - description: Apple Pay Eligibility - type: boolean - ineligible_reason: - description: Reason the card is ineligible for Apple Pay + bank_transfer: + $ref: >- + #/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer + funding_type: + description: >- + The funding method type to be used when there are not enough funds + in the customer balance. Permitted values include: `bank_transfer`. enum: - - missing_agreement - - missing_cardholder_contact - - unsupported_region + - bank_transfer + nullable: true + type: string + title: invoice_payment_method_options_customer_balance + type: object + x-expandableFields: + - bank_transfer + invoice_payment_method_options_customer_balance_bank_transfer: + description: '' + properties: + eu_bank_transfer: + $ref: >- + #/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer + type: + description: >- + The bank transfer type that can be used for funding. Permitted + values include: `eu_bank_transfer`, `gb_bank_transfer`, + `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`. nullable: true type: string + title: invoice_payment_method_options_customer_balance_bank_transfer + type: object + x-expandableFields: + - eu_bank_transfer + invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer: + description: '' + properties: + country: + description: >- + The desired country code of the bank account information. Permitted + values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`. + enum: + - BE + - DE + - ES + - FR + - IE + - NL + type: string required: - - eligible - title: IssuingCardApplePay + - country + title: >- + invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer type: object x-expandableFields: [] - issuing_card_authorization_controls: + invoice_payment_method_options_konbini: + description: '' + properties: {} + title: invoice_payment_method_options_konbini + type: object + x-expandableFields: [] + invoice_payment_method_options_sepa_debit: + description: '' + properties: {} + title: invoice_payment_method_options_sepa_debit + type: object + x-expandableFields: [] + invoice_payment_method_options_us_bank_account: description: '' properties: - allowed_categories: + financial_connections: + $ref: >- + #/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options + verification_method: + description: Bank account verification method. + enum: + - automatic + - instant + - microdeposits + type: string + x-stripeBypassValidation: true + title: invoice_payment_method_options_us_bank_account + type: object + x-expandableFields: + - financial_connections + invoice_payment_method_options_us_bank_account_linked_account_options: + description: '' + properties: + permissions: description: >- - Array of strings containing - [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) - of authorizations to allow. All other categories will be blocked. - Cannot be set with `blocked_categories`. + The list of permissions to request. The `payment_method` permission + must be included. items: enum: - - ac_refrigeration_repair - - accounting_bookkeeping_services - - advertising_services - - agricultural_cooperative - - airlines_air_carriers - - airports_flying_fields - - ambulance_services - - amusement_parks_carnivals - - antique_reproductions - - antique_shops - - aquariums - - architectural_surveying_services - - art_dealers_and_galleries - - artists_supply_and_craft_shops - - auto_and_home_supply_stores - - auto_body_repair_shops - - auto_paint_shops - - auto_service_shops - - automated_cash_disburse - - automated_fuel_dispensers - - automobile_associations - - automotive_parts_and_accessories_stores - - automotive_tire_stores - - bail_and_bond_payments - - bakeries - - bands_orchestras - - barber_and_beauty_shops - - betting_casino_gambling - - bicycle_shops - - billiard_pool_establishments - - boat_dealers - - boat_rentals_and_leases - - book_stores - - books_periodicals_and_newspapers - - bowling_alleys - - bus_lines - - business_secretarial_schools - - buying_shopping_services - - cable_satellite_and_other_pay_television_and_radio - - camera_and_photographic_supply_stores - - candy_nut_and_confectionery_stores - - car_and_truck_dealers_new_used - - car_and_truck_dealers_used_only - - car_rental_agencies - - car_washes - - carpentry_services - - carpet_upholstery_cleaning - - caterers - - charitable_and_social_service_organizations_fundraising - - chemicals_and_allied_products - - child_care_services - - childrens_and_infants_wear_stores - - chiropodists_podiatrists - - chiropractors - - cigar_stores_and_stands - - civic_social_fraternal_associations - - cleaning_and_maintenance - - clothing_rental - - colleges_universities - - commercial_equipment - - commercial_footwear - - commercial_photography_art_and_graphics - - commuter_transport_and_ferries - - computer_network_services - - computer_programming - - computer_repair - - computer_software_stores - - computers_peripherals_and_software - - concrete_work_services - - construction_materials - - consulting_public_relations - - correspondence_schools - - cosmetic_stores - - counseling_services - - country_clubs - - courier_services - - court_costs - - credit_reporting_agencies - - cruise_lines - - dairy_products_stores - - dance_hall_studios_schools - - dating_escort_services - - dentists_orthodontists - - department_stores - - detective_agencies - - digital_goods_applications - - digital_goods_games - - digital_goods_large_volume - - digital_goods_media - - direct_marketing_catalog_merchant - - direct_marketing_combination_catalog_and_retail_merchant - - direct_marketing_inbound_telemarketing - - direct_marketing_insurance_services - - direct_marketing_other - - direct_marketing_outbound_telemarketing - - direct_marketing_subscription - - direct_marketing_travel - - discount_stores - - doctors - - door_to_door_sales - - drapery_window_covering_and_upholstery_stores - - drinking_places - - drug_stores_and_pharmacies - - drugs_drug_proprietaries_and_druggist_sundries - - dry_cleaners - - durable_goods - - duty_free_stores - - eating_places_restaurants - - educational_services - - electric_razor_stores - - electric_vehicle_charging - - electrical_parts_and_equipment - - electrical_services - - electronics_repair_shops - - electronics_stores - - elementary_secondary_schools - - emergency_services_gcas_visa_use_only - - employment_temp_agencies - - equipment_rental - - exterminating_services - - family_clothing_stores - - fast_food_restaurants - - financial_institutions - - fines_government_administrative_entities - - fireplace_fireplace_screens_and_accessories_stores - - floor_covering_stores - - florists - - florists_supplies_nursery_stock_and_flowers - - freezer_and_locker_meat_provisioners - - fuel_dealers_non_automotive - - funeral_services_crematories - - >- - furniture_home_furnishings_and_equipment_stores_except_appliances - - furniture_repair_refinishing - - furriers_and_fur_shops - - general_services - - gift_card_novelty_and_souvenir_shops - - glass_paint_and_wallpaper_stores - - glassware_crystal_stores - - golf_courses_public - - government_licensed_horse_dog_racing_us_region_only - - >- - government_licensed_online_casions_online_gambling_us_region_only - - government_owned_lotteries_non_us_region - - government_owned_lotteries_us_region_only - - government_services - - grocery_stores_supermarkets - - hardware_equipment_and_supplies - - hardware_stores - - health_and_beauty_spas - - hearing_aids_sales_and_supplies - - heating_plumbing_a_c - - hobby_toy_and_game_shops - - home_supply_warehouse_stores - - hospitals - - hotels_motels_and_resorts - - household_appliance_stores - - industrial_supplies - - information_retrieval_services - - insurance_default - - insurance_underwriting_premiums - - intra_company_purchases - - jewelry_stores_watches_clocks_and_silverware_stores - - landscaping_services - - laundries - - laundry_cleaning_services - - legal_services_attorneys - - luggage_and_leather_goods_stores - - lumber_building_materials_stores - - manual_cash_disburse - - marinas_service_and_supplies - - marketplaces - - masonry_stonework_and_plaster - - massage_parlors - - medical_and_dental_labs - - medical_dental_ophthalmic_and_hospital_equipment_and_supplies - - medical_services - - membership_organizations - - mens_and_boys_clothing_and_accessories_stores - - mens_womens_clothing_stores - - metal_service_centers - - miscellaneous - - miscellaneous_apparel_and_accessory_shops - - miscellaneous_auto_dealers - - miscellaneous_business_services - - miscellaneous_food_stores - - miscellaneous_general_merchandise - - miscellaneous_general_services - - miscellaneous_home_furnishing_specialty_stores - - miscellaneous_publishing_and_printing - - miscellaneous_recreation_services - - miscellaneous_repair_shops - - miscellaneous_specialty_retail - - mobile_home_dealers - - motion_picture_theaters - - motor_freight_carriers_and_trucking - - motor_homes_dealers - - motor_vehicle_supplies_and_new_parts - - motorcycle_shops_and_dealers - - motorcycle_shops_dealers - - music_stores_musical_instruments_pianos_and_sheet_music - - news_dealers_and_newsstands - - non_fi_money_orders - - non_fi_stored_value_card_purchase_load - - nondurable_goods - - nurseries_lawn_and_garden_supply_stores - - nursing_personal_care - - office_and_commercial_furniture - - opticians_eyeglasses - - optometrists_ophthalmologist - - orthopedic_goods_prosthetic_devices - - osteopaths - - package_stores_beer_wine_and_liquor - - paints_varnishes_and_supplies - - parking_lots_garages - - passenger_railways - - pawn_shops - - pet_shops_pet_food_and_supplies - - petroleum_and_petroleum_products - - photo_developing - - photographic_photocopy_microfilm_equipment_and_supplies - - photographic_studios - - picture_video_production - - piece_goods_notions_and_other_dry_goods - - plumbing_heating_equipment_and_supplies - - political_organizations - - postal_services_government_only - - precious_stones_and_metals_watches_and_jewelry - - professional_services - - public_warehousing_and_storage - - quick_copy_repro_and_blueprint - - railroads - - real_estate_agents_and_managers_rentals - - record_stores - - recreational_vehicle_rentals - - religious_goods_stores - - religious_organizations - - roofing_siding_sheet_metal - - secretarial_support_services - - security_brokers_dealers - - service_stations - - sewing_needlework_fabric_and_piece_goods_stores - - shoe_repair_hat_cleaning - - shoe_stores - - small_appliance_repair - - snowmobile_dealers - - special_trade_services - - specialty_cleaning - - sporting_goods_stores - - sporting_recreation_camps - - sports_and_riding_apparel_stores - - sports_clubs_fields - - stamp_and_coin_stores - - stationary_office_supplies_printing_and_writing_paper - - stationery_stores_office_and_school_supply_stores - - swimming_pools_sales - - t_ui_travel_germany - - tailors_alterations - - tax_payments_government_agencies - - tax_preparation_services - - taxicabs_limousines - - telecommunication_equipment_and_telephone_sales - - telecommunication_services - - telegraph_services - - tent_and_awning_shops - - testing_laboratories - - theatrical_ticket_agencies - - timeshares - - tire_retreading_and_repair - - tolls_bridge_fees - - tourist_attractions_and_exhibits - - towing_services - - trailer_parks_campgrounds - - transportation_services - - travel_agencies_tour_operators - - truck_stop_iteration - - truck_utility_trailer_rentals - - typesetting_plate_making_and_related_services - - typewriter_stores - - u_s_federal_government_agencies_or_departments - - uniforms_commercial_clothing - - used_merchandise_and_secondhand_stores - - utilities - - variety_stores - - veterinary_services - - video_amusement_game_supplies - - video_game_arcades - - video_tape_rental_stores - - vocational_trade_schools - - watch_jewelry_repair - - welding_repair - - wholesale_clubs - - wig_and_toupee_stores - - wires_money_orders - - womens_accessory_and_specialty_shops - - womens_ready_to_wear_stores - - wrecking_and_salvage_yards + - balances + - ownership + - payment_method + - transactions type: string - nullable: true type: array - blocked_categories: - description: >- - Array of strings containing - [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) - of authorizations to decline. All other categories will be allowed. - Cannot be set with `allowed_categories`. + prefetch: + description: Data features requested to be retrieved upon account creation. items: enum: - - ac_refrigeration_repair - - accounting_bookkeeping_services - - advertising_services - - agricultural_cooperative - - airlines_air_carriers - - airports_flying_fields - - ambulance_services - - amusement_parks_carnivals - - antique_reproductions - - antique_shops - - aquariums - - architectural_surveying_services - - art_dealers_and_galleries - - artists_supply_and_craft_shops - - auto_and_home_supply_stores - - auto_body_repair_shops - - auto_paint_shops - - auto_service_shops - - automated_cash_disburse - - automated_fuel_dispensers - - automobile_associations - - automotive_parts_and_accessories_stores - - automotive_tire_stores - - bail_and_bond_payments - - bakeries - - bands_orchestras - - barber_and_beauty_shops - - betting_casino_gambling - - bicycle_shops - - billiard_pool_establishments - - boat_dealers - - boat_rentals_and_leases - - book_stores - - books_periodicals_and_newspapers - - bowling_alleys - - bus_lines - - business_secretarial_schools - - buying_shopping_services - - cable_satellite_and_other_pay_television_and_radio - - camera_and_photographic_supply_stores - - candy_nut_and_confectionery_stores - - car_and_truck_dealers_new_used - - car_and_truck_dealers_used_only - - car_rental_agencies - - car_washes - - carpentry_services - - carpet_upholstery_cleaning - - caterers - - charitable_and_social_service_organizations_fundraising - - chemicals_and_allied_products - - child_care_services - - childrens_and_infants_wear_stores - - chiropodists_podiatrists - - chiropractors - - cigar_stores_and_stands - - civic_social_fraternal_associations - - cleaning_and_maintenance - - clothing_rental - - colleges_universities - - commercial_equipment - - commercial_footwear - - commercial_photography_art_and_graphics - - commuter_transport_and_ferries - - computer_network_services - - computer_programming - - computer_repair - - computer_software_stores - - computers_peripherals_and_software - - concrete_work_services - - construction_materials - - consulting_public_relations - - correspondence_schools - - cosmetic_stores - - counseling_services - - country_clubs - - courier_services - - court_costs - - credit_reporting_agencies - - cruise_lines - - dairy_products_stores - - dance_hall_studios_schools - - dating_escort_services - - dentists_orthodontists - - department_stores - - detective_agencies - - digital_goods_applications - - digital_goods_games - - digital_goods_large_volume - - digital_goods_media - - direct_marketing_catalog_merchant - - direct_marketing_combination_catalog_and_retail_merchant - - direct_marketing_inbound_telemarketing - - direct_marketing_insurance_services - - direct_marketing_other - - direct_marketing_outbound_telemarketing - - direct_marketing_subscription - - direct_marketing_travel - - discount_stores - - doctors - - door_to_door_sales - - drapery_window_covering_and_upholstery_stores - - drinking_places - - drug_stores_and_pharmacies - - drugs_drug_proprietaries_and_druggist_sundries - - dry_cleaners - - durable_goods - - duty_free_stores - - eating_places_restaurants - - educational_services - - electric_razor_stores - - electric_vehicle_charging - - electrical_parts_and_equipment - - electrical_services - - electronics_repair_shops - - electronics_stores - - elementary_secondary_schools - - emergency_services_gcas_visa_use_only - - employment_temp_agencies - - equipment_rental - - exterminating_services - - family_clothing_stores - - fast_food_restaurants - - financial_institutions - - fines_government_administrative_entities - - fireplace_fireplace_screens_and_accessories_stores - - floor_covering_stores - - florists - - florists_supplies_nursery_stock_and_flowers - - freezer_and_locker_meat_provisioners - - fuel_dealers_non_automotive - - funeral_services_crematories - - >- - furniture_home_furnishings_and_equipment_stores_except_appliances - - furniture_repair_refinishing - - furriers_and_fur_shops - - general_services - - gift_card_novelty_and_souvenir_shops - - glass_paint_and_wallpaper_stores - - glassware_crystal_stores - - golf_courses_public - - government_licensed_horse_dog_racing_us_region_only - - >- - government_licensed_online_casions_online_gambling_us_region_only - - government_owned_lotteries_non_us_region - - government_owned_lotteries_us_region_only - - government_services - - grocery_stores_supermarkets - - hardware_equipment_and_supplies - - hardware_stores - - health_and_beauty_spas - - hearing_aids_sales_and_supplies - - heating_plumbing_a_c - - hobby_toy_and_game_shops - - home_supply_warehouse_stores - - hospitals - - hotels_motels_and_resorts - - household_appliance_stores - - industrial_supplies - - information_retrieval_services - - insurance_default - - insurance_underwriting_premiums - - intra_company_purchases - - jewelry_stores_watches_clocks_and_silverware_stores - - landscaping_services - - laundries - - laundry_cleaning_services - - legal_services_attorneys - - luggage_and_leather_goods_stores - - lumber_building_materials_stores - - manual_cash_disburse - - marinas_service_and_supplies - - marketplaces - - masonry_stonework_and_plaster - - massage_parlors - - medical_and_dental_labs - - medical_dental_ophthalmic_and_hospital_equipment_and_supplies - - medical_services - - membership_organizations - - mens_and_boys_clothing_and_accessories_stores - - mens_womens_clothing_stores - - metal_service_centers - - miscellaneous - - miscellaneous_apparel_and_accessory_shops - - miscellaneous_auto_dealers - - miscellaneous_business_services - - miscellaneous_food_stores - - miscellaneous_general_merchandise - - miscellaneous_general_services - - miscellaneous_home_furnishing_specialty_stores - - miscellaneous_publishing_and_printing - - miscellaneous_recreation_services - - miscellaneous_repair_shops - - miscellaneous_specialty_retail - - mobile_home_dealers - - motion_picture_theaters - - motor_freight_carriers_and_trucking - - motor_homes_dealers - - motor_vehicle_supplies_and_new_parts - - motorcycle_shops_and_dealers - - motorcycle_shops_dealers - - music_stores_musical_instruments_pianos_and_sheet_music - - news_dealers_and_newsstands - - non_fi_money_orders - - non_fi_stored_value_card_purchase_load - - nondurable_goods - - nurseries_lawn_and_garden_supply_stores - - nursing_personal_care - - office_and_commercial_furniture - - opticians_eyeglasses - - optometrists_ophthalmologist - - orthopedic_goods_prosthetic_devices - - osteopaths - - package_stores_beer_wine_and_liquor - - paints_varnishes_and_supplies - - parking_lots_garages - - passenger_railways - - pawn_shops - - pet_shops_pet_food_and_supplies - - petroleum_and_petroleum_products - - photo_developing - - photographic_photocopy_microfilm_equipment_and_supplies - - photographic_studios - - picture_video_production - - piece_goods_notions_and_other_dry_goods - - plumbing_heating_equipment_and_supplies - - political_organizations - - postal_services_government_only - - precious_stones_and_metals_watches_and_jewelry - - professional_services - - public_warehousing_and_storage - - quick_copy_repro_and_blueprint - - railroads - - real_estate_agents_and_managers_rentals - - record_stores - - recreational_vehicle_rentals - - religious_goods_stores - - religious_organizations - - roofing_siding_sheet_metal - - secretarial_support_services - - security_brokers_dealers - - service_stations - - sewing_needlework_fabric_and_piece_goods_stores - - shoe_repair_hat_cleaning - - shoe_stores - - small_appliance_repair - - snowmobile_dealers - - special_trade_services - - specialty_cleaning - - sporting_goods_stores - - sporting_recreation_camps - - sports_and_riding_apparel_stores - - sports_clubs_fields - - stamp_and_coin_stores - - stationary_office_supplies_printing_and_writing_paper - - stationery_stores_office_and_school_supply_stores - - swimming_pools_sales - - t_ui_travel_germany - - tailors_alterations - - tax_payments_government_agencies - - tax_preparation_services - - taxicabs_limousines - - telecommunication_equipment_and_telephone_sales - - telecommunication_services - - telegraph_services - - tent_and_awning_shops - - testing_laboratories - - theatrical_ticket_agencies - - timeshares - - tire_retreading_and_repair - - tolls_bridge_fees - - tourist_attractions_and_exhibits - - towing_services - - trailer_parks_campgrounds - - transportation_services - - travel_agencies_tour_operators - - truck_stop_iteration - - truck_utility_trailer_rentals - - typesetting_plate_making_and_related_services - - typewriter_stores - - u_s_federal_government_agencies_or_departments - - uniforms_commercial_clothing - - used_merchandise_and_secondhand_stores - - utilities - - variety_stores - - veterinary_services - - video_amusement_game_supplies - - video_game_arcades - - video_tape_rental_stores - - vocational_trade_schools - - watch_jewelry_repair - - welding_repair - - wholesale_clubs - - wig_and_toupee_stores - - wires_money_orders - - womens_accessory_and_specialty_shops - - womens_ready_to_wear_stores - - wrecking_and_salvage_yards + - balances + - ownership + - transactions type: string + x-stripeBypassValidation: true nullable: true type: array - spending_limits: - 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). - items: - $ref: '#/components/schemas/issuing_card_spending_limit' - nullable: true - type: array - spending_limits_currency: - description: >- - Currency of the amounts within `spending_limits`. Always the same as - the currency of the card. - nullable: true - type: string - title: IssuingCardAuthorizationControls + title: invoice_payment_method_options_us_bank_account_linked_account_options type: object - x-expandableFields: - - spending_limits - issuing_card_google_pay: + x-expandableFields: [] + invoice_rendering_pdf: description: '' properties: - eligible: - description: Google Pay Eligibility - type: boolean - ineligible_reason: - description: Reason the card is ineligible for Google Pay + page_size: + description: >- + Page size of invoice pdf. Options include a4, letter, and auto. If + set to auto, page size will be switched to a4 or letter based on + customer locale. enum: - - missing_agreement - - missing_cardholder_contact - - unsupported_region + - a4 + - auto + - letter nullable: true type: string - required: - - eligible - title: IssuingCardGooglePay + title: InvoiceRenderingPdf type: object x-expandableFields: [] - issuing_card_shipping: + invoice_setting_custom_field: description: '' properties: - address: - $ref: '#/components/schemas/address' - carrier: - description: The delivery company that shipped a card. - enum: - - dhl - - fedex - - royal_mail - - usps - nullable: true - type: string - customs: - anyOf: - - $ref: '#/components/schemas/issuing_card_shipping_customs' - description: Additional information that may be required for clearing customs. - nullable: true - eta: - description: >- - A unix timestamp representing a best estimate of when the card will - be delivered. - format: unix-time - nullable: true - type: integer name: - description: Recipient name. + description: The name of the custom field. maxLength: 5000 type: string - phone_number: - description: >- - The phone number of the receiver of the shipment. Our courier - partners will use this number to contact you in the event of card - delivery issues. For individual shipments to the EU/UK, if this - field is empty, we will provide them with the phone number provided - when the cardholder was initially created. + value: + description: The value of the custom field. maxLength: 5000 - nullable: true type: string - require_signature: + required: + - name + - value + title: InvoiceSettingCustomField + type: object + x-expandableFields: [] + invoice_setting_customer_rendering_options: + description: '' + properties: + amount_tax_display: description: >- - Whether a signature is required for card delivery. This feature is - only supported for US users. Standard shipping service does not - support signature on delivery. The default value for standard - shipping service is false and for express and priority services is - true. + How line-item prices and amounts will be displayed with respect to + tax on invoice PDFs. + maxLength: 5000 nullable: true - type: boolean - service: - description: 'Shipment service, such as `standard` or `express`.' - enum: - - express - - priority - - standard type: string - x-stripeBypassValidation: true - status: - description: The delivery status of the card. - enum: - - canceled - - delivered - - failure - - pending - - returned - - shipped + title: InvoiceSettingCustomerRenderingOptions + type: object + x-expandableFields: [] + invoice_setting_customer_setting: + description: '' + properties: + custom_fields: + description: Default custom fields to be displayed on invoices for this customer. + items: + $ref: '#/components/schemas/invoice_setting_custom_field' nullable: true - type: string - tracking_number: - description: A tracking number for a card shipment. + type: array + default_payment_method: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/payment_method' + description: >- + ID of a payment method that's attached to the customer, to be used + as the customer's default payment method for subscriptions and + invoices. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/payment_method' + footer: + description: Default footer to be displayed on invoices for this customer. maxLength: 5000 nullable: true type: string - tracking_url: + rendering_options: + anyOf: + - $ref: '#/components/schemas/invoice_setting_customer_rendering_options' + description: Default options for invoice PDF rendering for this customer. + nullable: true + title: InvoiceSettingCustomerSetting + type: object + x-expandableFields: + - custom_fields + - default_payment_method + - rendering_options + invoice_setting_quote_setting: + description: '' + properties: + days_until_due: description: >- - A link to the shipping carrier's site where you can view detailed - information about a card shipment. - maxLength: 5000 + Number of days within which a customer must pay invoices generated + by this quote. This value will be `null` for quotes where + `collection_method=charge_automatically`. nullable: true - type: string - type: - description: Packaging options. - enum: - - bulk - - individual - type: string + type: integer + issuer: + $ref: '#/components/schemas/connect_account_reference' required: - - address - - name - - service - - type - title: IssuingCardShipping + - issuer + title: InvoiceSettingQuoteSetting type: object x-expandableFields: - - address - - customs - issuing_card_shipping_customs: + - issuer + invoice_setting_rendering_options: description: '' properties: - eori_number: + amount_tax_display: description: >- - A registration number used for customs in Europe. See - [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and - [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) - for the EU. + How line-item prices and amounts will be displayed with respect to + tax on invoice PDFs. maxLength: 5000 nullable: true type: string - title: IssuingCardShippingCustoms + title: InvoiceSettingRenderingOptions type: object x-expandableFields: [] - issuing_card_spending_limit: + invoice_setting_subscription_schedule_phase_setting: description: '' properties: - amount: + account_tax_ids: description: >- - Maximum amount allowed to spend per interval. This amount is in the - card's currency and in the [smallest currency - unit](https://stripe.com/docs/currencies#zero-decimal). + The account tax IDs associated with this phase of the subscription + schedule. Will be set on invoices generated by this phase of the + subscription schedule. + items: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/tax_id' + - $ref: '#/components/schemas/deleted_tax_id' + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/tax_id' + - $ref: '#/components/schemas/deleted_tax_id' + nullable: true + type: array + days_until_due: + description: >- + Number of days within which a customer must pay invoices generated + by this subscription schedule. This value will be `null` for + subscription schedules where `billing=charge_automatically`. + nullable: true type: integer - categories: + issuer: + anyOf: + - $ref: '#/components/schemas/connect_account_reference' description: >- - Array of strings containing - [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) - this limit applies to. Omitting this field will apply the limit to - all categories. - items: - enum: - - ac_refrigeration_repair - - accounting_bookkeeping_services - - advertising_services - - agricultural_cooperative - - airlines_air_carriers - - airports_flying_fields - - ambulance_services - - amusement_parks_carnivals - - antique_reproductions - - antique_shops - - aquariums - - architectural_surveying_services - - art_dealers_and_galleries - - artists_supply_and_craft_shops - - auto_and_home_supply_stores - - auto_body_repair_shops - - auto_paint_shops - - auto_service_shops - - automated_cash_disburse - - automated_fuel_dispensers - - automobile_associations - - automotive_parts_and_accessories_stores - - automotive_tire_stores - - bail_and_bond_payments - - bakeries - - bands_orchestras - - barber_and_beauty_shops - - betting_casino_gambling - - bicycle_shops - - billiard_pool_establishments - - boat_dealers - - boat_rentals_and_leases - - book_stores - - books_periodicals_and_newspapers - - bowling_alleys - - bus_lines - - business_secretarial_schools - - buying_shopping_services - - cable_satellite_and_other_pay_television_and_radio - - camera_and_photographic_supply_stores - - candy_nut_and_confectionery_stores - - car_and_truck_dealers_new_used - - car_and_truck_dealers_used_only - - car_rental_agencies - - car_washes - - carpentry_services - - carpet_upholstery_cleaning - - caterers - - charitable_and_social_service_organizations_fundraising - - chemicals_and_allied_products - - child_care_services - - childrens_and_infants_wear_stores - - chiropodists_podiatrists - - chiropractors - - cigar_stores_and_stands - - civic_social_fraternal_associations - - cleaning_and_maintenance - - clothing_rental - - colleges_universities - - commercial_equipment - - commercial_footwear - - commercial_photography_art_and_graphics - - commuter_transport_and_ferries - - computer_network_services - - computer_programming - - computer_repair - - computer_software_stores - - computers_peripherals_and_software - - concrete_work_services - - construction_materials - - consulting_public_relations - - correspondence_schools - - cosmetic_stores - - counseling_services - - country_clubs - - courier_services - - court_costs - - credit_reporting_agencies - - cruise_lines - - dairy_products_stores - - dance_hall_studios_schools - - dating_escort_services - - dentists_orthodontists - - department_stores - - detective_agencies - - digital_goods_applications - - digital_goods_games - - digital_goods_large_volume - - digital_goods_media - - direct_marketing_catalog_merchant - - direct_marketing_combination_catalog_and_retail_merchant - - direct_marketing_inbound_telemarketing - - direct_marketing_insurance_services - - direct_marketing_other - - direct_marketing_outbound_telemarketing - - direct_marketing_subscription - - direct_marketing_travel - - discount_stores - - doctors - - door_to_door_sales - - drapery_window_covering_and_upholstery_stores - - drinking_places - - drug_stores_and_pharmacies - - drugs_drug_proprietaries_and_druggist_sundries - - dry_cleaners - - durable_goods - - duty_free_stores - - eating_places_restaurants - - educational_services - - electric_razor_stores - - electric_vehicle_charging - - electrical_parts_and_equipment - - electrical_services - - electronics_repair_shops - - electronics_stores - - elementary_secondary_schools - - emergency_services_gcas_visa_use_only - - employment_temp_agencies - - equipment_rental - - exterminating_services - - family_clothing_stores - - fast_food_restaurants - - financial_institutions - - fines_government_administrative_entities - - fireplace_fireplace_screens_and_accessories_stores - - floor_covering_stores - - florists - - florists_supplies_nursery_stock_and_flowers - - freezer_and_locker_meat_provisioners - - fuel_dealers_non_automotive - - funeral_services_crematories - - >- - furniture_home_furnishings_and_equipment_stores_except_appliances - - furniture_repair_refinishing - - furriers_and_fur_shops - - general_services - - gift_card_novelty_and_souvenir_shops - - glass_paint_and_wallpaper_stores - - glassware_crystal_stores - - golf_courses_public - - government_licensed_horse_dog_racing_us_region_only - - >- - government_licensed_online_casions_online_gambling_us_region_only - - government_owned_lotteries_non_us_region - - government_owned_lotteries_us_region_only - - government_services - - grocery_stores_supermarkets - - hardware_equipment_and_supplies - - hardware_stores - - health_and_beauty_spas - - hearing_aids_sales_and_supplies - - heating_plumbing_a_c - - hobby_toy_and_game_shops - - home_supply_warehouse_stores - - hospitals - - hotels_motels_and_resorts - - household_appliance_stores - - industrial_supplies - - information_retrieval_services - - insurance_default - - insurance_underwriting_premiums - - intra_company_purchases - - jewelry_stores_watches_clocks_and_silverware_stores - - landscaping_services - - laundries - - laundry_cleaning_services - - legal_services_attorneys - - luggage_and_leather_goods_stores - - lumber_building_materials_stores - - manual_cash_disburse - - marinas_service_and_supplies - - marketplaces - - masonry_stonework_and_plaster - - massage_parlors - - medical_and_dental_labs - - medical_dental_ophthalmic_and_hospital_equipment_and_supplies - - medical_services - - membership_organizations - - mens_and_boys_clothing_and_accessories_stores - - mens_womens_clothing_stores - - metal_service_centers - - miscellaneous - - miscellaneous_apparel_and_accessory_shops - - miscellaneous_auto_dealers - - miscellaneous_business_services - - miscellaneous_food_stores - - miscellaneous_general_merchandise - - miscellaneous_general_services - - miscellaneous_home_furnishing_specialty_stores - - miscellaneous_publishing_and_printing - - miscellaneous_recreation_services - - miscellaneous_repair_shops - - miscellaneous_specialty_retail - - mobile_home_dealers - - motion_picture_theaters - - motor_freight_carriers_and_trucking - - motor_homes_dealers - - motor_vehicle_supplies_and_new_parts - - motorcycle_shops_and_dealers - - motorcycle_shops_dealers - - music_stores_musical_instruments_pianos_and_sheet_music - - news_dealers_and_newsstands - - non_fi_money_orders - - non_fi_stored_value_card_purchase_load - - nondurable_goods - - nurseries_lawn_and_garden_supply_stores - - nursing_personal_care - - office_and_commercial_furniture - - opticians_eyeglasses - - optometrists_ophthalmologist - - orthopedic_goods_prosthetic_devices - - osteopaths - - package_stores_beer_wine_and_liquor - - paints_varnishes_and_supplies - - parking_lots_garages - - passenger_railways - - pawn_shops - - pet_shops_pet_food_and_supplies - - petroleum_and_petroleum_products - - photo_developing - - photographic_photocopy_microfilm_equipment_and_supplies - - photographic_studios - - picture_video_production - - piece_goods_notions_and_other_dry_goods - - plumbing_heating_equipment_and_supplies - - political_organizations - - postal_services_government_only - - precious_stones_and_metals_watches_and_jewelry - - professional_services - - public_warehousing_and_storage - - quick_copy_repro_and_blueprint - - railroads - - real_estate_agents_and_managers_rentals - - record_stores - - recreational_vehicle_rentals - - religious_goods_stores - - religious_organizations - - roofing_siding_sheet_metal - - secretarial_support_services - - security_brokers_dealers - - service_stations - - sewing_needlework_fabric_and_piece_goods_stores - - shoe_repair_hat_cleaning - - shoe_stores - - small_appliance_repair - - snowmobile_dealers - - special_trade_services - - specialty_cleaning - - sporting_goods_stores - - sporting_recreation_camps - - sports_and_riding_apparel_stores - - sports_clubs_fields - - stamp_and_coin_stores - - stationary_office_supplies_printing_and_writing_paper - - stationery_stores_office_and_school_supply_stores - - swimming_pools_sales - - t_ui_travel_germany - - tailors_alterations - - tax_payments_government_agencies - - tax_preparation_services - - taxicabs_limousines - - telecommunication_equipment_and_telephone_sales - - telecommunication_services - - telegraph_services - - tent_and_awning_shops - - testing_laboratories - - theatrical_ticket_agencies - - timeshares - - tire_retreading_and_repair - - tolls_bridge_fees - - tourist_attractions_and_exhibits - - towing_services - - trailer_parks_campgrounds - - transportation_services - - travel_agencies_tour_operators - - truck_stop_iteration - - truck_utility_trailer_rentals - - typesetting_plate_making_and_related_services - - typewriter_stores - - u_s_federal_government_agencies_or_departments - - uniforms_commercial_clothing - - used_merchandise_and_secondhand_stores - - utilities - - variety_stores - - veterinary_services - - video_amusement_game_supplies - - video_game_arcades - - video_tape_rental_stores - - vocational_trade_schools - - watch_jewelry_repair - - welding_repair - - wholesale_clubs - - wig_and_toupee_stores - - wires_money_orders - - womens_accessory_and_specialty_shops - - womens_ready_to_wear_stores - - wrecking_and_salvage_yards - type: string + The connected account that issues the invoice. The invoice is + presented with the branding and support information of the specified + account. + nullable: true + title: InvoiceSettingSubscriptionSchedulePhaseSetting + type: object + x-expandableFields: + - account_tax_ids + - issuer + invoice_setting_subscription_schedule_setting: + description: '' + properties: + account_tax_ids: + description: >- + The account tax IDs associated with the subscription schedule. Will + be set on invoices generated by the subscription schedule. + items: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/tax_id' + - $ref: '#/components/schemas/deleted_tax_id' + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/tax_id' + - $ref: '#/components/schemas/deleted_tax_id' nullable: true type: array - interval: - description: Interval (or event) to which the amount applies. + days_until_due: + description: >- + Number of days within which a customer must pay invoices generated + by this subscription schedule. This value will be `null` for + subscription schedules where `billing=charge_automatically`. + nullable: true + type: integer + issuer: + $ref: '#/components/schemas/connect_account_reference' + required: + - issuer + title: InvoiceSettingSubscriptionScheduleSetting + type: object + x-expandableFields: + - account_tax_ids + - issuer + invoice_tax_amount: + description: '' + properties: + amount: + description: 'The amount, in cents (or local equivalent), of the tax.' + type: integer + inclusive: + description: Whether this tax amount is inclusive or exclusive. + type: boolean + tax_rate: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/tax_rate' + description: The tax rate that was applied to get this tax amount. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/tax_rate' + taxability_reason: + description: >- + The reasoning behind this tax, for example, if the product is tax + exempt. The possible values for this field may be extended as new + tax rules are supported. enum: - - all_time - - daily - - monthly - - per_authorization - - weekly - - yearly + - customer_exempt + - not_collecting + - not_subject_to_tax + - not_supported + - portion_product_exempt + - portion_reduced_rated + - portion_standard_rated + - product_exempt + - product_exempt_holiday + - proportionally_rated + - reduced_rated + - reverse_charge + - standard_rated + - taxable_basis_reduced + - zero_rated + nullable: true type: string + x-stripeBypassValidation: true + taxable_amount: + description: >- + The amount on which tax is calculated, in cents (or local + equivalent). + nullable: true + type: integer required: - amount - - interval - title: IssuingCardSpendingLimit + - inclusive + - tax_rate + title: InvoiceTaxAmount type: object - x-expandableFields: [] - issuing_card_wallets: + x-expandableFields: + - tax_rate + invoice_threshold_reason: description: '' properties: - apple_pay: - $ref: '#/components/schemas/issuing_card_apple_pay' - google_pay: - $ref: '#/components/schemas/issuing_card_google_pay' - primary_account_identifier: - description: Unique identifier for a card used with digital wallets - maxLength: 5000 + amount_gte: + description: >- + The total invoice amount threshold boundary if it triggered the + threshold invoice. nullable: true - type: string + type: integer + item_reasons: + description: Indicates which line items triggered a threshold invoice. + items: + $ref: '#/components/schemas/invoice_item_threshold_reason' + type: array required: - - apple_pay - - google_pay - title: IssuingCardWallets + - item_reasons + title: InvoiceThresholdReason type: object x-expandableFields: - - apple_pay - - google_pay - issuing_cardholder_address: + - item_reasons + invoice_transfer_data: description: '' properties: - address: - $ref: '#/components/schemas/address' + amount: + description: >- + The amount in cents (or local equivalent) that will be transferred + to the destination account when the invoice is paid. By default, the + entire amount is transferred to the destination. + nullable: true + type: integer + destination: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/account' + description: >- + The account where funds from the payment will be transferred to upon + payment success. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/account' required: - - address - title: IssuingCardholderAddress + - destination + title: InvoiceTransferData type: object x-expandableFields: - - address - issuing_cardholder_authorization_controls: - description: '' + - destination + invoiceitem: + description: >- + Invoice Items represent the component lines of an + [invoice](https://stripe.com/docs/api/invoices). An invoice item is + added to an + + invoice by creating or updating it with an `invoice` field, at which + point it will be included as + + [an invoice line item](https://stripe.com/docs/api/invoices/line_item) + within + + [invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines). + + + Invoice Items can be created before you are ready to actually send the + invoice. This can be particularly useful when combined + + with a [subscription](https://stripe.com/docs/api/subscriptions). + Sometimes you want to add a charge or credit to a customer, but actually + charge + + or credit the customer’s card only at the end of a regular billing + cycle. This is useful for combining several charges + + (to minimize per-transaction fees), or for having Stripe tabulate your + usage-based billing totals. + + + Related guides: [Integrate with the Invoicing + API](https://stripe.com/docs/invoicing/integration), [Subscription + Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items). properties: - allowed_categories: + amount: description: >- - Array of strings containing - [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) - of authorizations to allow. All other categories will be blocked. - Cannot be set with `blocked_categories`. - items: - enum: - - ac_refrigeration_repair - - accounting_bookkeeping_services - - advertising_services - - agricultural_cooperative - - airlines_air_carriers - - airports_flying_fields - - ambulance_services - - amusement_parks_carnivals - - antique_reproductions - - antique_shops - - aquariums - - architectural_surveying_services - - art_dealers_and_galleries - - artists_supply_and_craft_shops - - auto_and_home_supply_stores - - auto_body_repair_shops - - auto_paint_shops - - auto_service_shops - - automated_cash_disburse - - automated_fuel_dispensers + Amount (in the `currency` specified) of the invoice item. This + should always be equal to `unit_amount * quantity`. + type: integer + 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). + type: string + customer: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/customer' + - $ref: '#/components/schemas/deleted_customer' + description: >- + The ID of the customer who will be billed when this invoice item is + billed. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/customer' + - $ref: '#/components/schemas/deleted_customer' + date: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + description: + description: >- + An arbitrary string attached to the object. Often useful for + displaying to users. + maxLength: 5000 + nullable: true + type: string + discountable: + description: >- + If true, discounts will apply to this invoice item. Always false for + prorations. + type: boolean + discounts: + description: >- + The discounts which apply to the invoice item. Item discounts are + applied before invoice discounts. Use `expand[]=discounts` to expand + each discount. + items: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/discount' + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/discount' + nullable: true + type: array + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + invoice: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/invoice' + description: The ID of the invoice this invoice item belongs to. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/invoice' + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + metadata: + additionalProperties: + maxLength: 500 + type: 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. + nullable: true + type: object + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - invoiceitem + type: string + period: + $ref: '#/components/schemas/invoice_line_item_period' + price: + anyOf: + - $ref: '#/components/schemas/price' + description: The price of the invoice item. + nullable: true + proration: + description: >- + Whether the invoice item was created automatically as a proration + adjustment when the customer switched plans. + type: boolean + quantity: + description: >- + Quantity of units for the invoice item. If the invoice item is a + proration, the quantity of the subscription that the proration was + computed for. + type: integer + subscription: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/subscription' + description: >- + The subscription that this invoice item has been created for, if + any. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/subscription' + subscription_item: + description: >- + The subscription item that this invoice item has been created for, + if any. + maxLength: 5000 + type: string + tax_rates: + description: >- + The tax rates which apply to the invoice item. When set, the + `default_tax_rates` on the invoice do not apply to this invoice + item. + items: + $ref: '#/components/schemas/tax_rate' + nullable: true + type: array + test_clock: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/test_helpers.test_clock' + description: ID of the test clock this invoice item belongs to. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/test_helpers.test_clock' + unit_amount: + description: Unit amount (in the `currency` specified) of the invoice item. + nullable: true + type: integer + unit_amount_decimal: + description: >- + Same as `unit_amount`, but contains a decimal value with at most 12 + decimal places. + format: decimal + nullable: true + type: string + required: + - amount + - currency + - customer + - date + - discountable + - id + - livemode + - object + - period + - proration + - quantity + title: InvoiceItem + type: object + x-expandableFields: + - customer + - discounts + - invoice + - period + - price + - subscription + - tax_rates + - test_clock + x-resourceId: invoiceitem + invoices_payment_method_options: + description: '' + properties: + acss_debit: + anyOf: + - $ref: '#/components/schemas/invoice_payment_method_options_acss_debit' + description: >- + If paying by `acss_debit`, this sub-hash contains details about the + Canadian pre-authorized debit payment method options to pass to the + invoice’s PaymentIntent. + nullable: true + bancontact: + anyOf: + - $ref: '#/components/schemas/invoice_payment_method_options_bancontact' + description: >- + If paying by `bancontact`, this sub-hash contains details about the + Bancontact payment method options to pass to the invoice’s + PaymentIntent. + nullable: true + card: + anyOf: + - $ref: '#/components/schemas/invoice_payment_method_options_card' + description: >- + If paying by `card`, this sub-hash contains details about the Card + payment method options to pass to the invoice’s PaymentIntent. + nullable: true + customer_balance: + anyOf: + - $ref: >- + #/components/schemas/invoice_payment_method_options_customer_balance + description: >- + If paying by `customer_balance`, this sub-hash contains details + about the Bank transfer payment method options to pass to the + invoice’s PaymentIntent. + nullable: true + konbini: + anyOf: + - $ref: '#/components/schemas/invoice_payment_method_options_konbini' + description: >- + If paying by `konbini`, this sub-hash contains details about the + Konbini payment method options to pass to the invoice’s + PaymentIntent. + nullable: true + sepa_debit: + anyOf: + - $ref: '#/components/schemas/invoice_payment_method_options_sepa_debit' + description: >- + If paying by `sepa_debit`, this sub-hash contains details about the + SEPA Direct Debit payment method options to pass to the invoice’s + PaymentIntent. + nullable: true + us_bank_account: + anyOf: + - $ref: >- + #/components/schemas/invoice_payment_method_options_us_bank_account + description: >- + If paying by `us_bank_account`, this sub-hash contains details about + the ACH direct debit payment method options to pass to the invoice’s + PaymentIntent. + nullable: true + title: InvoicesPaymentMethodOptions + type: object + x-expandableFields: + - acss_debit + - bancontact + - card + - customer_balance + - konbini + - sepa_debit + - us_bank_account + invoices_payment_settings: + description: '' + properties: + default_mandate: + description: >- + ID of the mandate to be used for this invoice. It must correspond to + the payment method used to pay the invoice, including the invoice's + default_payment_method or default_source, if set. + maxLength: 5000 + nullable: true + type: string + payment_method_options: + anyOf: + - $ref: '#/components/schemas/invoices_payment_method_options' + description: >- + Payment-method-specific configuration to provide to the invoice’s + PaymentIntent. + nullable: true + payment_method_types: + description: >- + The list of payment method types (e.g. card) to provide to the + invoice’s PaymentIntent. If not set, Stripe attempts to + automatically determine the types to use by looking at the invoice’s + default payment method, the subscription’s default payment method, + the customer’s default payment method, and your [invoice template + settings](https://dashboard.stripe.com/settings/billing/invoice). + items: + enum: + - ach_credit_transfer + - ach_debit + - acss_debit + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - boleto + - card + - cashapp + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - konbini + - link + - p24 + - paynow + - paypal + - promptpay + - revolut_pay + - sepa_debit + - sofort + - us_bank_account + - wechat_pay + type: string + x-stripeBypassValidation: true + nullable: true + type: array + title: InvoicesPaymentSettings + type: object + x-expandableFields: + - payment_method_options + invoices_resource_from_invoice: + description: '' + properties: + action: + description: The relation between this invoice and the cloned invoice + maxLength: 5000 + type: string + invoice: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/invoice' + description: The invoice that was cloned. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/invoice' + required: + - action + - invoice + title: InvoicesResourceFromInvoice + type: object + x-expandableFields: + - invoice + invoices_resource_invoice_rendering: + description: '' + properties: + amount_tax_display: + description: >- + How line-item prices and amounts will be displayed with respect to + tax on invoice PDFs. + maxLength: 5000 + nullable: true + type: string + pdf: + anyOf: + - $ref: '#/components/schemas/invoice_rendering_pdf' + description: Invoice pdf rendering options + nullable: true + title: InvoicesResourceInvoiceRendering + type: object + x-expandableFields: + - pdf + invoices_resource_invoice_tax_id: + description: '' + properties: + type: + 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`, `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`, + `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`, or + `unknown` + enum: + - ad_nrt + - ae_trn + - ar_cuit + - au_abn + - au_arn + - bg_uic + - bh_vat + - bo_tin + - br_cnpj + - br_cpf + - ca_bn + - ca_gst_hst + - ca_pst_bc + - ca_pst_mb + - ca_pst_sk + - ca_qst + - ch_vat + - cl_tin + - cn_tin + - co_nit + - cr_tin + - do_rcn + - ec_ruc + - eg_tin + - es_cif + - eu_oss_vat + - eu_vat + - gb_vat + - ge_vat + - hk_br + - hu_tin + - id_npwp + - il_vat + - in_gst + - is_vat + - jp_cn + - jp_rn + - jp_trn + - ke_pin + - kr_brn + - kz_bin + - li_uid + - 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 + - ua_vat + - unknown + - us_ein + - uy_ruc + - ve_rif + - vn_tin + - za_vat + type: string + value: + description: The value of the tax ID. + maxLength: 5000 + nullable: true + type: string + required: + - type + title: InvoicesResourceInvoiceTaxID + type: object + x-expandableFields: [] + invoices_resource_line_items_credited_items: + description: '' + properties: + invoice: + description: Invoice containing the credited invoice line items + maxLength: 5000 + type: string + invoice_line_items: + description: Credited invoice line items + items: + maxLength: 5000 + type: string + type: array + required: + - invoice + - invoice_line_items + title: InvoicesResourceLineItemsCreditedItems + type: object + x-expandableFields: [] + invoices_resource_line_items_proration_details: + description: '' + properties: + credited_items: + anyOf: + - $ref: '#/components/schemas/invoices_resource_line_items_credited_items' + description: >- + For a credit proration `line_item`, the original debit line_items to + which the credit proration applies. + nullable: true + title: InvoicesResourceLineItemsProrationDetails + type: object + x-expandableFields: + - credited_items + invoices_resource_shipping_cost: + description: '' + properties: + amount_subtotal: + description: Total shipping cost before any taxes are applied. + type: integer + amount_tax: + description: >- + Total tax amount applied due to shipping costs. If no tax was + applied, defaults to 0. + type: integer + amount_total: + description: Total shipping cost after taxes are applied. + type: integer + shipping_rate: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/shipping_rate' + description: The ID of the ShippingRate for this invoice. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/shipping_rate' + taxes: + description: The taxes applied to the shipping rate. + items: + $ref: '#/components/schemas/line_items_tax_amount' + type: array + required: + - amount_subtotal + - amount_tax + - amount_total + title: InvoicesResourceShippingCost + type: object + x-expandableFields: + - shipping_rate + - taxes + invoices_resource_status_transitions: + description: '' + properties: + finalized_at: + description: The time that the invoice draft was finalized. + format: unix-time + nullable: true + type: integer + marked_uncollectible_at: + description: The time that the invoice was marked uncollectible. + format: unix-time + nullable: true + type: integer + paid_at: + description: The time that the invoice was paid. + format: unix-time + nullable: true + type: integer + voided_at: + description: The time that the invoice was voided. + format: unix-time + nullable: true + type: integer + title: InvoicesResourceStatusTransitions + type: object + x-expandableFields: [] + issuing.authorization: + description: >- + When an [issued card](https://stripe.com/docs/issuing) is used to make a + purchase, an Issuing `Authorization` + + object is created. + [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) + must be approved for the + + purchase to be completed successfully. + + + Related guide: [Issued card + authorizations](https://stripe.com/docs/issuing/purchases/authorizations) + properties: + amount: + description: >- + The total amount that was authorized or rejected. This amount is in + `currency` and in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). `amount` + should be the same as `merchant_amount`, unless `currency` and + `merchant_currency` are different. + type: integer + amount_details: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_amount_details' + 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). + nullable: true + approved: + description: Whether the authorization has been approved. + type: boolean + authorization_method: + description: How the card details were provided. + enum: + - chip + - contactless + - keyed_in + - online + - swipe + type: string + balance_transactions: + description: List of balance transactions associated with this authorization. + items: + $ref: '#/components/schemas/balance_transaction' + type: array + card: + $ref: '#/components/schemas/issuing.card' + cardholder: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/issuing.cardholder' + description: The cardholder to whom this authorization belongs. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/issuing.cardholder' + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + 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). + type: string + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + merchant_amount: + 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. + type: integer + merchant_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). + type: string + merchant_data: + $ref: '#/components/schemas/issuing_authorization_merchant_data' + metadata: + additionalProperties: + maxLength: 500 + type: 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. + type: object + network_data: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_network_data' + description: >- + Details about the authorization, such as identifiers, set by the + card network. + nullable: true + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - issuing.authorization + type: string + pending_request: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_pending_request' + description: >- + The pending authorization request. This field will only be non-null + during an `issuing_authorization.request` webhook. + nullable: true + request_history: + description: >- + History of every time a `pending_request` authorization was + approved/declined, either by you directly or by Stripe (e.g. based + on your spending_controls). If the merchant changes the + authorization by performing an incremental authorization, you can + look at this field to see the previous requests for the + authorization. This field can be helpful in determining why a given + authorization was approved/declined. + items: + $ref: '#/components/schemas/issuing_authorization_request' + type: array + status: + description: The current status of the authorization in its lifecycle. + enum: + - closed + - pending + - reversed + type: string + token: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/issuing.token' + description: >- + [Token](https://stripe.com/docs/api/issuing/tokens/object) object + used for this authorization. If a network token was not used for + this authorization, this field will be null. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/issuing.token' + transactions: + description: >- + List of + [transactions](https://stripe.com/docs/api/issuing/transactions) + associated with this authorization. + items: + $ref: '#/components/schemas/issuing.transaction' + type: array + treasury: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_treasury' + description: >- + [Treasury](https://stripe.com/docs/api/treasury) details related to + this authorization if it was created on a + [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts). + nullable: true + verification_data: + $ref: '#/components/schemas/issuing_authorization_verification_data' + wallet: + description: >- + The digital wallet used for this transaction. One of `apple_pay`, + `google_pay`, or `samsung_pay`. Will populate as `null` when no + digital wallet was utilized. + maxLength: 5000 + nullable: true + type: string + required: + - amount + - approved + - authorization_method + - balance_transactions + - card + - created + - currency + - id + - livemode + - merchant_amount + - merchant_currency + - merchant_data + - metadata + - object + - request_history + - status + - transactions + - verification_data + title: IssuingAuthorization + type: object + x-expandableFields: + - amount_details + - balance_transactions + - card + - cardholder + - merchant_data + - network_data + - pending_request + - request_history + - token + - transactions + - treasury + - verification_data + x-resourceId: issuing.authorization + issuing.card: + description: >- + You can [create physical or virtual + cards](https://stripe.com/docs/issuing/cards) that are issued to + cardholders. + properties: + brand: + description: The brand of the card. + maxLength: 5000 + type: string + cancellation_reason: + description: The reason why the card was canceled. + enum: + - design_rejected + - lost + - stolen + nullable: true + type: string + x-stripeBypassValidation: true + cardholder: + $ref: '#/components/schemas/issuing.cardholder' + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + 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. + type: string + cvc: + 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. + maxLength: 5000 + type: string + exp_month: + description: The expiration month of the card. + type: integer + exp_year: + description: The expiration year of the card. + type: integer + financial_account: + description: The financial account this card is attached to. + maxLength: 5000 + nullable: true + type: string + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + last4: + description: The last 4 digits of the card number. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + metadata: + additionalProperties: + maxLength: 500 + type: 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. + type: object + number: + description: >- + The full unredacted card number. 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. + maxLength: 5000 + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - issuing.card + type: string + personalization_design: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/issuing.personalization_design' + description: The personalization design object belonging to this card. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/issuing.personalization_design' + replaced_by: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/issuing.card' + description: 'The latest card that replaces this card, if any.' + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/issuing.card' + replacement_for: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/issuing.card' + description: 'The card this card replaces, if any.' + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/issuing.card' + replacement_reason: + description: The reason why the previous card needed to be replaced. + enum: + - damaged + - expired + - lost + - stolen + nullable: true + type: string + x-stripeBypassValidation: true + shipping: + anyOf: + - $ref: '#/components/schemas/issuing_card_shipping' + description: Where and how the card will be shipped. + nullable: true + spending_controls: + $ref: '#/components/schemas/issuing_card_authorization_controls' + status: + description: >- + Whether authorizations can be approved on this card. May be blocked + from activating cards depending on past-due Cardholder requirements. + Defaults to `inactive`. + enum: + - active + - canceled + - inactive + type: string + x-stripeBypassValidation: true + type: + description: The type of the card. + enum: + - physical + - virtual + type: string + wallets: + anyOf: + - $ref: '#/components/schemas/issuing_card_wallets' + description: >- + Information relating to digital wallets (like Apple Pay and Google + Pay). + nullable: true + required: + - brand + - cardholder + - created + - currency + - exp_month + - exp_year + - id + - last4 + - livemode + - metadata + - object + - spending_controls + - status + - type + title: IssuingCard + type: object + x-expandableFields: + - cardholder + - personalization_design + - replaced_by + - replacement_for + - shipping + - spending_controls + - wallets + x-resourceId: issuing.card + issuing.cardholder: + description: >- + An Issuing `Cardholder` object represents an individual or business + entity who is [issued](https://stripe.com/docs/issuing) cards. + + + Related guide: [How to create a + cardholder](https://stripe.com/docs/issuing/cards#create-cardholder) + properties: + billing: + $ref: '#/components/schemas/issuing_cardholder_address' + company: + anyOf: + - $ref: '#/components/schemas/issuing_cardholder_company' + description: Additional information about a `company` cardholder. + nullable: true + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + email: + description: The cardholder's email address. + maxLength: 5000 + nullable: true + type: string + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + individual: + anyOf: + - $ref: '#/components/schemas/issuing_cardholder_individual' + description: Additional information about an `individual` cardholder. + nullable: true + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + metadata: + additionalProperties: + maxLength: 500 + type: 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. + type: object + name: + description: The cardholder's name. This will be printed on cards issued to them. + maxLength: 5000 + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - issuing.cardholder + type: string + phone_number: + description: >- + The cardholder's phone number. This is required for all cardholders + who will be creating EU cards. See the [3D Secure + documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) + for more details. + maxLength: 5000 + nullable: true + type: string + preferred_locales: + description: >- + The cardholder’s preferred locales (languages), ordered by + preference. Locales can be `de`, `en`, `es`, `fr`, or `it`. + This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder. + items: + enum: + - de + - en + - es + - fr + - it + type: string + nullable: true + type: array + requirements: + $ref: '#/components/schemas/issuing_cardholder_requirements' + spending_controls: + anyOf: + - $ref: '#/components/schemas/issuing_cardholder_authorization_controls' + description: >- + Rules that control spending across this cardholder's cards. Refer to + our + [documentation](https://stripe.com/docs/issuing/controls/spending-controls) + for more details. + nullable: true + status: + description: >- + Specifies whether to permit authorizations on this cardholder's + cards. + enum: + - active + - blocked + - inactive + type: string + type: + description: >- + One of `individual` or `company`. See [Choose a cardholder + type](https://stripe.com/docs/issuing/other/choose-cardholder) for + more details. + enum: + - company + - individual + type: string + x-stripeBypassValidation: true + required: + - billing + - created + - id + - livemode + - metadata + - name + - object + - requirements + - status + - type + title: IssuingCardholder + type: object + x-expandableFields: + - billing + - company + - individual + - requirements + - spending_controls + x-resourceId: issuing.cardholder + issuing.dispute: + description: >- + As a [card issuer](https://stripe.com/docs/issuing), you can dispute + transactions that the cardholder does not recognize, suspects to be + fraudulent, or has other issues with. + + + Related guide: [Issuing + disputes](https://stripe.com/docs/issuing/purchases/disputes) + properties: + amount: + description: >- + Disputed amount in the card's currency and in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). Usually the + amount of the `transaction`, but can differ (usually because of + currency fluctuation). + type: integer + balance_transactions: + description: List of balance transactions associated with the dispute. + items: + $ref: '#/components/schemas/balance_transaction' + nullable: true + type: array + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + currency: + description: The currency the `transaction` was made in. + type: string + evidence: + $ref: '#/components/schemas/issuing_dispute_evidence' + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + metadata: + additionalProperties: + maxLength: 500 + type: 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. + type: object + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - issuing.dispute + type: string + status: + description: Current status of the dispute. + enum: + - expired + - lost + - submitted + - unsubmitted + - won + type: string + transaction: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/issuing.transaction' + description: The transaction being disputed. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/issuing.transaction' + treasury: + anyOf: + - $ref: '#/components/schemas/issuing_dispute_treasury' + description: >- + [Treasury](https://stripe.com/docs/api/treasury) details related to + this dispute if it was created on a + [FinancialAccount](/docs/api/treasury/financial_accounts + nullable: true + required: + - amount + - created + - currency + - evidence + - id + - livemode + - metadata + - object + - status + - transaction + title: IssuingDispute + type: object + x-expandableFields: + - balance_transactions + - evidence + - transaction + - treasury + x-resourceId: issuing.dispute + issuing.personalization_design: + description: >- + A Personalization Design is a logical grouping of a Physical Bundle, + card logo, and carrier text that represents a product line. + properties: + card_logo: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/file' + description: >- + The file for the card logo to use with physical bundles that support + card logos. Must have a `purpose` value of `issuing_logo`. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/file' + carrier_text: + anyOf: + - $ref: '#/components/schemas/issuing_personalization_design_carrier_text' + description: >- + Hash containing carrier text, for use with physical bundles that + support carrier text. + nullable: true + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + lookup_key: + description: >- + A lookup key used to retrieve personalization designs dynamically + from a static string. This may be up to 200 characters. + maxLength: 5000 + nullable: true + type: string + metadata: + additionalProperties: + maxLength: 500 + type: 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. + type: object + name: + description: Friendly display name. + maxLength: 5000 + nullable: true + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - issuing.personalization_design + type: string + physical_bundle: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/issuing.physical_bundle' + description: The physical bundle object belonging to this personalization design. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/issuing.physical_bundle' + preferences: + $ref: '#/components/schemas/issuing_personalization_design_preferences' + rejection_reasons: + $ref: >- + #/components/schemas/issuing_personalization_design_rejection_reasons + status: + description: Whether this personalization design can be used to create cards. + enum: + - active + - inactive + - rejected + - review + type: string + required: + - created + - id + - livemode + - metadata + - object + - physical_bundle + - preferences + - rejection_reasons + - status + title: IssuingPersonalizationDesign + type: object + x-expandableFields: + - card_logo + - carrier_text + - physical_bundle + - preferences + - rejection_reasons + x-resourceId: issuing.personalization_design + issuing.physical_bundle: + description: >- + A Physical Bundle represents the bundle of physical items - card stock, + carrier letter, and envelope - that is shipped to a cardholder when you + create a physical card. + properties: + features: + $ref: '#/components/schemas/issuing_physical_bundle_features' + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + name: + description: Friendly display name. + maxLength: 5000 + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - issuing.physical_bundle + type: string + status: + description: Whether this physical bundle can be used to create cards. + enum: + - active + - inactive + - review + type: string + type: + description: >- + Whether this physical bundle is a standard Stripe offering or + custom-made for you. + enum: + - custom + - standard + type: string + required: + - id + - livemode + - name + - object + - status + - type + title: IssuingPhysicalBundle + type: object + x-expandableFields: + - features + x-resourceId: issuing.physical_bundle + issuing.settlement: + description: >- + When a non-stripe BIN is used, any use of an [issued + card](https://stripe.com/docs/issuing) must be settled directly with the + card network. The net amount owed is represented by an Issuing + `Settlement` object. + properties: + bin: + description: The Bank Identification Number reflecting this settlement record. + maxLength: 5000 + type: string + clearing_date: + description: >- + The date that the transactions are cleared and posted to user's + accounts. + type: integer + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + 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). + type: string + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + interchange_fees: + description: >- + The total interchange received as reimbursement for the + transactions. + type: integer + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + metadata: + additionalProperties: + maxLength: 500 + type: 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. + type: object + net_total: + description: The total net amount required to settle with the network. + type: integer + network: + description: 'The card network for this settlement report. One of ["visa"]' + enum: + - visa + type: string + network_fees: + description: The total amount of fees owed to the network. + type: integer + network_settlement_identifier: + description: The Settlement Identification Number assigned by the network. + maxLength: 5000 + type: string + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - issuing.settlement + type: string + settlement_service: + description: One of `international` or `uk_national_net`. + maxLength: 5000 + type: string + transaction_count: + description: The total number of transactions reflected in this settlement. + type: integer + transaction_volume: + description: The total transaction amount reflected in this settlement. + type: integer + required: + - bin + - clearing_date + - created + - currency + - id + - interchange_fees + - livemode + - metadata + - net_total + - network + - network_fees + - network_settlement_identifier + - object + - settlement_service + - transaction_count + - transaction_volume + title: IssuingSettlement + type: object + x-expandableFields: [] + x-resourceId: issuing.settlement + issuing.token: + description: >- + An issuing token object is created when an issued card is added to a + digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you + can [view and manage these + tokens](https://stripe.com/docs/issuing/controls/token-management) + through Stripe. + properties: + card: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/issuing.card' + description: Card associated with this token. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/issuing.card' + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + device_fingerprint: + description: >- + The hashed ID derived from the device ID from the card network + associated with the token. + maxLength: 5000 + nullable: true + type: string + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + last4: + description: The last four digits of the token. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + network: + description: The token service provider / card network associated with the token. + enum: + - mastercard + - visa + type: string + network_data: + $ref: '#/components/schemas/issuing_network_token_network_data' + network_updated_at: + description: >- + Time at which the token was last updated by the card network. + Measured in seconds since the Unix epoch. + format: unix-time + type: integer + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - issuing.token + type: string + status: + description: The usage state of the token. + enum: + - active + - deleted + - requested + - suspended + type: string + wallet_provider: + description: 'The digital wallet for this token, if one was used.' + enum: + - apple_pay + - google_pay + - samsung_pay + type: string + required: + - card + - created + - id + - livemode + - network + - network_updated_at + - object + - status + title: IssuingNetworkToken + type: object + x-expandableFields: + - card + - network_data + x-resourceId: issuing.token + issuing.transaction: + description: >- + Any use of an [issued card](https://stripe.com/docs/issuing) that + results in funds entering or leaving + + your Stripe account, such as a completed purchase or refund, is + represented by an Issuing + + `Transaction` object. + + + Related guide: [Issued card + transactions](https://stripe.com/docs/issuing/purchases/transactions) + properties: + amount: + description: >- + The transaction amount, which will be reflected in your balance. + This amount is in your currency and in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). + type: integer + amount_details: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_amount_details' + 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). + nullable: true + authorization: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/issuing.authorization' + description: The `Authorization` object that led to this transaction. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/issuing.authorization' + balance_transaction: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/balance_transaction' + description: >- + ID of the [balance + transaction](https://stripe.com/docs/api/balance_transactions) + associated with this transaction. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/balance_transaction' + card: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/issuing.card' + description: The card used to make this transaction. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/issuing.card' + cardholder: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/issuing.cardholder' + description: The cardholder to whom this transaction belongs. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/issuing.cardholder' + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + 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). + type: string + dispute: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/issuing.dispute' + description: 'If you''ve disputed the transaction, the ID of the dispute.' + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/issuing.dispute' + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + merchant_amount: + 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. + type: integer + merchant_currency: + description: The currency with which the merchant is taking payment. + type: string + merchant_data: + $ref: '#/components/schemas/issuing_authorization_merchant_data' + metadata: + additionalProperties: + maxLength: 500 + type: 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. + type: object + network_data: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_network_data' + description: >- + Details about the transaction, such as processing dates, set by the + card network. + nullable: true + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - issuing.transaction + type: string + purchase_details: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_purchase_details' + description: >- + Additional purchase information that is optionally provided by the + merchant. + nullable: true + token: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/issuing.token' + description: >- + [Token](https://stripe.com/docs/api/issuing/tokens/object) object + used for this transaction. If a network token was not used for this + transaction, this field will be null. + nullable: true + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/issuing.token' + treasury: + anyOf: + - $ref: '#/components/schemas/issuing_transaction_treasury' + description: >- + [Treasury](https://stripe.com/docs/api/treasury) details related to + this transaction if it was created on a + [FinancialAccount](/docs/api/treasury/financial_accounts + nullable: true + type: + description: The nature of the transaction. + enum: + - capture + - refund + type: string + x-stripeBypassValidation: true + wallet: + description: >- + The digital wallet used for this transaction. One of `apple_pay`, + `google_pay`, or `samsung_pay`. + enum: + - apple_pay + - google_pay + - samsung_pay + nullable: true + type: string + required: + - amount + - card + - created + - currency + - id + - livemode + - merchant_amount + - merchant_currency + - merchant_data + - metadata + - object + - type + title: IssuingTransaction + type: object + x-expandableFields: + - amount_details + - authorization + - balance_transaction + - card + - cardholder + - dispute + - merchant_data + - network_data + - purchase_details + - token + - treasury + x-resourceId: issuing.transaction + issuing_authorization_amount_details: + description: '' + properties: + atm_fee: + description: The fee charged by the ATM for the cash withdrawal. + nullable: true + type: integer + cashback_amount: + description: The amount of cash requested by the cardholder. + nullable: true + type: integer + title: IssuingAuthorizationAmountDetails + type: object + x-expandableFields: [] + issuing_authorization_authentication_exemption: + description: '' + properties: + claimed_by: + description: >- + The entity that requested the exemption, either the acquiring + merchant or the Issuing user. + enum: + - acquirer + - issuer + type: string + type: + description: The specific exemption claimed for this authorization. + enum: + - low_value_transaction + - transaction_risk_analysis + - unknown + type: string + x-stripeBypassValidation: true + required: + - claimed_by + - type + title: IssuingAuthorizationAuthenticationExemption + type: object + x-expandableFields: [] + issuing_authorization_merchant_data: + description: '' + properties: + category: + description: >- + A categorization of the seller's type of business. See our [merchant + categories + guide](https://stripe.com/docs/issuing/merchant-categories) for a + list of possible values. + maxLength: 5000 + type: string + category_code: + description: The merchant category code for the seller’s business + maxLength: 5000 + type: string + city: + description: City where the seller is located + maxLength: 5000 + nullable: true + type: string + country: + description: Country where the seller is located + maxLength: 5000 + nullable: true + type: string + name: + description: Name of the seller + maxLength: 5000 + nullable: true + type: string + network_id: + description: >- + Identifier assigned to the seller by the card network. Different + card networks may assign different network_id fields to the same + merchant. + maxLength: 5000 + type: string + postal_code: + description: Postal code where the seller is located + maxLength: 5000 + nullable: true + type: string + state: + description: State where the seller is located + maxLength: 5000 + nullable: true + type: string + terminal_id: + description: An ID assigned by the seller to the location of the sale. + maxLength: 5000 + nullable: true + type: string + url: + description: URL provided by the merchant on a 3DS request + maxLength: 5000 + nullable: true + type: string + required: + - category + - category_code + - network_id + title: IssuingAuthorizationMerchantData + type: object + x-expandableFields: [] + issuing_authorization_network_data: + description: '' + properties: + acquiring_institution_id: + description: >- + Identifier assigned to the acquirer by the card network. Sometimes + this value is not provided by the network; in this case, the value + will be `null`. + maxLength: 5000 + nullable: true + type: string + system_trace_audit_number: + description: >- + The System Trace Audit Number (STAN) is a 6-digit identifier + assigned by the acquirer. Prefer `network_data.transaction_id` if + present, unless you have special requirements. + maxLength: 5000 + nullable: true + type: string + transaction_id: + description: >- + Unique identifier for the authorization assigned by the card network + used to match subsequent messages, disputes, and transactions. + maxLength: 5000 + nullable: true + type: string + title: IssuingAuthorizationNetworkData + type: object + x-expandableFields: [] + issuing_authorization_pending_request: + description: '' + properties: + amount: + description: >- + The additional amount Stripe will hold if the authorization is + approved, in the card's + [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) + and in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). + type: integer + amount_details: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_amount_details' + 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). + nullable: true + 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). + type: string + is_amount_controllable: + 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. + type: boolean + merchant_amount: + 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). + type: integer + merchant_currency: + description: The local currency the merchant is requesting to authorize. + type: string + network_risk_score: + description: >- + The card network's estimate of the likelihood that an authorization + is fraudulent. Takes on values between 1 and 99. + nullable: true + type: integer + required: + - amount + - currency + - is_amount_controllable + - merchant_amount + - merchant_currency + title: IssuingAuthorizationPendingRequest + type: object + x-expandableFields: + - amount_details + issuing_authorization_request: + description: '' + properties: + amount: + description: >- + The `pending_request.amount` at the time of the request, presented + in your card's currency and in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held + this amount from your account to fund the authorization if the + request was approved. + type: integer + amount_details: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_amount_details' + 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). + nullable: true + approved: + description: Whether this request was approved. + type: boolean + authorization_code: + description: >- + A code created by Stripe which is shared with the merchant to + validate the authorization. This field will be populated if the + authorization message was approved. The code typically starts with + the letter "S", followed by a six-digit number. For example, + "S498162". Please note that the code is not guaranteed to be unique + across authorizations. + maxLength: 5000 + nullable: true + type: string + created: + description: >- + Time at which the object was created. Measured in seconds since the + Unix epoch. + format: unix-time + type: integer + 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). + maxLength: 5000 + type: string + merchant_amount: + description: >- + The `pending_request.merchant_amount` at the time of the request, + presented in the `merchant_currency` and in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). + type: integer + merchant_currency: + description: >- + The currency that was collected by the merchant and presented to the + cardholder for the 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). + maxLength: 5000 + type: string + network_risk_score: + description: >- + The card network's estimate of the likelihood that an authorization + is fraudulent. Takes on values between 1 and 99. + nullable: true + type: integer + reason: + description: >- + When an authorization is approved or declined by you or by Stripe, + this field provides additional detail on the reason for the outcome. + enum: + - account_disabled + - card_active + - card_inactive + - cardholder_inactive + - cardholder_verification_required + - insufficient_funds + - not_allowed + - spending_controls + - suspected_fraud + - verification_failed + - webhook_approved + - webhook_declined + - webhook_error + - webhook_timeout + type: string + x-stripeBypassValidation: true + reason_message: + description: >- + If the `request_history.reason` is `webhook_error` because the + direct webhook response is invalid (for example, parsing errors or + missing parameters), we surface a more detailed error message via + this field. + maxLength: 5000 + nullable: true + type: string + requested_at: + description: >- + Time when the card network received an authorization request from + the acquirer in UTC. Referred to by networks as transmission time. + format: unix-time + nullable: true + type: integer + required: + - amount + - approved + - created + - currency + - merchant_amount + - merchant_currency + - reason + title: IssuingAuthorizationRequest + type: object + x-expandableFields: + - amount_details + issuing_authorization_three_d_secure: + description: '' + properties: + result: + description: The outcome of the 3D Secure authentication request. + enum: + - attempt_acknowledged + - authenticated + - failed + - required + type: string + x-stripeBypassValidation: true + required: + - result + title: IssuingAuthorizationThreeDSecure + type: object + x-expandableFields: [] + issuing_authorization_treasury: + description: '' + properties: + received_credits: + description: >- + The array of + [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) + associated with this authorization + items: + maxLength: 5000 + type: string + type: array + received_debits: + description: >- + The array of + [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) + associated with this authorization + items: + maxLength: 5000 + type: string + type: array + transaction: + description: >- + The Treasury + [Transaction](https://stripe.com/docs/api/treasury/transactions) + associated with this authorization + maxLength: 5000 + nullable: true + type: string + required: + - received_credits + - received_debits + title: IssuingAuthorizationTreasury + type: object + x-expandableFields: [] + issuing_authorization_verification_data: + description: '' + properties: + address_line1_check: + description: >- + Whether the cardholder provided an address first line and if it + matched the cardholder’s `billing.address.line1`. + enum: + - match + - mismatch + - not_provided + type: string + address_postal_code_check: + description: >- + Whether the cardholder provided a postal code and if it matched the + cardholder’s `billing.address.postal_code`. + enum: + - match + - mismatch + - not_provided + type: string + authentication_exemption: + anyOf: + - $ref: >- + #/components/schemas/issuing_authorization_authentication_exemption + description: The exemption applied to this authorization. + nullable: true + cvc_check: + description: >- + Whether the cardholder provided a CVC and if it matched Stripe’s + record. + enum: + - match + - mismatch + - not_provided + type: string + expiry_check: + description: >- + Whether the cardholder provided an expiry date and if it matched + Stripe’s record. + enum: + - match + - mismatch + - not_provided + type: string + postal_code: + description: >- + The postal code submitted as part of the authorization used for + postal code verification. + maxLength: 5000 + nullable: true + type: string + three_d_secure: + anyOf: + - $ref: '#/components/schemas/issuing_authorization_three_d_secure' + description: 3D Secure details. + nullable: true + required: + - address_line1_check + - address_postal_code_check + - cvc_check + - expiry_check + title: IssuingAuthorizationVerificationData + type: object + x-expandableFields: + - authentication_exemption + - three_d_secure + issuing_card_apple_pay: + description: '' + properties: + eligible: + description: Apple Pay Eligibility + type: boolean + ineligible_reason: + description: Reason the card is ineligible for Apple Pay + enum: + - missing_agreement + - missing_cardholder_contact + - unsupported_region + nullable: true + type: string + required: + - eligible + title: IssuingCardApplePay + type: object + x-expandableFields: [] + issuing_card_authorization_controls: + description: '' + properties: + allowed_categories: + description: >- + Array of strings containing + [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + of authorizations to allow. All other categories will be blocked. + Cannot be set with `blocked_categories`. + items: + enum: + - ac_refrigeration_repair + - accounting_bookkeeping_services + - advertising_services + - agricultural_cooperative + - airlines_air_carriers + - airports_flying_fields + - ambulance_services + - amusement_parks_carnivals + - antique_reproductions + - antique_shops + - aquariums + - architectural_surveying_services + - art_dealers_and_galleries + - artists_supply_and_craft_shops + - auto_and_home_supply_stores + - auto_body_repair_shops + - auto_paint_shops + - auto_service_shops + - automated_cash_disburse + - automated_fuel_dispensers + - automobile_associations + - automotive_parts_and_accessories_stores + - automotive_tire_stores + - bail_and_bond_payments + - bakeries + - bands_orchestras + - barber_and_beauty_shops + - betting_casino_gambling + - bicycle_shops + - billiard_pool_establishments + - boat_dealers + - boat_rentals_and_leases + - book_stores + - books_periodicals_and_newspapers + - bowling_alleys + - bus_lines + - business_secretarial_schools + - buying_shopping_services + - cable_satellite_and_other_pay_television_and_radio + - camera_and_photographic_supply_stores + - candy_nut_and_confectionery_stores + - car_and_truck_dealers_new_used + - car_and_truck_dealers_used_only + - car_rental_agencies + - car_washes + - carpentry_services + - carpet_upholstery_cleaning + - caterers + - charitable_and_social_service_organizations_fundraising + - chemicals_and_allied_products + - child_care_services + - childrens_and_infants_wear_stores + - chiropodists_podiatrists + - chiropractors + - cigar_stores_and_stands + - civic_social_fraternal_associations + - cleaning_and_maintenance + - clothing_rental + - colleges_universities + - commercial_equipment + - commercial_footwear + - commercial_photography_art_and_graphics + - commuter_transport_and_ferries + - computer_network_services + - computer_programming + - computer_repair + - computer_software_stores + - computers_peripherals_and_software + - concrete_work_services + - construction_materials + - consulting_public_relations + - correspondence_schools + - cosmetic_stores + - counseling_services + - country_clubs + - courier_services + - court_costs + - credit_reporting_agencies + - cruise_lines + - dairy_products_stores + - dance_hall_studios_schools + - dating_escort_services + - dentists_orthodontists + - department_stores + - detective_agencies + - digital_goods_applications + - digital_goods_games + - digital_goods_large_volume + - digital_goods_media + - direct_marketing_catalog_merchant + - direct_marketing_combination_catalog_and_retail_merchant + - direct_marketing_inbound_telemarketing + - direct_marketing_insurance_services + - direct_marketing_other + - direct_marketing_outbound_telemarketing + - direct_marketing_subscription + - direct_marketing_travel + - discount_stores + - doctors + - door_to_door_sales + - drapery_window_covering_and_upholstery_stores + - drinking_places + - drug_stores_and_pharmacies + - drugs_drug_proprietaries_and_druggist_sundries + - dry_cleaners + - durable_goods + - duty_free_stores + - eating_places_restaurants + - educational_services + - electric_razor_stores + - electric_vehicle_charging + - electrical_parts_and_equipment + - electrical_services + - electronics_repair_shops + - electronics_stores + - elementary_secondary_schools + - emergency_services_gcas_visa_use_only + - employment_temp_agencies + - equipment_rental + - exterminating_services + - family_clothing_stores + - fast_food_restaurants + - financial_institutions + - fines_government_administrative_entities + - fireplace_fireplace_screens_and_accessories_stores + - floor_covering_stores + - florists + - florists_supplies_nursery_stock_and_flowers + - freezer_and_locker_meat_provisioners + - fuel_dealers_non_automotive + - funeral_services_crematories + - >- + furniture_home_furnishings_and_equipment_stores_except_appliances + - furniture_repair_refinishing + - furriers_and_fur_shops + - general_services + - gift_card_novelty_and_souvenir_shops + - glass_paint_and_wallpaper_stores + - glassware_crystal_stores + - golf_courses_public + - government_licensed_horse_dog_racing_us_region_only + - >- + government_licensed_online_casions_online_gambling_us_region_only + - government_owned_lotteries_non_us_region + - government_owned_lotteries_us_region_only + - government_services + - grocery_stores_supermarkets + - hardware_equipment_and_supplies + - hardware_stores + - health_and_beauty_spas + - hearing_aids_sales_and_supplies + - heating_plumbing_a_c + - hobby_toy_and_game_shops + - home_supply_warehouse_stores + - hospitals + - hotels_motels_and_resorts + - household_appliance_stores + - industrial_supplies + - information_retrieval_services + - insurance_default + - insurance_underwriting_premiums + - intra_company_purchases + - jewelry_stores_watches_clocks_and_silverware_stores + - landscaping_services + - laundries + - laundry_cleaning_services + - legal_services_attorneys + - luggage_and_leather_goods_stores + - lumber_building_materials_stores + - manual_cash_disburse + - marinas_service_and_supplies + - marketplaces + - masonry_stonework_and_plaster + - massage_parlors + - medical_and_dental_labs + - medical_dental_ophthalmic_and_hospital_equipment_and_supplies + - medical_services + - membership_organizations + - mens_and_boys_clothing_and_accessories_stores + - mens_womens_clothing_stores + - metal_service_centers + - miscellaneous + - miscellaneous_apparel_and_accessory_shops + - miscellaneous_auto_dealers + - miscellaneous_business_services + - miscellaneous_food_stores + - miscellaneous_general_merchandise + - miscellaneous_general_services + - miscellaneous_home_furnishing_specialty_stores + - miscellaneous_publishing_and_printing + - miscellaneous_recreation_services + - miscellaneous_repair_shops + - miscellaneous_specialty_retail + - mobile_home_dealers + - motion_picture_theaters + - motor_freight_carriers_and_trucking + - motor_homes_dealers + - motor_vehicle_supplies_and_new_parts + - motorcycle_shops_and_dealers + - motorcycle_shops_dealers + - music_stores_musical_instruments_pianos_and_sheet_music + - news_dealers_and_newsstands + - non_fi_money_orders + - non_fi_stored_value_card_purchase_load + - nondurable_goods + - nurseries_lawn_and_garden_supply_stores + - nursing_personal_care + - office_and_commercial_furniture + - opticians_eyeglasses + - optometrists_ophthalmologist + - orthopedic_goods_prosthetic_devices + - osteopaths + - package_stores_beer_wine_and_liquor + - paints_varnishes_and_supplies + - parking_lots_garages + - passenger_railways + - pawn_shops + - pet_shops_pet_food_and_supplies + - petroleum_and_petroleum_products + - photo_developing + - photographic_photocopy_microfilm_equipment_and_supplies + - photographic_studios + - picture_video_production + - piece_goods_notions_and_other_dry_goods + - plumbing_heating_equipment_and_supplies + - political_organizations + - postal_services_government_only + - precious_stones_and_metals_watches_and_jewelry + - professional_services + - public_warehousing_and_storage + - quick_copy_repro_and_blueprint + - railroads + - real_estate_agents_and_managers_rentals + - record_stores + - recreational_vehicle_rentals + - religious_goods_stores + - religious_organizations + - roofing_siding_sheet_metal + - secretarial_support_services + - security_brokers_dealers + - service_stations + - sewing_needlework_fabric_and_piece_goods_stores + - shoe_repair_hat_cleaning + - shoe_stores + - small_appliance_repair + - snowmobile_dealers + - special_trade_services + - specialty_cleaning + - sporting_goods_stores + - sporting_recreation_camps + - sports_and_riding_apparel_stores + - sports_clubs_fields + - stamp_and_coin_stores + - stationary_office_supplies_printing_and_writing_paper + - stationery_stores_office_and_school_supply_stores + - swimming_pools_sales + - t_ui_travel_germany + - tailors_alterations + - tax_payments_government_agencies + - tax_preparation_services + - taxicabs_limousines + - telecommunication_equipment_and_telephone_sales + - telecommunication_services + - telegraph_services + - tent_and_awning_shops + - testing_laboratories + - theatrical_ticket_agencies + - timeshares + - tire_retreading_and_repair + - tolls_bridge_fees + - tourist_attractions_and_exhibits + - towing_services + - trailer_parks_campgrounds + - transportation_services + - travel_agencies_tour_operators + - truck_stop_iteration + - truck_utility_trailer_rentals + - typesetting_plate_making_and_related_services + - typewriter_stores + - u_s_federal_government_agencies_or_departments + - uniforms_commercial_clothing + - used_merchandise_and_secondhand_stores + - utilities + - variety_stores + - veterinary_services + - video_amusement_game_supplies + - video_game_arcades + - video_tape_rental_stores + - vocational_trade_schools + - watch_jewelry_repair + - welding_repair + - wholesale_clubs + - wig_and_toupee_stores + - wires_money_orders + - womens_accessory_and_specialty_shops + - womens_ready_to_wear_stores + - wrecking_and_salvage_yards + type: string + nullable: true + type: array + allowed_merchant_countries: + description: >- + Array of strings containing representing countries from which + authorizations will be allowed. Authorizations from merchants in all + other countries will be declined. Country codes should be ISO 3166 + alpha-2 country codes (e.g. `US`). Cannot be set with + `blocked_merchant_countries`. Provide an empty value to unset this + control. + items: + maxLength: 5000 + type: string + nullable: true + type: array + blocked_categories: + description: >- + Array of strings containing + [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + of authorizations to decline. All other categories will be allowed. + Cannot be set with `allowed_categories`. + items: + enum: + - ac_refrigeration_repair + - accounting_bookkeeping_services + - advertising_services + - agricultural_cooperative + - airlines_air_carriers + - airports_flying_fields + - ambulance_services + - amusement_parks_carnivals + - antique_reproductions + - antique_shops + - aquariums + - architectural_surveying_services + - art_dealers_and_galleries + - artists_supply_and_craft_shops + - auto_and_home_supply_stores + - auto_body_repair_shops + - auto_paint_shops + - auto_service_shops + - automated_cash_disburse + - automated_fuel_dispensers + - automobile_associations + - automotive_parts_and_accessories_stores + - automotive_tire_stores + - bail_and_bond_payments + - bakeries + - bands_orchestras + - barber_and_beauty_shops + - betting_casino_gambling + - bicycle_shops + - billiard_pool_establishments + - boat_dealers + - boat_rentals_and_leases + - book_stores + - books_periodicals_and_newspapers + - bowling_alleys + - bus_lines + - business_secretarial_schools + - buying_shopping_services + - cable_satellite_and_other_pay_television_and_radio + - camera_and_photographic_supply_stores + - candy_nut_and_confectionery_stores + - car_and_truck_dealers_new_used + - car_and_truck_dealers_used_only + - car_rental_agencies + - car_washes + - carpentry_services + - carpet_upholstery_cleaning + - caterers + - charitable_and_social_service_organizations_fundraising + - chemicals_and_allied_products + - child_care_services + - childrens_and_infants_wear_stores + - chiropodists_podiatrists + - chiropractors + - cigar_stores_and_stands + - civic_social_fraternal_associations + - cleaning_and_maintenance + - clothing_rental + - colleges_universities + - commercial_equipment + - commercial_footwear + - commercial_photography_art_and_graphics + - commuter_transport_and_ferries + - computer_network_services + - computer_programming + - computer_repair + - computer_software_stores + - computers_peripherals_and_software + - concrete_work_services + - construction_materials + - consulting_public_relations + - correspondence_schools + - cosmetic_stores + - counseling_services + - country_clubs + - courier_services + - court_costs + - credit_reporting_agencies + - cruise_lines + - dairy_products_stores + - dance_hall_studios_schools + - dating_escort_services + - dentists_orthodontists + - department_stores + - detective_agencies + - digital_goods_applications + - digital_goods_games + - digital_goods_large_volume + - digital_goods_media + - direct_marketing_catalog_merchant + - direct_marketing_combination_catalog_and_retail_merchant + - direct_marketing_inbound_telemarketing + - direct_marketing_insurance_services + - direct_marketing_other + - direct_marketing_outbound_telemarketing + - direct_marketing_subscription + - direct_marketing_travel + - discount_stores + - doctors + - door_to_door_sales + - drapery_window_covering_and_upholstery_stores + - drinking_places + - drug_stores_and_pharmacies + - drugs_drug_proprietaries_and_druggist_sundries + - dry_cleaners + - durable_goods + - duty_free_stores + - eating_places_restaurants + - educational_services + - electric_razor_stores + - electric_vehicle_charging + - electrical_parts_and_equipment + - electrical_services + - electronics_repair_shops + - electronics_stores + - elementary_secondary_schools + - emergency_services_gcas_visa_use_only + - employment_temp_agencies + - equipment_rental + - exterminating_services + - family_clothing_stores + - fast_food_restaurants + - financial_institutions + - fines_government_administrative_entities + - fireplace_fireplace_screens_and_accessories_stores + - floor_covering_stores + - florists + - florists_supplies_nursery_stock_and_flowers + - freezer_and_locker_meat_provisioners + - fuel_dealers_non_automotive + - funeral_services_crematories + - >- + furniture_home_furnishings_and_equipment_stores_except_appliances + - furniture_repair_refinishing + - furriers_and_fur_shops + - general_services + - gift_card_novelty_and_souvenir_shops + - glass_paint_and_wallpaper_stores + - glassware_crystal_stores + - golf_courses_public + - government_licensed_horse_dog_racing_us_region_only + - >- + government_licensed_online_casions_online_gambling_us_region_only + - government_owned_lotteries_non_us_region + - government_owned_lotteries_us_region_only + - government_services + - grocery_stores_supermarkets + - hardware_equipment_and_supplies + - hardware_stores + - health_and_beauty_spas + - hearing_aids_sales_and_supplies + - heating_plumbing_a_c + - hobby_toy_and_game_shops + - home_supply_warehouse_stores + - hospitals + - hotels_motels_and_resorts + - household_appliance_stores + - industrial_supplies + - information_retrieval_services + - insurance_default + - insurance_underwriting_premiums + - intra_company_purchases + - jewelry_stores_watches_clocks_and_silverware_stores + - landscaping_services + - laundries + - laundry_cleaning_services + - legal_services_attorneys + - luggage_and_leather_goods_stores + - lumber_building_materials_stores + - manual_cash_disburse + - marinas_service_and_supplies + - marketplaces + - masonry_stonework_and_plaster + - massage_parlors + - medical_and_dental_labs + - medical_dental_ophthalmic_and_hospital_equipment_and_supplies + - medical_services + - membership_organizations + - mens_and_boys_clothing_and_accessories_stores + - mens_womens_clothing_stores + - metal_service_centers + - miscellaneous + - miscellaneous_apparel_and_accessory_shops + - miscellaneous_auto_dealers + - miscellaneous_business_services + - miscellaneous_food_stores + - miscellaneous_general_merchandise + - miscellaneous_general_services + - miscellaneous_home_furnishing_specialty_stores + - miscellaneous_publishing_and_printing + - miscellaneous_recreation_services + - miscellaneous_repair_shops + - miscellaneous_specialty_retail + - mobile_home_dealers + - motion_picture_theaters + - motor_freight_carriers_and_trucking + - motor_homes_dealers + - motor_vehicle_supplies_and_new_parts + - motorcycle_shops_and_dealers + - motorcycle_shops_dealers + - music_stores_musical_instruments_pianos_and_sheet_music + - news_dealers_and_newsstands + - non_fi_money_orders + - non_fi_stored_value_card_purchase_load + - nondurable_goods + - nurseries_lawn_and_garden_supply_stores + - nursing_personal_care + - office_and_commercial_furniture + - opticians_eyeglasses + - optometrists_ophthalmologist + - orthopedic_goods_prosthetic_devices + - osteopaths + - package_stores_beer_wine_and_liquor + - paints_varnishes_and_supplies + - parking_lots_garages + - passenger_railways + - pawn_shops + - pet_shops_pet_food_and_supplies + - petroleum_and_petroleum_products + - photo_developing + - photographic_photocopy_microfilm_equipment_and_supplies + - photographic_studios + - picture_video_production + - piece_goods_notions_and_other_dry_goods + - plumbing_heating_equipment_and_supplies + - political_organizations + - postal_services_government_only + - precious_stones_and_metals_watches_and_jewelry + - professional_services + - public_warehousing_and_storage + - quick_copy_repro_and_blueprint + - railroads + - real_estate_agents_and_managers_rentals + - record_stores + - recreational_vehicle_rentals + - religious_goods_stores + - religious_organizations + - roofing_siding_sheet_metal + - secretarial_support_services + - security_brokers_dealers + - service_stations + - sewing_needlework_fabric_and_piece_goods_stores + - shoe_repair_hat_cleaning + - shoe_stores + - small_appliance_repair + - snowmobile_dealers + - special_trade_services + - specialty_cleaning + - sporting_goods_stores + - sporting_recreation_camps + - sports_and_riding_apparel_stores + - sports_clubs_fields + - stamp_and_coin_stores + - stationary_office_supplies_printing_and_writing_paper + - stationery_stores_office_and_school_supply_stores + - swimming_pools_sales + - t_ui_travel_germany + - tailors_alterations + - tax_payments_government_agencies + - tax_preparation_services + - taxicabs_limousines + - telecommunication_equipment_and_telephone_sales + - telecommunication_services + - telegraph_services + - tent_and_awning_shops + - testing_laboratories + - theatrical_ticket_agencies + - timeshares + - tire_retreading_and_repair + - tolls_bridge_fees + - tourist_attractions_and_exhibits + - towing_services + - trailer_parks_campgrounds + - transportation_services + - travel_agencies_tour_operators + - truck_stop_iteration + - truck_utility_trailer_rentals + - typesetting_plate_making_and_related_services + - typewriter_stores + - u_s_federal_government_agencies_or_departments + - uniforms_commercial_clothing + - used_merchandise_and_secondhand_stores + - utilities + - variety_stores + - veterinary_services + - video_amusement_game_supplies + - video_game_arcades + - video_tape_rental_stores + - vocational_trade_schools + - watch_jewelry_repair + - welding_repair + - wholesale_clubs + - wig_and_toupee_stores + - wires_money_orders + - womens_accessory_and_specialty_shops + - womens_ready_to_wear_stores + - wrecking_and_salvage_yards + type: string + nullable: true + type: array + blocked_merchant_countries: + description: >- + Array of strings containing representing countries from which + authorizations will be declined. Country codes should be ISO 3166 + alpha-2 country codes (e.g. `US`). Cannot be set with + `allowed_merchant_countries`. Provide an empty value to unset this + control. + items: + maxLength: 5000 + type: string + nullable: true + type: array + spending_limits: + 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). + items: + $ref: '#/components/schemas/issuing_card_spending_limit' + nullable: true + type: array + spending_limits_currency: + description: >- + Currency of the amounts within `spending_limits`. Always the same as + the currency of the card. + nullable: true + type: string + title: IssuingCardAuthorizationControls + type: object + x-expandableFields: + - spending_limits + issuing_card_google_pay: + description: '' + properties: + eligible: + description: Google Pay Eligibility + type: boolean + ineligible_reason: + description: Reason the card is ineligible for Google Pay + enum: + - missing_agreement + - missing_cardholder_contact + - unsupported_region + nullable: true + type: string + required: + - eligible + title: IssuingCardGooglePay + type: object + x-expandableFields: [] + issuing_card_shipping: + description: '' + properties: + address: + $ref: '#/components/schemas/address' + carrier: + description: The delivery company that shipped a card. + enum: + - dhl + - fedex + - royal_mail + - usps + nullable: true + type: string + customs: + anyOf: + - $ref: '#/components/schemas/issuing_card_shipping_customs' + description: Additional information that may be required for clearing customs. + nullable: true + eta: + description: >- + A unix timestamp representing a best estimate of when the card will + be delivered. + format: unix-time + nullable: true + type: integer + name: + description: Recipient name. + maxLength: 5000 + type: string + phone_number: + description: >- + The phone number of the receiver of the shipment. Our courier + partners will use this number to contact you in the event of card + delivery issues. For individual shipments to the EU/UK, if this + field is empty, we will provide them with the phone number provided + when the cardholder was initially created. + maxLength: 5000 + nullable: true + type: string + require_signature: + description: >- + Whether a signature is required for card delivery. This feature is + only supported for US users. Standard shipping service does not + support signature on delivery. The default value for standard + shipping service is false and for express and priority services is + true. + nullable: true + type: boolean + service: + description: 'Shipment service, such as `standard` or `express`.' + enum: + - express + - priority + - standard + type: string + x-stripeBypassValidation: true + status: + description: The delivery status of the card. + enum: + - canceled + - delivered + - failure + - pending + - returned + - shipped + nullable: true + type: string + tracking_number: + description: A tracking number for a card shipment. + maxLength: 5000 + nullable: true + type: string + tracking_url: + description: >- + A link to the shipping carrier's site where you can view detailed + information about a card shipment. + maxLength: 5000 + nullable: true + type: string + type: + description: Packaging options. + enum: + - bulk + - individual + type: string + required: + - address + - name + - service + - type + title: IssuingCardShipping + type: object + x-expandableFields: + - address + - customs + issuing_card_shipping_customs: + description: '' + properties: + eori_number: + description: >- + A registration number used for customs in Europe. See + [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and + [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) + for the EU. + maxLength: 5000 + nullable: true + type: string + title: IssuingCardShippingCustoms + type: object + x-expandableFields: [] + issuing_card_spending_limit: + description: '' + properties: + amount: + description: >- + Maximum amount allowed to spend per interval. This amount is in the + card's currency and in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). + type: integer + categories: + description: >- + Array of strings containing + [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + this limit applies to. Omitting this field will apply the limit to + all categories. + items: + enum: + - ac_refrigeration_repair + - accounting_bookkeeping_services + - advertising_services + - agricultural_cooperative + - airlines_air_carriers + - airports_flying_fields + - ambulance_services + - amusement_parks_carnivals + - antique_reproductions + - antique_shops + - aquariums + - architectural_surveying_services + - art_dealers_and_galleries + - artists_supply_and_craft_shops + - auto_and_home_supply_stores + - auto_body_repair_shops + - auto_paint_shops + - auto_service_shops + - automated_cash_disburse + - automated_fuel_dispensers + - automobile_associations + - automotive_parts_and_accessories_stores + - automotive_tire_stores + - bail_and_bond_payments + - bakeries + - bands_orchestras + - barber_and_beauty_shops + - betting_casino_gambling + - bicycle_shops + - billiard_pool_establishments + - boat_dealers + - boat_rentals_and_leases + - book_stores + - books_periodicals_and_newspapers + - bowling_alleys + - bus_lines + - business_secretarial_schools + - buying_shopping_services + - cable_satellite_and_other_pay_television_and_radio + - camera_and_photographic_supply_stores + - candy_nut_and_confectionery_stores + - car_and_truck_dealers_new_used + - car_and_truck_dealers_used_only + - car_rental_agencies + - car_washes + - carpentry_services + - carpet_upholstery_cleaning + - caterers + - charitable_and_social_service_organizations_fundraising + - chemicals_and_allied_products + - child_care_services + - childrens_and_infants_wear_stores + - chiropodists_podiatrists + - chiropractors + - cigar_stores_and_stands + - civic_social_fraternal_associations + - cleaning_and_maintenance + - clothing_rental + - colleges_universities + - commercial_equipment + - commercial_footwear + - commercial_photography_art_and_graphics + - commuter_transport_and_ferries + - computer_network_services + - computer_programming + - computer_repair + - computer_software_stores + - computers_peripherals_and_software + - concrete_work_services + - construction_materials + - consulting_public_relations + - correspondence_schools + - cosmetic_stores + - counseling_services + - country_clubs + - courier_services + - court_costs + - credit_reporting_agencies + - cruise_lines + - dairy_products_stores + - dance_hall_studios_schools + - dating_escort_services + - dentists_orthodontists + - department_stores + - detective_agencies + - digital_goods_applications + - digital_goods_games + - digital_goods_large_volume + - digital_goods_media + - direct_marketing_catalog_merchant + - direct_marketing_combination_catalog_and_retail_merchant + - direct_marketing_inbound_telemarketing + - direct_marketing_insurance_services + - direct_marketing_other + - direct_marketing_outbound_telemarketing + - direct_marketing_subscription + - direct_marketing_travel + - discount_stores + - doctors + - door_to_door_sales + - drapery_window_covering_and_upholstery_stores + - drinking_places + - drug_stores_and_pharmacies + - drugs_drug_proprietaries_and_druggist_sundries + - dry_cleaners + - durable_goods + - duty_free_stores + - eating_places_restaurants + - educational_services + - electric_razor_stores + - electric_vehicle_charging + - electrical_parts_and_equipment + - electrical_services + - electronics_repair_shops + - electronics_stores + - elementary_secondary_schools + - emergency_services_gcas_visa_use_only + - employment_temp_agencies + - equipment_rental + - exterminating_services + - family_clothing_stores + - fast_food_restaurants + - financial_institutions + - fines_government_administrative_entities + - fireplace_fireplace_screens_and_accessories_stores + - floor_covering_stores + - florists + - florists_supplies_nursery_stock_and_flowers + - freezer_and_locker_meat_provisioners + - fuel_dealers_non_automotive + - funeral_services_crematories + - >- + furniture_home_furnishings_and_equipment_stores_except_appliances + - furniture_repair_refinishing + - furriers_and_fur_shops + - general_services + - gift_card_novelty_and_souvenir_shops + - glass_paint_and_wallpaper_stores + - glassware_crystal_stores + - golf_courses_public + - government_licensed_horse_dog_racing_us_region_only + - >- + government_licensed_online_casions_online_gambling_us_region_only + - government_owned_lotteries_non_us_region + - government_owned_lotteries_us_region_only + - government_services + - grocery_stores_supermarkets + - hardware_equipment_and_supplies + - hardware_stores + - health_and_beauty_spas + - hearing_aids_sales_and_supplies + - heating_plumbing_a_c + - hobby_toy_and_game_shops + - home_supply_warehouse_stores + - hospitals + - hotels_motels_and_resorts + - household_appliance_stores + - industrial_supplies + - information_retrieval_services + - insurance_default + - insurance_underwriting_premiums + - intra_company_purchases + - jewelry_stores_watches_clocks_and_silverware_stores + - landscaping_services + - laundries + - laundry_cleaning_services + - legal_services_attorneys + - luggage_and_leather_goods_stores + - lumber_building_materials_stores + - manual_cash_disburse + - marinas_service_and_supplies + - marketplaces + - masonry_stonework_and_plaster + - massage_parlors + - medical_and_dental_labs + - medical_dental_ophthalmic_and_hospital_equipment_and_supplies + - medical_services + - membership_organizations + - mens_and_boys_clothing_and_accessories_stores + - mens_womens_clothing_stores + - metal_service_centers + - miscellaneous + - miscellaneous_apparel_and_accessory_shops + - miscellaneous_auto_dealers + - miscellaneous_business_services + - miscellaneous_food_stores + - miscellaneous_general_merchandise + - miscellaneous_general_services + - miscellaneous_home_furnishing_specialty_stores + - miscellaneous_publishing_and_printing + - miscellaneous_recreation_services + - miscellaneous_repair_shops + - miscellaneous_specialty_retail + - mobile_home_dealers + - motion_picture_theaters + - motor_freight_carriers_and_trucking + - motor_homes_dealers + - motor_vehicle_supplies_and_new_parts + - motorcycle_shops_and_dealers + - motorcycle_shops_dealers + - music_stores_musical_instruments_pianos_and_sheet_music + - news_dealers_and_newsstands + - non_fi_money_orders + - non_fi_stored_value_card_purchase_load + - nondurable_goods + - nurseries_lawn_and_garden_supply_stores + - nursing_personal_care + - office_and_commercial_furniture + - opticians_eyeglasses + - optometrists_ophthalmologist + - orthopedic_goods_prosthetic_devices + - osteopaths + - package_stores_beer_wine_and_liquor + - paints_varnishes_and_supplies + - parking_lots_garages + - passenger_railways + - pawn_shops + - pet_shops_pet_food_and_supplies + - petroleum_and_petroleum_products + - photo_developing + - photographic_photocopy_microfilm_equipment_and_supplies + - photographic_studios + - picture_video_production + - piece_goods_notions_and_other_dry_goods + - plumbing_heating_equipment_and_supplies + - political_organizations + - postal_services_government_only + - precious_stones_and_metals_watches_and_jewelry + - professional_services + - public_warehousing_and_storage + - quick_copy_repro_and_blueprint + - railroads + - real_estate_agents_and_managers_rentals + - record_stores + - recreational_vehicle_rentals + - religious_goods_stores + - religious_organizations + - roofing_siding_sheet_metal + - secretarial_support_services + - security_brokers_dealers + - service_stations + - sewing_needlework_fabric_and_piece_goods_stores + - shoe_repair_hat_cleaning + - shoe_stores + - small_appliance_repair + - snowmobile_dealers + - special_trade_services + - specialty_cleaning + - sporting_goods_stores + - sporting_recreation_camps + - sports_and_riding_apparel_stores + - sports_clubs_fields + - stamp_and_coin_stores + - stationary_office_supplies_printing_and_writing_paper + - stationery_stores_office_and_school_supply_stores + - swimming_pools_sales + - t_ui_travel_germany + - tailors_alterations + - tax_payments_government_agencies + - tax_preparation_services + - taxicabs_limousines + - telecommunication_equipment_and_telephone_sales + - telecommunication_services + - telegraph_services + - tent_and_awning_shops + - testing_laboratories + - theatrical_ticket_agencies + - timeshares + - tire_retreading_and_repair + - tolls_bridge_fees + - tourist_attractions_and_exhibits + - towing_services + - trailer_parks_campgrounds + - transportation_services + - travel_agencies_tour_operators + - truck_stop_iteration + - truck_utility_trailer_rentals + - typesetting_plate_making_and_related_services + - typewriter_stores + - u_s_federal_government_agencies_or_departments + - uniforms_commercial_clothing + - used_merchandise_and_secondhand_stores + - utilities + - variety_stores + - veterinary_services + - video_amusement_game_supplies + - video_game_arcades + - video_tape_rental_stores + - vocational_trade_schools + - watch_jewelry_repair + - welding_repair + - wholesale_clubs + - wig_and_toupee_stores + - wires_money_orders + - womens_accessory_and_specialty_shops + - womens_ready_to_wear_stores + - wrecking_and_salvage_yards + type: string + nullable: true + type: array + interval: + description: Interval (or event) to which the amount applies. + enum: + - all_time + - daily + - monthly + - per_authorization + - weekly + - yearly + type: string + required: + - amount + - interval + title: IssuingCardSpendingLimit + type: object + x-expandableFields: [] + issuing_card_wallets: + description: '' + properties: + apple_pay: + $ref: '#/components/schemas/issuing_card_apple_pay' + google_pay: + $ref: '#/components/schemas/issuing_card_google_pay' + primary_account_identifier: + description: Unique identifier for a card used with digital wallets + maxLength: 5000 + nullable: true + type: string + required: + - apple_pay + - google_pay + title: IssuingCardWallets + type: object + x-expandableFields: + - apple_pay + - google_pay + issuing_cardholder_address: + description: '' + properties: + address: + $ref: '#/components/schemas/address' + required: + - address + title: IssuingCardholderAddress + type: object + x-expandableFields: + - address + issuing_cardholder_authorization_controls: + description: '' + properties: + allowed_categories: + description: >- + Array of strings containing + [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) + of authorizations to allow. All other categories will be blocked. + Cannot be set with `blocked_categories`. + items: + enum: + - ac_refrigeration_repair + - accounting_bookkeeping_services + - advertising_services + - agricultural_cooperative + - airlines_air_carriers + - airports_flying_fields + - ambulance_services + - amusement_parks_carnivals + - antique_reproductions + - antique_shops + - aquariums + - architectural_surveying_services + - art_dealers_and_galleries + - artists_supply_and_craft_shops + - auto_and_home_supply_stores + - auto_body_repair_shops + - auto_paint_shops + - auto_service_shops + - automated_cash_disburse + - automated_fuel_dispensers - automobile_associations - automotive_parts_and_accessories_stores - automotive_tire_stores @@ -15900,6 +18791,19 @@ components: type: string nullable: true type: array + allowed_merchant_countries: + description: >- + Array of strings containing representing countries from which + authorizations will be allowed. Authorizations from merchants in all + other countries will be declined. Country codes should be ISO 3166 + alpha-2 country codes (e.g. `US`). Cannot be set with + `blocked_merchant_countries`. Provide an empty value to unset this + control. + items: + maxLength: 5000 + type: string + nullable: true + type: array blocked_categories: description: >- Array of strings containing @@ -16208,6 +19112,18 @@ components: type: string nullable: true type: array + blocked_merchant_countries: + description: >- + Array of strings containing representing countries from which + authorizations will be declined. Country codes should be ISO 3166 + alpha-2 country codes (e.g. `US`). Cannot be set with + `allowed_merchant_countries`. Provide an empty value to unset this + control. + items: + maxLength: 5000 + type: string + nullable: true + type: array spending_limits: description: >- Limit spending with amount-based rules that apply across this @@ -16231,8 +19147,9 @@ components: anyOf: - $ref: '#/components/schemas/issuing_cardholder_user_terms_acceptance' description: >- - Information about cardholder acceptance of [Authorized User - Terms](https://stripe.com/docs/issuing/cards). + Information about cardholder acceptance of Celtic [Authorized User + Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). + Required for cards backed by a Celtic program. nullable: true title: IssuingCardholderCardIssuing type: object @@ -16718,14 +19635,14 @@ components: date: description: >- The Unix timestamp marking when the cardholder accepted the - Authorized User Terms. Required for Celtic Spend Card users. + Authorized User Terms. format: unix-time nullable: true type: integer ip: description: >- The IP address from which the cardholder accepted the Authorized - User Terms. Required for Celtic Spend Card users. + User Terms. maxLength: 5000 nullable: true type: string @@ -17379,6 +20296,126 @@ components: type: object x-expandableFields: - cardholder_address + issuing_personalization_design_carrier_text: + description: '' + properties: + footer_body: + description: The footer body text of the carrier letter. + maxLength: 5000 + nullable: true + type: string + footer_title: + description: The footer title text of the carrier letter. + maxLength: 5000 + nullable: true + type: string + header_body: + description: The header body text of the carrier letter. + maxLength: 5000 + nullable: true + type: string + header_title: + description: The header title text of the carrier letter. + maxLength: 5000 + nullable: true + type: string + title: IssuingPersonalizationDesignCarrierText + type: object + x-expandableFields: [] + issuing_personalization_design_preferences: + description: '' + properties: + is_default: + description: >- + Whether we use this personalization design to create cards when one + isn't specified. A connected account uses the Connect platform's + default design if no personalization design is set as the default + design. + type: boolean + is_platform_default: + description: >- + Whether this personalization design is used to create cards when one + is not specified and a default for this connected account does not + exist. + nullable: true + type: boolean + required: + - is_default + title: IssuingPersonalizationDesignPreferences + type: object + x-expandableFields: [] + issuing_personalization_design_rejection_reasons: + description: '' + properties: + card_logo: + description: The reason(s) the card logo was rejected. + items: + enum: + - geographic_location + - inappropriate + - network_name + - non_binary_image + - non_fiat_currency + - other + - other_entity + - promotional_material + type: string + nullable: true + type: array + carrier_text: + description: The reason(s) the carrier text was rejected. + items: + enum: + - geographic_location + - inappropriate + - network_name + - non_fiat_currency + - other + - other_entity + - promotional_material + type: string + nullable: true + type: array + title: IssuingPersonalizationDesignRejectionReasons + type: object + x-expandableFields: [] + issuing_physical_bundle_features: + description: '' + properties: + card_logo: + description: >- + The policy for how to use card logo images in a card design with + this physical bundle. + enum: + - optional + - required + - unsupported + type: string + carrier_text: + description: >- + The policy for how to use carrier letter text in a card design with + this physical bundle. + enum: + - optional + - required + - unsupported + type: string + second_line: + description: >- + The policy for how to use a second line on a card with this physical + bundle. + enum: + - optional + - required + - unsupported + type: string + required: + - card_logo + - carrier_text + - second_line + title: IssuingPhysicalBundleFeatures + type: object + x-expandableFields: [] issuing_transaction_amount_details: description: '' properties: @@ -17469,7 +20506,9 @@ components: maxLength: 5000 type: string unit: - description: The units for `volume_decimal`. One of `us_gallon` or `liter`. + description: >- + The units for `volume_decimal`. One of `liter`, `us_gallon`, or + `other`. maxLength: 5000 type: string unit_cost_decimal: @@ -17800,6 +20839,7 @@ components: - public_company - public_corporation - public_partnership + - registered_charity - single_member_llc - sole_establishment - sole_proprietorship @@ -18135,12 +21175,16 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/discount' - nullable: true type: array id: description: Unique identifier for the object. maxLength: 5000 type: string + invoice: + description: The ID of the invoice that contains this line item. + maxLength: 5000 + nullable: true + type: string invoice_item: anyOf: - maxLength: 5000 @@ -18166,9 +21210,10 @@ components: 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. Note - that for line items with `type=subscription` this will reflect the - metadata of the subscription that caused the line item to be - created. + that for line items with `type=subscription`, `metadata` reflects + the current metadata from the subscription associated with the line + item, unless the invoice line was directly updated with different + metadata after creation. type: object object: description: >- @@ -18249,6 +21294,7 @@ components: - amount - currency - discountable + - discounts - id - livemode - metadata @@ -18350,6 +21396,8 @@ components: items: enum: - balances + - ownership + - transactions type: string x-stripeBypassValidation: true nullable: true @@ -18366,8 +21414,10 @@ components: x-expandableFields: [] login_link: description: >- - Login Links are single-use login link for an Express account to access - their Stripe dashboard. + Login Links are single-use URLs for a connected account to access the + Express Dashboard. The connected account's + [account.controller.stripe_dashboard.type](/api/accounts/object#account_object-controller-stripe_dashboard-type) + must be `express` to have access to the Express Dashboard. properties: created: description: >- @@ -18508,6 +21558,12 @@ components: title: mandate_acss_debit type: object x-expandableFields: [] + mandate_amazon_pay: + description: '' + properties: {} + title: mandate_amazon_pay + type: object + x-expandableFields: [] mandate_au_becs_debit: description: '' properties: @@ -18540,6 +21596,18 @@ components: description: The unique reference identifying the mandate on the Bacs network. maxLength: 5000 type: string + revocation_reason: + description: >- + When the mandate is revoked on the Bacs network this field displays + the reason for the revocation. + enum: + - account_closed + - bank_account_restricted + - bank_ownership_changed + - could_not_process + - debit_not_authorized + nullable: true + type: string url: description: The URL that will contain the mandate that the customer has signed. maxLength: 5000 @@ -18574,6 +21642,8 @@ components: properties: acss_debit: $ref: '#/components/schemas/mandate_acss_debit' + amazon_pay: + $ref: '#/components/schemas/mandate_amazon_pay' au_becs_debit: $ref: '#/components/schemas/mandate_au_becs_debit' bacs_debit: @@ -18586,6 +21656,8 @@ components: $ref: '#/components/schemas/mandate_link' paypal: $ref: '#/components/schemas/mandate_paypal' + revolut_pay: + $ref: '#/components/schemas/mandate_revolut_pay' sepa_debit: $ref: '#/components/schemas/mandate_sepa_debit' type: @@ -18604,12 +21676,14 @@ components: type: object x-expandableFields: - acss_debit + - amazon_pay - au_becs_debit - bacs_debit - card - cashapp - link - paypal + - revolut_pay - sepa_debit - us_bank_account mandate_paypal: @@ -18633,6 +21707,12 @@ components: title: mandate_paypal type: object x-expandableFields: [] + mandate_revolut_pay: + description: '' + properties: {} + title: mandate_revolut_pay + type: object + x-expandableFields: [] mandate_sepa_debit: description: '' properties: @@ -18670,7 +21750,13 @@ components: x-expandableFields: [] mandate_us_bank_account: description: '' - properties: {} + properties: + collection_method: + description: Mandate collection method + enum: + - paper + type: string + x-stripeBypassValidation: true title: mandate_us_bank_account type: object x-expandableFields: [] @@ -18684,7 +21770,10 @@ components: type: string type: array preferred: - description: The preferred network for the card. + description: >- + The preferred network for co-branded cards. Can be + `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if + requested network is not valid for the card. maxLength: 5000 nullable: true type: string @@ -18843,8 +21932,20 @@ components: maxLength: 5000 nullable: true type: string + mandate: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/mandate' + description: ID of the mandate used to make this payment. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/mandate' network: - description: The US bank account network used to send funds. + description: >- + The network rails used. See the + [docs](https://stripe.com/docs/treasury/money-movement/timelines) to + learn more about money movement timelines for each network type. enum: - ach - us_domestic_wire @@ -18858,7 +21959,8 @@ components: - network title: outbound_payments_payment_method_details_us_bank_account type: object - x-expandableFields: [] + x-expandableFields: + - mandate outbound_transfers_payment_method_details: description: '' properties: @@ -18915,8 +22017,20 @@ components: maxLength: 5000 nullable: true type: string + mandate: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/mandate' + description: ID of the mandate used to make this payment. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/mandate' network: - description: The US bank account network used to send funds. + description: >- + The network rails used. See the + [docs](https://stripe.com/docs/treasury/money-movement/timelines) to + learn more about money movement timelines for each network type. enum: - ach - us_domestic_wire @@ -18930,7 +22044,8 @@ components: - network title: outbound_transfers_payment_method_details_us_bank_account type: object - x-expandableFields: [] + x-expandableFields: + - mandate package_dimensions: description: '' properties: @@ -19281,6 +22396,9 @@ components: nullable: true type: string confirmation_method: + description: >- + Describes whether we can confirm this PaymentIntent automatically, + or if it requires customer action to confirm the payment. enum: - automatic - manual @@ -19494,9 +22612,11 @@ components: nullable: true statement_descriptor: description: >- - For non-card charges, you can use this value as the complete - description that appears on your customers’ statements. Must contain - at least one letter, maximum 22 characters. + For card charges, use + [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). + Otherwise, you can use this value as the complete description of a + charge on your customers' statements. It must contain at least one + letter and be 1–22 characters long. maxLength: 5000 nullable: true type: string @@ -19613,6 +22733,9 @@ components: #/components/schemas/payment_intent_next_action_promptpay_display_qr_code redirect_to_url: $ref: '#/components/schemas/payment_intent_next_action_redirect_to_url' + swish_handle_redirect_or_display_qr_code: + $ref: >- + #/components/schemas/payment_intent_next_action_swish_handle_redirect_or_display_qr_code type: description: >- Type of the next action to perform, one of `redirect_to_url`, @@ -19655,6 +22778,7 @@ components: - pix_display_qr_code - promptpay_display_qr_code - redirect_to_url + - swish_handle_redirect_or_display_qr_code - verify_with_microdeposits - wechat_pay_display_qr_code - wechat_pay_redirect_to_android_app @@ -20099,6 +23223,48 @@ components: title: PaymentIntentNextActionRedirectToUrl type: object x-expandableFields: [] + payment_intent_next_action_swish_handle_redirect_or_display_qr_code: + description: '' + properties: + hosted_instructions_url: + description: >- + The URL to the hosted Swish instructions page, which allows + customers to view the QR code. + maxLength: 5000 + type: string + qr_code: + $ref: '#/components/schemas/payment_intent_next_action_swish_qr_code' + required: + - hosted_instructions_url + - qr_code + title: PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode + type: object + x-expandableFields: + - qr_code + payment_intent_next_action_swish_qr_code: + description: '' + properties: + data: + description: >- + The raw data string used to generate QR code, it should be used + together with QR code library. + maxLength: 5000 + type: string + image_url_png: + description: The image_url_png string used to render QR code + maxLength: 5000 + type: string + image_url_svg: + description: The image_url_svg string used to render QR code + maxLength: 5000 + type: string + required: + - data + - image_url_png + - image_url_svg + title: PaymentIntentNextActionSwishQRCode + type: object + x-expandableFields: [] payment_intent_next_action_verify_with_microdeposits: description: '' properties: @@ -20239,6 +23405,11 @@ components: - $ref: '#/components/schemas/payment_method_options_alipay' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + amazon_pay: + anyOf: + - $ref: '#/components/schemas/payment_method_options_amazon_pay' + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client au_becs_debit: anyOf: - $ref: >- @@ -20330,6 +23501,12 @@ components: - $ref: '#/components/schemas/payment_intent_payment_method_options_link' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + mobilepay: + anyOf: + - $ref: >- + #/components/schemas/payment_intent_payment_method_options_mobilepay + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client oxxo: anyOf: - $ref: '#/components/schemas/payment_method_options_oxxo' @@ -20376,6 +23553,11 @@ components: - $ref: '#/components/schemas/payment_method_options_sofort' - $ref: >- #/components/schemas/payment_intent_type_specific_payment_method_options_client + swish: + anyOf: + - $ref: '#/components/schemas/payment_intent_payment_method_options_swish' + - $ref: >- + #/components/schemas/payment_intent_type_specific_payment_method_options_client us_bank_account: anyOf: - $ref: >- @@ -20399,6 +23581,7 @@ components: - affirm - afterpay_clearpay - alipay + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -20417,6 +23600,7 @@ components: - klarna - konbini - link + - mobilepay - oxxo - p24 - paynow @@ -20426,6 +23610,7 @@ components: - revolut_pay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay - zip @@ -20503,7 +23688,30 @@ components: x-expandableFields: [] payment_intent_payment_method_options_blik: description: '' - properties: {} + properties: + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + Providing this parameter will [attach the payment + method](https://stripe.com/docs/payments/save-during-payment) to the + PaymentIntent's Customer, if present, after the PaymentIntent is + confirmed and any required actions from the user are complete. If no + Customer was provided, the payment method can still be + [attached](https://stripe.com/docs/api/payment_methods/attach) to a + Customer after the transaction completes. + + + When processing card payments, Stripe also uses `setup_future_usage` + to dynamically optimize your payment flow and comply with regional + legislation and network rules, such as + [SCA](https://stripe.com/docs/strong-customer-authentication). + enum: + - none + type: string + x-stripeBypassValidation: true title: payment_intent_payment_method_options_blik type: object x-expandableFields: [] @@ -20565,8 +23773,8 @@ components: type: string request_incremental_authorization: description: >- - Request ability to - [increment](https://stripe.com/docs/payments/incremental-authorization) + Request ability to [increment the + authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent. enum: - if_available @@ -20597,18 +23805,24 @@ components: level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your - own fraud engine, provide this option. Permitted values include: - `automatic` or `any`. If not provided, defaults to `automatic`. Read - our guide on [manually requesting 3D - Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) + own fraud engine, provide this option. If not provided, this value + defaults to `automatic`. Read our guide on [manually requesting 3D + Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. enum: - any - automatic - - challenge_only + - challenge nullable: true type: string + x-stripeBypassValidation: true + require_cvc_recollection: + description: >- + When enabled, using a card that is attached to a customer will + require the CVC to be provided again (i.e. using the cvc_token + parameter). + type: boolean setup_future_usage: description: >- Indicates that you intend to make future payments with this @@ -20761,6 +23975,41 @@ components: title: payment_intent_payment_method_options_mandate_options_sepa_debit type: object x-expandableFields: [] + payment_intent_payment_method_options_mobilepay: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + Providing this parameter will [attach the payment + method](https://stripe.com/docs/payments/save-during-payment) to the + PaymentIntent's Customer, if present, after the PaymentIntent is + confirmed and any required actions from the user are complete. If no + Customer was provided, the payment method can still be + [attached](https://stripe.com/docs/api/payment_methods/attach) to a + Customer after the transaction completes. + + + When processing card payments, Stripe also uses `setup_future_usage` + to dynamically optimize your payment flow and comply with regional + legislation and network rules, such as + [SCA](https://stripe.com/docs/strong-customer-authentication). + enum: + - none + type: string + title: payment_intent_payment_method_options_mobilepay + type: object + x-expandableFields: [] payment_intent_payment_method_options_sepa_debit: description: '' properties: @@ -20795,11 +24044,49 @@ components: type: object x-expandableFields: - mandate_options + payment_intent_payment_method_options_swish: + description: '' + properties: + reference: + description: >- + The order ID displayed in the Swish app after the payment is + authorized. + maxLength: 35 + nullable: true + type: string + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + Providing this parameter will [attach the payment + method](https://stripe.com/docs/payments/save-during-payment) to the + PaymentIntent's Customer, if present, after the PaymentIntent is + confirmed and any required actions from the user are complete. If no + Customer was provided, the payment method can still be + [attached](https://stripe.com/docs/api/payment_methods/attach) to a + Customer after the transaction completes. + + + When processing card payments, Stripe also uses `setup_future_usage` + to dynamically optimize your payment flow and comply with regional + legislation and network rules, such as + [SCA](https://stripe.com/docs/strong-customer-authentication). + enum: + - none + type: string + title: payment_intent_payment_method_options_swish + type: object + x-expandableFields: [] payment_intent_payment_method_options_us_bank_account: description: '' properties: financial_connections: $ref: '#/components/schemas/linked_account_options_us_bank_account' + mandate_options: + $ref: >- + #/components/schemas/payment_method_options_us_bank_account_mandate_options preferred_settlement_speed: description: Preferred transaction settlement speed enum: @@ -20842,6 +24129,7 @@ components: type: object x-expandableFields: - financial_connections + - mandate_options payment_intent_processing: description: '' properties: @@ -20893,6 +24181,12 @@ components: type: string installments: $ref: '#/components/schemas/payment_flows_installment_options' + require_cvc_recollection: + description: >- + When enabled, using a card that is attached to a customer will + require the CVC to be provided again (i.e. using the cvc_token + parameter). + type: boolean setup_future_usage: description: >- Indicates that you intend to make future payments with this @@ -20985,7 +24279,9 @@ components: automatic_tax: $ref: '#/components/schemas/payment_links_resource_automatic_tax' billing_address_collection: - description: Configuration for collecting the customer's billing address. + description: >- + Configuration for collecting the customer's billing address. + Defaults to `auto`. enum: - auto - required @@ -21007,7 +24303,7 @@ components: custom_fields: description: >- Collect additional information from your customer using custom - fields. Up to 2 fields are supported. + fields. Up to 3 fields are supported. items: $ref: '#/components/schemas/payment_links_resource_custom_fields' type: array @@ -21023,6 +24319,13 @@ components: description: Unique identifier for the object. maxLength: 5000 type: string + inactive_message: + description: >- + The custom message to be displayed to a customer when a payment link + is no longer active. + maxLength: 5000 + nullable: true + type: string invoice_creation: anyOf: - $ref: '#/components/schemas/payment_links_resource_invoice_creation' @@ -21103,7 +24406,9 @@ components: during checkout. nullable: true payment_method_collection: - description: Configuration for collecting a payment method during checkout. + description: >- + Configuration for collecting a payment method during checkout. + Defaults to `always`. enum: - always - if_required @@ -21142,6 +24447,7 @@ components: - promptpay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay type: string @@ -21150,6 +24456,11 @@ components: type: array phone_number_collection: $ref: '#/components/schemas/payment_links_resource_phone_number_collection' + restrictions: + anyOf: + - $ref: '#/components/schemas/payment_links_resource_restrictions' + description: Settings that restrict the usage of a payment link. + nullable: true shipping_address_collection: anyOf: - $ref: >- @@ -21226,6 +24537,7 @@ components: - on_behalf_of - payment_intent_data - phone_number_collection + - restrictions - shipping_address_collection - shipping_options - subscription_data @@ -21262,10 +24574,40 @@ components: If `true`, tax will be calculated automatically using the customer's location. type: boolean + liability: + anyOf: + - $ref: '#/components/schemas/connect_account_reference' + 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. + nullable: true required: - enabled title: PaymentLinksResourceAutomaticTax type: object + x-expandableFields: + - liability + payment_links_resource_completed_sessions: + description: '' + properties: + count: + description: >- + The current number of checkout sessions that have been completed on + the payment link which count towards the `completed_sessions` + restriction to be met. + type: integer + limit: + description: >- + The maximum number of checkout sessions that can be completed for + the `completed_sessions` restriction to be met. + type: integer + required: + - count + - limit + title: PaymentLinksResourceCompletedSessions + type: object x-expandableFields: [] payment_links_resource_completion_behavior_confirmation_page: description: '' @@ -21297,6 +24639,14 @@ components: payment_links_resource_consent_collection: description: '' properties: + payment_method_reuse_agreement: + anyOf: + - $ref: >- + #/components/schemas/payment_links_resource_payment_method_reuse_agreement + description: >- + Settings related to the payment method reuse text shown in the + Checkout UI. + nullable: true promotions: description: >- If set to `auto`, enables the collection of customer consent for @@ -21318,7 +24668,8 @@ components: type: string title: PaymentLinksResourceConsentCollection type: object - x-expandableFields: [] + x-expandableFields: + - payment_method_reuse_agreement payment_links_resource_custom_fields: description: '' properties: @@ -21452,6 +24803,13 @@ components: payment_links_resource_custom_text: description: '' properties: + after_submit: + anyOf: + - $ref: '#/components/schemas/payment_links_resource_custom_text_position' + description: >- + Custom text that should be displayed after the payment confirmation + button. + nullable: true shipping_address: anyOf: - $ref: '#/components/schemas/payment_links_resource_custom_text_position' @@ -21476,6 +24834,7 @@ components: title: PaymentLinksResourceCustomText type: object x-expandableFields: + - after_submit - shipping_address - submit - terms_of_service_acceptance @@ -21545,6 +24904,14 @@ components: maxLength: 5000 nullable: true type: string + issuer: + anyOf: + - $ref: '#/components/schemas/connect_account_reference' + description: >- + The connected account that issues the invoice. The invoice is + presented with the branding and support information of the specified + account. + nullable: true metadata: additionalProperties: maxLength: 500 @@ -21565,6 +24932,7 @@ components: x-expandableFields: - account_tax_ids - custom_fields + - issuer - rendering_options payment_links_resource_payment_intent_data: description: '' @@ -21623,11 +24991,41 @@ components: maxLength: 5000 nullable: true type: string + transfer_group: + description: >- + A string that identifies the resulting payment as part of a group. + See the PaymentIntents [use case for connected + accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) + for details. + maxLength: 5000 + nullable: true + type: string required: - metadata title: PaymentLinksResourcePaymentIntentData type: object x-expandableFields: [] + payment_links_resource_payment_method_reuse_agreement: + description: '' + properties: + position: + description: >- + Determines the position and visibility of the payment method reuse + agreement in the UI. When set to `auto`, Stripe's defaults will be + used. + + + When set to `hidden`, the payment method reuse agreement text will + always be hidden in the UI. + enum: + - auto + - hidden + type: string + required: + - position + title: PaymentLinksResourcePaymentMethodReuseAgreement + type: object + x-expandableFields: [] payment_links_resource_phone_number_collection: description: '' properties: @@ -21639,6 +25037,17 @@ components: title: PaymentLinksResourcePhoneNumberCollection type: object x-expandableFields: [] + payment_links_resource_restrictions: + description: '' + properties: + completed_sessions: + $ref: '#/components/schemas/payment_links_resource_completed_sessions' + required: + - completed_sessions + title: PaymentLinksResourceRestrictions + type: object + x-expandableFields: + - completed_sessions payment_links_resource_shipping_address_collection: description: '' properties: @@ -21928,6 +25337,9 @@ components: maxLength: 5000 nullable: true type: string + invoice_settings: + $ref: >- + #/components/schemas/payment_links_resource_subscription_data_invoice_settings metadata: additionalProperties: maxLength: 500 @@ -21944,11 +25356,31 @@ components: customer is charged for the first time. nullable: true type: integer + trial_settings: + anyOf: + - $ref: >- + #/components/schemas/subscriptions_trials_resource_trial_settings + description: Settings related to subscription trials. + nullable: true required: + - invoice_settings - metadata title: PaymentLinksResourceSubscriptionData type: object - x-expandableFields: [] + x-expandableFields: + - invoice_settings + - trial_settings + payment_links_resource_subscription_data_invoice_settings: + description: '' + properties: + issuer: + $ref: '#/components/schemas/connect_account_reference' + required: + - issuer + title: PaymentLinksResourceSubscriptionDataInvoiceSettings + type: object + x-expandableFields: + - issuer payment_links_resource_tax_id_collection: description: '' properties: @@ -22009,6 +25441,8 @@ components: $ref: '#/components/schemas/payment_method_afterpay_clearpay' alipay: $ref: '#/components/schemas/payment_flows_private_payment_methods_alipay' + amazon_pay: + $ref: '#/components/schemas/payment_method_amazon_pay' au_becs_debit: $ref: '#/components/schemas/payment_method_au_becs_debit' bacs_debit: @@ -22085,6 +25519,8 @@ components: additional information about the object in a structured format. nullable: true type: object + mobilepay: + $ref: '#/components/schemas/payment_method_mobilepay' object: description: >- String representing the object's type. Objects of the same type @@ -22112,6 +25548,8 @@ components: $ref: '#/components/schemas/payment_method_sepa_debit' sofort: $ref: '#/components/schemas/payment_method_sofort' + swish: + $ref: '#/components/schemas/payment_method_swish' type: description: >- The type of the PaymentMethod. An additional hash is included on the @@ -22122,6 +25560,7 @@ components: - affirm - afterpay_clearpay - alipay + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -22140,6 +25579,7 @@ components: - klarna - konbini - link + - mobilepay - oxxo - p24 - paynow @@ -22149,6 +25589,7 @@ components: - revolut_pay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay - zip @@ -22174,6 +25615,7 @@ components: - affirm - afterpay_clearpay - alipay + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -22194,6 +25636,7 @@ components: - klarna - konbini - link + - mobilepay - oxxo - p24 - paynow @@ -22204,6 +25647,7 @@ components: - revolut_pay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay - zip @@ -22253,6 +25697,12 @@ components: title: payment_method_afterpay_clearpay type: object x-expandableFields: [] + payment_method_amazon_pay: + description: '' + properties: {} + title: payment_method_amazon_pay + type: object + x-expandableFields: [] payment_method_au_becs_debit: description: '' properties: @@ -22347,6 +25797,16 @@ components: maxLength: 5000 nullable: true type: string + display_brand: + description: >- + The brand to use when displaying the card, this accounts for + customer's brand choice on dual-branded cards. Can be + `american_express`, `cartes_bancaires`, `diners_club`, `discover`, + `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, + `visa`, or `other` and may contain more values in the future. + maxLength: 5000 + nullable: true + type: string exp_month: description: Two-digit number representing the card's expiration month. type: integer @@ -22861,6 +26321,11 @@ components: and are not available in this API. + **Note:** The ability to turn off cards is in limited preview. Please + [contact us](https://support.stripe.com/contact) if you require this + functionality. + + Related guides: - [Payment Method Configurations @@ -22887,6 +26352,9 @@ components: alipay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties + amazon_pay: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties apple_pay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties @@ -22921,6 +26389,9 @@ components: cashapp: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties + customer_balance: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties eps: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties @@ -22940,9 +26411,6 @@ components: description: Unique identifier for the object. maxLength: 5000 type: string - id_bank_transfer: - $ref: >- - #/components/schemas/payment_method_config_resource_payment_method_properties ideal: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties @@ -22968,16 +26436,13 @@ components: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean - multibanco: + mobilepay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties name: description: The configuration's name. maxLength: 5000 type: string - netbanking: - $ref: >- - #/components/schemas/payment_method_config_resource_payment_method_properties object: description: >- String representing the object's type. Objects of the same type @@ -22996,9 +26461,6 @@ components: maxLength: 5000 nullable: true type: string - pay_by_bank: - $ref: >- - #/components/schemas/payment_method_config_resource_payment_method_properties paynow: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties @@ -23008,13 +26470,16 @@ components: promptpay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties + revolut_pay: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties sepa_debit: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties sofort: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties - upi: + swish: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties us_bank_account: @@ -23023,6 +26488,9 @@ components: wechat_pay: $ref: >- #/components/schemas/payment_method_config_resource_payment_method_properties + zip: + $ref: >- + #/components/schemas/payment_method_config_resource_payment_method_properties required: - active - id @@ -23037,6 +26505,7 @@ components: - affirm - afterpay_clearpay - alipay + - amazon_pay - apple_pay - au_becs_debit - bacs_debit @@ -23046,30 +26515,30 @@ components: - card - cartes_bancaires - cashapp + - customer_balance - eps - fpx - giropay - google_pay - grabpay - - id_bank_transfer - ideal - jcb - klarna - konbini - link - - multibanco - - netbanking + - mobilepay - oxxo - p24 - - pay_by_bank - paynow - paypal - promptpay + - revolut_pay - sepa_debit - sofort - - upi + - swish - us_bank_account - wechat_pay + - zip x-resourceId: payment_method_configuration payment_method_customer_balance: description: '' @@ -23093,6 +26562,8 @@ components: alipay: $ref: >- #/components/schemas/payment_flows_private_payment_methods_alipay_details + amazon_pay: + $ref: '#/components/schemas/payment_method_details_amazon_pay' au_becs_debit: $ref: '#/components/schemas/payment_method_details_au_becs_debit' bacs_debit: @@ -23129,6 +26600,8 @@ components: $ref: '#/components/schemas/payment_method_details_konbini' link: $ref: '#/components/schemas/payment_method_details_link' + mobilepay: + $ref: '#/components/schemas/payment_method_details_mobilepay' multibanco: $ref: '#/components/schemas/payment_method_details_multibanco' oxxo: @@ -23151,6 +26624,8 @@ components: $ref: '#/components/schemas/payment_method_details_sofort' stripe_account: $ref: '#/components/schemas/payment_method_details_stripe_account' + swish: + $ref: '#/components/schemas/payment_method_details_swish' type: description: >- The type of transaction-specific details of the payment method used @@ -23184,6 +26659,7 @@ components: - affirm - afterpay_clearpay - alipay + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -23202,6 +26678,7 @@ components: - klarna - konbini - link + - mobilepay - multibanco - oxxo - p24 @@ -23213,6 +26690,7 @@ components: - sepa_debit - sofort - stripe_account + - swish - us_bank_account - wechat - wechat_pay @@ -23346,6 +26824,12 @@ components: title: payment_method_details_afterpay_clearpay type: object x-expandableFields: [] + payment_method_details_amazon_pay: + description: '' + properties: {} + title: payment_method_details_amazon_pay + type: object + x-expandableFields: [] payment_method_details_au_becs_debit: description: '' properties: @@ -23898,7 +27382,11 @@ components: nullable: true type: string cardholder_verification_method: - description: How the cardholder verified ownership of the card. + description: >- + Describes the method used by the cardholder to verify ownership of + the card. One of the following: `approval`, `failure`, `none`, + `offline_pin`, `offline_pin_and_signature`, `online_pin`, or + `signature`. maxLength: 5000 nullable: true type: string @@ -24278,7 +27766,7 @@ components: bank: description: >- The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, - `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, + `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. enum: @@ -24290,6 +27778,7 @@ components: - knab - moneyou - n26 + - nn - rabobank - regiobank - revolut @@ -24311,6 +27800,7 @@ components: - INGBNL2A - KNABNL2H - MOYONL21 + - NNBANL2G - NTSBDEB1 - RABONL2U - RBRBNL21 @@ -24514,7 +28004,11 @@ components: nullable: true type: string cardholder_verification_method: - description: How the cardholder verified ownership of the card. + description: >- + Describes the method used by the cardholder to verify ownership of + the card. One of the following: `approval`, `failure`, `none`, + `offline_pin`, `offline_pin_and_signature`, `online_pin`, or + `signature`. maxLength: 5000 nullable: true type: string @@ -24618,6 +28112,17 @@ components: title: payment_method_details_link type: object x-expandableFields: [] + payment_method_details_mobilepay: + description: '' + properties: + card: + anyOf: + - $ref: '#/components/schemas/internal_card' + nullable: true + title: payment_method_details_mobilepay + type: object + x-expandableFields: + - card payment_method_details_multibanco: description: '' properties: @@ -24652,11 +28157,12 @@ components: description: >- The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, - `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `blik`, - `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, - `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, - `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, - `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`. + `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, + `blik`, `noble_pay`, `ideabank`, `envelobank`, + `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, + `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, + `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, + `bank_millennium`, `alior_bank`, or `boz`. enum: - alior_bank - bank_millennium @@ -24682,6 +28188,7 @@ components: - santander_przelew24 - tmobile_usbugi_bankowe - toyota_bank + - velobank - volkswagen_bank nullable: true type: string @@ -24924,6 +28431,30 @@ components: title: payment_method_details_stripe_account type: object x-expandableFields: [] + payment_method_details_swish: + description: '' + properties: + fingerprint: + description: >- + Uniquely identifies the payer's Swish account. You can use this + attribute to check whether two Swish transactions were paid for by + the same payer + maxLength: 5000 + nullable: true + type: string + payment_reference: + description: Payer bank reference number for the payment + maxLength: 5000 + nullable: true + type: string + verified_phone_last4: + description: The last four digits of the Swish account phone number + maxLength: 5000 + nullable: true + type: string + title: payment_method_details_swish + type: object + x-expandableFields: [] payment_method_details_us_bank_account: description: '' properties: @@ -24958,6 +28489,20 @@ components: maxLength: 5000 nullable: true type: string + mandate: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/mandate' + description: ID of the mandate used to make this payment. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/mandate' + payment_reference: + description: Reference number to locate ACH payments with customer's bank. + maxLength: 5000 + nullable: true + type: string routing_number: description: Routing number of the bank account. maxLength: 5000 @@ -24965,7 +28510,8 @@ components: type: string title: payment_method_details_us_bank_account type: object - x-expandableFields: [] + x-expandableFields: + - mandate payment_method_details_wechat: description: '' properties: {} @@ -25219,7 +28765,7 @@ components: description: >- The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, - `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, + `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. enum: - abn_amro @@ -25230,6 +28776,7 @@ components: - knab - moneyou - n26 + - nn - rabobank - regiobank - revolut @@ -25253,6 +28800,7 @@ components: - INGBNL2A - KNABNL2H - MOYONL21 + - NNBANL2G - NTSBDEB1 - RABONL2U - RBRBNL21 @@ -25390,6 +28938,12 @@ components: title: payment_method_link type: object x-expandableFields: [] + payment_method_mobilepay: + description: '' + properties: {} + title: payment_method_mobilepay + type: object + x-expandableFields: [] payment_method_options_affirm: description: '' properties: @@ -25506,6 +29060,42 @@ components: title: payment_method_options_alipay type: object x-expandableFields: [] + payment_method_options_amazon_pay: + description: '' + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + Providing this parameter will [attach the payment + method](https://stripe.com/docs/payments/save-during-payment) to the + PaymentIntent's Customer, if present, after the PaymentIntent is + confirmed and any required actions from the user are complete. If no + Customer was provided, the payment method can still be + [attached](https://stripe.com/docs/api/payment_methods/attach) to a + Customer after the transaction completes. + + + When processing card payments, Stripe also uses `setup_future_usage` + to dynamically optimize your payment flow and comply with regional + legislation and network rules, such as + [SCA](https://stripe.com/docs/strong-customer-authentication). + enum: + - none + - off_session + type: string + title: payment_method_options_amazon_pay + type: object + x-expandableFields: [] payment_method_options_bacs_debit: description: '' properties: @@ -26046,6 +29636,7 @@ components: enum: - none type: string + x-stripeBypassValidation: true title: payment_method_options_klarna type: object x-expandableFields: [] @@ -26319,7 +29910,37 @@ components: x-expandableFields: [] payment_method_options_revolut_pay: description: '' - properties: {} + properties: + capture_method: + description: >- + Controls when the funds will be captured from the customer's + account. + enum: + - manual + type: string + setup_future_usage: + description: >- + Indicates that you intend to make future payments with this + PaymentIntent's payment method. + + + Providing this parameter will [attach the payment + method](https://stripe.com/docs/payments/save-during-payment) to the + PaymentIntent's Customer, if present, after the PaymentIntent is + confirmed and any required actions from the user are complete. If no + Customer was provided, the payment method can still be + [attached](https://stripe.com/docs/api/payment_methods/attach) to a + Customer after the transaction completes. + + + When processing card payments, Stripe also uses `setup_future_usage` + to dynamically optimize your payment flow and comply with regional + legislation and network rules, such as + [SCA](https://stripe.com/docs/strong-customer-authentication). + enum: + - none + - off_session + type: string title: payment_method_options_revolut_pay type: object x-expandableFields: [] @@ -26366,6 +29987,18 @@ components: title: payment_method_options_sofort type: object x-expandableFields: [] + payment_method_options_us_bank_account_mandate_options: + description: '' + properties: + collection_method: + description: Mandate collection method + enum: + - paper + type: string + x-stripeBypassValidation: true + title: payment_method_options_us_bank_account_mandate_options + type: object + x-expandableFields: [] payment_method_options_wechat_pay: description: '' properties: @@ -26474,6 +30107,7 @@ components: - santander_przelew24 - tmobile_usbugi_bankowe - toyota_bank + - velobank - volkswagen_bank nullable: true type: string @@ -26581,6 +30215,12 @@ components: title: payment_method_sofort type: object x-expandableFields: [] + payment_method_swish: + description: '' + properties: {} + title: payment_method_swish + type: object + x-expandableFields: [] payment_method_us_bank_account: description: '' properties: @@ -26759,6 +30399,15 @@ components: enabled: description: Indicates whether automatic tax is enabled for the session type: boolean + liability: + anyOf: + - $ref: '#/components/schemas/connect_account_reference' + 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. + nullable: true status: description: >- The status of the most recent automated tax calculation for this @@ -26773,7 +30422,8 @@ components: - enabled title: PaymentPagesCheckoutSessionAutomaticTax type: object - x-expandableFields: [] + x-expandableFields: + - liability payment_pages_checkout_session_consent: description: '' properties: @@ -26803,6 +30453,14 @@ components: payment_pages_checkout_session_consent_collection: description: '' properties: + payment_method_reuse_agreement: + anyOf: + - $ref: >- + #/components/schemas/payment_pages_checkout_session_payment_method_reuse_agreement + description: >- + If set to `hidden`, it will hide legal text related to the reuse of + a payment method. + nullable: true promotions: description: >- If set to `auto`, enables the collection of customer consent for @@ -26829,7 +30487,8 @@ components: type: string title: PaymentPagesCheckoutSessionConsentCollection type: object - x-expandableFields: [] + x-expandableFields: + - payment_method_reuse_agreement payment_pages_checkout_session_currency_conversion: description: '' properties: @@ -27015,6 +30674,14 @@ components: payment_pages_checkout_session_custom_text: description: '' properties: + after_submit: + anyOf: + - $ref: >- + #/components/schemas/payment_pages_checkout_session_custom_text_position + description: >- + Custom text that should be displayed after the payment confirmation + button. + nullable: true shipping_address: anyOf: - $ref: >- @@ -27042,6 +30709,7 @@ components: title: PaymentPagesCheckoutSessionCustomText type: object x-expandableFields: + - after_submit - shipping_address - submit - terms_of_service_acceptance @@ -27163,6 +30831,14 @@ components: maxLength: 5000 nullable: true type: string + issuer: + anyOf: + - $ref: '#/components/schemas/connect_account_reference' + description: >- + The connected account that issues the invoice. The invoice is + presented with the branding and support information of the specified + account. + nullable: true metadata: additionalProperties: maxLength: 500 @@ -27183,7 +30859,29 @@ components: x-expandableFields: - account_tax_ids - custom_fields + - issuer - rendering_options + payment_pages_checkout_session_payment_method_reuse_agreement: + description: '' + properties: + position: + description: >- + Determines the position and visibility of the payment method reuse + agreement in the UI. When set to `auto`, Stripe's defaults will be + used. + + + When set to `hidden`, the payment method reuse agreement text will + always be hidden in the UI. + enum: + - auto + - hidden + type: string + required: + - position + title: PaymentPagesCheckoutSessionPaymentMethodReuseAgreement + type: object + x-expandableFields: [] payment_pages_checkout_session_phone_number_collection: description: '' properties: @@ -27195,6 +30893,34 @@ components: title: PaymentPagesCheckoutSessionPhoneNumberCollection type: object x-expandableFields: [] + payment_pages_checkout_session_saved_payment_method_options: + description: '' + properties: + allow_redisplay_filters: + description: >- + Controls which payment methods are eligible to be redisplayed to + returning customers. Corresponds to `allow_redisplay` on the payment + method. + items: + enum: + - always + - limited + - unspecified + type: string + nullable: true + type: array + payment_method_save: + description: >- + Enable customers to choose if they wish to save their payment method + for future use. + enum: + - disabled + - enabled + nullable: true + type: string + title: PaymentPagesCheckoutSessionSavedPaymentMethodOptions + type: object + x-expandableFields: [] payment_pages_checkout_session_shipping_address_collection: description: '' properties: @@ -27520,14 +31246,15 @@ components: `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `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`, `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`, `my_itn`, - `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, + `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`, + `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`, or `unknown` + `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, or + `unknown` enum: - ad_nrt - ae_trn @@ -27535,6 +31262,7 @@ components: - au_abn - au_arn - bg_uic + - bh_vat - bo_tin - br_cnpj - br_cpf @@ -27568,13 +31296,17 @@ components: - jp_trn - ke_pin - kr_brn + - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst + - ng_tin - no_vat + - no_voec - nz_gst + - om_vat - pe_ruc - ph_tin - ro_tin @@ -27961,19 +31693,17 @@ components: account. - A platform cannot access a Standard or Express account's persons after - the account starts onboarding, such as after generating an account link - for the account. - - See the [Standard - onboarding](https://stripe.com/docs/connect/standard-accounts) or - [Express onboarding - documentation](https://stripe.com/docs/connect/express-accounts) for - information about platform prefilling and account onboarding steps. + A platform cannot access a person for an account where + [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `stripe`, which includes Standard and Express accounts, after + creating an Account Link or Account Session to start Connect onboarding. - Related guide: [Handling identity verification with the - API](https://stripe.com/docs/connect/handling-api-verification#person-information) + See the [Standard onboarding](/connect/standard-accounts) or [Express + onboarding](/connect/express-accounts) documentation for information + about prefilling information and account onboarding steps. Learn more + about [handling identity verification with the + API](/connect/handling-api-verification#person-information). properties: account: description: The account the person is associated with. @@ -28230,10 +31960,12 @@ components: type: array pending_verification: description: >- - Fields that may become required depending on the results of - verification or review. Will be an empty array unless an - asynchronous verification is pending. If verification fails, these - fields move to `eventually_due` or `currently_due`. + Fields that might become required depending on the results of + verification or review. It's an empty array unless an asynchronous + verification is pending. If verification fails, these fields move to + `eventually_due` or `currently_due`. Fields might appear in + `eventually_due` or `currently_due` and in `pending_verification` if + verification fails but another verification is still pending. items: maxLength: 5000 type: string @@ -28344,10 +32076,13 @@ components: type: array pending_verification: description: >- - Fields that may become required depending on the results of - verification or review. Will be an empty array unless an - asynchronous verification is pending. If verification fails, these - fields move to `eventually_due`, `currently_due`, or `past_due`. + Fields that might become required depending on the results of + verification or review. It's an empty array unless an asynchronous + verification is pending. If verification fails, these fields move to + `eventually_due`, `currently_due`, or `past_due`. Fields might + appear in `eventually_due`, `currently_due`, or `past_due` and in + `pending_verification` if verification fails but another + verification is still pending. items: maxLength: 5000 type: string @@ -28484,6 +32219,11 @@ components: additional information about the object in a structured format. nullable: true type: object + meter: + description: The meter tracking the usage of a metered price + maxLength: 5000 + nullable: true + type: string nickname: description: 'A brief description of the plan, hidden from customers.' maxLength: 5000 @@ -28695,8 +32435,6 @@ components: $ref: '#/components/schemas/portal_payment_method_update' subscription_cancel: $ref: '#/components/schemas/portal_subscription_cancel' - subscription_pause: - $ref: '#/components/schemas/portal_subscription_pause' subscription_update: $ref: '#/components/schemas/portal_subscription_update' required: @@ -28704,7 +32442,6 @@ components: - invoice_history - payment_method_update - subscription_cancel - - subscription_pause - subscription_update title: PortalFeatures type: object @@ -28713,7 +32450,6 @@ components: - invoice_history - payment_method_update - subscription_cancel - - subscription_pause - subscription_update portal_flows_after_completion_hosted_confirmation: description: '' @@ -29054,17 +32790,6 @@ components: title: PortalSubscriptionCancellationReason type: object x-expandableFields: [] - portal_subscription_pause: - description: '' - properties: - enabled: - description: Whether the feature is enabled. - type: boolean - required: - - enabled - title: PortalSubscriptionPause - type: object - x-expandableFields: [] portal_subscription_update: description: '' properties: @@ -29093,7 +32818,8 @@ components: description: >- Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and - `always_invoice`. + `always_invoice`. Defaults to a value of `none` if you don't set it + during creation. enum: - always_invoice - create_prorations @@ -29420,14 +33146,6 @@ components: maxLength: 5000 nullable: true type: string - features: - description: >- - A list of up to 15 features for this product. These are displayed in - [pricing - tables](https://stripe.com/docs/payments/checkout/pricing-table). - items: - $ref: '#/components/schemas/product_feature' - type: array id: description: Unique identifier for the object. maxLength: 5000 @@ -29445,6 +33163,14 @@ components: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean + marketing_features: + description: >- + A list of up to 15 marketing features for this product. These are + displayed in [pricing + tables](https://stripe.com/docs/payments/checkout/pricing-table). + items: + $ref: '#/components/schemas/product_marketing_feature' + type: array metadata: additionalProperties: maxLength: 500 @@ -29514,10 +33240,10 @@ components: required: - active - created - - features - id - images - livemode + - marketing_features - metadata - name - object @@ -29526,18 +33252,54 @@ components: type: object x-expandableFields: - default_price - - features + - marketing_features - package_dimensions - tax_code x-resourceId: product product_feature: + description: >- + A product_feature represents an attachment between a feature and a + product. + + When a product is purchased that has a feature attached, Stripe will + create an entitlement to the feature for the purchasing customer. + properties: + entitlement_feature: + $ref: '#/components/schemas/entitlements.feature' + id: + description: Unique identifier for the object. + maxLength: 5000 + type: string + livemode: + description: >- + Has the value `true` if the object exists in live mode or the value + `false` if the object exists in test mode. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same type + share the same value. + enum: + - product_feature + type: string + required: + - entitlement_feature + - id + - livemode + - object + title: ProductFeature + type: object + x-expandableFields: + - entitlement_feature + x-resourceId: product_feature + product_marketing_feature: description: '' properties: name: - description: The feature's name. Up to 80 characters long. + description: The marketing feature name. Up to 80 characters long. maxLength: 5000 type: string - title: ProductFeature + title: ProductMarketingFeature type: object x-expandableFields: [] promotion_code: @@ -29841,10 +33603,7 @@ components: - $ref: '#/components/schemas/invoice' - $ref: '#/components/schemas/deleted_invoice' invoice_settings: - anyOf: - - $ref: '#/components/schemas/invoice_setting_quote_setting' - description: All invoices will be billed using the specified settings. - nullable: true + $ref: '#/components/schemas/invoice_setting_quote_setting' line_items: description: A list of items the customer is being quoted for. properties: @@ -29986,6 +33745,7 @@ components: - discounts - expires_at - id + - invoice_settings - livemode - metadata - object @@ -30021,6 +33781,15 @@ components: enabled: description: Automatically calculate taxes type: boolean + liability: + anyOf: + - $ref: '#/components/schemas/connect_account_reference' + 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. + nullable: true status: description: >- The status of the most recent automated tax calculation for this @@ -30035,7 +33804,8 @@ components: - enabled title: QuotesResourceAutomaticTax type: object - x-expandableFields: [] + x-expandableFields: + - liability quotes_resource_computed: description: '' properties: @@ -30684,12 +34454,7 @@ components: aggregate_usage: description: >- Specifies a usage aggregation strategy for prices of - `usage_type=metered`. Allowed values are `sum` for summing up all - usage during a period, `last_during_period` for using the last usage - record reported within a period, `last_ever` for using the last - usage record ever (across period bounds) or `max` which uses the - usage record with the maximum reported usage during a period. - Defaults to `sum`. + `usage_type=metered`. Defaults to `sum`. enum: - last_during_period - last_ever @@ -30713,6 +34478,11 @@ components: between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. type: integer + meter: + description: The meter tracking the usage of a metered price + maxLength: 5000 + nullable: true + type: string usage_type: description: >- Configures how the quantity per period should be determined. Can be @@ -30787,6 +34557,8 @@ components: displaying to users (available on non-card refunds only). maxLength: 5000 type: string + destination_details: + $ref: '#/components/schemas/refund_destination_details' failure_balance_transaction: anyOf: - maxLength: 5000 @@ -30881,10 +34653,8 @@ components: - $ref: '#/components/schemas/transfer_reversal' status: description: >- - Status of the refund. For credit card refunds, this can be - `pending`, `succeeded`, or `failed`. For other types of refunds, it - can be `pending`, `requires_action`, `succeeded`, `failed`, or - `canceled`. Learn more about [failed + Status of the refund. This can be `pending`, `requires_action`, + `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds). maxLength: 5000 nullable: true @@ -30913,12 +34683,163 @@ components: x-expandableFields: - balance_transaction - charge + - destination_details - failure_balance_transaction - next_action - payment_intent - source_transfer_reversal - transfer_reversal x-resourceId: refund + refund_destination_details: + description: '' + properties: + affirm: + $ref: '#/components/schemas/destination_details_unimplemented' + afterpay_clearpay: + $ref: '#/components/schemas/destination_details_unimplemented' + alipay: + $ref: '#/components/schemas/destination_details_unimplemented' + amazon_pay: + $ref: '#/components/schemas/destination_details_unimplemented' + au_bank_transfer: + $ref: '#/components/schemas/destination_details_unimplemented' + blik: + $ref: '#/components/schemas/refund_destination_details_generic' + br_bank_transfer: + $ref: '#/components/schemas/refund_destination_details_generic' + card: + $ref: '#/components/schemas/refund_destination_details_card' + cashapp: + $ref: '#/components/schemas/destination_details_unimplemented' + customer_cash_balance: + $ref: '#/components/schemas/destination_details_unimplemented' + eps: + $ref: '#/components/schemas/destination_details_unimplemented' + eu_bank_transfer: + $ref: '#/components/schemas/refund_destination_details_generic' + gb_bank_transfer: + $ref: '#/components/schemas/refund_destination_details_generic' + giropay: + $ref: '#/components/schemas/destination_details_unimplemented' + grabpay: + $ref: '#/components/schemas/destination_details_unimplemented' + jp_bank_transfer: + $ref: '#/components/schemas/refund_destination_details_generic' + klarna: + $ref: '#/components/schemas/destination_details_unimplemented' + mx_bank_transfer: + $ref: '#/components/schemas/refund_destination_details_generic' + p24: + $ref: '#/components/schemas/refund_destination_details_generic' + paynow: + $ref: '#/components/schemas/destination_details_unimplemented' + paypal: + $ref: '#/components/schemas/destination_details_unimplemented' + pix: + $ref: '#/components/schemas/destination_details_unimplemented' + revolut: + $ref: '#/components/schemas/destination_details_unimplemented' + sofort: + $ref: '#/components/schemas/destination_details_unimplemented' + swish: + $ref: '#/components/schemas/refund_destination_details_generic' + th_bank_transfer: + $ref: '#/components/schemas/refund_destination_details_generic' + type: + description: >- + The type of transaction-specific details of the payment method used + in the refund (e.g., `card`). An additional hash is included on + `destination_details` with a name matching this value. It contains + information specific to the refund transaction. + maxLength: 5000 + type: string + us_bank_transfer: + $ref: '#/components/schemas/refund_destination_details_generic' + wechat_pay: + $ref: '#/components/schemas/destination_details_unimplemented' + zip: + $ref: '#/components/schemas/destination_details_unimplemented' + required: + - type + title: refund_destination_details + type: object + x-expandableFields: + - affirm + - afterpay_clearpay + - alipay + - amazon_pay + - au_bank_transfer + - blik + - br_bank_transfer + - card + - cashapp + - customer_cash_balance + - eps + - eu_bank_transfer + - gb_bank_transfer + - giropay + - grabpay + - jp_bank_transfer + - klarna + - mx_bank_transfer + - p24 + - paynow + - paypal + - pix + - revolut + - sofort + - swish + - th_bank_transfer + - us_bank_transfer + - wechat_pay + - zip + refund_destination_details_card: + description: '' + properties: + reference: + description: Value of the reference number assigned to the refund. + maxLength: 5000 + type: string + reference_status: + description: >- + Status of the reference number on the refund. This can be `pending`, + `available` or `unavailable`. + maxLength: 5000 + type: string + reference_type: + description: Type of the reference number assigned to the refund. + maxLength: 5000 + type: string + type: + description: 'The type of refund. This can be `refund`, `reversal`, or `pending`.' + enum: + - pending + - refund + - reversal + type: string + required: + - type + title: refund_destination_details_card + type: object + x-expandableFields: [] + refund_destination_details_generic: + description: '' + properties: + reference: + description: The reference assigned to the refund. + maxLength: 5000 + nullable: true + type: string + reference_status: + description: >- + Status of the reference on the refund. This can be `pending`, + `available` or `unavailable`. + maxLength: 5000 + nullable: true + type: string + title: refund_destination_details_generic + type: object + x-expandableFields: [] refund_next_action: description: '' properties: @@ -31418,11 +35339,21 @@ components: Whether Stripe automatically computes tax on invoices created during this phase. type: boolean + liability: + anyOf: + - $ref: '#/components/schemas/connect_account_reference' + 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. + nullable: true required: - enabled title: SchedulesPhaseAutomaticTax type: object - x-expandableFields: [] + x-expandableFields: + - liability secret_service_resource_scope: description: '' properties: @@ -31638,6 +35569,8 @@ components: properties: acss_debit: $ref: '#/components/schemas/setup_attempt_payment_method_details_acss_debit' + amazon_pay: + $ref: '#/components/schemas/setup_attempt_payment_method_details_amazon_pay' au_becs_debit: $ref: >- #/components/schemas/setup_attempt_payment_method_details_au_becs_debit @@ -31662,6 +35595,9 @@ components: $ref: '#/components/schemas/setup_attempt_payment_method_details_link' paypal: $ref: '#/components/schemas/setup_attempt_payment_method_details_paypal' + revolut_pay: + $ref: >- + #/components/schemas/setup_attempt_payment_method_details_revolut_pay sepa_debit: $ref: '#/components/schemas/setup_attempt_payment_method_details_sepa_debit' sofort: @@ -31683,6 +35619,7 @@ components: type: object x-expandableFields: - acss_debit + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -31694,6 +35631,7 @@ components: - klarna - link - paypal + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -31703,6 +35641,12 @@ components: title: setup_attempt_payment_method_details_acss_debit type: object x-expandableFields: [] + setup_attempt_payment_method_details_amazon_pay: + description: '' + properties: {} + title: setup_attempt_payment_method_details_amazon_pay + type: object + x-expandableFields: [] setup_attempt_payment_method_details_au_becs_debit: description: '' properties: {} @@ -31927,10 +35871,16 @@ components: x-expansionResources: oneOf: - $ref: '#/components/schemas/payment_method' + offline: + anyOf: + - $ref: '#/components/schemas/payment_method_details_card_present_offline' + description: Details about payments collected offline. + nullable: true title: setup_attempt_payment_method_details_card_present type: object x-expandableFields: - generated_card + - offline setup_attempt_payment_method_details_card_wallet: description: '' properties: @@ -31968,7 +35918,7 @@ components: bank: description: >- The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, - `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, + `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`. enum: @@ -31980,6 +35930,7 @@ components: - knab - moneyou - n26 + - nn - rabobank - regiobank - revolut @@ -32001,6 +35952,7 @@ components: - INGBNL2A - KNABNL2H - MOYONL21 + - NNBANL2G - NTSBDEB1 - RABONL2U - RBRBNL21 @@ -32072,6 +36024,12 @@ components: title: setup_attempt_payment_method_details_paypal type: object x-expandableFields: [] + setup_attempt_payment_method_details_revolut_pay: + description: '' + properties: {} + title: setup_attempt_payment_method_details_revolut_pay + type: object + x-expandableFields: [] setup_attempt_payment_method_details_sepa_debit: description: '' properties: {} @@ -32179,7 +36137,7 @@ components: not be valid. The SetupIntent transitions through multiple - [statuses](https://stripe.com/docs/payments/intents#intent-statuses) as + [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides you through the setup process. @@ -32189,15 +36147,15 @@ components: for future payments. For example, cardholders in [certain - regions](/guides/strong-customer-authentication) might need to be run - through + regions](https://stripe.com/guides/strong-customer-authentication) might + need to be run through [Strong Customer - Authentication](https://stripe.com/docs/strong-customer-authentication) + Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection to streamline later [off-session - payments](https://stripe.com/docs/payments/setup-intents). + payments](https://docs.stripe.com/payments/setup-intents). If you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), @@ -32218,7 +36176,7 @@ components: Related guide: [Setup Intents - API](https://stripe.com/docs/payments/setup-intents) + API](https://docs.stripe.com/payments/setup-intents) properties: application: anyOf: @@ -32568,8 +36526,20 @@ components: #/components/schemas/setup_intent_payment_method_options_acss_debit - $ref: >- #/components/schemas/setup_intent_type_specific_payment_method_options_client + amazon_pay: + anyOf: + - $ref: >- + #/components/schemas/setup_intent_payment_method_options_amazon_pay + - $ref: >- + #/components/schemas/setup_intent_type_specific_payment_method_options_client card: $ref: '#/components/schemas/setup_intent_payment_method_options_card' + card_present: + anyOf: + - $ref: >- + #/components/schemas/setup_intent_payment_method_options_card_present + - $ref: >- + #/components/schemas/setup_intent_type_specific_payment_method_options_client link: anyOf: - $ref: '#/components/schemas/setup_intent_payment_method_options_link' @@ -32596,7 +36566,9 @@ components: type: object x-expandableFields: - acss_debit + - amazon_pay - card + - card_present - link - paypal - sepa_debit @@ -32626,6 +36598,12 @@ components: type: object x-expandableFields: - mandate_options + setup_intent_payment_method_options_amazon_pay: + description: '' + properties: {} + title: setup_intent_payment_method_options_amazon_pay + type: object + x-expandableFields: [] setup_intent_payment_method_options_card: description: '' properties: @@ -32663,18 +36641,18 @@ components: level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your - own fraud engine, provide this option. Permitted values include: - `automatic` or `any`. If not provided, defaults to `automatic`. Read - our guide on [manually requesting 3D - Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) + own fraud engine, provide this option. If not provided, this value + defaults to `automatic`. Read our guide on [manually requesting 3D + Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. enum: - any - automatic - - challenge_only + - challenge nullable: true type: string + x-stripeBypassValidation: true title: setup_intent_payment_method_options_card type: object x-expandableFields: @@ -32767,6 +36745,12 @@ components: title: setup_intent_payment_method_options_card_mandate_options type: object x-expandableFields: [] + setup_intent_payment_method_options_card_present: + description: '' + properties: {} + title: setup_intent_payment_method_options_card_present + type: object + x-expandableFields: [] setup_intent_payment_method_options_link: description: '' properties: {} @@ -32850,6 +36834,9 @@ components: properties: financial_connections: $ref: '#/components/schemas/linked_account_options_us_bank_account' + mandate_options: + $ref: >- + #/components/schemas/payment_method_options_us_bank_account_mandate_options verification_method: description: Bank account verification method. enum: @@ -32862,6 +36849,7 @@ components: type: object x-expandableFields: - financial_connections + - mandate_options setup_intent_type_specific_payment_method_options_client: description: '' properties: @@ -34436,11 +38424,19 @@ components: $ref: '#/components/schemas/subscription_automatic_tax' billing_cycle_anchor: description: >- - Determines the date of the first full invoice, and, for plans with - `month` or `year` intervals, the day of the month for subsequent - invoices. The timestamp is in UTC format. + The reference point that aligns future [billing + cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. + It sets the day of week for `week` intervals, the day of month for + `month` and `year` intervals, and the month of year for `year` + intervals. The timestamp is in UTC format. format: unix-time type: integer + billing_cycle_anchor_config: + anyOf: + - $ref: >- + #/components/schemas/subscriptions_resource_billing_cycle_anchor_config + description: The fixed values used to calculate the `billing_cycle_anchor`. + nullable: true billing_thresholds: anyOf: - $ref: '#/components/schemas/subscription_billing_thresholds' @@ -34596,8 +38592,24 @@ components: description: >- Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription - overrides a discount applied on a customer-wide basis. + overrides a discount applied on a customer-wide basis. This field + has been deprecated and will be removed in a future API version. Use + `discounts` instead. nullable: true + discounts: + description: >- + The discounts applied to the subscription. Subscription item + discounts are applied before subscription discounts. Use + `expand[]=discounts` to expand each discount. + items: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/discount' + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/discount' + type: array ended_at: description: 'If the subscription has ended, the date the subscription ended.' format: unix-time @@ -34697,7 +38709,9 @@ components: - $ref: '#/components/schemas/subscriptions_resource_pause_collection' description: >- If specified, payment collection for this subscription will be - paused. + paused. Note that the subscription status will be unchanged and will + not be updated to `paused`. Learn more about [pausing + collection](/billing/subscriptions/pause-payment). nullable: true payment_settings: anyOf: @@ -34757,23 +38771,33 @@ components: status: description: >- Possible values are `incomplete`, `incomplete_expired`, `trialing`, - `active`, `past_due`, `canceled`, or `unpaid`. + `active`, `past_due`, `canceled`, `unpaid`, or `paused`. For `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A - subscription in this state can only have metadata and default_source - updated. Once the first invoice is paid, the subscription moves into - an `active` state. If the first invoice is not paid within 23 hours, - the subscription transitions to `incomplete_expired`. This is a - terminal state, the open invoice will be voided and no further - invoices will be generated. + subscription in this status can only have metadata and + default_source updated. Once the first invoice is paid, the + subscription moves into an `active` status. If the first invoice is + not paid within 23 hours, the subscription transitions to + `incomplete_expired`. This is a terminal status, the open invoice + will be voided and no further invoices will be generated. A subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. + A subscription can only enter a `paused` status [when a trial ends + without a payment + method](/billing/subscriptions/trials#create-free-trials-without-payment). + A `paused` subscription doesn't generate invoices and can be resumed + after your customer adds their payment method. The `paused` status + is different from [pausing + collection](/billing/subscriptions/pause-payment), which still + generates invoices and leaves the subscription's status unchanged. + + If subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has @@ -34843,6 +38867,7 @@ components: - current_period_end - current_period_start - customer + - discounts - id - items - livemode @@ -34855,6 +38880,7 @@ components: x-expandableFields: - application - automatic_tax + - billing_cycle_anchor_config - billing_thresholds - cancellation_details - customer @@ -34862,6 +38888,7 @@ components: - default_source - default_tax_rates - discount + - discounts - items - latest_invoice - on_behalf_of @@ -34881,11 +38908,21 @@ components: enabled: description: Whether Stripe automatically computes tax on this subscription. type: boolean + liability: + anyOf: + - $ref: '#/components/schemas/connect_account_reference' + 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. + nullable: true required: - enabled title: SubscriptionAutomaticTax type: object - x-expandableFields: [] + x-expandableFields: + - liability subscription_billing_thresholds: description: '' properties: @@ -34916,10 +38953,11 @@ components: maxLength: 500 type: string description: >- - Set of [key-value pairs](https://stripe.com/docs/api/metadata) that - will reflect the metadata of the subscription at the time of invoice - creation. *Note: This attribute is populated only for invoices - created on or after June 29, 2023.* + Set of [key-value pairs](https://stripe.com/docs/api/metadata) + defined as subscription metadata when an invoice is created. Becomes + an immutable snapshot of the subscription metadata at the time of + invoice finalization. + *Note: This attribute is populated only for invoices created on or after June 29, 2023.* nullable: true type: object title: SubscriptionDetailsData @@ -34944,6 +38982,20 @@ components: Time at which the object was created. Measured in seconds since the Unix epoch. type: integer + discounts: + description: >- + The discounts applied to the subscription item. Subscription item + discounts are applied before subscription discounts. Use + `expand[]=discounts` to expand each discount. + items: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/discount' + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/discount' + type: array id: description: Unique identifier for the object. maxLength: 5000 @@ -34986,6 +39038,7 @@ components: type: array required: - created + - discounts - id - metadata - object @@ -34995,6 +39048,7 @@ components: type: object x-expandableFields: - billing_thresholds + - discounts - price - tax_rates x-resourceId: subscription_item @@ -35041,12 +39095,13 @@ components: However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D - Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) + Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine. enum: - any - automatic + - challenge nullable: true type: string title: subscription_payment_method_options_card @@ -35146,7 +39201,7 @@ components: Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription - schedule and keep the underlying subscription running.`cancel` will + schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. enum: @@ -35259,6 +39314,11 @@ components: An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase. properties: + discounts: + description: The stackable discounts that will be applied to the item. + items: + $ref: '#/components/schemas/discounts_resource_stackable_discount' + type: array price: anyOf: - maxLength: 5000 @@ -35283,10 +39343,12 @@ components: nullable: true type: array required: + - discounts - price title: SubscriptionScheduleAddInvoiceItem type: object x-expandableFields: + - discounts - price - tax_rates subscription_schedule_configuration_item: @@ -35299,6 +39361,14 @@ components: Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period nullable: true + discounts: + description: >- + The discounts applied to the subscription item. Subscription item + discounts are applied before subscription discounts. Use + `expand[]=discounts` to expand each discount. + items: + $ref: '#/components/schemas/discounts_resource_stackable_discount' + type: array metadata: additionalProperties: maxLength: 500 @@ -35332,11 +39402,13 @@ components: nullable: true type: array required: + - discounts - price title: SubscriptionScheduleConfigurationItem type: object x-expandableFields: - billing_thresholds + - discounts - price - tax_rates subscription_schedule_current_phase: @@ -35463,6 +39535,14 @@ components: maxLength: 5000 nullable: true type: string + discounts: + description: >- + The stackable discounts that will be applied to the subscription on + this phase. Subscription item discounts are applied before + subscription discounts. + items: + $ref: '#/components/schemas/discounts_resource_stackable_discount' + type: array end_date: description: The end of this phase of the subscription schedule. format: unix-time @@ -35534,6 +39614,7 @@ components: required: - add_invoice_items - currency + - discounts - end_date - items - proration_behavior @@ -35547,6 +39628,7 @@ components: - coupon - default_payment_method - default_tax_rates + - discounts - invoice_settings - items - on_behalf_of @@ -35620,11 +39702,7 @@ components: nullable: true type: string invoice_settings: - anyOf: - - $ref: >- - #/components/schemas/invoice_setting_subscription_schedule_setting - description: The subscription schedule's default invoice settings. - nullable: true + $ref: '#/components/schemas/invoice_setting_subscription_schedule_setting' on_behalf_of: anyOf: - maxLength: 5000 @@ -35648,6 +39726,7 @@ components: nullable: true required: - billing_cycle_anchor + - invoice_settings title: SubscriptionSchedulesResourceDefaultSettings type: object x-expandableFields: @@ -35665,11 +39744,21 @@ components: Whether Stripe automatically computes tax on invoices created during this phase. type: boolean + liability: + anyOf: + - $ref: '#/components/schemas/connect_account_reference' + 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. + nullable: true required: - enabled title: SubscriptionSchedulesResourceDefaultSettingsAutomaticTax type: object - x-expandableFields: [] + x-expandableFields: + - liability subscription_transfer_data: description: '' properties: @@ -35698,6 +39787,33 @@ components: type: object x-expandableFields: - destination + subscriptions_resource_billing_cycle_anchor_config: + description: '' + properties: + day_of_month: + description: The day of the month of the billing_cycle_anchor. + type: integer + hour: + description: The hour of the day of the billing_cycle_anchor. + nullable: true + type: integer + minute: + description: The minute of the hour of the billing_cycle_anchor. + nullable: true + type: integer + month: + description: The month to start full cycle billing periods. + nullable: true + type: integer + second: + description: The second of the minute of the billing_cycle_anchor. + nullable: true + type: integer + required: + - day_of_month + title: SubscriptionsResourceBillingCycleAnchorConfig + type: object + x-expandableFields: [] subscriptions_resource_pause_collection: description: >- The Pause Collection settings determine how we will pause collection for @@ -35766,6 +39882,13 @@ components: This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription. nullable: true + sepa_debit: + anyOf: + - $ref: '#/components/schemas/invoice_payment_method_options_sepa_debit' + description: >- + This sub-hash contains details about the SEPA Direct Debit payment + method options to pass to invoices created by the subscription. + nullable: true us_bank_account: anyOf: - $ref: >- @@ -35782,6 +39905,7 @@ components: - card - customer_balance - konbini + - sepa_debit - us_bank_account subscriptions_resource_payment_settings: description: '' @@ -35807,6 +39931,7 @@ components: - ach_credit_transfer - ach_debit - acss_debit + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -35814,15 +39939,18 @@ components: - card - cashapp - customer_balance + - eps - fpx - giropay - grabpay - ideal - konbini - link + - p24 - paynow - paypal - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -36013,6 +40141,11 @@ components: enum: - tax.calculation type: string + ship_from_details: + anyOf: + - $ref: '#/components/schemas/tax_product_resource_ship_from_details' + description: 'The details of the ship from location, such as the address.' + nullable: true shipping_cost: anyOf: - $ref: >- @@ -36051,6 +40184,7 @@ components: x-expandableFields: - customer_details - line_items + - ship_from_details - shipping_cost - tax_breakdown x-resourceId: tax.calculation @@ -36059,12 +40193,15 @@ components: properties: amount: description: >- - The line item amount in integer cents. If `tax_behavior=inclusive`, - then this amount includes taxes. Otherwise, taxes were calculated on - top of this amount. + The line item amount in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). If + `tax_behavior=inclusive`, then this amount includes taxes. + Otherwise, taxes were calculated on top of this amount. type: integer amount_tax: - description: 'The amount of tax calculated for this line item, in integer cents.' + description: >- + The amount of tax calculated for this line item, in the [smallest + currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer id: description: Unique identifier for the object. @@ -36375,6 +40512,11 @@ components: #/components/schemas/tax_product_resource_tax_transaction_resource_reversal description: 'If `type=reversal`, contains information about what was reversed.' nullable: true + ship_from_details: + anyOf: + - $ref: '#/components/schemas/tax_product_resource_ship_from_details' + description: 'The details of the ship from location, such as the address.' + nullable: true shipping_cost: anyOf: - $ref: >- @@ -36409,6 +40551,7 @@ components: - customer_details - line_items - reversal + - ship_from_details - shipping_cost x-resourceId: tax.transaction tax.transaction_line_item: @@ -36416,12 +40559,15 @@ components: properties: amount: description: >- - The line item amount in integer cents. If `tax_behavior=inclusive`, - then this amount includes taxes. Otherwise, taxes were calculated on - top of this amount. + The line item amount in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). If + `tax_behavior=inclusive`, then this amount includes taxes. + Otherwise, taxes were calculated on top of this amount. type: integer amount_tax: - description: 'The amount of tax calculated for this line item, in integer cents.' + description: >- + The amount of tax calculated for this line item, in the [smallest + currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer id: description: Unique identifier for the object. @@ -36581,6 +40727,54 @@ components: title: TaxDeductedAtSource type: object x-expandableFields: [] + tax_i_ds_owner: + description: '' + properties: + account: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/account' + description: The account being referenced when `type` is `account`. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/account' + application: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/application' + description: >- + The Connect Application being referenced when `type` is + `application`. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/application' + customer: + anyOf: + - maxLength: 5000 + type: string + - $ref: '#/components/schemas/customer' + description: The customer being referenced when `type` is `customer`. + x-expansionResources: + oneOf: + - $ref: '#/components/schemas/customer' + type: + description: Type of owner referenced. + enum: + - account + - application + - customer + - self + type: string + required: + - type + title: TaxIDsOwner + type: object + x-expandableFields: + - account + - application + - customer tax_id: description: >- You can add one or multiple tax IDs to a @@ -36631,21 +40825,26 @@ components: enum: - tax_id type: string + owner: + anyOf: + - $ref: '#/components/schemas/tax_i_ds_owner' + description: The account or customer the tax ID belongs to. + nullable: true type: description: >- Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, - `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, - `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, - `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, - `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, - `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, - `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, - `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, - `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`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, - `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type - `unknown` + `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, + `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, + `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, + `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, + `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, + `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, + `kz_bin`, `li_uid`, `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`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or + `za_vat`. Note that some legacy tax IDs have type `unknown` enum: - ad_nrt - ae_trn @@ -36653,6 +40852,7 @@ components: - au_abn - au_arn - bg_uic + - bh_vat - bo_tin - br_cnpj - br_cpf @@ -36686,13 +40886,17 @@ components: - jp_trn - ke_pin - kr_brn + - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst + - ng_tin - no_vat + - no_voec - nz_gst + - om_vat - pe_ruc - ph_tin - ro_tin @@ -36735,6 +40939,7 @@ components: type: object x-expandableFields: - customer + - owner - verification x-resourceId: tax_id tax_id_verification: @@ -37083,6 +41288,7 @@ components: - state_communications_tax - state_sales_tax type: string + x-stripeBypassValidation: true required: - state - type @@ -37173,14 +41379,15 @@ components: `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `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`, `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`, `my_itn`, - `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, + `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`, + `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`, or `unknown` + `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, or + `unknown` enum: - ad_nrt - ae_trn @@ -37188,6 +41395,7 @@ components: - au_abn - au_arn - bg_uic + - bh_vat - bo_tin - br_cnpj - br_cpf @@ -37221,13 +41429,17 @@ components: - jp_trn - ke_pin - kr_brn + - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst + - ng_tin - no_vat + - no_voec - nz_gst + - om_vat - pe_ruc - ph_tin - ro_tin @@ -37301,7 +41513,9 @@ components: description: '' properties: amount: - description: 'The amount of tax, in integer cents.' + description: >- + The amount of tax, in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). type: integer jurisdiction: $ref: '#/components/schemas/tax_product_resource_jurisdiction' @@ -37345,7 +41559,9 @@ components: - zero_rated type: string taxable_amount: - description: 'The amount on which tax is calculated, in integer cents.' + description: >- + The amount on which tax is calculated, in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). type: integer required: - amount @@ -37390,6 +41606,7 @@ components: - sales_tax - vat type: string + x-stripeBypassValidation: true required: - display_name - percentage_decimal @@ -37439,11 +41656,24 @@ components: title: TaxProductResourcePostalAddress type: object x-expandableFields: [] + tax_product_resource_ship_from_details: + description: '' + properties: + address: + $ref: '#/components/schemas/tax_product_resource_postal_address' + required: + - address + title: TaxProductResourceShipFromDetails + type: object + x-expandableFields: + - address tax_product_resource_tax_breakdown: description: '' properties: amount: - description: 'The amount of tax, in integer cents.' + description: >- + The amount of tax, in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). type: integer inclusive: description: >- @@ -37475,7 +41705,9 @@ components: - zero_rated type: string taxable_amount: - description: 'The amount on which tax is calculated, in integer cents.' + description: >- + The amount on which tax is calculated, in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). type: integer required: - amount @@ -37492,12 +41724,15 @@ components: properties: amount: description: >- - The shipping amount in integer cents. If `tax_behavior=inclusive`, - then this amount includes taxes. Otherwise, taxes were calculated on - top of this amount. + The shipping amount in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). If + `tax_behavior=inclusive`, then this amount includes taxes. + Otherwise, taxes were calculated on top of this amount. type: integer amount_tax: - description: 'The amount of tax calculated for shipping, in integer cents.' + description: >- + The amount of tax calculated for shipping, in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). type: integer shipping_rate: description: >- @@ -37571,6 +41806,7 @@ components: - vat nullable: true type: string + x-stripeBypassValidation: true required: - percentage_decimal title: TaxProductResourceTaxRateDetails @@ -37679,12 +41915,15 @@ components: properties: amount: description: >- - The shipping amount in integer cents. If `tax_behavior=inclusive`, - then this amount includes taxes. Otherwise, taxes were calculated on - top of this amount. + The shipping amount in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). If + `tax_behavior=inclusive`, then this amount includes taxes. + Otherwise, taxes were calculated on top of this amount. type: integer amount_tax: - description: 'The amount of tax calculated for shipping, in integer cents.' + description: >- + The amount of tax calculated for shipping, in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal). type: integer shipping_rate: description: >- @@ -37785,6 +42024,19 @@ components: maxLength: 5000 nullable: true type: string + jurisdiction_level: + description: >- + The level of the jurisdiction that imposes this tax rate. Will be + `null` for manually defined tax rates. + enum: + - city + - country + - county + - district + - multiple + - state + nullable: true + type: string livemode: description: >- Has the value `true` if the object exists in live mode or the value @@ -37835,10 +42087,10 @@ components: - qst - rst - sales_tax - - service_tax - vat nullable: true type: string + x-stripeBypassValidation: true required: - active - created @@ -37873,6 +42125,13 @@ components: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode. type: boolean + name: + description: >- + String indicating the name of the Configuration object, set by the + user + maxLength: 5000 + nullable: true + type: string object: description: >- String representing the object's type. Objects of the same type @@ -38015,12 +42274,13 @@ components: device_type: description: >- Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, - `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, or - `simulated_wisepos_e`. + `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, + `simulated_wisepos_e`, or `mobile_phone_reader`. enum: - bbpos_chipper2x - bbpos_wisepad3 - bbpos_wisepos_e + - mobile_phone_reader - simulated_wisepos_e - stripe_m2 - verifone_P400 @@ -38075,7 +42335,9 @@ components: type: string status: description: The networking status of the reader. - maxLength: 5000 + enum: + - offline + - online nullable: true type: string required: @@ -38267,6 +42529,9 @@ components: terminal_reader_reader_resource_process_config: description: Represents a per-transaction override of a reader configuration properties: + enable_customer_cancellation: + description: Enable customer initiated cancellation when processing this payment. + type: boolean skip_tipping: description: Override showing a tipping selection screen on this transaction. type: boolean @@ -38299,7 +42564,12 @@ components: - process_config terminal_reader_reader_resource_process_setup_config: description: Represents a per-setup override of a reader configuration - properties: {} + properties: + enable_customer_cancellation: + description: >- + Enable customer initiated cancellation when processing this + SetupIntent. + type: boolean title: TerminalReaderReaderResourceProcessSetupConfig type: object x-expandableFields: [] @@ -38442,6 +42712,9 @@ components: charge refunded. An application fee can be refunded only by the application that created the charge. type: boolean + refund_payment_config: + $ref: >- + #/components/schemas/terminal_reader_reader_resource_refund_payment_config reverse_transfer: description: >- Boolean indicating whether the transfer should be reversed when @@ -38456,6 +42729,16 @@ components: - charge - payment_intent - refund + - refund_payment_config + terminal_reader_reader_resource_refund_payment_config: + description: Represents a per-transaction override of a reader configuration + properties: + enable_customer_cancellation: + description: Enable customer initiated cancellation when refunding this payment. + type: boolean + title: TerminalReaderReaderResourceRefundPaymentConfig + type: object + x-expandableFields: [] terminal_reader_reader_resource_set_reader_display_action: description: Represents a reader action to set the reader display properties: @@ -38569,6 +42852,19 @@ components: - frictionless nullable: true type: string + electronic_commerce_indicator: + description: |- + The Electronic Commerce Indicator (ECI). A protocol-level field + indicating what degree of authentication was performed. + enum: + - '01' + - '02' + - '05' + - '06' + - '07' + nullable: true + type: string + x-stripeBypassValidation: true result: description: Indicates the outcome of 3D Secure authentication. enum: @@ -38594,6 +42890,13 @@ components: - rejected nullable: true type: string + transaction_id: + description: |- + The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID + (dsTransId) for this payment. + maxLength: 5000 + nullable: true + type: string version: description: The version of 3D Secure that was used. enum: @@ -38620,6 +42923,35 @@ components: - frictionless nullable: true type: string + electronic_commerce_indicator: + description: |- + The Electronic Commerce Indicator (ECI). A protocol-level field + indicating what degree of authentication was performed. + enum: + - '01' + - '02' + - '05' + - '06' + - '07' + nullable: true + type: string + x-stripeBypassValidation: true + exemption_indicator: + description: >- + The exemption requested via 3DS and accepted by the issuer at + authentication time. + enum: + - low_risk + - none + nullable: true + type: string + exemption_indicator_applied: + description: >- + Whether Stripe requested the value of `exemption_indicator` in the + transaction. This will depend on + + the outcome of Stripe's internal risk assessment. + type: boolean result: description: Indicates the outcome of 3D Secure authentication. enum: @@ -38645,6 +42977,13 @@ components: - rejected nullable: true type: string + transaction_id: + description: |- + The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID + (dsTransId) for this payment. + maxLength: 5000 + nullable: true + type: string version: description: The version of 3D Secure that was used. enum: @@ -38713,8 +43052,7 @@ components: information for later use, create [Customer](https://stripe.com/docs/api#customers) - objects or [Custom - accounts](https://stripe.com/docs/api#external_accounts). + objects or [External accounts](/api#external_accounts). [Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection, @@ -38774,6 +43112,20 @@ components: - bank_account - card x-resourceId: token + token_card_networks: + description: '' + properties: + preferred: + description: >- + The preferred network for co-branded cards. Can be + `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if + requested network is not valid for the card. + maxLength: 5000 + nullable: true + type: string + title: token_card_networks + type: object + x-expandableFields: [] topup: description: >- To top up your Stripe balance, you create a top-up object. You can @@ -39170,8 +43522,8 @@ components: reversal. - Related guide: [Reversing - transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reversing-transfers) + Related guide: [Reverse + transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers) properties: amount: description: 'Amount, in cents (or local equivalent).' @@ -41470,6 +45822,13 @@ components: maxLength: 5000 nullable: true type: string + payout: + description: >- + Set if the ReceivedDebit was created due to a + [Payout](https://stripe.com/docs/api#payouts) object. + maxLength: 5000 + nullable: true + type: string title: TreasuryReceivedDebitsResourceLinkedFlows type: object x-expandableFields: [] @@ -41713,6 +46072,11 @@ components: Related guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing) + + + This is our legacy usage-based billing API. See the [updated usage-based + billing + docs](https://docs.stripe.com/billing/subscriptions/usage-based). properties: id: description: Unique identifier for the object. @@ -41815,7 +46179,7 @@ components: x-expandableFields: [] webhook_endpoint: description: >- - You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) + You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be notified about events that happen in your Stripe account or connected @@ -41829,7 +46193,7 @@ components: Related guide: [Setting up - webhooks](https://stripe.com/docs/webhooks/configure) + webhooks](https://docs.stripe.com/webhooks/configure) properties: api_version: description: The API version events are rendered as for this webhook endpoint. @@ -41889,7 +46253,7 @@ components: secret: description: >- The endpoint's secret, used to generate [webhook - signatures](https://stripe.com/docs/webhooks/signatures). Only + signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation. maxLength: 5000 type: string @@ -41938,7 +46302,7 @@ info: details. termsOfService: 'https://stripe.com/us/terms/' title: Stripe API - version: '2023-10-16' + version: '2024-04-10' x-stripeSpecFilename: spec3 openapi: 3.0.0 paths: @@ -41991,6 +46355,9 @@ paths: content: application/x-www-form-urlencoded: encoding: + collection_options: + explode: true + style: deepObject expand: explode: true style: deepObject @@ -42003,13 +46370,31 @@ paths: type: string collect: description: >- - Which information the platform needs to collect from the - user. One of `currently_due` or `eventually_due`. Default is - `currently_due`. + The collect parameter is deprecated. Use + `collection_options` instead. enum: - currently_due - eventually_due type: string + collection_options: + description: >- + Specifies the requirements that Stripe collects from + connected accounts in the Connect Onboarding flow. + properties: + fields: + enum: + - currently_due + - eventually_due + type: string + future_requirements: + enum: + - include + - omit + type: string + required: + - fields + title: collection_options_params + type: object expand: description: Specifies which fields in the response should be expanded. items: @@ -42091,10 +46476,144 @@ paths: and each embedded component maps to its configuration (e.g. whether it has been enabled or not). properties: + account_management: + properties: + enabled: + type: boolean + features: + properties: + external_account_collection: + type: boolean + title: account_features_param + type: object + required: + - enabled + title: account_config_param + type: object account_onboarding: properties: enabled: type: boolean + features: + properties: + external_account_collection: + type: boolean + title: account_features_param + type: object + required: + - enabled + title: account_config_param + type: object + balances: + properties: + enabled: + type: boolean + features: + properties: + edit_payout_schedule: + type: boolean + instant_payouts: + type: boolean + standard_payouts: + type: boolean + title: payouts_features_param + type: object + required: + - enabled + title: payouts_config_param + type: object + documents: + properties: + enabled: + type: boolean + features: + properties: {} + title: base_features_param + type: object + required: + - enabled + title: base_config_param + type: object + notification_banner: + properties: + enabled: + type: boolean + features: + properties: + external_account_collection: + type: boolean + title: account_features_param + type: object + required: + - enabled + title: account_config_param + type: object + payment_details: + properties: + enabled: + type: boolean + features: + properties: + capture_payments: + type: boolean + destination_on_behalf_of_charge_management: + type: boolean + dispute_management: + type: boolean + refund_management: + type: boolean + title: payments_features_param + type: object + required: + - enabled + title: payments_config_param + type: object + payments: + properties: + enabled: + type: boolean + features: + properties: + capture_payments: + type: boolean + destination_on_behalf_of_charge_management: + type: boolean + dispute_management: + type: boolean + refund_management: + type: boolean + title: payments_features_param + type: object + required: + - enabled + title: payments_config_param + type: object + payouts: + properties: + enabled: + type: boolean + features: + properties: + edit_payout_schedule: + type: boolean + instant_payouts: + type: boolean + standard_payouts: + type: boolean + title: payouts_features_param + type: object + required: + - enabled + title: payouts_config_param + type: object + payouts_list: + properties: + enabled: + type: boolean + features: + properties: {} + title: base_features_param + type: object required: - enabled title: base_config_param @@ -42133,7 +46652,10 @@ paths: empty.

operationId: GetAccounts parameters: - - explode: true + - description: >- + Only return connected accounts that were created during the given + date interval. + explode: true in: query name: created required: false @@ -42284,6 +46806,9 @@ paths: company: explode: true style: deepObject + controller: + explode: true + style: deepObject documents: explode: true style: deepObject @@ -42375,6 +46900,23 @@ paths: business_profile: description: Business information about the account. properties: + annual_revenue: + properties: + amount: + type: integer + currency: + type: string + fiscal_year_end: + maxLength: 5000 + type: string + required: + - amount + - currency + - fiscal_year_end + title: annual_revenue_specs + type: object + estimated_worker_count: + type: integer mcc: maxLength: 4 type: string @@ -42433,7 +46975,13 @@ paths: title: business_profile_specs type: object business_type: - description: The business type. + description: >- + The 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. enum: - company - government_entity @@ -42444,11 +46992,24 @@ paths: capabilities: description: >- Each key of the dictionary represents a capability, and each - capability maps to its settings (e.g. whether it has been - requested or not). Each capability will be inactive until - you have provided its specific requirements and Stripe has - verified them. An account may have some of its requested - capabilities be active and some be inactive. + capability + + maps to its settings (for example, whether it has been + requested or not). Each + + capability is inactive until you have provided its specific + + requirements and Stripe has verified them. An account might + have some + + of its requested capabilities be active and some be + inactive. + + + Required when + [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type) + + is `none`, which includes Custom accounts. properties: acss_debit_payments: properties: @@ -42468,6 +47029,12 @@ paths: type: boolean title: capability_param type: object + amazon_pay_payments: + properties: + requested: + type: boolean + title: capability_param + type: object au_becs_debit_payments: properties: requested: @@ -42594,6 +47161,12 @@ paths: type: boolean title: capability_param type: object + mobilepay_payments: + properties: + requested: + type: boolean + title: capability_param + type: object oxxo_payments: properties: requested: @@ -42636,6 +47209,12 @@ paths: type: boolean title: capability_param type: object + swish_payments: + properties: + requested: + type: boolean + title: capability_param + type: object tax_reporting_us_1099_k: properties: requested: @@ -42677,7 +47256,12 @@ paths: company: description: >- Information about the company or business. This field is - available for any `business_type`. + 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. properties: address: properties: @@ -42808,6 +47392,7 @@ paths: - public_company - public_corporation - public_partnership + - registered_charity - single_member_llc - sole_establishment - sole_proprietorship @@ -42842,6 +47427,46 @@ paths: type: object title: company_specs type: object + controller: + description: >- + A hash of configuration describing the account controller's + attributes. + properties: + fees: + properties: + payer: + enum: + - account + - application + type: string + title: controller_fees_specs + type: object + losses: + properties: + payments: + enum: + - application + - stripe + type: string + title: controller_losses_specs + type: object + requirement_collection: + enum: + - application + - stripe + type: string + stripe_dashboard: + properties: + type: + enum: + - express + - full + - none + type: string + title: controller_dashboard_specs + type: object + title: controller_specs + type: object country: description: >- The country in which the account holder resides, or in which @@ -42862,7 +47487,7 @@ paths: 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://stripe.com/docs/payouts). + country](https://docs.stripe.com/payouts). type: string documents: description: >- @@ -42937,8 +47562,10 @@ paths: email: description: >- The email address of the account holder. This is only to - make the account easier to identify to you. Stripe only - emails Custom accounts with your consent. + make the account easier to identify to you. If + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `application`, which includes Custom accounts, Stripe + doesn't email the account without your consent. type: string expand: description: Specifies which fields in the response should be expanded. @@ -42949,22 +47576,24 @@ paths: external_account: description: >- A card or bank account to attach to the account for - receiving - [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) - (you won’t be able to use it for top-ups). You can provide - either a token, like the ones returned by - [Stripe.js](https://stripe.com/docs/js), or a dictionary, as - documented in the `external_account` parameter for [bank - account](https://stripe.com/docs/api#account_create_bank_account) - creation.

By default, providing an external account - sets it as the new default external account for its - currency, and deletes the old default if one exists. To add - additional external accounts without replacing the existing - default for the currency, use the [bank - account](https://stripe.com/docs/api#account_create_bank_account) - or [card - creation](https://stripe.com/docs/api#account_create_card) - APIs. + receiving [payouts](/connect/bank-debit-card-payouts) (you + won’t be able to use it for top-ups). You can provide either + a token, like the ones returned by [Stripe.js](/js), or a + dictionary, as documented in the `external_account` + parameter for [bank + account](/api#account_create_bank_account) creation. +

By default, providing an external account sets it as + the new default external account for its currency, and + deletes the old default if one exists. To add additional + external accounts without replacing the existing default for + the currency, use the [bank + account](/api#account_create_bank_account) or [card + creation](/api#account_create_card) APIs. After 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. maxLength: 5000 type: string x-stripeBypassValidation: true @@ -42972,7 +47601,12 @@ paths: description: >- Information about the person represented by the account. This field is null unless `business_type` is set to - `individual`. + `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. properties: address: properties: @@ -43141,6 +47775,25 @@ paths: type: string title: address_specs type: object + relationship: + properties: + director: + type: boolean + executive: + type: boolean + owner: + type: boolean + percent_ownership: + anyOf: + - type: number + - enum: + - '' + type: string + title: + maxLength: 5000 + type: string + title: individual_relationship_specs + type: object ssn_last_4: maxLength: 5000 type: string @@ -43342,7 +47995,10 @@ paths: tos_acceptance: description: >- Details on the account's acceptance of the [Stripe Services - Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). + Agreement](/connect/updating-accounts#tos-acceptance). 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. properties: date: format: unix-time @@ -43384,14 +48040,18 @@ paths: '/v1/accounts/{account}': delete: description: >- -

With Connect, you can delete accounts you +

With Connect, you can delete accounts you manage.

-

Accounts created using test-mode keys can be deleted at any time. - Standard accounts created using live-mode keys cannot be deleted. Custom - or Express accounts created using live-mode keys can only be deleted - once all balances are zero.

+

Test-mode accounts can be deleted at any time.

+ + +

Live-mode accounts where Stripe is responsible for negative account + balances cannot be deleted, which includes Standard accounts. Live-mode + accounts where your platform is liable for negative account balances, + which includes Custom and Express accounts, can be deleted when all balances are zero.

If you want to delete your own account, use the - -

Updates a connected account by +

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.

-

For Custom accounts, you can update any information on the account. - For other accounts, you can update all information until that +

For accounts where controller.requirement_collection + + is application, which includes Custom accounts, you can + update any information on the account.

+ + +

For accounts where controller.requirement_collection - account has started to go through Connect Onboarding. Once you create an - Account Link + is stripe, which includes Standard and Express accounts, + you can update all information until you create - for a Standard or Express account, some parameters can no longer be - changed. These are marked as Custom Only or - Custom and Express + an Account Link or Account Session to start Connect + onboarding, - below.

+ after which some properties can no longer be updated.

To update your own account, use the - + The 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. enum: - company - government_entity @@ -43622,11 +48312,24 @@ paths: capabilities: description: >- Each key of the dictionary represents a capability, and each - capability maps to its settings (e.g. whether it has been - requested or not). Each capability will be inactive until - you have provided its specific requirements and Stripe has - verified them. An account may have some of its requested - capabilities be active and some be inactive. + capability + + maps to its settings (for example, whether it has been + requested or not). Each + + capability is inactive until you have provided its specific + + requirements and Stripe has verified them. An account might + have some + + of its requested capabilities be active and some be + inactive. + + + Required when + [account.controller.stripe_dashboard.type](/api/accounts/create#create_account-controller-dashboard-type) + + is `none`, which includes Custom accounts. properties: acss_debit_payments: properties: @@ -43646,6 +48349,12 @@ paths: type: boolean title: capability_param type: object + amazon_pay_payments: + properties: + requested: + type: boolean + title: capability_param + type: object au_becs_debit_payments: properties: requested: @@ -43772,6 +48481,12 @@ paths: type: boolean title: capability_param type: object + mobilepay_payments: + properties: + requested: + type: boolean + title: capability_param + type: object oxxo_payments: properties: requested: @@ -43814,6 +48529,12 @@ paths: type: boolean title: capability_param type: object + swish_payments: + properties: + requested: + type: boolean + title: capability_param + type: object tax_reporting_us_1099_k: properties: requested: @@ -43855,7 +48576,12 @@ paths: company: description: >- Information about the company or business. This field is - available for any `business_type`. + 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. properties: address: properties: @@ -43986,6 +48712,7 @@ paths: - public_company - public_corporation - public_partnership + - registered_charity - single_member_llc - sole_establishment - sole_proprietorship @@ -44025,7 +48752,7 @@ paths: 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://stripe.com/docs/payouts). + country](https://docs.stripe.com/payouts). type: string documents: description: >- @@ -44100,8 +48827,10 @@ paths: email: description: >- The email address of the account holder. This is only to - make the account easier to identify to you. Stripe only - emails Custom accounts with your consent. + make the account easier to identify to you. If + [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) + is `application`, which includes Custom accounts, Stripe + doesn't email the account without your consent. type: string expand: description: Specifies which fields in the response should be expanded. @@ -44112,22 +48841,24 @@ paths: external_account: description: >- A card or bank account to attach to the account for - receiving - [payouts](https://stripe.com/docs/connect/bank-debit-card-payouts) - (you won’t be able to use it for top-ups). You can provide - either a token, like the ones returned by - [Stripe.js](https://stripe.com/docs/js), or a dictionary, as - documented in the `external_account` parameter for [bank - account](https://stripe.com/docs/api#account_create_bank_account) - creation.

By default, providing an external account - sets it as the new default external account for its - currency, and deletes the old default if one exists. To add - additional external accounts without replacing the existing - default for the currency, use the [bank - account](https://stripe.com/docs/api#account_create_bank_account) - or [card - creation](https://stripe.com/docs/api#account_create_card) - APIs. + receiving [payouts](/connect/bank-debit-card-payouts) (you + won’t be able to use it for top-ups). You can provide either + a token, like the ones returned by [Stripe.js](/js), or a + dictionary, as documented in the `external_account` + parameter for [bank + account](/api#account_create_bank_account) creation. +

By default, providing an external account sets it as + the new default external account for its currency, and + deletes the old default if one exists. To add additional + external accounts without replacing the existing default for + the currency, use the [bank + account](/api#account_create_bank_account) or [card + creation](/api#account_create_card) APIs. After 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. maxLength: 5000 type: string x-stripeBypassValidation: true @@ -44135,7 +48866,12 @@ paths: description: >- Information about the person represented by the account. This field is null unless `business_type` is set to - `individual`. + `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. properties: address: properties: @@ -44304,6 +49040,25 @@ paths: type: string title: address_specs type: object + relationship: + properties: + director: + type: boolean + executive: + type: boolean + owner: + type: boolean + percent_ownership: + anyOf: + - type: number + - enum: + - '' + type: string + title: + maxLength: 5000 + type: string + title: individual_relationship_specs + type: object ssn_last_4: maxLength: 5000 type: string @@ -44425,6 +49180,19 @@ paths: type: string title: card_payments_settings_specs type: object + invoices: + properties: + default_account_tax_ids: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: invoices_settings_specs + type: object payments: properties: statement_descriptor: @@ -44500,26 +49268,427 @@ paths: type: object title: treasury_settings_specs type: object - title: settings_specs_update - type: object - tos_acceptance: - description: >- - Details on the account's acceptance of the [Stripe Services - Agreement](https://stripe.com/docs/connect/updating-accounts#tos-acceptance). - properties: - date: - format: unix-time - type: integer - ip: - type: string - service_agreement: - maxLength: 5000 - type: string - user_agent: - maxLength: 5000 + title: settings_specs_update + type: object + tos_acceptance: + description: >- + Details on the account's acceptance of the [Stripe Services + Agreement](/connect/updating-accounts#tos-acceptance). 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. + properties: + date: + format: unix-time + type: integer + ip: + type: string + service_agreement: + maxLength: 5000 + type: string + user_agent: + maxLength: 5000 + type: string + title: tos_acceptance_specs + type: object + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/account' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/accounts/{account}/bank_accounts': + post: + description:

Create an external account for a given account.

+ operationId: PostAccountsAccountBankAccounts + parameters: + - in: path + name: account + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + bank_account: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + bank_account: + anyOf: + - properties: + account_holder_name: + maxLength: 5000 + type: string + account_holder_type: + enum: + - company + - individual + maxLength: 5000 + type: string + account_number: + maxLength: 5000 + type: string + account_type: + enum: + - checking + - futsu + - savings + - toza + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + currency: + type: string + documents: + properties: + bank_account_ownership_verification: + properties: + files: + items: + maxLength: 500 + type: string + type: array + title: documents_param + type: object + title: external_account_documents_param + type: object + object: + enum: + - bank_account + maxLength: 5000 + type: string + routing_number: + maxLength: 5000 + type: string + required: + - account_number + - country + title: external_account_payout_bank_account + type: object + - maxLength: 5000 + type: string + description: >- + Either a token, like the ones returned by + [Stripe.js](https://stripe.com/docs/js), or a dictionary + containing a user's bank account details. + default_for_currency: + description: >- + When set to true, or if this is the first external account + added in this currency, this account becomes the default + external account for its currency. + type: boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + external_account: + description: >- + Please refer to full + [documentation](https://stripe.com/docs/api) instead. + maxLength: 5000 + type: string + x-stripeBypassValidation: true + metadata: + additionalProperties: + type: 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. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + type: object + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/external_account' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/accounts/{account}/bank_accounts/{id}': + delete: + description:

Delete a specified external account for a given account.

+ operationId: DeleteAccountsAccountBankAccountsId + parameters: + - in: path + name: account + required: true + schema: + maxLength: 5000 + type: string + style: simple + - in: path + name: id + required: true + schema: + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/deleted_external_account' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + get: + description:

Retrieve a specified external account for a given account.

+ operationId: GetAccountsAccountBankAccountsId + parameters: + - in: path + name: account + required: true + schema: + maxLength: 5000 + type: string + style: simple + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: id + required: true + schema: + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/external_account' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description: >- +

Updates the metadata, account holder name, account holder type of a + bank account belonging to + + a connected account and optionally sets it as the default for its + currency. Other bank account + + details are not editable by design.

+ + +

You can only update bank accounts when account.controller.requirement_collection + is application, which includes Custom accounts.

+ + +

You can re-enable a disabled bank account by performing an update + call without providing any + + arguments or changes.

+ operationId: PostAccountsAccountBankAccountsId + parameters: + - in: path + name: account + required: true + schema: + maxLength: 5000 + type: string + style: simple + - in: path + name: id + required: true + schema: + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + documents: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + account_holder_name: + description: >- + The name of the person or business that owns the bank + account. + maxLength: 5000 + type: string + account_holder_type: + description: >- + The type of entity that holds the account. This can be + either `individual` or `company`. + enum: + - '' + - company + - individual + maxLength: 5000 + type: string + account_type: + description: >- + The bank account type. This can only be `checking` or + `savings` in most countries. In Japan, this can only be + `futsu` or `toza`. + enum: + - checking + - futsu + - savings + - toza + maxLength: 5000 + type: string + address_city: + description: City/District/Suburb/Town/Village. + maxLength: 5000 + type: string + address_country: + description: 'Billing address country, if provided when creating card.' + maxLength: 5000 + type: string + address_line1: + description: Address line 1 (Street address/PO Box/Company name). + maxLength: 5000 + type: string + address_line2: + description: Address line 2 (Apartment/Suite/Unit/Building). + maxLength: 5000 + type: string + address_state: + description: State/County/Province/Region. + maxLength: 5000 + type: string + address_zip: + description: ZIP or postal code. + maxLength: 5000 + type: string + default_for_currency: + description: >- + When set to true, this becomes the default external account + for its currency. + type: boolean + documents: + description: >- + Documents that may be submitted to satisfy various + informational requests. + properties: + bank_account_ownership_verification: + properties: + files: + items: + maxLength: 500 + type: string + type: array + title: documents_param + type: object + title: external_account_documents_param + type: object + exp_month: + description: Two digit number representing the card’s expiration month. + maxLength: 5000 + type: string + exp_year: + description: Four digit number representing the card’s expiration year. + maxLength: 5000 + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' type: string - title: tos_acceptance_specs - type: object + 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. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + name: + description: Cardholder name. + maxLength: 5000 + type: string type: object required: false responses: @@ -44527,7 +49696,327 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/account' + $ref: '#/components/schemas/external_account' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/accounts/{account}/capabilities': + get: + description: >- +

Returns a list of capabilities associated with the account. The + capabilities are returned sorted by creation date, with the most recent + capability appearing first.

+ operationId: GetAccountsAccountCapabilities + parameters: + - in: path + name: account + required: true + schema: + maxLength: 5000 + type: string + style: simple + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/capability' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: ListAccountCapability + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/accounts/{account}/capabilities/{capability}': + get: + description:

Retrieves information about the specified Account Capability.

+ operationId: GetAccountsAccountCapabilitiesCapability + parameters: + - in: path + name: account + required: true + schema: + maxLength: 5000 + type: string + style: simple + - in: path + name: capability + required: true + schema: + type: string + style: simple + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/capability' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description: >- +

Updates an existing Account Capability. Request or remove a + capability by updating its requested parameter.

+ operationId: PostAccountsAccountCapabilitiesCapability + parameters: + - in: path + name: account + required: true + schema: + maxLength: 5000 + type: string + style: simple + - in: path + name: capability + required: true + schema: + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + requested: + description: >- + To request a new capability for an account, pass true. There + can be a delay before the requested capability becomes + active. If the capability has any activation requirements, + the response includes them in the `requirements` arrays. + + + If a capability isn't permanent, you can remove it from the + account by passing false. Most capabilities are permanent + after they've been requested. Attempting to remove a + permanent capability returns an error. + type: boolean + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/capability' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/accounts/{account}/external_accounts': + get: + description:

List external accounts for an account.

+ operationId: GetAccountsAccountExternalAccounts + parameters: + - in: path + name: account + required: true + schema: + maxLength: 5000 + type: string + style: simple + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: Filter external accounts according to a particular object type. + in: query + name: object + required: false + schema: + enum: + - bank_account + - card + maxLength: 5000 + type: string + x-stripeBypassValidation: true + style: form + - 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. + in: query + name: starting_after + required: false + schema: + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + description: >- + The list contains all external accounts that have been + attached to the Stripe account. These may be bank accounts + or cards. + items: + anyOf: + - $ref: '#/components/schemas/bank_account' + - $ref: '#/components/schemas/card' + title: Polymorphic + x-stripeBypassValidation: true + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: ExternalAccountList + type: object + x-expandableFields: + - data description: Successful response. default: content: @@ -44535,10 +50024,9 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/accounts/{account}/bank_accounts': post: description:

Create an external account for a given account.

- operationId: PostAccountsAccountBankAccounts + operationId: PostAccountsAccountExternalAccounts parameters: - in: path name: account @@ -44669,10 +50157,10 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/accounts/{account}/bank_accounts/{id}': + '/v1/accounts/{account}/external_accounts/{id}': delete: description:

Delete a specified external account for a given account.

- operationId: DeleteAccountsAccountBankAccountsId + operationId: DeleteAccountsAccountExternalAccountsId parameters: - in: path name: account @@ -44711,7 +50199,7 @@ paths: description: Error response. get: description:

Retrieve a specified external account for a given account.

- operationId: GetAccountsAccountBankAccountsId + operationId: GetAccountsAccountExternalAccountsId parameters: - in: path name: account @@ -44762,15 +50250,25 @@ paths: post: description: >-

Updates the metadata, account holder name, account holder type of a - bank account belonging to a Custom account, and optionally - sets it as the default for its currency. Other bank account details are - not editable by design.

+ bank account belonging to + + a connected account and optionally sets it as the default for its + currency. Other bank account + + details are not editable by design.

+ + +

You can only update bank accounts when account.controller.requirement_collection + is application, which includes Custom accounts.

You can re-enable a disabled bank account by performing an update - call without providing any arguments or changes.

- operationId: PostAccountsAccountBankAccountsId + call without providing any + + arguments or changes.

+ operationId: PostAccountsAccountExternalAccountsId parameters: - in: path name: account @@ -44897,146 +50395,17 @@ paths: - '' type: 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. Individual keys can be unset by posting an empty - value to them. All keys can be unset by posting an empty - value to `metadata`. - name: - description: Cardholder name. - maxLength: 5000 - type: string - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/external_account' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - '/v1/accounts/{account}/capabilities': - get: - description: >- -

Returns a list of capabilities associated with the account. The - capabilities are returned sorted by creation date, with the most recent - capability appearing first.

- operationId: GetAccountsAccountCapabilities - parameters: - - in: path - name: account - required: true - schema: - maxLength: 5000 - type: string - style: simple - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - description: '' - properties: - data: - items: - $ref: '#/components/schemas/capability' - type: array - has_more: - description: >- - True if this list has another page of items after this one - that can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same - type share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - type: string - required: - - data - - has_more - - object - - url - title: ListAccountCapability - type: object - x-expandableFields: - - data - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - '/v1/accounts/{account}/capabilities/{capability}': - get: - description:

Retrieves information about the specified Account Capability.

- operationId: GetAccountsAccountCapabilitiesCapability - parameters: - - in: path - name: account - required: true - schema: - maxLength: 5000 - type: string - style: simple - - in: path - name: capability - required: true - schema: - type: string - style: simple - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} + 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. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + name: + description: Cardholder name. + maxLength: 5000 + type: string type: object required: false responses: @@ -45044,7 +50413,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/capability' + $ref: '#/components/schemas/external_account' description: Successful response. default: content: @@ -45052,11 +50421,17 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + '/v1/accounts/{account}/login_links': post: description: >- -

Updates an existing Account Capability. Request or remove a - capability by updating its requested parameter.

- operationId: PostAccountsAccountCapabilitiesCapability +

Creates a single-use login link for a connected account to access the + Express Dashboard.

+ + +

You can only create login links for accounts that use the Express Dashboard and are + connected to your platform.

+ operationId: PostAccountsAccountLoginLinks parameters: - in: path name: account @@ -45065,12 +50440,6 @@ paths: maxLength: 5000 type: string style: simple - - in: path - name: capability - required: true - schema: - type: string - style: simple requestBody: content: application/x-www-form-urlencoded: @@ -45087,19 +50456,6 @@ paths: maxLength: 5000 type: string type: array - requested: - description: >- - To request a new capability for an account, pass true. There - can be a delay before the requested capability becomes - active. If the capability has any activation requirements, - the response includes them in the `requirements` arrays. - - - If a capability isn't permanent, you can remove it from the - account by passing false. Most capabilities are permanent - after they've been requested. Attempting to remove a - permanent capability returns an error. - type: boolean type: object required: false responses: @@ -45107,7 +50463,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/capability' + $ref: '#/components/schemas/login_link' description: Successful response. default: content: @@ -45115,10 +50471,13 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/accounts/{account}/external_accounts': + '/v1/accounts/{account}/people': get: - description:

List external accounts for an account.

- operationId: GetAccountsAccountExternalAccounts + description: >- +

Returns a list of people associated with the account’s legal entity. + The people are returned sorted by creation date, with the most recent + people appearing first.

+ operationId: GetAccountsAccountPeople parameters: - in: path name: account @@ -45137,6 +50496,7 @@ paths: name: ending_before required: false schema: + maxLength: 5000 type: string style: form - description: Specifies which fields in the response should be expanded. @@ -45159,18 +50519,28 @@ paths: schema: type: integer style: form - - description: Filter external accounts according to a particular object type. + - description: >- + Filters on the list of people returned based on the person's + relationship to the account's company. + explode: true in: query - name: object + name: relationship required: false schema: - enum: - - bank_account - - card - maxLength: 5000 - type: string - x-stripeBypassValidation: true - style: form + properties: + director: + type: boolean + executive: + type: boolean + legal_guardian: + type: boolean + owner: + type: boolean + representative: + type: boolean + title: all_people_relationship_specs + type: object + style: deepObject - 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 @@ -45181,6 +50551,7 @@ paths: name: starting_after required: false schema: + maxLength: 5000 type: string style: form requestBody: @@ -45200,16 +50571,8 @@ paths: description: '' properties: data: - description: >- - The list contains all external accounts that have been - attached to the Stripe account. These may be bank accounts - or cards. items: - anyOf: - - $ref: '#/components/schemas/bank_account' - - $ref: '#/components/schemas/card' - title: Polymorphic - x-stripeBypassValidation: true + $ref: '#/components/schemas/person' type: array has_more: description: >- @@ -45232,7 +50595,7 @@ paths: - has_more - object - url - title: ExternalAccountList + title: PersonList type: object x-expandableFields: - data @@ -45244,8 +50607,8 @@ paths: $ref: '#/components/schemas/error' description: Error response. post: - description:

Create an external account for a given account.

- operationId: PostAccountsAccountExternalAccounts + description:

Creates a new person.

+ operationId: PostAccountsAccountPeople parameters: - in: path name: account @@ -45258,343 +50621,281 @@ paths: content: application/x-www-form-urlencoded: encoding: - bank_account: + additional_tos_acceptances: explode: true style: deepObject - expand: + address: explode: true style: deepObject - metadata: + address_kana: + explode: true + style: deepObject + address_kanji: + explode: true + style: deepObject + dob: explode: true style: deepObject - schema: - additionalProperties: false - properties: - bank_account: - anyOf: - - properties: - account_holder_name: - maxLength: 5000 - type: string - account_holder_type: - enum: - - company - - individual - maxLength: 5000 - type: string - account_number: - maxLength: 5000 - type: string - account_type: - enum: - - checking - - futsu - - savings - - toza - maxLength: 5000 - type: string - country: - maxLength: 5000 - type: string - currency: - type: string - documents: - properties: - bank_account_ownership_verification: - properties: - files: - items: - maxLength: 500 - type: string - type: array - title: documents_param - type: object - title: external_account_documents_param - type: object - object: - enum: - - bank_account - maxLength: 5000 - type: string - routing_number: - maxLength: 5000 - type: string - required: - - account_number - - country - title: external_account_payout_bank_account - type: object - - maxLength: 5000 - type: string - description: >- - Either a token, like the ones returned by - [Stripe.js](https://stripe.com/docs/js), or a dictionary - containing a user's bank account details. - default_for_currency: - description: >- - When set to true, or if this is the first external account - added in this currency, this account becomes the default - external account for its currency. - type: boolean - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - external_account: - description: >- - Please refer to full - [documentation](https://stripe.com/docs/api) instead. - maxLength: 5000 - type: string - x-stripeBypassValidation: true - metadata: - additionalProperties: - type: 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. Individual keys can be unset by posting an empty - value to them. All keys can be unset by posting an empty - value to `metadata`. - type: object - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/external_account' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - '/v1/accounts/{account}/external_accounts/{id}': - delete: - description:

Delete a specified external account for a given account.

- operationId: DeleteAccountsAccountExternalAccountsId - parameters: - - in: path - name: account - required: true - schema: - maxLength: 5000 - type: string - style: simple - - in: path - name: id - required: true - schema: - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/deleted_external_account' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - get: - description:

Retrieve a specified external account for a given account.

- operationId: GetAccountsAccountExternalAccountsId - parameters: - - in: path - name: account - required: true - schema: - maxLength: 5000 - type: string - style: simple - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject - - in: path - name: id - required: true - schema: - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/external_account' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - post: - description: >- -

Updates the metadata, account holder name, account holder type of a - bank account belonging to a Custom account, and optionally - sets it as the default for its currency. Other bank account details are - not editable by design.

- - -

You can re-enable a disabled bank account by performing an update - call without providing any arguments or changes.

- operationId: PostAccountsAccountExternalAccountsId - parameters: - - in: path - name: account - required: true - schema: - maxLength: 5000 - type: string - style: simple - - in: path - name: id - required: true - schema: - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: documents: explode: true style: deepObject expand: explode: true style: deepObject + full_name_aliases: + explode: true + style: deepObject metadata: explode: true style: deepObject + registered_address: + explode: true + style: deepObject + relationship: + explode: true + style: deepObject + verification: + explode: true + style: deepObject schema: additionalProperties: false properties: - account_holder_name: + additional_tos_acceptances: description: >- - The name of the person or business that owns the bank - account. - maxLength: 5000 + Details on the legal guardian's acceptance of the required + Stripe agreements. + properties: + account: + properties: + date: + format: unix-time + type: integer + ip: + type: string + user_agent: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: settings_terms_of_service_specs + type: object + title: person_additional_tos_acceptances_specs + type: object + address: + description: The person's address. + properties: + city: + maxLength: 100 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 200 + type: string + line2: + maxLength: 200 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: address_specs + type: object + address_kana: + description: The Kana variation of the person's address (Japan only). + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + town: + maxLength: 5000 + type: string + title: japan_address_kana_specs + type: object + address_kanji: + description: The Kanji variation of the person's address (Japan only). + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + town: + maxLength: 5000 + type: string + title: japan_address_kanji_specs + type: object + dob: + anyOf: + - properties: + day: + type: integer + month: + type: integer + year: + type: integer + required: + - day + - month + - year + title: date_of_birth_specs + type: object + - enum: + - '' + type: string + description: The person's date of birth. + documents: + description: >- + Documents that may be submitted to satisfy various + informational requests. + properties: + company_authorization: + properties: + files: + items: + anyOf: + - maxLength: 500 + type: string + - enum: + - '' + type: string + type: array + title: documents_param + type: object + passport: + properties: + files: + items: + anyOf: + - maxLength: 500 + type: string + - enum: + - '' + type: string + type: array + title: documents_param + type: object + visa: + properties: + files: + items: + anyOf: + - maxLength: 500 + type: string + - enum: + - '' + type: string + type: array + title: documents_param + type: object + title: person_documents_specs + type: object + email: + description: The person's email address. type: string - account_holder_type: - description: >- - The type of entity that holds the account. This can be - either `individual` or `company`. - enum: - - '' - - company - - individual + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + first_name: + description: The person's first name. maxLength: 5000 type: string - account_type: - description: >- - The bank account type. This can only be `checking` or - `savings` in most countries. In Japan, this can only be - `futsu` or `toza`. - enum: - - checking - - futsu - - savings - - toza + first_name_kana: + description: The Kana variation of the person's first name (Japan only). maxLength: 5000 type: string - address_city: - description: City/District/Suburb/Town/Village. + first_name_kanji: + description: The Kanji variation of the person's first name (Japan only). maxLength: 5000 type: string - address_country: - description: 'Billing address country, if provided when creating card.' - maxLength: 5000 + full_name_aliases: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + description: >- + A list of alternate names or aliases that the person is + known by. + gender: + description: >- + The person's gender (International regulations require + either "male" or "female"). type: string - address_line1: - description: Address line 1 (Street address/PO Box/Company name). + id_number: + description: >- + The person's ID number, as appropriate for their country. + For example, a social security number in the U.S., social + insurance number in Canada, etc. Instead of the number + itself, you can also provide a [PII token provided by + Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string - address_line2: - description: Address line 2 (Apartment/Suite/Unit/Building). + id_number_secondary: + description: >- + The person's secondary ID number, as appropriate for their + country, will be used for enhanced verification checks. In + Thailand, this would be the laser code found on the back of + an ID card. Instead of the number itself, you can also + provide a [PII token provided by + Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string - address_state: - description: State/County/Province/Region. + last_name: + description: The person's last name. maxLength: 5000 type: string - address_zip: - description: ZIP or postal code. + last_name_kana: + description: The Kana variation of the person's last name (Japan only). maxLength: 5000 type: string - default_for_currency: - description: >- - When set to true, this becomes the default external account - for its currency. - type: boolean - documents: - description: >- - Documents that may be submitted to satisfy various - informational requests. - properties: - bank_account_ownership_verification: - properties: - files: - items: - maxLength: 500 - type: string - type: array - title: documents_param - type: object - title: external_account_documents_param - type: object - exp_month: - description: Two digit number representing the card’s expiration month. + last_name_kanji: + description: The Kanji variation of the person's last name (Japan only). maxLength: 5000 type: string - exp_year: - description: Four digit number representing the card’s expiration year. + maiden_name: + description: The person's maiden name. maxLength: 5000 type: string - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array metadata: anyOf: - additionalProperties: @@ -45611,10 +50912,111 @@ paths: format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - name: - description: Cardholder name. + nationality: + description: >- + The country where the person is a national. Two-letter + country code ([ISO 3166-1 + alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), + or "XX" if unavailable. + maxLength: 5000 + type: string + person_token: + description: >- + A [person + token](https://docs.stripe.com/connect/account-tokens), used + to securely provide details to the person. + maxLength: 5000 + type: string + phone: + description: The person's phone number. + type: string + political_exposure: + description: >- + Indicates if the person or any of their representatives, + family members, or other closely related persons, declares + that they hold or have held an important public job or + function, in any jurisdiction. maxLength: 5000 type: string + registered_address: + description: The person's registered address. + properties: + city: + maxLength: 100 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 200 + type: string + line2: + maxLength: 200 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: address_specs + type: object + relationship: + description: >- + The relationship that this person has with the account's + legal entity. + properties: + director: + type: boolean + executive: + type: boolean + legal_guardian: + type: boolean + owner: + type: boolean + percent_ownership: + anyOf: + - type: number + - enum: + - '' + type: string + representative: + type: boolean + title: + maxLength: 5000 + type: string + title: relationship_specs + type: object + ssn_last_4: + description: >- + The last four digits of the person's Social Security number + (U.S. only). + type: string + verification: + description: The person's verification status. + properties: + additional_document: + properties: + back: + maxLength: 500 + type: string + front: + maxLength: 500 + type: string + title: person_verification_document_specs + type: object + document: + properties: + back: + maxLength: 500 + type: string + front: + maxLength: 500 + type: string + title: person_verification_document_specs + type: object + title: person_verification_specs + type: object type: object required: false responses: @@ -45622,7 +51024,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/external_account' + $ref: '#/components/schemas/person' description: Successful response. default: content: @@ -45630,17 +51032,16 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/accounts/{account}/login_links': - post: + '/v1/accounts/{account}/people/{person}': + delete: description: >- -

Creates a single-use login link for an Express account to access - their Stripe dashboard.

- - -

You may only create login links for Express accounts connected to - your platform.

- operationId: PostAccountsAccountLoginLinks +

Deletes an existing person’s relationship to the account’s legal + entity. Any person with a relationship for an account can be deleted + through the API, except if the person is the + account_opener. If your integration is using the + executive parameter, you cannot delete the only verified + executive on file.

+ operationId: DeleteAccountsAccountPeoplePerson parameters: - in: path name: account @@ -45649,22 +51050,20 @@ paths: maxLength: 5000 type: string style: simple + - in: path + name: person + required: true + schema: + maxLength: 5000 + type: string + style: simple requestBody: content: application/x-www-form-urlencoded: - encoding: - expand: - explode: true - style: deepObject + encoding: {} schema: additionalProperties: false - properties: - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array + properties: {} type: object required: false responses: @@ -45672,7 +51071,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/login_link' + $ref: '#/components/schemas/deleted_person' description: Successful response. default: content: @@ -45680,13 +51079,9 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/accounts/{account}/people': get: - description: >- -

Returns a list of people associated with the account’s legal entity. - The people are returned sorted by creation date, with the most recent - people appearing first.

- operationId: GetAccountsAccountPeople + description:

Retrieves an existing person.

+ operationId: GetAccountsAccountPeoplePerson parameters: - in: path name: account @@ -45695,19 +51090,6 @@ paths: maxLength: 5000 type: string style: simple - - description: >- - A cursor for use in pagination. `ending_before` is an object ID that - defines your place in the list. For instance, if you make a list - request and receive 100 objects, starting with `obj_bar`, your - subsequent call can include `ending_before=obj_bar` in order to - fetch the previous page of the list. - in: query - name: ending_before - required: false - schema: - maxLength: 5000 - type: string - style: form - description: Specifies which fields in the response should be expanded. explode: true in: query @@ -45719,50 +51101,13 @@ paths: type: string type: array style: deepObject - - description: >- - A limit on the number of objects to be returned. Limit can range - between 1 and 100, and the default is 10. - in: query - name: limit - required: false - schema: - type: integer - style: form - - description: >- - Filters on the list of people returned based on the person's - relationship to the account's company. - explode: true - in: query - name: relationship - required: false - schema: - properties: - director: - type: boolean - executive: - type: boolean - legal_guardian: - type: boolean - owner: - type: boolean - representative: - type: boolean - title: all_people_relationship_specs - type: object - style: deepObject - - 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. - in: query - name: starting_after - required: false + - in: path + name: person + required: true schema: maxLength: 5000 type: string - style: form + style: simple requestBody: content: application/x-www-form-urlencoded: @@ -45777,37 +51122,7 @@ paths: content: application/json: schema: - description: '' - properties: - data: - items: - $ref: '#/components/schemas/person' - type: array - has_more: - description: >- - True if this list has another page of items after this one - that can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same - type share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - type: string - required: - - data - - has_more - - object - - url - title: PersonList - type: object - x-expandableFields: - - data + $ref: '#/components/schemas/person' description: Successful response. default: content: @@ -45816,8 +51131,8 @@ paths: $ref: '#/components/schemas/error' description: Error response. post: - description:

Creates a new person.

- operationId: PostAccountsAccountPeople + description:

Updates an existing person.

+ operationId: PostAccountsAccountPeoplePerson parameters: - in: path name: account @@ -45826,6 +51141,13 @@ paths: maxLength: 5000 type: string style: simple + - in: path + name: person + required: true + schema: + maxLength: 5000 + type: string + style: simple requestBody: content: application/x-www-form-urlencoded: @@ -46076,7 +51398,7 @@ paths: For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by - Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string id_number_secondary: @@ -46086,7 +51408,7 @@ paths: Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by - Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string last_name: @@ -46132,7 +51454,7 @@ paths: person_token: description: >- A [person - token](https://stripe.com/docs/connect/account-tokens), used + token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. maxLength: 5000 type: string @@ -46241,16 +51563,13 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/accounts/{account}/people/{person}': - delete: + '/v1/accounts/{account}/persons': + get: description: >- -

Deletes an existing person’s relationship to the account’s legal - entity. Any person with a relationship for an account can be deleted - through the API, except if the person is the - account_opener. If your integration is using the - executive parameter, you cannot delete the only verified - executive on file.

- operationId: DeleteAccountsAccountPeoplePerson +

Returns a list of people associated with the account’s legal entity. + The people are returned sorted by creation date, with the most recent + people appearing first.

+ operationId: GetAccountsAccountPersons parameters: - in: path name: account @@ -46259,46 +51578,19 @@ paths: maxLength: 5000 type: string style: simple - - in: path - name: person - required: true - schema: - maxLength: 5000 - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/deleted_person' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - get: - description:

Retrieves an existing person.

- operationId: GetAccountsAccountPeoplePerson - parameters: - - in: path - name: account - required: true + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false schema: maxLength: 5000 type: string - style: simple + style: form - description: Specifies which fields in the response should be expanded. explode: true in: query @@ -46310,13 +51602,50 @@ paths: type: string type: array style: deepObject - - in: path - name: person - required: true + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: >- + Filters on the list of people returned based on the person's + relationship to the account's company. + explode: true + in: query + name: relationship + required: false + schema: + properties: + director: + type: boolean + executive: + type: boolean + legal_guardian: + type: boolean + owner: + type: boolean + representative: + type: boolean + title: all_people_relationship_specs + type: object + style: deepObject + - 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. + in: query + name: starting_after + required: false schema: maxLength: 5000 type: string - style: simple + style: form requestBody: content: application/x-www-form-urlencoded: @@ -46331,7 +51660,37 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/person' + description: '' + properties: + data: + items: + $ref: '#/components/schemas/person' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: PersonList + type: object + x-expandableFields: + - data description: Successful response. default: content: @@ -46340,8 +51699,8 @@ paths: $ref: '#/components/schemas/error' description: Error response. post: - description:

Updates an existing person.

- operationId: PostAccountsAccountPeoplePerson + description:

Creates a new person.

+ operationId: PostAccountsAccountPersons parameters: - in: path name: account @@ -46350,13 +51709,6 @@ paths: maxLength: 5000 type: string style: simple - - in: path - name: person - required: true - schema: - maxLength: 5000 - type: string - style: simple requestBody: content: application/x-www-form-urlencoded: @@ -46607,7 +51959,7 @@ paths: For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by - Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string id_number_secondary: @@ -46617,7 +51969,7 @@ paths: Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by - Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string last_name: @@ -46663,7 +52015,7 @@ paths: person_token: description: >- A [person - token](https://stripe.com/docs/connect/account-tokens), used + token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. maxLength: 5000 type: string @@ -46772,13 +52124,16 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/accounts/{account}/persons': - get: + '/v1/accounts/{account}/persons/{person}': + delete: description: >- -

Returns a list of people associated with the account’s legal entity. - The people are returned sorted by creation date, with the most recent - people appearing first.

- operationId: GetAccountsAccountPersons +

Deletes an existing person’s relationship to the account’s legal + entity. Any person with a relationship for an account can be deleted + through the API, except if the person is the + account_opener. If your integration is using the + executive parameter, you cannot delete the only verified + executive on file.

+ operationId: DeleteAccountsAccountPersonsPerson parameters: - in: path name: account @@ -46787,19 +52142,46 @@ paths: maxLength: 5000 type: string style: simple - - description: >- - A cursor for use in pagination. `ending_before` is an object ID that - defines your place in the list. For instance, if you make a list - request and receive 100 objects, starting with `obj_bar`, your - subsequent call can include `ending_before=obj_bar` in order to - fetch the previous page of the list. - in: query - name: ending_before - required: false + - in: path + name: person + required: true schema: maxLength: 5000 type: string - style: form + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/deleted_person' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + get: + description:

Retrieves an existing person.

+ operationId: GetAccountsAccountPersonsPerson + parameters: + - in: path + name: account + required: true + schema: + maxLength: 5000 + type: string + style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query @@ -46811,50 +52193,13 @@ paths: type: string type: array style: deepObject - - description: >- - A limit on the number of objects to be returned. Limit can range - between 1 and 100, and the default is 10. - in: query - name: limit - required: false - schema: - type: integer - style: form - - description: >- - Filters on the list of people returned based on the person's - relationship to the account's company. - explode: true - in: query - name: relationship - required: false - schema: - properties: - director: - type: boolean - executive: - type: boolean - legal_guardian: - type: boolean - owner: - type: boolean - representative: - type: boolean - title: all_people_relationship_specs - type: object - style: deepObject - - 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. - in: query - name: starting_after - required: false + - in: path + name: person + required: true schema: maxLength: 5000 type: string - style: form + style: simple requestBody: content: application/x-www-form-urlencoded: @@ -46869,37 +52214,7 @@ paths: content: application/json: schema: - description: '' - properties: - data: - items: - $ref: '#/components/schemas/person' - type: array - has_more: - description: >- - True if this list has another page of items after this one - that can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same - type share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - type: string - required: - - data - - has_more - - object - - url - title: PersonList - type: object - x-expandableFields: - - data + $ref: '#/components/schemas/person' description: Successful response. default: content: @@ -46908,8 +52223,8 @@ paths: $ref: '#/components/schemas/error' description: Error response. post: - description:

Creates a new person.

- operationId: PostAccountsAccountPersons + description:

Updates an existing person.

+ operationId: PostAccountsAccountPersonsPerson parameters: - in: path name: account @@ -46918,6 +52233,13 @@ paths: maxLength: 5000 type: string style: simple + - in: path + name: person + required: true + schema: + maxLength: 5000 + type: string + style: simple requestBody: content: application/x-www-form-urlencoded: @@ -47168,7 +52490,7 @@ paths: For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by - Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string id_number_secondary: @@ -47178,7 +52500,7 @@ paths: Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by - Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). + Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii). maxLength: 5000 type: string last_name: @@ -47224,7 +52546,7 @@ paths: person_token: description: >- A [person - token](https://stripe.com/docs/connect/account-tokens), used + token](https://docs.stripe.com/connect/account-tokens), used to securely provide details to the person. maxLength: 5000 type: string @@ -47319,13 +52641,221 @@ paths: title: person_verification_specs type: object type: object - required: false + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/person' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/accounts/{account}/reject': + post: + description: >- +

With Connect, you can reject accounts that you + have flagged as suspicious.

+ + +

Only accounts where your platform is liable for negative account + balances, which includes Custom and Express accounts, can be rejected. + Test-mode accounts can be rejected at any time. Live-mode accounts can + only be rejected after all balances are zero.

+ operationId: PostAccountsAccountReject + parameters: + - in: path + name: account + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + reason: + description: >- + The reason for rejecting the account. Can be `fraud`, + `terms_of_service`, or `other`. + maxLength: 5000 + type: string + required: + - reason + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/account' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/apple_pay/domains: + get: + description:

List apple pay domains.

+ operationId: GetApplePayDomains + parameters: + - in: query + name: domain_name + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/apple_pay_domain' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/apple_pay/domains + type: string + required: + - data + - has_more + - object + - url + title: ApplePayDomainList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description:

Create an apple pay domain.

+ operationId: PostApplePayDomains + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + domain_name: + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + required: + - domain_name + type: object + required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/person' + $ref: '#/components/schemas/apple_pay_domain' description: Successful response. default: content: @@ -47333,31 +52863,62 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/accounts/{account}/persons/{person}': + '/v1/apple_pay/domains/{domain}': delete: - description: >- -

Deletes an existing person’s relationship to the account’s legal - entity. Any person with a relationship for an account can be deleted - through the API, except if the person is the - account_opener. If your integration is using the - executive parameter, you cannot delete the only verified - executive on file.

- operationId: DeleteAccountsAccountPersonsPerson + description:

Delete an apple pay domain.

+ operationId: DeleteApplePayDomainsDomain parameters: - in: path - name: account + name: domain required: true schema: maxLength: 5000 type: string style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/deleted_apple_pay_domain' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + get: + description:

Retrieve an apple pay domain.

+ operationId: GetApplePayDomainsDomain + parameters: - in: path - name: person + name: domain required: true schema: maxLength: 5000 type: string style: simple + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject requestBody: content: application/x-www-form-urlencoded: @@ -47372,7 +52933,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/deleted_person' + $ref: '#/components/schemas/apple_pay_domain' description: Successful response. default: content: @@ -47380,17 +52941,59 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + /v1/application_fees: get: - description:

Retrieves an existing person.

- operationId: GetAccountsAccountPersonsPerson + description: >- +

Returns a list of application fees you’ve previously collected. The + application fees are returned in sorted order, with the most recent fees + appearing first.

+ operationId: GetApplicationFees parameters: - - in: path - name: account - required: true + - description: >- + Only return application fees for the charge specified by this charge + ID. + in: query + name: charge + required: false schema: maxLength: 5000 type: string - style: simple + style: form + - description: >- + Only return applications fees that were created during the given + date interval. + explode: true + in: query + name: created + required: false + schema: + anyOf: + - properties: + gt: + type: integer + gte: + type: integer + lt: + type: integer + lte: + type: integer + title: range_query_specs + type: object + - type: integer + style: deepObject + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form - description: Specifies which fields in the response should be expanded. explode: true in: query @@ -47402,13 +53005,28 @@ paths: type: string type: array style: deepObject - - in: path - name: person - required: true + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - 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. + in: query + name: starting_after + required: false schema: maxLength: 5000 type: string - style: simple + style: form requestBody: content: application/x-www-form-urlencoded: @@ -47423,7 +53041,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/person' + description: '' + properties: + data: + items: + $ref: '#/components/schemas/application_fee' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/application_fees + type: string + required: + - data + - has_more + - object + - url + title: PlatformEarningList + type: object + x-expandableFields: + - data description: Successful response. default: content: @@ -47431,19 +53080,34 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - post: - description:

Updates an existing person.

- operationId: PostAccountsAccountPersonsPerson + '/v1/application_fees/{fee}/refunds/{id}': + get: + description: >- +

By default, you can see the 10 most recent refunds stored directly on + the application fee object, but you can also retrieve details about a + specific refund stored on the application fee.

+ operationId: GetApplicationFeesFeeRefundsId parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject - in: path - name: account + name: fee required: true schema: maxLength: 5000 type: string style: simple - in: path - name: person + name: id required: true schema: maxLength: 5000 @@ -47452,282 +53116,68 @@ paths: requestBody: content: application/x-www-form-urlencoded: - encoding: - additional_tos_acceptances: - explode: true - style: deepObject - address: - explode: true - style: deepObject - address_kana: - explode: true - style: deepObject - address_kanji: - explode: true - style: deepObject - dob: - explode: true - style: deepObject - documents: - explode: true - style: deepObject - expand: - explode: true - style: deepObject - full_name_aliases: - explode: true - style: deepObject - metadata: - explode: true - style: deepObject - registered_address: - explode: true - style: deepObject - relationship: - explode: true - style: deepObject - verification: - explode: true - style: deepObject + encoding: {} schema: additionalProperties: false - properties: - additional_tos_acceptances: - description: >- - Details on the legal guardian's acceptance of the required - Stripe agreements. - properties: - account: - properties: - date: - format: unix-time - type: integer - ip: - type: string - user_agent: - anyOf: - - maxLength: 5000 - type: string - - enum: - - '' - type: string - title: settings_terms_of_service_specs - type: object - title: person_additional_tos_acceptances_specs - type: object - address: - description: The person's address. - properties: - city: - maxLength: 100 - type: string - country: - maxLength: 5000 - type: string - line1: - maxLength: 200 - type: string - line2: - maxLength: 200 - type: string - postal_code: - maxLength: 5000 - type: string - state: - maxLength: 5000 - type: string - title: address_specs - type: object - address_kana: - description: The Kana variation of the person's address (Japan only). - properties: - city: - maxLength: 5000 - type: string - country: - maxLength: 5000 - type: string - line1: - maxLength: 5000 - type: string - line2: - maxLength: 5000 - type: string - postal_code: - maxLength: 5000 - type: string - state: - maxLength: 5000 - type: string - town: - maxLength: 5000 - type: string - title: japan_address_kana_specs - type: object - address_kanji: - description: The Kanji variation of the person's address (Japan only). - properties: - city: - maxLength: 5000 - type: string - country: - maxLength: 5000 - type: string - line1: - maxLength: 5000 - type: string - line2: - maxLength: 5000 - type: string - postal_code: - maxLength: 5000 - type: string - state: - maxLength: 5000 - type: string - town: - maxLength: 5000 - type: string - title: japan_address_kanji_specs - type: object - dob: - anyOf: - - properties: - day: - type: integer - month: - type: integer - year: - type: integer - required: - - day - - month - - year - title: date_of_birth_specs - type: object - - enum: - - '' - type: string - description: The person's date of birth. - documents: - description: >- - Documents that may be submitted to satisfy various - informational requests. - properties: - company_authorization: - properties: - files: - items: - anyOf: - - maxLength: 500 - type: string - - enum: - - '' - type: string - type: array - title: documents_param - type: object - passport: - properties: - files: - items: - anyOf: - - maxLength: 500 - type: string - - enum: - - '' - type: string - type: array - title: documents_param - type: object - visa: - properties: - files: - items: - anyOf: - - maxLength: 500 - type: string - - enum: - - '' - type: string - type: array - title: documents_param - type: object - title: person_documents_specs - type: object - email: - description: The person's email address. - type: string - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - first_name: - description: The person's first name. - maxLength: 5000 - type: string - first_name_kana: - description: The Kana variation of the person's first name (Japan only). - maxLength: 5000 - type: string - first_name_kanji: - description: The Kanji variation of the person's first name (Japan only). - maxLength: 5000 - type: string - full_name_aliases: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - description: >- - A list of alternate names or aliases that the person is - known by. - gender: - description: >- - The person's gender (International regulations require - either "male" or "female"). - type: string - id_number: - description: >- - The person's ID number, as appropriate for their country. - For example, a social security number in the U.S., social - insurance number in Canada, etc. Instead of the number - itself, you can also provide a [PII token provided by - Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). - maxLength: 5000 - type: string - id_number_secondary: - description: >- - The person's secondary ID number, as appropriate for their - country, will be used for enhanced verification checks. In - Thailand, this would be the laser code found on the back of - an ID card. Instead of the number itself, you can also - provide a [PII token provided by - Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii). - maxLength: 5000 - type: string - last_name: - description: The person's last name. - maxLength: 5000 - type: string - last_name_kana: - description: The Kana variation of the person's last name (Japan only). - maxLength: 5000 - type: string - last_name_kanji: - description: The Kanji variation of the person's last name (Japan only). - maxLength: 5000 - type: string - maiden_name: - description: The person's maiden name. - maxLength: 5000 - type: string + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/fee_refund' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description: >- +

Updates the specified application fee refund by setting the values of + the parameters passed. Any parameters not provided will be left + unchanged.

+ + +

This request only accepts metadata as an argument.

+ operationId: PostApplicationFeesFeeRefundsId + parameters: + - in: path + name: fee + required: true + schema: + maxLength: 5000 + type: string + style: simple + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array metadata: anyOf: - additionalProperties: @@ -47744,111 +53194,102 @@ paths: format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. - nationality: - description: >- - The country where the person is a national. Two-letter - country code ([ISO 3166-1 - alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)), - or "XX" if unavailable. - maxLength: 5000 - type: string - person_token: - description: >- - A [person - token](https://stripe.com/docs/connect/account-tokens), used - to securely provide details to the person. - maxLength: 5000 - type: string - phone: - description: The person's phone number. - type: string - political_exposure: - description: >- - Indicates if the person or any of their representatives, - family members, or other closely related persons, declares - that they hold or have held an important public job or - function, in any jurisdiction. + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/fee_refund' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/application_fees/{id}': + get: + description: >- +

Retrieves the details of an application fee that your account has + collected. The same information is returned when refunding the + application fee.

+ operationId: GetApplicationFeesId + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/application_fee' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/application_fees/{id}/refund': + post: + description: '' + operationId: PostApplicationFeesIdRefund + parameters: + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + amount: + type: integer + directive: maxLength: 5000 type: string - registered_address: - description: The person's registered address. - properties: - city: - maxLength: 100 - type: string - country: - maxLength: 5000 - type: string - line1: - maxLength: 200 - type: string - line2: - maxLength: 200 - type: string - postal_code: - maxLength: 5000 - type: string - state: - maxLength: 5000 - type: string - title: address_specs - type: object - relationship: - description: >- - The relationship that this person has with the account's - legal entity. - properties: - director: - type: boolean - executive: - type: boolean - legal_guardian: - type: boolean - owner: - type: boolean - percent_ownership: - anyOf: - - type: number - - enum: - - '' - type: string - representative: - type: boolean - title: - maxLength: 5000 - type: string - title: relationship_specs - type: object - ssn_last_4: - description: >- - The last four digits of the person's Social Security number - (U.S. only). - type: string - verification: - description: The person's verification status. - properties: - additional_document: - properties: - back: - maxLength: 500 - type: string - front: - maxLength: 500 - type: string - title: person_verification_document_specs - type: object - document: - properties: - back: - maxLength: 500 - type: string - front: - maxLength: 500 - type: string - title: person_verification_document_specs - type: object - title: person_verification_specs - type: object + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array type: object required: false responses: @@ -47856,7 +53297,124 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/person' + $ref: '#/components/schemas/application_fee' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/application_fees/{id}/refunds': + get: + description: >- +

You can see a list of the refunds belonging to a specific application + fee. Note that the 10 most recent refunds are always available by + default on the application fee object. If you need more than those 10, + you can use this API method and the limit and + starting_after parameters to page through additional + refunds.

+ operationId: GetApplicationFeesIdRefunds + parameters: + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + description: Details about each object. + items: + $ref: '#/components/schemas/fee_refund' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: FeeRefundList + type: object + x-expandableFields: + - data description: Successful response. default: content: @@ -47864,20 +53422,32 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/accounts/{account}/reject': post: description: >- -

With Connect, you may flag accounts as - suspicious.

+

Refunds an application fee that has previously been collected but not + yet refunded. + + Funds will be refunded to the Stripe account from which the fee was + originally collected.

-

Test-mode Custom and Express accounts can be rejected at any time. - Accounts created using live-mode keys may only be rejected once all - balances are zero.

- operationId: PostAccountsAccountReject +

You can optionally refund only part of an application fee. + + You can do so multiple times, until the entire fee has been + refunded.

+ + +

Once entirely refunded, an application fee can’t be refunded again. + + This method will raise an error when called on an already-refunded + application fee, + + or when trying to refund more money than is left on an application + fee.

+ operationId: PostApplicationFeesIdRefunds parameters: - in: path - name: account + name: id required: true schema: maxLength: 5000 @@ -47890,31 +53460,44 @@ paths: expand: explode: true style: deepObject + metadata: + explode: true + style: deepObject schema: additionalProperties: false properties: + amount: + description: >- + A positive integer, in _cents (or local equivalent)_, + representing how much of this fee to refund. Can refund only + up to the remaining unrefunded amount of the fee. + type: integer expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array - reason: + metadata: + additionalProperties: + type: string description: >- - The reason for rejecting the account. Can be `fraud`, - `terms_of_service`, or `other`. - maxLength: 5000 - type: string - required: - - reason + 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. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + type: object type: object - required: true + required: false responses: '200': content: application/json: schema: - $ref: '#/components/schemas/account' + $ref: '#/components/schemas/fee_refund' description: Successful response. default: content: @@ -47922,18 +53505,11 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - /v1/apple_pay/domains: + /v1/apps/secrets: get: - description:

List apple pay domains.

- operationId: GetApplePayDomains + description:

List all secrets stored on the given scope.

+ operationId: GetAppsSecrets parameters: - - in: query - name: domain_name - required: false - schema: - maxLength: 5000 - type: string - style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list @@ -47967,6 +53543,29 @@ paths: schema: type: integer style: form + - description: >- + Specifies the scoping of the secret. Requests originating from UI + extensions can only access account-scoped secrets or secrets scoped + to their own user. + explode: true + in: query + name: scope + required: true + schema: + properties: + type: + enum: + - account + - user + type: string + user: + maxLength: 5000 + type: string + required: + - type + title: scope_param + type: object + style: deepObject - 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 @@ -47988,44 +53587,117 @@ paths: additionalProperties: false properties: {} type: object - required: false + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/apps.secret' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/apps/secrets + type: string + required: + - data + - has_more + - object + - url + title: SecretServiceResourceSecretList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description:

Create or replace a secret in the secret store.

+ operationId: PostAppsSecrets + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + scope: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + expires_at: + description: >- + The Unix timestamp for the expiry time of the secret, after + which the secret deletes. + format: unix-time + type: integer + name: + description: A name for the secret that's unique within the scope. + maxLength: 5000 + type: string + payload: + description: The plaintext secret value to be stored. + maxLength: 5000 + type: string + scope: + description: >- + Specifies the scoping of the secret. Requests originating + from UI extensions can only access account-scoped secrets or + secrets scoped to their own user. + properties: + type: + enum: + - account + - user + type: string + user: + maxLength: 5000 + type: string + required: + - type + title: scope_param + type: object + required: + - name + - payload + - scope + type: object + required: true responses: '200': content: application/json: schema: - description: '' - properties: - data: - items: - $ref: '#/components/schemas/apple_pay_domain' - type: array - has_more: - description: >- - True if this list has another page of items after this one - that can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same - type share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - pattern: ^/v1/apple_pay/domains - type: string - required: - - data - - has_more - - object - - url - title: ApplePayDomainList - type: object - x-expandableFields: - - data + $ref: '#/components/schemas/apps.secret' description: Successful response. default: content: @@ -48033,9 +53705,10 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + /v1/apps/secrets/delete: post: - description:

Create an apple pay domain.

- operationId: PostApplePayDomains + description:

Deletes a secret from the secret store by name and scope.

+ operationId: PostAppsSecretsDelete requestBody: content: application/x-www-form-urlencoded: @@ -48043,19 +53716,43 @@ paths: expand: explode: true style: deepObject + scope: + explode: true + style: deepObject schema: additionalProperties: false properties: - domain_name: - type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array + name: + description: A name for the secret that's unique within the scope. + maxLength: 5000 + type: string + scope: + description: >- + Specifies the scoping of the secret. Requests originating + from UI extensions can only access account-scoped secrets or + secrets scoped to their own user. + properties: + type: + enum: + - account + - user + type: string + user: + maxLength: 5000 + type: string + required: + - type + title: scope_param + type: object required: - - domain_name + - name + - scope type: object required: true responses: @@ -48063,7 +53760,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/apple_pay_domain' + $ref: '#/components/schemas/apps.secret' description: Successful response. default: content: @@ -48071,18 +53768,53 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/apple_pay/domains/{domain}': - delete: - description:

Delete an apple pay domain.

- operationId: DeleteApplePayDomainsDomain + /v1/apps/secrets/find: + get: + description:

Finds a secret in the secret store by name and scope.

+ operationId: GetAppsSecretsFind parameters: - - in: path - name: domain + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: A name for the secret that's unique within the scope. + in: query + name: name required: true schema: maxLength: 5000 type: string - style: simple + style: form + - description: >- + Specifies the scoping of the secret. Requests originating from UI + extensions can only access account-scoped secrets or secrets scoped + to their own user. + explode: true + in: query + name: scope + required: true + schema: + properties: + type: + enum: + - account + - user + type: string + user: + maxLength: 5000 + type: string + required: + - type + title: scope_param + type: object + style: deepObject requestBody: content: application/x-www-form-urlencoded: @@ -48097,7 +53829,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/deleted_apple_pay_domain' + $ref: '#/components/schemas/apps.secret' description: Successful response. default: content: @@ -48105,17 +53837,14 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + /v1/balance: get: - description:

Retrieve an apple pay domain.

- operationId: GetApplePayDomainsDomain + description: >- +

Retrieves the current account balance, based on the authentication + that was used to make the request. + For a sample request, see Accounting for negative balances.

+ operationId: GetBalance parameters: - - in: path - name: domain - required: true - schema: - maxLength: 5000 - type: string - style: simple - description: Specifies which fields in the response should be expanded. explode: true in: query @@ -48141,7 +53870,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/apple_pay_domain' + $ref: '#/components/schemas/balance' description: Successful response. default: content: @@ -48149,25 +53878,23 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - /v1/application_fees: + /v1/balance/history: get: description: >- -

Returns a list of application fees you’ve previously collected. The - application fees are returned in sorted order, with the most recent fees - appearing first.

- operationId: GetApplicationFees +

Returns a list of transactions that have contributed to the Stripe + account balance (e.g., charges, transfers, and so forth). The + transactions are returned in sorted order, with the most recent + transactions appearing first.

+ + +

Note that this endpoint was previously called “Balance history” and + used the path /v1/balance/history.

+ operationId: GetBalanceHistory parameters: - description: >- - Only return application fees for the charge specified by this charge - ID. - in: query - name: charge - required: false - schema: - maxLength: 5000 - type: string - style: form - - explode: true + Only return transactions that were created during the given date + interval. + explode: true in: query name: created required: false @@ -48186,6 +53913,17 @@ paths: type: object - type: integer style: deepObject + - description: >- + Only return transactions in a certain currency. Three-letter [ISO + currency code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). + in: query + name: currency + required: false + schema: + type: string + style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list @@ -48219,6 +53957,24 @@ paths: schema: type: integer style: form + - description: >- + For automatic Stripe payouts only, only returns transactions that + were paid out on the specified payout ID. + in: query + name: payout + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Only returns the original transaction. + in: query + name: source + required: false + schema: + maxLength: 5000 + type: string + style: form - 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 @@ -48232,6 +53988,29 @@ paths: maxLength: 5000 type: string style: form + - 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`. + in: query + name: type + required: false + schema: + maxLength: 5000 + type: string + style: form requestBody: content: application/x-www-form-urlencoded: @@ -48250,7 +54029,7 @@ paths: properties: data: items: - $ref: '#/components/schemas/application_fee' + $ref: '#/components/schemas/balance_transaction' type: array has_more: description: >- @@ -48267,14 +54046,14 @@ paths: url: description: The URL where this list can be accessed. maxLength: 5000 - pattern: ^/v1/application_fees + pattern: ^/v1/balance_transactions type: string required: - data - has_more - object - url - title: PlatformEarningList + title: BalanceTransactionsList type: object x-expandableFields: - data @@ -48285,13 +54064,15 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/application_fees/{fee}/refunds/{id}': + '/v1/balance/history/{id}': get: description: >- -

By default, you can see the 10 most recent refunds stored directly on - the application fee object, but you can also retrieve details about a - specific refund stored on the application fee.

- operationId: GetApplicationFeesFeeRefundsId +

Retrieves the balance transaction with the given ID.

+ + +

Note that this endpoint previously used the path + /v1/balance/history/:id.

+ operationId: GetBalanceHistoryId parameters: - description: Specifies which fields in the response should be expanded. explode: true @@ -48304,13 +54085,6 @@ paths: type: string type: array style: deepObject - - in: path - name: fee - required: true - schema: - maxLength: 5000 - type: string - style: simple - in: path name: id required: true @@ -48332,7 +54106,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/fee_refund' + $ref: '#/components/schemas/balance_transaction' description: Successful response. default: content: @@ -48340,187 +54114,52 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - post: + /v1/balance_transactions: + get: description: >- -

Updates the specified application fee refund by setting the values of - the parameters passed. Any parameters not provided will be left - unchanged.

+

Returns a list of transactions that have contributed to the Stripe + account balance (e.g., charges, transfers, and so forth). The + transactions are returned in sorted order, with the most recent + transactions appearing first.

-

This request only accepts metadata as an argument.

- operationId: PostApplicationFeesFeeRefundsId - parameters: - - in: path - name: fee - required: true - schema: - maxLength: 5000 - type: string - style: simple - - in: path - name: id - required: true - schema: - maxLength: 5000 - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: - expand: - explode: true - style: deepObject - metadata: - explode: true - style: deepObject - schema: - additionalProperties: false - properties: - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - metadata: - anyOf: - - additionalProperties: - type: string - type: object - - enum: - - '' - type: 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. Individual keys can be unset by posting an empty - value to them. All keys can be unset by posting an empty - value to `metadata`. - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/fee_refund' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - '/v1/application_fees/{id}': - get: - description: >- -

Retrieves the details of an application fee that your account has - collected. The same information is returned when refunding the - application fee.

- operationId: GetApplicationFeesId +

Note that this endpoint was previously called “Balance history” and + used the path /v1/balance/history.

+ operationId: GetBalanceTransactions parameters: - - description: Specifies which fields in the response should be expanded. + - description: >- + Only return transactions that were created during the given date + interval. explode: true in: query - name: expand + name: created required: false schema: - items: - maxLength: 5000 - type: string - type: array + anyOf: + - properties: + gt: + type: integer + gte: + type: integer + lt: + type: integer + lte: + type: integer + title: range_query_specs + type: object + - type: integer style: deepObject - - in: path - name: id - required: true - schema: - maxLength: 5000 - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/application_fee' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - '/v1/application_fees/{id}/refund': - post: - description: '' - operationId: PostApplicationFeesIdRefund - parameters: - - in: path - name: id - required: true + - description: >- + Only return transactions in a certain currency. Three-letter [ISO + currency code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a [supported + currency](https://stripe.com/docs/currencies). + in: query + name: currency + required: false schema: - maxLength: 5000 type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: - expand: - explode: true - style: deepObject - schema: - additionalProperties: false - properties: - amount: - type: integer - directive: - maxLength: 5000 - type: string - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/application_fee' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - '/v1/application_fees/{id}/refunds': - get: - description: >- -

You can see a list of the refunds belonging to a specific application - fee. Note that the 10 most recent refunds are always available by - default on the application fee object. If you need more than those 10, - you can use this API method and the limit and - starting_after parameters to page through additional - refunds.

- operationId: GetApplicationFeesIdRefunds - parameters: + style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list @@ -48545,13 +54184,6 @@ paths: type: string type: array style: deepObject - - in: path - name: id - required: true - schema: - maxLength: 5000 - type: string - style: simple - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @@ -48561,6 +54193,24 @@ paths: schema: type: integer style: form + - description: >- + For automatic Stripe payouts only, only returns transactions that + were paid out on the specified payout ID. + in: query + name: payout + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Only returns the original transaction. + in: query + name: source + required: false + schema: + maxLength: 5000 + type: string + style: form - 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 @@ -48568,7 +54218,30 @@ paths: subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. in: query - name: starting_after + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + - 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`. + in: query + name: type required: false schema: maxLength: 5000 @@ -48591,9 +54264,8 @@ paths: description: '' properties: data: - description: Details about each object. items: - $ref: '#/components/schemas/fee_refund' + $ref: '#/components/schemas/balance_transaction' type: array has_more: description: >- @@ -48610,13 +54282,14 @@ paths: url: description: The URL where this list can be accessed. maxLength: 5000 + pattern: ^/v1/balance_transactions type: string required: - data - has_more - object - url - title: FeeRefundList + title: BalanceTransactionsList type: object x-expandableFields: - data @@ -48627,30 +54300,27 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - post: + '/v1/balance_transactions/{id}': + get: description: >- -

Refunds an application fee that has previously been collected but not - yet refunded. - - Funds will be refunded to the Stripe account from which the fee was - originally collected.

- - -

You can optionally refund only part of an application fee. - - You can do so multiple times, until the entire fee has been - refunded.

- - -

Once entirely refunded, an application fee can’t be refunded again. +

Retrieves the balance transaction with the given ID.

- This method will raise an error when called on an already-refunded - application fee, - or when trying to refund more money than is left on an application - fee.

- operationId: PostApplicationFeesIdRefunds +

Note that this endpoint previously used the path + /v1/balance/history/:id.

+ operationId: GetBalanceTransactionsId parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject - in: path name: id required: true @@ -48658,51 +54328,158 @@ paths: maxLength: 5000 type: string style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/balance_transaction' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/billing/meter_event_adjustments: + post: + description:

Creates a billing meter event adjustment

+ operationId: PostBillingMeterEventAdjustments requestBody: content: application/x-www-form-urlencoded: encoding: + cancel: + explode: true + style: deepObject expand: explode: true style: deepObject - metadata: + schema: + additionalProperties: false + properties: + cancel: + description: Specifies which event to cancel. + properties: + identifier: + maxLength: 100 + type: string + title: event_adjustment_cancel_settings_param + type: object + event_name: + description: >- + The name of the meter event. Corresponds with the + `event_name` field on a meter. + maxLength: 100 + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: + description: >- + Specifies whether to cancel a single event or a range of + events for a time period. Time period cancellation is not + supported yet. + enum: + - cancel + type: string + required: + - event_name + - type + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing.meter_event_adjustment' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/billing/meter_events: + post: + description:

Creates a billing meter event

+ operationId: PostBillingMeterEvents + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + payload: explode: true style: deepObject schema: additionalProperties: false properties: - amount: + event_name: description: >- - A positive integer, in _cents (or local equivalent)_, - representing how much of this fee to refund. Can refund only - up to the remaining unrefunded amount of the fee. - type: integer + The name of the meter event. Corresponds with the + `event_name` field on a meter. + maxLength: 100 + type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array - metadata: + identifier: + description: >- + A unique identifier for the event. If not provided, one will + be generated. We recommend using a globally unique + identifier for this. We'll enforce uniqueness within a + rolling 24 hour period. + maxLength: 100 + type: string + payload: additionalProperties: type: 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. Individual keys can be unset by posting an empty - value to them. All keys can be unset by posting an empty - value to `metadata`. + 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). type: object + timestamp: + description: >- + The time of the event. Measured in seconds since the Unix + epoch. Must be within the past 35 calendar days or up to 5 + minutes in the future. Defaults to current timestamp if not + specified. + format: unix-time + type: integer + required: + - event_name + - payload type: object - required: false + required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/fee_refund' + $ref: '#/components/schemas/billing.meter_event' description: Successful response. default: content: @@ -48710,10 +54487,10 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - /v1/apps/secrets: + /v1/billing/meters: get: - description:

List all secrets stored on the given scope.

- operationId: GetAppsSecrets + description:

Retrieve a list of billing meters.

+ operationId: GetBillingMeters parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that @@ -48748,29 +54525,6 @@ paths: schema: type: integer style: form - - description: >- - Specifies the scoping of the secret. Requests originating from UI - extensions can only access account-scoped secrets or secrets scoped - to their own user. - explode: true - in: query - name: scope - required: true - schema: - properties: - type: - enum: - - account - - user - type: string - user: - maxLength: 5000 - type: string - required: - - type - title: scope_param - type: object - style: deepObject - 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 @@ -48784,6 +54538,16 @@ paths: maxLength: 5000 type: string style: form + - description: Filter results to only include meters with the given status. + in: query + name: status + required: false + schema: + enum: + - active + - inactive + type: string + style: form requestBody: content: application/x-www-form-urlencoded: @@ -48802,7 +54566,7 @@ paths: properties: data: items: - $ref: '#/components/schemas/apps.secret' + $ref: '#/components/schemas/billing.meter' type: array has_more: description: >- @@ -48819,14 +54583,14 @@ paths: url: description: The URL where this list can be accessed. maxLength: 5000 - pattern: ^/v1/apps/secrets + pattern: ^/v1/billing/meters type: string required: - data - has_more - object - url - title: SecretServiceResourceSecretList + title: BillingMeterResourceBillingMeterList type: object x-expandableFields: - data @@ -48838,126 +54602,90 @@ paths: $ref: '#/components/schemas/error' description: Error response. post: - description:

Create or replace a secret in the secret store.

- operationId: PostAppsSecrets + description:

Creates a billing meter

+ operationId: PostBillingMeters requestBody: content: application/x-www-form-urlencoded: encoding: + customer_mapping: + explode: true + style: deepObject + default_aggregation: + explode: true + style: deepObject expand: explode: true style: deepObject - scope: + value_settings: explode: true style: deepObject schema: additionalProperties: false properties: - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - expires_at: - description: >- - The Unix timestamp for the expiry time of the secret, after - which the secret deletes. - format: unix-time - type: integer - name: - description: A name for the secret that's unique within the scope. - maxLength: 5000 - type: string - payload: - description: The plaintext secret value to be stored. - maxLength: 5000 - type: string - scope: - description: >- - Specifies the scoping of the secret. Requests originating - from UI extensions can only access account-scoped secrets or - secrets scoped to their own user. + customer_mapping: + description: Fields that specify how to map a meter event to a customer. properties: + event_payload_key: + maxLength: 100 + type: string type: enum: - - account - - user - type: string - user: - maxLength: 5000 + - by_id type: string required: + - event_payload_key - type - title: scope_param + title: customer_mapping_param type: object - required: - - name - - payload - - scope - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/apps.secret' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - /v1/apps/secrets/delete: - post: - description:

Deletes a secret from the secret store by name and scope.

- operationId: PostAppsSecretsDelete - requestBody: - content: - application/x-www-form-urlencoded: - encoding: - expand: - explode: true - style: deepObject - scope: - explode: true - style: deepObject - schema: - additionalProperties: false - properties: + default_aggregation: + description: The default settings to aggregate a meter's events with. + properties: + formula: + enum: + - count + - sum + type: string + required: + - formula + title: aggregation_settings_param + type: object + display_name: + description: The meter's name. + maxLength: 250 + type: string + event_name: + description: >- + The name of the meter event to record usage for. Corresponds + with the `event_name` field on meter events. + maxLength: 100 + type: string + event_time_window: + description: 'The time window to pre-aggregate meter events for, if any.' + enum: + - day + - hour + type: string expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array - name: - description: A name for the secret that's unique within the scope. - maxLength: 5000 - type: string - scope: - description: >- - Specifies the scoping of the secret. Requests originating - from UI extensions can only access account-scoped secrets or - secrets scoped to their own user. + value_settings: + description: Fields that specify how to calculate a meter event's value. properties: - type: - enum: - - account - - user - type: string - user: - maxLength: 5000 + event_payload_key: + maxLength: 100 type: string required: - - type - title: scope_param + - event_payload_key + title: meter_value_settings_param type: object required: - - name - - scope + - default_aggregation + - display_name + - event_name type: object required: true responses: @@ -48965,7 +54693,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/apps.secret' + $ref: '#/components/schemas/billing.meter' description: Successful response. default: content: @@ -48973,10 +54701,10 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - /v1/apps/secrets/find: + '/v1/billing/meters/{id}': get: - description:

Finds a secret in the secret store by name and scope.

- operationId: GetAppsSecretsFind + description:

Retrieves a billing meter given an ID

+ operationId: GetBillingMetersId parameters: - description: Specifies which fields in the response should be expanded. explode: true @@ -48989,78 +54717,14 @@ paths: type: string type: array style: deepObject - - description: A name for the secret that's unique within the scope. - in: query - name: name + - description: Unique identifier for the object. + in: path + name: id required: true schema: maxLength: 5000 type: string - style: form - - description: >- - Specifies the scoping of the secret. Requests originating from UI - extensions can only access account-scoped secrets or secrets scoped - to their own user. - explode: true - in: query - name: scope - required: true - schema: - properties: - type: - enum: - - account - - user - type: string - user: - maxLength: 5000 - type: string - required: - - type - title: scope_param - type: object - style: deepObject - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/apps.secret' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - /v1/balance: - get: - description: >- -

Retrieves the current account balance, based on the authentication - that was used to make the request. - For a sample request, see Accounting for negative balances.

- operationId: GetBalance - parameters: - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject + style: simple requestBody: content: application/x-www-form-urlencoded: @@ -49075,7 +54739,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/balance' + $ref: '#/components/schemas/billing.meter' description: Successful response. default: content: @@ -49083,143 +54747,38 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - /v1/balance/history: - get: - description: >- -

Returns a list of transactions that have contributed to the Stripe - account balance (e.g., charges, transfers, and so forth). The - transactions are returned in sorted order, with the most recent - transactions appearing first.

- - -

Note that this endpoint was previously called “Balance history” and - used the path /v1/balance/history.

- operationId: GetBalanceHistory + post: + description:

Updates a billing meter

+ operationId: PostBillingMetersId parameters: - - explode: true - in: query - name: created - required: false - schema: - anyOf: - - properties: - gt: - type: integer - gte: - type: integer - lt: - type: integer - lte: - type: integer - title: range_query_specs - type: object - - type: integer - style: deepObject - - description: >- - Only return transactions in a certain currency. Three-letter [ISO - currency code](https://www.iso.org/iso-4217-currency-codes.html), in - lowercase. Must be a [supported - currency](https://stripe.com/docs/currencies). - in: query - name: currency - required: false - schema: - type: string - style: form - - description: >- - A cursor for use in pagination. `ending_before` is an object ID that - defines your place in the list. For instance, if you make a list - request and receive 100 objects, starting with `obj_bar`, your - subsequent call can include `ending_before=obj_bar` in order to - fetch the previous page of the list. - in: query - name: ending_before - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject - - description: >- - A limit on the number of objects to be returned. Limit can range - between 1 and 100, and the default is 10. - in: query - name: limit - required: false - schema: - type: integer - style: form - - description: >- - For automatic Stripe payouts only, only returns transactions that - were paid out on the specified payout ID. - in: query - name: payout - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: Only returns the original transaction. - in: query - name: source - required: false - schema: - maxLength: 5000 - type: string - style: form - - 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. - in: query - name: starting_after - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: >- - Only returns transactions of the given type. One of: `adjustment`, - `advance`, `advance_funding`, `anticipation_repayment`, - `application_fee`, `application_fee_refund`, `charge`, - `connect_collection_transfer`, `contribution`, - `issuing_authorization_hold`, `issuing_authorization_release`, - `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, - `obligation_outbound`, `obligation_reversal_inbound`, - `obligation_reversal_outbound`, `obligation_payout`, - `obligation_payout_failure`, `payment`, `payment_failure_refund`, - `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`. - in: query - name: type - required: false + - description: Unique identifier for the object. + in: path + name: id + required: true schema: maxLength: 5000 type: string - style: form + style: simple requestBody: content: application/x-www-form-urlencoded: - encoding: {} + encoding: + expand: + explode: true + style: deepObject schema: additionalProperties: false - properties: {} + properties: + display_name: + description: The meter's name. + maxLength: 250 + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array type: object required: false responses: @@ -49227,38 +54786,7 @@ paths: content: application/json: schema: - description: '' - properties: - data: - items: - $ref: '#/components/schemas/balance_transaction' - type: array - has_more: - description: >- - True if this list has another page of items after this one - that can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same - type share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - pattern: ^/v1/balance_transactions - type: string - required: - - data - - has_more - - object - - url - title: BalanceTransactionsList - type: object - x-expandableFields: - - data + $ref: '#/components/schemas/billing.meter' description: Successful response. default: content: @@ -49266,28 +54794,13 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/balance/history/{id}': - get: - description: >- -

Retrieves the balance transaction with the given ID.

- - -

Note that this endpoint previously used the path - /v1/balance/history/:id.

- operationId: GetBalanceHistoryId + '/v1/billing/meters/{id}/deactivate': + post: + description:

Deactivates a billing meter

+ operationId: PostBillingMetersIdDeactivate parameters: - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject - - in: path + - description: Unique identifier for the object. + in: path name: id required: true schema: @@ -49297,10 +54810,19 @@ paths: requestBody: content: application/x-www-form-urlencoded: - encoding: {} + encoding: + expand: + explode: true + style: deepObject schema: additionalProperties: false - properties: {} + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array type: object required: false responses: @@ -49308,7 +54830,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/balance_transaction' + $ref: '#/components/schemas/billing.meter' description: Successful response. default: content: @@ -49316,48 +54838,28 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - /v1/balance_transactions: + '/v1/billing/meters/{id}/event_summaries': get: - description: >- -

Returns a list of transactions that have contributed to the Stripe - account balance (e.g., charges, transfers, and so forth). The - transactions are returned in sorted order, with the most recent - transactions appearing first.

- - -

Note that this endpoint was previously called “Balance history” and - used the path /v1/balance/history.

- operationId: GetBalanceTransactions + description:

Retrieve a list of billing meter event summaries.

+ operationId: GetBillingMetersIdEventSummaries parameters: - - explode: true + - description: The customer for which to fetch event summaries. in: query - name: created - required: false + name: customer + required: true schema: - anyOf: - - properties: - gt: - type: integer - gte: - type: integer - lt: - type: integer - lte: - type: integer - title: range_query_specs - type: object - - type: integer - style: deepObject + maxLength: 5000 + type: string + style: form - description: >- - Only return transactions in a certain currency. Three-letter [ISO - currency code](https://www.iso.org/iso-4217-currency-codes.html), in - lowercase. Must be a [supported - currency](https://stripe.com/docs/currencies). + The timestamp from when to stop aggregating meter events + (exclusive). in: query - name: currency - required: false + name: end_time + required: true schema: - type: string + format: unix-time + type: integer style: form - description: >- A cursor for use in pagination. `ending_before` is an object ID that @@ -49383,6 +54885,14 @@ paths: type: string type: array style: deepObject + - description: Unique identifier for the object. + in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @@ -49393,22 +54903,14 @@ paths: type: integer style: form - description: >- - For automatic Stripe payouts only, only returns transactions that - were paid out on the specified payout ID. - in: query - name: payout - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: Only returns the original transaction. + The timestamp from when to start aggregating meter events + (inclusive). in: query - name: source - required: false + name: start_time + required: true schema: - maxLength: 5000 - type: string + format: unix-time + type: integer style: form - description: >- A cursor for use in pagination. `starting_after` is an object ID @@ -49424,26 +54926,15 @@ paths: type: string style: form - description: >- - Only returns transactions of the given type. One of: `adjustment`, - `advance`, `advance_funding`, `anticipation_repayment`, - `application_fee`, `application_fee_refund`, `charge`, - `connect_collection_transfer`, `contribution`, - `issuing_authorization_hold`, `issuing_authorization_release`, - `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, - `obligation_outbound`, `obligation_reversal_inbound`, - `obligation_reversal_outbound`, `obligation_payout`, - `obligation_payout_failure`, `payment`, `payment_failure_refund`, - `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`. + Specifies what granularity to use when generating event summaries. + If not specified, a single event summary would be returned for the + specified time range. in: query - name: type + name: value_grouping_window required: false schema: - maxLength: 5000 + enum: + - hour type: string style: form requestBody: @@ -49464,7 +54955,7 @@ paths: properties: data: items: - $ref: '#/components/schemas/balance_transaction' + $ref: '#/components/schemas/billing.meter_event_summary' type: array has_more: description: >- @@ -49481,14 +54972,14 @@ paths: url: description: The URL where this list can be accessed. maxLength: 5000 - pattern: ^/v1/balance_transactions + pattern: '^/v1/billing/meters/[^/]+/event_summaries' type: string required: - data - has_more - object - url - title: BalanceTransactionsList + title: BillingMeterResourceBillingMeterEventSummaryList type: object x-expandableFields: - data @@ -49499,28 +54990,13 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/balance_transactions/{id}': - get: - description: >- -

Retrieves the balance transaction with the given ID.

- - -

Note that this endpoint previously used the path - /v1/balance/history/:id.

- operationId: GetBalanceTransactionsId + '/v1/billing/meters/{id}/reactivate': + post: + description:

Reactivates a billing meter

+ operationId: PostBillingMetersIdReactivate parameters: - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject - - in: path + - description: Unique identifier for the object. + in: path name: id required: true schema: @@ -49530,10 +55006,19 @@ paths: requestBody: content: application/x-www-form-urlencoded: - encoding: {} + encoding: + expand: + explode: true + style: deepObject schema: additionalProperties: false - properties: {} + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array type: object required: false responses: @@ -49541,7 +55026,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/balance_transaction' + $ref: '#/components/schemas/billing.meter' description: Successful response. default: content: @@ -49803,322 +55288,8 @@ paths: type: string required: - enabled - - options - title: subscription_cancellation_reason_creation_param - type: object - enabled: - type: boolean - mode: - enum: - - at_period_end - - immediately - type: string - proration_behavior: - enum: - - always_invoice - - create_prorations - - none - type: string - required: - - enabled - title: subscription_cancel_creation_param - type: object - subscription_pause: - properties: - enabled: - type: boolean - title: subscription_pause_param - type: object - subscription_update: - properties: - default_allowed_updates: - anyOf: - - items: - enum: - - price - - promotion_code - - quantity - type: string - type: array - - enum: - - '' - type: string - enabled: - type: boolean - products: - anyOf: - - items: - properties: - prices: - items: - maxLength: 5000 - type: string - type: array - product: - maxLength: 5000 - type: string - required: - - prices - - product - title: subscription_update_product_param - type: object - type: array - - enum: - - '' - type: string - proration_behavior: - enum: - - always_invoice - - create_prorations - - none - type: string - required: - - default_allowed_updates - - enabled - - products - title: subscription_update_creation_param - type: object - title: features_creation_param - type: object - login_page: - description: >- - The hosted login page for this configuration. Learn more - about the portal login page in our [integration - docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share). - properties: - enabled: - type: boolean - required: - - enabled - title: login_page_create_param - type: object - metadata: - additionalProperties: - type: 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. Individual keys can be unset by posting an empty - value to them. All keys can be unset by posting an empty - value to `metadata`. - type: object - required: - - business_profile - - features - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/billing_portal.configuration' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - '/v1/billing_portal/configurations/{configuration}': - get: - description: >- -

Retrieves a configuration that describes the functionality of the - customer portal.

- operationId: GetBillingPortalConfigurationsConfiguration - parameters: - - in: path - name: configuration - required: true - schema: - maxLength: 5000 - type: string - style: simple - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/billing_portal.configuration' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - post: - description: >- -

Updates a configuration that describes the functionality of the - customer portal.

- operationId: PostBillingPortalConfigurationsConfiguration - parameters: - - in: path - name: configuration - required: true - schema: - maxLength: 5000 - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: - business_profile: - explode: true - style: deepObject - default_return_url: - explode: true - style: deepObject - expand: - explode: true - style: deepObject - features: - explode: true - style: deepObject - login_page: - explode: true - style: deepObject - metadata: - explode: true - style: deepObject - schema: - additionalProperties: false - properties: - active: - description: >- - Whether the configuration is active and can be used to - create portal sessions. - type: boolean - business_profile: - description: The business information shown to customers in the portal. - properties: - headline: - anyOf: - - maxLength: 60 - type: string - - enum: - - '' - type: string - privacy_policy_url: - anyOf: - - type: string - - enum: - - '' - type: string - terms_of_service_url: - anyOf: - - type: string - - enum: - - '' - type: string - title: business_profile_update_param - type: object - default_return_url: - anyOf: - - type: string - - enum: - - '' - type: string - description: >- - The default URL to redirect customers to when they click on - the portal's link to return to your website. This can be - [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) - when creating the session. - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - features: - description: Information about the features available in the portal. - properties: - customer_update: - properties: - allowed_updates: - anyOf: - - items: - enum: - - address - - email - - name - - phone - - shipping - - tax_id - type: string - type: array - - enum: - - '' - type: string - enabled: - type: boolean - title: customer_update_updating_param - type: object - invoice_history: - properties: - enabled: - type: boolean - required: - - enabled - title: invoice_list_param - type: object - payment_method_update: - properties: - enabled: - type: boolean - required: - - enabled - title: payment_method_update_param - type: object - subscription_cancel: - properties: - cancellation_reason: - properties: - enabled: - type: boolean - options: - anyOf: - - items: - enum: - - customer_service - - low_quality - - missing_features - - other - - switched_service - - too_complex - - too_expensive - - unused - type: string - type: array - - enum: - - '' - type: string - required: - - enabled - title: subscription_cancellation_reason_updating_param + - options + title: subscription_cancellation_reason_creation_param type: object enabled: type: boolean @@ -50133,13 +55304,315 @@ paths: - create_prorations - none type: string - title: subscription_cancel_updating_param + required: + - enabled + title: subscription_cancel_creation_param type: object - subscription_pause: + subscription_update: properties: + default_allowed_updates: + anyOf: + - items: + enum: + - price + - promotion_code + - quantity + type: string + type: array + - enum: + - '' + type: string enabled: type: boolean - title: subscription_pause_param + products: + anyOf: + - items: + properties: + prices: + items: + maxLength: 5000 + type: string + type: array + product: + maxLength: 5000 + type: string + required: + - prices + - product + title: subscription_update_product_param + type: object + type: array + - enum: + - '' + type: string + proration_behavior: + enum: + - always_invoice + - create_prorations + - none + type: string + required: + - default_allowed_updates + - enabled + - products + title: subscription_update_creation_param + type: object + title: features_creation_param + type: object + login_page: + description: >- + The hosted login page for this configuration. Learn more + about the portal login page in our [integration + docs](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal#share). + properties: + enabled: + type: boolean + required: + - enabled + title: login_page_create_param + type: object + metadata: + additionalProperties: + type: 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. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + type: object + required: + - business_profile + - features + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing_portal.configuration' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/billing_portal/configurations/{configuration}': + get: + description: >- +

Retrieves a configuration that describes the functionality of the + customer portal.

+ operationId: GetBillingPortalConfigurationsConfiguration + parameters: + - in: path + name: configuration + required: true + schema: + maxLength: 5000 + type: string + style: simple + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/billing_portal.configuration' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description: >- +

Updates a configuration that describes the functionality of the + customer portal.

+ operationId: PostBillingPortalConfigurationsConfiguration + parameters: + - in: path + name: configuration + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + business_profile: + explode: true + style: deepObject + default_return_url: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + features: + explode: true + style: deepObject + login_page: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + active: + description: >- + Whether the configuration is active and can be used to + create portal sessions. + type: boolean + business_profile: + description: The business information shown to customers in the portal. + properties: + headline: + anyOf: + - maxLength: 60 + type: string + - enum: + - '' + type: string + privacy_policy_url: + anyOf: + - type: string + - enum: + - '' + type: string + terms_of_service_url: + anyOf: + - type: string + - enum: + - '' + type: string + title: business_profile_update_param + type: object + default_return_url: + anyOf: + - type: string + - enum: + - '' + type: string + description: >- + The default URL to redirect customers to when they click on + the portal's link to return to your website. This can be + [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) + when creating the session. + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + features: + description: Information about the features available in the portal. + properties: + customer_update: + properties: + allowed_updates: + anyOf: + - items: + enum: + - address + - email + - name + - phone + - shipping + - tax_id + type: string + type: array + - enum: + - '' + type: string + enabled: + type: boolean + title: customer_update_updating_param + type: object + invoice_history: + properties: + enabled: + type: boolean + required: + - enabled + title: invoice_list_param + type: object + payment_method_update: + properties: + enabled: + type: boolean + required: + - enabled + title: payment_method_update_param + type: object + subscription_cancel: + properties: + cancellation_reason: + properties: + enabled: + type: boolean + options: + anyOf: + - items: + enum: + - customer_service + - low_quality + - missing_features + - other + - switched_service + - too_complex + - too_expensive + - unused + type: string + type: array + - enum: + - '' + type: string + required: + - enabled + title: subscription_cancellation_reason_updating_param + type: object + enabled: + type: boolean + mode: + enum: + - at_period_end + - immediately + type: string + proration_behavior: + enum: + - always_invoice + - create_prorations + - none + type: string + title: subscription_cancel_updating_param type: object subscription_update: properties: @@ -50449,7 +55922,7 @@ paths: specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the - [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). + [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, @@ -50485,7 +55958,10 @@ paths: first.

operationId: GetCharges parameters: - - explode: true + - description: >- + Only return charges that were created during the given date + interval. + explode: true in: query name: created required: false @@ -50629,14 +56105,13 @@ paths: description: Error response. post: description: >- -

Use the Payment Intents API - to initiate a new payment instead +

This method is no longer recommended—use the Payment Intents API - of using this method. Confirmation of the PaymentIntent creates the - Charge + to initiate a new payment instead. Confirmation of the PaymentIntent + creates the Charge - object used to request payment, so this method is limited to legacy - integrations.

+ object used to request payment.

operationId: PostCharges requestBody: content: @@ -50688,7 +56163,7 @@ paths: account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees - [documentation](https://stripe.com/docs/connect/direct-charges#collecting-fees). + [documentation](https://stripe.com/docs/connect/direct-charges#collect-fees). type: integer capture: description: >- @@ -50820,7 +56295,7 @@ paths: The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and - Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#on-behalf-of). + Transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). maxLength: 5000 type: string radar_options: @@ -51703,7 +57178,8 @@ paths: properties: amount: description: >- - A positive integer in cents (or local equivalent) + A positive integer in the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal) representing how much of this charge to refund. Can refund only up to the remaining, unrefunded amount of the charge. type: integer @@ -52159,6 +57635,28 @@ paths: description:

Returns a list of Checkout Sessions.

operationId: GetCheckoutSessions parameters: + - description: >- + Only return Checkout Sessions that were created during the given + date interval. + explode: true + in: query + name: created + required: false + schema: + anyOf: + - properties: + gt: + type: integer + gte: + type: integer + lt: + type: integer + lte: + type: integer + title: range_query_specs + type: object + - type: integer + style: deepObject - description: Only return the Checkout Sessions for the Customer specified. in: query name: customer @@ -52359,6 +57857,9 @@ paths: payment_intent_data: explode: true style: deepObject + payment_method_data: + explode: true + style: deepObject payment_method_options: explode: true style: deepObject @@ -52368,6 +57869,9 @@ paths: phone_number_collection: explode: true style: deepObject + saved_payment_method_options: + explode: true + style: deepObject setup_intent_data: explode: true style: deepObject @@ -52411,6 +57915,19 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_params @@ -52418,7 +57935,7 @@ paths: billing_address_collection: description: >- Specify whether Checkout should collect the customer's - billing address. + billing address. Defaults to `auto`. enum: - auto - required @@ -52446,6 +57963,17 @@ paths: Configure fields for the Checkout Session to gather active consent from customers. properties: + payment_method_reuse_agreement: + properties: + position: + enum: + - auto + - hidden + type: string + required: + - position + title: payment_method_reuse_agreement_params + type: object promotions: enum: - auto @@ -52469,7 +57997,7 @@ paths: custom_fields: description: >- Collect additional information from your customer using - custom fields. Up to 2 fields are supported. + custom fields. Up to 3 fields are supported. items: properties: dropdown: @@ -52546,6 +58074,19 @@ paths: Display additional text for your customers using custom text. properties: + after_submit: + anyOf: + - properties: + message: + maxLength: 1200 + type: string + required: + - message + title: custom_text_position_param + type: object + - enum: + - '' + type: string shipping_address: anyOf: - properties: @@ -52745,10 +58286,10 @@ paths: - items: properties: name: - maxLength: 30 + maxLength: 40 type: string value: - maxLength: 30 + maxLength: 140 type: string required: - name @@ -52765,6 +58306,19 @@ paths: footer: maxLength: 5000 type: string + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object metadata: additionalProperties: type: string @@ -53068,7 +58622,8 @@ paths: or a discount. - Can only be set in `subscription` mode. + Can only be set in `subscription` mode. Defaults to + `always`. If you'd like information on how to collect a payment method @@ -53085,6 +58640,19 @@ paths: Checkout session. maxLength: 100 type: string + payment_method_data: + description: >- + This parameter allows you to set some attributes on the + payment method created during a Checkout session. + properties: + allow_redisplay: + enum: + - always + - limited + - unspecified + type: string + title: payment_method_data_param + type: object payment_method_options: description: Payment-method-specific configuration. properties: @@ -53165,6 +58733,15 @@ paths: type: string title: payment_method_options_param type: object + amazon_pay: + properties: + setup_future_usage: + enum: + - none + - off_session + type: string + title: payment_method_options_param + type: object au_becs_debit: properties: setup_future_usage: @@ -53211,6 +58788,13 @@ paths: type: boolean title: installments_param type: object + request_three_d_secure: + enum: + - any + - automatic + - challenge + type: string + x-stripeBypassValidation: true setup_future_usage: enum: - off_session @@ -53350,6 +58934,14 @@ paths: type: string title: payment_method_options_param type: object + mobilepay: + properties: + setup_future_usage: + enum: + - none + type: string + title: payment_method_options_param + type: object oxxo: properties: expires_after_days: @@ -53457,6 +59049,13 @@ paths: type: string title: payment_method_options_param type: object + swish: + properties: + reference: + maxLength: 5000 + type: string + title: payment_method_options_param + type: object us_bank_account: properties: financial_connections: @@ -53476,6 +59075,8 @@ paths: items: enum: - balances + - ownership + - transactions type: string x-stripeBypassValidation: true type: array @@ -53552,6 +59153,7 @@ paths: - affirm - afterpay_clearpay - alipay + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -53568,6 +59170,7 @@ paths: - klarna - konbini - link + - mobilepay - oxxo - p24 - paynow @@ -53577,6 +59180,7 @@ paths: - revolut_pay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay - zip @@ -53603,11 +59207,10 @@ paths: type: object redirect_on_completion: description: >- - This parameter applies to `ui_mode: embedded`. By default, - Stripe will always redirect to your return_url after a - successful confirmation. If you set `redirect_on_completion: - 'if_required'`, then we will only redirect if your user - chooses a redirect-based payment method. + This parameter applies to `ui_mode: embedded`. Learn more + about the [redirect + behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) + of embedded sessions. Defaults to `always`. enum: - always - if_required @@ -53623,7 +59226,28 @@ paths: and redirect-based payment methods are enabled on the session. + maxLength: 5000 type: string + saved_payment_method_options: + description: >- + Controls saved payment method settings for the session. Only + available in `payment` and `subscription` mode. + properties: + allow_redisplay_filters: + items: + enum: + - always + - limited + - unspecified + type: string + type: array + payment_method_save: + enum: + - disabled + - enabled + type: string + title: saved_payment_method_options_param + type: object setup_intent_data: description: >- A subset of parameters to be passed to SetupIntent creation @@ -54001,123 +59625,548 @@ paths: relevant text on the page, such as the submit button. `submit_type` can only be - specified on Checkout Sessions in `payment` mode, but not - Checkout Sessions + specified on Checkout Sessions in `payment` mode. If blank + or `auto`, `pay` is used. + enum: + - auto + - book + - donate + - pay + type: string + subscription_data: + description: >- + A subset of parameters to be passed to subscription creation + for Checkout Sessions in `subscription` mode. + properties: + application_fee_percent: + type: number + billing_cycle_anchor: + format: unix-time + type: integer + default_tax_rates: + items: + maxLength: 5000 + type: string + type: array + description: + maxLength: 500 + type: string + invoice_settings: + properties: + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + title: invoice_settings_params + type: object + metadata: + additionalProperties: + type: string + type: object + on_behalf_of: + type: string + proration_behavior: + enum: + - create_prorations + - none + type: string + transfer_data: + properties: + amount_percent: + type: number + destination: + type: string + required: + - destination + title: transfer_data_specs + type: object + trial_end: + format: unix-time + type: integer + trial_period_days: + type: integer + trial_settings: + properties: + end_behavior: + properties: + missing_payment_method: + enum: + - cancel + - create_invoice + - pause + type: string + required: + - missing_payment_method + title: end_behavior + type: object + required: + - end_behavior + title: trial_settings_config + type: object + title: subscription_data_params + type: object + success_url: + description: >- + The URL to which Stripe should send customers when payment + or setup + + is complete. + + This parameter is not allowed if ui_mode is `embedded`. If + you’d like to use + + information from the successful Checkout Session on your + page, read the + + guide on [customizing your success + page](https://stripe.com/docs/payments/checkout/custom-success-page). + maxLength: 5000 + type: string + tax_id_collection: + description: Controls tax ID collection settings for the session. + properties: + enabled: + type: boolean + required: + - enabled + title: tax_id_collection_params + type: object + ui_mode: + description: The UI mode of the Session. Defaults to `hosted`. + enum: + - embedded + - hosted + type: string + x-stripeBypassValidation: true + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/checkout.session' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/checkout/sessions/{session}': + get: + description:

Retrieves a Session object.

+ operationId: GetCheckoutSessionsSession + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: session + required: true + schema: + maxLength: 66 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/checkout.session' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/checkout/sessions/{session}/expire': + post: + description: >- +

A Session can be expired when it is in one of these statuses: + open

+ + +

After it expires, a customer can’t complete a Session and customers + loading the Session see a message saying the Session is expired.

+ operationId: PostCheckoutSessionsSessionExpire + parameters: + - in: path + name: session + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/checkout.session' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/checkout/sessions/{session}/line_items': + get: + description: >- +

When retrieving a Checkout Session, there is an includable + line_items property containing the first handful of + those items. There is also a URL where you can retrieve the full + (paginated) list of line items.

+ operationId: GetCheckoutSessionsSessionLineItems + parameters: + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - in: path + name: session + required: true + schema: + maxLength: 5000 + type: string + style: simple + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + description: Details about each object. + items: + $ref: '#/components/schemas/item' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: PaymentPagesCheckoutSessionListLineItems + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/climate/orders: + get: + description: >- +

Lists all Climate order objects. The orders are returned sorted by + creation date, with the + + most recently created orders appearing first.

+ operationId: GetClimateOrders + parameters: + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/climate.order' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/climate/orders + type: string + required: + - data + - has_more + - object + - url + title: ClimateRemovalsOrdersList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description: >- +

Creates a Climate order object for a given Climate product. The order + will be processed immediately - in `subscription` or `setup` mode. - enum: - - auto - - book - - donate - - pay - type: string - subscription_data: + after creation and payment will be deducted your Stripe balance.

+ operationId: PostClimateOrders + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + beneficiary: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + amount: description: >- - A subset of parameters to be passed to subscription creation - for Checkout Sessions in `subscription` mode. + Requested amount of carbon removal units. Either this or + `metric_tons` must be specified. + type: integer + beneficiary: + description: >- + Publicly sharable reference for the end beneficiary of + carbon removal. Assumed to be the Stripe account if not set. properties: - application_fee_percent: - type: number - billing_cycle_anchor: - format: unix-time - type: integer - default_tax_rates: - items: - maxLength: 5000 - type: string - type: array - description: - maxLength: 500 - type: string - metadata: - additionalProperties: - type: string - type: object - on_behalf_of: - type: string - proration_behavior: - enum: - - create_prorations - - none + public_name: + maxLength: 5000 type: string - transfer_data: - properties: - amount_percent: - type: number - destination: - type: string - required: - - destination - title: transfer_data_specs - type: object - trial_end: - format: unix-time - type: integer - trial_period_days: - type: integer - trial_settings: - properties: - end_behavior: - properties: - missing_payment_method: - enum: - - cancel - - create_invoice - - pause - type: string - required: - - missing_payment_method - title: end_behavior - type: object - required: - - end_behavior - title: trial_settings_config - type: object - title: subscription_data_params + required: + - public_name + title: beneficiary_params type: object - success_url: + currency: description: >- - The URL to which Stripe should send customers when payment - or setup - - is complete. - - This parameter is not allowed if ui_mode is `embedded`. If - you’d like to use - - information from the successful Checkout Session on your - page, read the - - guide on [customizing your success - page](https://stripe.com/docs/payments/checkout/custom-success-page). + Request currency for the order as a three-letter [ISO + currency + code](https://www.iso.org/iso-4217-currency-codes.html), in + lowercase. Must be a supported [settlement currency for your + account](https://stripe.com/docs/currencies). If omitted, + the account's default currency will be used. maxLength: 5000 type: string - tax_id_collection: - description: Controls tax ID collection settings for the session. - properties: - enabled: - type: boolean - required: - - enabled - title: tax_id_collection_params + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + metadata: + additionalProperties: + type: 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. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. type: object - ui_mode: + metric_tons: description: >- - `ui_mode` can be `hosted` or `embedded`. The default is - `hosted`. - enum: - - embedded - - hosted + Requested number of tons for the order. Either this or + `amount` must be specified. + format: decimal type: string - x-stripeBypassValidation: true + product: + description: Unique identifier of the Climate product. + maxLength: 5000 + type: string + required: + - product type: object - required: false + required: true responses: '200': content: application/json: schema: - $ref: '#/components/schemas/checkout.session' + $ref: '#/components/schemas/climate.order' description: Successful response. default: content: @@ -54125,10 +60174,12 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/checkout/sessions/{session}': + '/v1/climate/orders/{order}': get: - description:

Retrieves a Session object.

- operationId: GetCheckoutSessionsSession + description: >- +

Retrieves the details of a Climate order object with the given + ID.

+ operationId: GetClimateOrdersOrder parameters: - description: Specifies which fields in the response should be expanded. explode: true @@ -54141,11 +60192,12 @@ paths: type: string type: array style: deepObject - - in: path - name: session + - description: Unique identifier of the order. + in: path + name: order required: true schema: - maxLength: 66 + maxLength: 5000 type: string style: simple requestBody: @@ -54162,7 +60214,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/checkout.session' + $ref: '#/components/schemas/climate.order' description: Successful response. default: content: @@ -54170,19 +60222,108 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/checkout/sessions/{session}/expire': post: description: >- -

A Session can be expired when it is in one of these statuses: - open

+

Updates the specified order by setting the values of the parameters + passed.

+ operationId: PostClimateOrdersOrder + parameters: + - description: Unique identifier of the order. + in: path + name: order + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + beneficiary: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + beneficiary: + anyOf: + - properties: + public_name: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + required: + - public_name + title: beneficiary_params + type: object + - enum: + - '' + type: string + description: >- + Publicly sharable reference for the end beneficiary of + carbon removal. Assumed to be the Stripe account if not set. + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + metadata: + additionalProperties: + type: 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. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + type: object + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/climate.order' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/climate/orders/{order}/cancel': + post: + description: >- +

Cancels a Climate order. You can cancel an order within 30 days of + creation. Stripe refunds the + reservation amount_subtotal, but not the + amount_fees for user-triggered cancellations. Frontier -

After it expires, a customer can’t complete a Session and customers - loading the Session see a message saying the Session is expired.

- operationId: PostCheckoutSessionsSessionExpire + might cancel reservations if suppliers fail to deliver. If Frontier + cancels the reservation, Stripe + + provides 90 days advance notice and refunds the + amount_total.

+ operationId: PostClimateOrdersOrderCancel parameters: - - in: path - name: session + - description: Unique identifier of the order. + in: path + name: order required: true schema: maxLength: 5000 @@ -54211,7 +60352,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/checkout.session' + $ref: '#/components/schemas/climate.order' description: Successful response. default: content: @@ -54219,14 +60360,10 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/checkout/sessions/{session}/line_items': + /v1/climate/products: get: - description: >- -

When retrieving a Checkout Session, there is an includable - line_items property containing the first handful of - those items. There is also a URL where you can retrieve the full - (paginated) list of line items.

- operationId: GetCheckoutSessionsSessionLineItems + description:

Lists all available Climate product objects.

+ operationId: GetClimateProducts parameters: - description: >- A cursor for use in pagination. `ending_before` is an object ID that @@ -54261,13 +60398,155 @@ paths: schema: type: integer style: form + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/climate.product' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/climate/products + type: string + required: + - data + - has_more + - object + - url + title: ClimateRemovalsProductsList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/climate/products/{product}': + get: + description:

Retrieves the details of a Climate product with the given ID.

+ operationId: GetClimateProductsProduct + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject - in: path - name: session + name: product required: true schema: maxLength: 5000 type: string style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/climate.product' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/climate/suppliers: + get: + description:

Lists all available Climate supplier objects.

+ operationId: GetClimateSuppliers + parameters: + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form - 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 @@ -54298,9 +60577,8 @@ paths: description: '' properties: data: - description: Details about each object. items: - $ref: '#/components/schemas/item' + $ref: '#/components/schemas/climate.supplier' type: array has_more: description: >- @@ -54317,13 +60595,14 @@ paths: url: description: The URL where this list can be accessed. maxLength: 5000 + pattern: ^/v1/climate/suppliers type: string required: - data - has_more - object - url - title: PaymentPagesCheckoutSessionListLineItems + title: ClimateRemovalsSuppliersList type: object x-expandableFields: - data @@ -54334,6 +60613,96 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + '/v1/climate/suppliers/{supplier}': + get: + description:

Retrieves a Climate supplier object.

+ operationId: GetClimateSuppliersSupplier + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: supplier + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/climate.supplier' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/confirmation_tokens/{confirmation_token}': + get: + description:

Retrieves an existing ConfirmationToken object

+ operationId: GetConfirmationTokensConfirmationToken + parameters: + - in: path + name: confirmation_token + required: true + schema: + maxLength: 5000 + type: string + style: simple + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/confirmation_token' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. /v1/country_specs: get: description:

Lists all Country Spec objects available in the API.

@@ -54953,6 +61322,28 @@ paths: description:

Returns a list of credit notes.

operationId: GetCreditNotes parameters: + - description: >- + Only return credit notes that were created during the given date + interval. + explode: true + in: query + name: created + required: false + schema: + anyOf: + - properties: + gt: + type: integer + gte: + type: integer + lt: + type: integer + lte: + type: integer + title: range_query_specs + type: object + - type: integer + style: deepObject - description: >- Only return credit notes for the customer specified by this customer ID. @@ -56056,6 +62447,79 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + /v1/customer_sessions: + post: + description: >- +

Creates a customer session object that includes a single-use client + secret that you can use on your front-end to grant client-side API + access for certain customer resources.

+ operationId: PostCustomerSessions + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + components: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + components: + description: >- + Configuration for each component. Exactly 1 component must + be enabled. + properties: + buy_button: + properties: + enabled: + type: boolean + required: + - enabled + title: buy_button_param + type: object + pricing_table: + properties: + enabled: + type: boolean + required: + - enabled + title: pricing_table_param + type: object + title: components + type: object + customer: + description: >- + The ID of an existing customer for which to create the + customer session. + maxLength: 5000 + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + required: + - components + - customer + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/customer_session' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. /v1/customers: get: description: >- @@ -56063,7 +62527,10 @@ paths: by creation date, with the most recent customers appearing first.

operationId: GetCustomers parameters: - - explode: true + - description: >- + Only return customers that were created during the given date + interval. + explode: true in: query name: created required: false @@ -56328,10 +62795,10 @@ paths: - items: properties: name: - maxLength: 30 + maxLength: 40 type: string value: - maxLength: 30 + maxLength: 140 type: string required: - name @@ -56357,7 +62824,7 @@ paths: - exclude_tax - include_inclusive_tax type: string - title: rendering_options_param + title: customer_rendering_options_param type: object - enum: - '' @@ -56404,7 +62871,7 @@ paths: type: array promotion_code: description: >- - The API ID of a promotion code to apply to the customer. The + The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. @@ -56465,6 +62932,11 @@ paths: - enum: - '' type: string + validate_location: + enum: + - deferred + - immediately + type: string title: tax_param type: object tax_exempt: @@ -56489,6 +62961,7 @@ paths: - au_abn - au_arn - bg_uic + - bh_vat - bo_tin - br_cnpj - br_cpf @@ -56522,13 +62995,17 @@ paths: - jp_trn - ke_pin - kr_brn + - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst + - ng_tin - no_vat + - no_voec - nz_gst + - om_vat - pe_ruc - ph_tin - ro_tin @@ -57061,10 +63538,10 @@ paths: - items: properties: name: - maxLength: 30 + maxLength: 40 type: string value: - maxLength: 30 + maxLength: 140 type: string required: - name @@ -57090,7 +63567,7 @@ paths: - exclude_tax - include_inclusive_tax type: string - title: rendering_options_param + title: customer_rendering_options_param type: object - enum: - '' @@ -57134,7 +63611,7 @@ paths: type: array promotion_code: description: >- - The API ID of a promotion code to apply to the customer. The + The ID of a promotion code to apply to the customer. The customer will have a discount applied on all recurring payments. Charges you create through the API will not have the discount. @@ -57195,6 +63672,11 @@ paths: - enum: - '' type: string + validate_location: + enum: + - deferred + - immediately + type: string title: tax_param type: object tax_exempt: @@ -59203,6 +65685,22 @@ paths: description:

Returns a list of PaymentMethods for a given Customer

operationId: GetCustomersCustomerPaymentMethods parameters: + - 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`. + in: query + name: allow_redisplay + required: false + schema: + enum: + - always + - limited + - unspecified + type: string + style: form - in: path name: customer required: true @@ -59269,6 +65767,7 @@ paths: - affirm - afterpay_clearpay - alipay + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -59285,6 +65784,7 @@ paths: - klarna - konbini - link + - mobilepay - oxxo - p24 - paynow @@ -59294,6 +65794,7 @@ paths: - revolut_pay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay - zip @@ -60163,6 +66664,9 @@ paths: add_invoice_items: explode: true style: deepObject + application_fee_percent: + explode: true + style: deepObject automatic_tax: explode: true style: deepObject @@ -60172,9 +66676,15 @@ paths: default_tax_rates: explode: true style: deepObject + discounts: + explode: true + style: deepObject expand: explode: true style: deepObject + invoice_settings: + explode: true + style: deepObject items: explode: true style: deepObject @@ -60206,6 +66716,21 @@ paths: You may pass up to 20 items. items: properties: + discounts: + items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array price: maxLength: 5000 type: string @@ -60247,6 +66772,11 @@ paths: type: object type: array application_fee_percent: + anyOf: + - type: number + - enum: + - '' + type: string description: >- A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the @@ -60256,7 +66786,6 @@ paths: an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). - type: number automatic_tax: description: >- Automatic tax settings for this subscription. We recommend @@ -60265,6 +66794,19 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_config @@ -60280,12 +66822,13 @@ paths: type: integer billing_cycle_anchor: description: >- - A future timestamp to anchor the subscription's [billing + A future timestamp in UTC format to anchor the + subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). - This is used to determine the date of the first full - invoice, and, for plans with `month` or `year` intervals, - the day of the month for subsequent invoices. The timestamp - is in UTC format. + The anchor is the reference point that aligns future billing + cycle dates. It sets the day of week for `week` intervals, + the day of month for `month` and `year` intervals, and the + month of year for `year` intervals. format: unix-time type: integer x-stripeBypassValidation: true @@ -60336,7 +66879,9 @@ paths: 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. + for that particular subscription. This field has been + deprecated and will be removed in a future API version. Use + `discounts` instead. maxLength: 5000 type: string currency: @@ -60388,12 +66933,62 @@ paths: The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + description: >- + The coupons to redeem into discounts for the subscription. + If not specified or empty, inherits the discount from the + subscription's customer. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array + invoice_settings: + description: All invoices will be billed using the specified settings. + properties: + account_tax_ids: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + title: invoice_settings_param + type: object items: description: >- A list of up to 20 subscription items, each with an attached @@ -60412,6 +67007,25 @@ paths: - enum: - '' type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string metadata: additionalProperties: type: string @@ -60499,13 +67113,13 @@ paths: `collection_method=charge_automatically`. - Use `allow_incomplete` to create subscriptions with - `status=incomplete` if the first invoice cannot be paid. - Creating subscriptions with this status allows you to manage - scenarios where additional user actions are needed to pay a - subscription's invoice. For example, SCA regulation may - require 3DS authentication to complete payment. See the [SCA - Migration + Use `allow_incomplete` to create Subscriptions with + `status=incomplete` if the first invoice can't be paid. + Creating Subscriptions with this status allows you to manage + scenarios where additional customer actions are needed to + pay a subscription's invoice. For example, SCA regulation + may require 3DS authentication to complete payment. See the + [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -60513,34 +67127,35 @@ paths: Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to - `status=active` when successfully confirming the payment - intent on the first invoice. This allows simpler management - of scenarios where additional user actions are needed to pay - a subscription’s invoice. Such as failed payments, [SCA + `status=active` when successfully confirming the + PaymentIntent on the first invoice. This allows simpler + management of scenarios where additional customer actions + are needed to pay a subscription’s invoice, such as failed + payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If - the payment intent is not confirmed within 23 hours - subscriptions transition to `status=incomplete_expired`, + the PaymentIntent is not confirmed within 23 hours + Subscriptions transition to `status=incomplete_expired`, which is a terminal state. Use `error_if_incomplete` if you want Stripe to return an - HTTP 402 status code if a subscription's first invoice - cannot be paid. For example, if a payment method requires - 3DS authentication due to SCA regulation and further user - action is needed, this parameter does not create a - subscription and returns an error instead. This was the + HTTP 402 status code if a subscription's first invoice can't + be paid. For example, if a payment method requires 3DS + authentication due to SCA regulation and further customer + action is needed, this parameter doesn't create a + Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. `pending_if_incomplete` is only used with updates and cannot - be passed when creating a subscription. + be passed when creating a Subscription. Subscriptions with `collection_method=send_invoice` are - automatically activated regardless of the first invoice + automatically activated regardless of the first Invoice status. enum: - allow_incomplete @@ -60631,6 +67246,7 @@ paths: enum: - any - automatic + - challenge type: string title: subscription_payment_method_options_param type: object @@ -60670,6 +67286,14 @@ paths: - enum: - '' type: string + sepa_debit: + anyOf: + - properties: {} + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string us_bank_account: anyOf: - properties: @@ -60690,6 +67314,8 @@ paths: items: enum: - balances + - ownership + - transactions type: string x-stripeBypassValidation: true type: array @@ -60716,6 +67342,7 @@ paths: - ach_credit_transfer - ach_debit - acss_debit + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -60723,15 +67350,18 @@ paths: - card - cashapp - customer_balance + - eps - fpx - giropay - grabpay - ideal - konbini - link + - p24 - paynow - paypal - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -60775,16 +67405,17 @@ paths: given subscription at the specified interval. promotion_code: description: >- - The API ID of a promotion code to apply to this - subscription. A promotion code applied to a subscription - will only affect invoices created for that particular - subscription. + The ID of a promotion code to apply to this subscription. A + promotion code 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. maxLength: 5000 type: string proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) + [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. enum: @@ -61046,6 +67677,9 @@ paths: add_invoice_items: explode: true style: deepObject + application_fee_percent: + explode: true + style: deepObject automatic_tax: explode: true style: deepObject @@ -61064,9 +67698,15 @@ paths: default_tax_rates: explode: true style: deepObject + discounts: + explode: true + style: deepObject expand: explode: true style: deepObject + invoice_settings: + explode: true + style: deepObject items: explode: true style: deepObject @@ -61101,6 +67741,21 @@ paths: You may pass up to 20 items. items: properties: + discounts: + items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array price: maxLength: 5000 type: string @@ -61142,6 +67797,11 @@ paths: type: object type: array application_fee_percent: + anyOf: + - type: number + - enum: + - '' + type: string description: >- A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the @@ -61151,7 +67811,6 @@ paths: an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). - type: number automatic_tax: description: >- Automatic tax settings for this subscription. We recommend @@ -61160,6 +67819,19 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_config @@ -61251,7 +67923,9 @@ paths: 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. + for that particular subscription. This field has been + deprecated and will be removed in a future API version. Use + `discounts` instead. maxLength: 5000 type: string days_until_due: @@ -61301,12 +67975,62 @@ paths: does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates. + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + description: >- + The coupons to redeem into discounts for the subscription. + If not specified or empty, inherits the discount from the + subscription's customer. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array + invoice_settings: + description: All invoices will be billed using the specified settings. + properties: + account_tax_ids: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + title: invoice_settings_param + type: object items: description: >- A list of up to 20 subscription items, each with an attached @@ -61329,6 +68053,25 @@ paths: type: boolean deleted: type: boolean + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string id: maxLength: 5000 type: string @@ -61438,7 +68181,10 @@ paths: type: string description: >- If specified, payment collection for this subscription will - be paused. + be paused. Note that the subscription status will be + unchanged and will not be updated to `paused`. Learn more + about [pausing + collection](/billing/subscriptions/pause-payment). payment_behavior: description: >- Use `allow_incomplete` to transition the subscription to @@ -61567,6 +68313,7 @@ paths: enum: - any - automatic + - challenge type: string title: subscription_payment_method_options_param type: object @@ -61606,6 +68353,14 @@ paths: - enum: - '' type: string + sepa_debit: + anyOf: + - properties: {} + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string us_bank_account: anyOf: - properties: @@ -61626,6 +68381,8 @@ paths: items: enum: - balances + - ownership + - transactions type: string x-stripeBypassValidation: true type: array @@ -61652,6 +68409,7 @@ paths: - ach_credit_transfer - ach_debit - acss_debit + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -61659,15 +68417,18 @@ paths: - card - cashapp - customer_balance + - eps - fpx - giropay - grabpay - ideal - konbini - link + - p24 - paynow - paypal - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -61719,7 +68480,7 @@ paths: proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) + [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is @@ -62055,18 +68816,18 @@ paths: type: description: >- Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, - `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, - `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, + `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, + `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, - `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `li_uid`, `mx_rfc`, - `my_frp`, `my_itn`, `my_sst`, `no_vat`, `nz_gst`, `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`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, - or `za_vat` + `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, + `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`, `ua_vat`, + `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` enum: - ad_nrt - ae_trn @@ -62074,6 +68835,7 @@ paths: - au_abn - au_arn - bg_uic + - bh_vat - bo_tin - br_cnpj - br_cpf @@ -62107,13 +68869,17 @@ paths: - jp_trn - ke_pin - kr_brn + - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst + - ng_tin - no_vat + - no_voec - nz_gst + - om_vat - pe_ruc - ph_tin - ro_tin @@ -62653,6 +69419,437 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + /v1/entitlements/active_entitlements: + get: + description:

Retrieve a list of active entitlements for a customer

+ operationId: GetEntitlementsActiveEntitlements + parameters: + - description: The ID of the customer. + in: query + name: customer + required: true + schema: + maxLength: 5000 + type: string + style: form + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/entitlements.active_entitlement' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: EntitlementsResourceCustomerEntitlementList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/entitlements/active_entitlements/{id}': + get: + description:

Retrieve an active entitlement

+ operationId: GetEntitlementsActiveEntitlementsId + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: The ID of the entitlement. + in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/entitlements.active_entitlement' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/entitlements/features: + get: + description:

Retrieve a list of features

+ operationId: GetEntitlementsFeatures + parameters: + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/entitlements.feature' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/entitlements/features + type: string + required: + - data + - has_more + - object + - url + title: EntitlementsResourceFeatureList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description:

Creates a feature

+ operationId: PostEntitlementsFeatures + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + lookup_key: + description: >- + A unique key you provide as your own system identifier. This + may be up to 80 characters. + maxLength: 80 + type: string + 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 in a structured format. + type: object + name: + description: >- + The feature's name, for your own purpose, not meant to be + displayable to the customer. + maxLength: 80 + type: string + required: + - lookup_key + - name + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/entitlements.feature' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/entitlements/features/{id}': + get: + description:

Retrieves a feature

+ operationId: GetEntitlementsFeaturesId + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: The ID of the feature. + in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/entitlements.feature' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description:

Update a feature’s metadata or permanently deactivate it.

+ operationId: PostEntitlementsFeaturesId + parameters: + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + active: + description: >- + Inactive features cannot be attached to new products and + will not be returned from the features list endpoint. + type: boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + 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 in a structured format. + type: object + name: + description: >- + The feature's name, for your own purpose, not meant to be + displayable to the customer. + maxLength: 80 + type: string + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/entitlements.feature' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. /v1/ephemeral_keys: post: description:

Creates a short-lived API key for a given resource.

@@ -62761,12 +69958,13 @@ paths: description: >-

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version - attribute (not according to your current Stripe API version or - Stripe-Version header).

+ href="https://docs.stripe.com/api/events/object">event object + api_version attribute (not according to your current Stripe + API version or Stripe-Version header).

operationId: GetEvents parameters: - - explode: true + - description: Only return events that were created during the given date interval. + explode: true in: query name: created required: false @@ -63126,7 +70324,8 @@ paths: description:

Returns a list of file links.

operationId: GetFileLinks parameters: - - explode: true + - description: Only return links that were created during the given date interval. + explode: true in: query name: created required: false @@ -63461,7 +70660,8 @@ paths: recently created files at the top.

operationId: GetFiles parameters: - - explode: true + - description: Only return files that were created during the given date interval. + explode: true in: query name: created required: false @@ -64089,7 +71289,509 @@ paths: - has_more - object - url - title: BankConnectionsResourceOwnerList + title: BankConnectionsResourceOwnerList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/financial_connections/accounts/{account}/refresh': + post: + description: >- +

Refreshes the data associated with a Financial Connections + Account.

+ operationId: PostFinancialConnectionsAccountsAccountRefresh + parameters: + - in: path + name: account + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + features: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + features: + description: The list of account features that you would like to refresh. + items: + enum: + - balance + - ownership + - transactions + type: string + x-stripeBypassValidation: true + type: array + required: + - features + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/financial_connections.account' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/financial_connections/accounts/{account}/subscribe': + post: + description: >- +

Subscribes to periodic refreshes of data associated with a Financial + Connections Account.

+ operationId: PostFinancialConnectionsAccountsAccountSubscribe + parameters: + - in: path + name: account + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + features: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + features: + description: >- + The list of account features to which you would like to + subscribe. + items: + enum: + - transactions + type: string + x-stripeBypassValidation: true + type: array + required: + - features + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/financial_connections.account' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/financial_connections/accounts/{account}/unsubscribe': + post: + description: >- +

Unsubscribes from periodic refreshes of data associated with a + Financial Connections Account.

+ operationId: PostFinancialConnectionsAccountsAccountUnsubscribe + parameters: + - in: path + name: account + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + features: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + features: + description: >- + The list of account features from which you would like to + unsubscribe. + items: + enum: + - transactions + type: string + x-stripeBypassValidation: true + type: array + required: + - features + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/financial_connections.account' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/financial_connections/sessions: + post: + description: >- +

To launch the Financial Connections authorization flow, create a + Session. The session’s client_secret can be + used to launch the flow using Stripe.js.

+ operationId: PostFinancialConnectionsSessions + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + account_holder: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + filters: + explode: true + style: deepObject + permissions: + explode: true + style: deepObject + prefetch: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + account_holder: + description: The account holder to link accounts for. + properties: + account: + maxLength: 5000 + type: string + customer: + maxLength: 5000 + type: string + type: + enum: + - account + - customer + type: string + required: + - type + title: accountholder_params + type: object + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + filters: + description: Filters to restrict the kinds of accounts to collect. + properties: + countries: + items: + maxLength: 5000 + type: string + type: array + required: + - countries + title: filters_params + type: object + permissions: + description: >- + List of data features that you would like to request access + to. + + + Possible values are `balances`, `transactions`, `ownership`, + and `payment_method`. + items: + enum: + - balances + - ownership + - payment_method + - transactions + maxLength: 5000 + type: string + x-stripeBypassValidation: true + type: array + prefetch: + description: >- + List of data features that you would like to retrieve upon + account creation. + items: + enum: + - balances + - ownership + - transactions + type: string + x-stripeBypassValidation: true + type: array + return_url: + description: >- + For webview integrations only. Upon completing OAuth login + in the native browser, the user will be redirected to this + URL to return to your app. + maxLength: 5000 + type: string + required: + - account_holder + - permissions + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/financial_connections.session' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/financial_connections/sessions/{session}': + get: + description: >- +

Retrieves the details of a Financial Connections + Session

+ operationId: GetFinancialConnectionsSessionsSession + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: session + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/financial_connections.session' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/financial_connections/transactions: + get: + description: >- +

Returns a list of Financial Connections Transaction + objects.

+ operationId: GetFinancialConnectionsTransactions + parameters: + - description: The ID of the Stripe account whose transactions will be retrieved. + in: query + name: account + required: true + schema: + maxLength: 5000 + type: string + style: form + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + A filter on the list based on the object `transacted_at` field. The + value can be a string with an integer Unix timestamp, or it can be a + dictionary with the following options: + explode: true + in: query + name: transacted_at + required: false + schema: + anyOf: + - properties: + gt: + type: integer + gte: + type: integer + lt: + type: integer + lte: + type: integer + title: range_query_specs + type: object + - type: integer + style: deepObject + - description: >- + A filter on the list based on the object `transaction_refresh` + field. The value can be a dictionary with the following options: + explode: true + in: query + name: transaction_refresh + required: false + schema: + properties: + after: + maxLength: 5000 + type: string + required: + - after + title: transaction_refresh_params + type: object + style: deepObject + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + description: Details about each object. + items: + $ref: '#/components/schemas/financial_connections.transaction' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/financial_connections/transactions + type: string + required: + - data + - has_more + - object + - url + title: BankConnectionsResourceTransactionList type: object x-expandableFields: - data @@ -64100,15 +71802,26 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/financial_connections/accounts/{account}/refresh': - post: + '/v1/financial_connections/transactions/{transaction}': + get: description: >- -

Refreshes the data associated with a Financial Connections - Account.

- operationId: PostFinancialConnectionsAccountsAccountRefresh +

Retrieves the details of a Financial Connections + Transaction

+ operationId: GetFinancialConnectionsTransactionsTransaction parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject - in: path - name: account + name: transaction required: true schema: maxLength: 5000 @@ -64117,41 +71830,135 @@ paths: requestBody: content: application/x-www-form-urlencoded: - encoding: - expand: - explode: true - style: deepObject - features: - explode: true - style: deepObject + encoding: {} schema: additionalProperties: false - properties: - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - features: - description: The list of account features that you would like to refresh. - items: - enum: - - balance - - ownership - type: string - x-stripeBypassValidation: true - type: array - required: - - features + properties: {} type: object - required: true + required: false responses: '200': content: application/json: schema: - $ref: '#/components/schemas/financial_connections.account' + $ref: '#/components/schemas/financial_connections.transaction' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/forwarding/requests: + get: + description:

Lists all ForwardingRequest objects.

+ operationId: GetForwardingRequests + parameters: + - description: >- + Similar to other List endpoints, filters results based on created + timestamp. You can pass gt, gte, lt, and lte timestamp values. + explode: true + in: query + name: created + required: false + schema: + properties: + gt: + type: integer + gte: + type: integer + lt: + type: integer + lte: + type: integer + title: created_param + type: object + style: deepObject + - description: >- + A pagination cursor to fetch the previous page of the list. The + value must be a ForwardingRequest ID. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: >- + A pagination cursor to fetch the next page of the list. The value + must be a ForwardingRequest ID. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: List of ForwardingRequest data. + properties: + data: + items: + $ref: '#/components/schemas/forwarding.request' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: ForwardingRequestList + type: object + x-expandableFields: + - data description: Successful response. default: content: @@ -64159,110 +71966,82 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - /v1/financial_connections/sessions: post: - description: >- -

To launch the Financial Connections authorization flow, create a - Session. The session’s client_secret can be - used to launch the flow using Stripe.js.

- operationId: PostFinancialConnectionsSessions + description:

Creates a ForwardingRequest object.

+ operationId: PostForwardingRequests requestBody: content: application/x-www-form-urlencoded: encoding: - account_holder: - explode: true - style: deepObject expand: explode: true style: deepObject - filters: + replacements: explode: true style: deepObject - permissions: - explode: true - style: deepObject - prefetch: + request: explode: true style: deepObject schema: additionalProperties: false properties: - account_holder: - description: The account holder to link accounts for. - properties: - account: - maxLength: 5000 - type: string - customer: - maxLength: 5000 - type: string - type: - enum: - - account - - customer - type: string - required: - - type - title: accountholder_params - type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array - filters: - description: Filters to restrict the kinds of accounts to collect. - properties: - countries: - items: - maxLength: 5000 - type: string - type: array - required: - - countries - title: filters_params - type: object - permissions: + payment_method: description: >- - List of data features that you would like to request access - to. - - - Possible values are `balances`, `transactions`, `ownership`, - and `payment_method`. + The PaymentMethod to insert into the forwarded request. + Forwarding previously consumed PaymentMethods is allowed. + maxLength: 5000 + type: string + replacements: + description: The field kinds to be replaced in the forwarded request. items: enum: - - balances - - ownership - - payment_method - - transactions - maxLength: 5000 + - card_cvc + - card_expiry + - card_number + - cardholder_name type: string - x-stripeBypassValidation: true type: array - prefetch: + request: description: >- - List of data features that you would like to retrieve upon - account creation. - items: - enum: - - balances - - ownership - type: string - x-stripeBypassValidation: true - type: array - return_url: + The request body and headers to be sent to the destination + endpoint. + properties: + body: + maxLength: 5000 + type: string + headers: + items: + properties: + name: + maxLength: 5000 + type: string + value: + maxLength: 5000 + type: string + required: + - name + - value + title: header_param + type: object + type: array + title: request_param + type: object + url: description: >- - For webview integrations only. Upon completing OAuth login - in the native browser, the user will be redirected to this - URL to return to your app. + The destination URL for the forwarded request. Must be + supported by the config. maxLength: 5000 type: string required: - - account_holder - - permissions + - payment_method + - replacements + - url type: object required: true responses: @@ -64270,7 +72049,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/financial_connections.session' + $ref: '#/components/schemas/forwarding.request' description: Successful response. default: content: @@ -64278,12 +72057,10 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/financial_connections/sessions/{session}': + '/v1/forwarding/requests/{id}': get: - description: >- -

Retrieves the details of a Financial Connections - Session

- operationId: GetFinancialConnectionsSessionsSession + description:

Retrieves a ForwardingRequest object.

+ operationId: GetForwardingRequestsId parameters: - description: Specifies which fields in the response should be expanded. explode: true @@ -64297,7 +72074,7 @@ paths: type: array style: deepObject - in: path - name: session + name: id required: true schema: maxLength: 5000 @@ -64317,7 +72094,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/financial_connections.session' + $ref: '#/components/schemas/forwarding.request' description: Successful response. default: content: @@ -64330,7 +72107,21 @@ paths: description:

List all verification reports.

operationId: GetIdentityVerificationReports parameters: - - explode: true + - description: >- + A string to reference this user. This can be a customer ID, a + session ID, or similar, and can be used to reconcile this + verification with your internal systems. + in: query + name: client_reference_id + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + Only return VerificationReports that were created during the given + date interval. + explode: true in: query name: created required: false @@ -64519,7 +72310,21 @@ paths: description:

Returns a list of VerificationSessions

operationId: GetIdentityVerificationSessions parameters: - - explode: true + - description: >- + A string to reference this user. This can be a customer ID, a + session ID, or similar, and can be used to reconcile this + verification with your internal systems. + in: query + name: client_reference_id + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + Only return VerificationSessions that were created during the given + date interval. + explode: true in: query name: created required: false @@ -64683,9 +72488,19 @@ paths: options: explode: true style: deepObject + provided_details: + explode: true + style: deepObject schema: additionalProperties: false properties: + client_reference_id: + description: >- + A string to reference this user. This can be a customer ID, + a session ID, or similar, and can be used to reconcile this + verification with your internal systems. + maxLength: 5000 + type: string expand: description: Specifies which fields in the response should be expanded. items: @@ -64731,6 +72546,17 @@ paths: type: string title: session_options_param type: object + provided_details: + description: >- + Details provided about the user being verified. These + details may be shown to the user. + properties: + email: + type: string + phone: + type: string + title: provided_details_param + type: object return_url: description: >- The URL that the user will be redirected to upon completing @@ -64740,16 +72566,21 @@ paths: description: >- The type of [verification check](https://stripe.com/docs/identity/verification-checks) - to be performed. + to be performed. You must provide a `type` if not passing + `verification_flow`. enum: - document - id_number type: string x-stripeBypassValidation: true - required: - - type + verification_flow: + description: >- + The ID of a Verification Flow from the Dashboard. See + https://docs.stripe.com/identity/verification-flows. + maxLength: 5000 + type: string type: object - required: true + required: false responses: '200': content: @@ -64848,6 +72679,9 @@ paths: options: explode: true style: deepObject + provided_details: + explode: true + style: deepObject schema: additionalProperties: false properties: @@ -64896,6 +72730,17 @@ paths: type: string title: session_options_param type: object + provided_details: + description: >- + Details provided about the user being verified. These + details may be shown to the user. + properties: + email: + type: string + phone: + type: string + title: provided_details_param + type: object type: description: >- The type of [verification @@ -65067,7 +72912,10 @@ paths: appearing first.

operationId: GetInvoiceitems parameters: - - explode: true + - description: >- + Only return invoice items that were created during the given date + interval. + explode: true in: query name: created required: false @@ -65293,6 +73141,9 @@ paths: discount: maxLength: 5000 type: string + promotion_code: + maxLength: 5000 + type: string title: discounts_data_param type: object type: array @@ -65300,8 +73151,8 @@ paths: - '' type: string description: >- - The coupons to redeem into discounts for the invoice item or - invoice line item. + The coupons and promotion codes to redeem into discounts for + the invoice item or invoice line item. expand: description: Specifies which fields in the response should be expanded. items: @@ -65516,13 +73367,408 @@ paths: type: string type: array style: deepObject - - in: path - name: invoiceitem - required: true + - in: path + name: invoiceitem + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/invoiceitem' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description: >- +

Updates the amount or description of an invoice item on an upcoming + invoice. Updating an invoice item is only possible before the invoice + it’s attached to is closed.

+ operationId: PostInvoiceitemsInvoiceitem + parameters: + - in: path + name: invoiceitem + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + discounts: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + period: + explode: true + style: deepObject + price_data: + explode: true + style: deepObject + tax_code: + explode: true + style: deepObject + tax_rates: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + amount: + description: >- + The integer amount in cents (or local equivalent) of the + charge to be applied to the upcoming invoice. If you want to + apply a credit to the customer's account, pass a negative + amount. + type: integer + description: + description: >- + An arbitrary string which you can attach to the invoice + item. The description is displayed in the invoice for easy + tracking. + maxLength: 5000 + type: string + discountable: + description: >- + Controls whether discounts apply to this invoice item. + Defaults to false for prorations or negative invoice items, + and true for all other invoice items. Cannot be set to true + for prorations. + type: boolean + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + description: >- + The coupons, promotion codes & existing discounts which + apply to the invoice item or invoice line item. Item + discounts are applied before invoice discounts. Pass an + empty string to remove previously-defined discounts. + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: 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. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + period: + description: >- + The period associated with this invoice item. When set to + different values, the period will be rendered on the + invoice. If you have [Stripe Revenue + Recognition](https://stripe.com/docs/revenue-recognition) + enabled, the period will be used to recognize and defer + revenue. See the [Revenue Recognition + documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) + for details. + properties: + end: + format: unix-time + type: integer + start: + format: unix-time + type: integer + required: + - end + - start + title: period + type: object + price: + description: The ID of the price object. + maxLength: 5000 + type: string + price_data: + description: >- + Data used to generate a new + [Price](https://stripe.com/docs/api/prices) object inline. + properties: + currency: + type: string + product: + maxLength: 5000 + type: string + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + - product + title: one_time_price_data + type: object + quantity: + description: >- + Non-negative integer. The quantity of units for the invoice + item. + type: integer + tax_behavior: + description: >- + Only required if a [default tax + behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) + was not provided in the Stripe Tax settings. Specifies + whether the price is considered inclusive of taxes or + exclusive of taxes. One of `inclusive`, `exclusive`, or + `unspecified`. Once specified as either `inclusive` or + `exclusive`, it cannot be changed. + enum: + - exclusive + - inclusive + - unspecified + type: string + tax_code: + anyOf: + - type: string + - enum: + - '' + type: string + description: 'A [tax code](https://stripe.com/docs/tax/tax-categories) ID.' + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + description: >- + The tax rates which apply to the invoice item. When set, the + `default_tax_rates` on the invoice do not apply to this + invoice item. Pass an empty string to remove + previously-defined tax rates. + unit_amount: + description: >- + The integer unit amount in cents (or local equivalent) of + the charge to be applied to the upcoming invoice. This + unit_amount will be multiplied by the quantity to get the + full amount. If you want to apply a credit to the customer's + account, pass a negative unit_amount. + type: integer + unit_amount_decimal: + description: >- + Same as `unit_amount`, but accepts a decimal value in cents + (or local equivalent) with at most 12 decimal places. Only + one of `unit_amount` and `unit_amount_decimal` can be set. + format: decimal + type: string + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/invoiceitem' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/invoices: + get: + description: >- +

You can list all invoices, or list the invoices for a specific + customer. The invoices are returned sorted by creation date, with the + most recently created invoices appearing first.

+ operationId: GetInvoices + parameters: + - description: >- + The collection method of the invoice to retrieve. Either + `charge_automatically` or `send_invoice`. + in: query + name: collection_method + required: false + schema: + enum: + - charge_automatically + - send_invoice + type: string + style: form + - description: >- + Only return invoices that were created during the given date + interval. + explode: true + in: query + name: created + required: false + schema: + anyOf: + - properties: + gt: + type: integer + gte: + type: integer + lt: + type: integer + lte: + type: integer + title: range_query_specs + type: object + - type: integer + style: deepObject + - description: Only return invoices for the customer specified by this customer ID. + in: query + name: customer + required: false + schema: + maxLength: 5000 + type: string + style: form + - explode: true + in: query + name: due_date + required: false + schema: + anyOf: + - properties: + gt: + type: integer + gte: + type: integer + lt: + type: integer + lte: + type: integer + title: range_query_specs + type: object + - type: integer + style: deepObject + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - 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. + in: query + name: starting_after + required: false schema: maxLength: 5000 type: string - style: simple + style: form + - description: >- + The status of the invoice, one of `draft`, `open`, `paid`, + `uncollectible`, or `void`. [Learn + more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) + in: query + name: status + required: false + schema: + enum: + - draft + - open + - paid + - uncollectible + - void + type: string + x-stripeBypassValidation: true + style: form + - description: >- + Only return invoices for the subscription specified by this + subscription ID. + in: query + name: subscription + required: false + schema: + maxLength: 5000 + type: string + style: form requestBody: content: application/x-www-form-urlencoded: @@ -65537,7 +73783,38 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/invoiceitem' + description: '' + properties: + data: + items: + $ref: '#/components/schemas/invoice' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/invoices + type: string + required: + - data + - has_more + - object + - url + title: InvoicesResourceList + type: object + x-expandableFields: + - data description: Successful response. default: content: @@ -65547,378 +73824,736 @@ paths: description: Error response. post: description: >- -

Updates the amount or description of an invoice item on an upcoming - invoice. Updating an invoice item is only possible before the invoice - it’s attached to is closed.

- operationId: PostInvoiceitemsInvoiceitem - parameters: - - in: path - name: invoiceitem - required: true - schema: - maxLength: 5000 - type: string - style: simple +

This endpoint creates a draft invoice for a given customer. The + invoice remains a draft until you finalize the invoice, which allows you to + pay or send the + invoice to your customers.

+ operationId: PostInvoices requestBody: content: application/x-www-form-urlencoded: encoding: + account_tax_ids: + explode: true + style: deepObject + automatic_tax: + explode: true + style: deepObject + custom_fields: + explode: true + style: deepObject + default_tax_rates: + explode: true + style: deepObject discounts: explode: true style: deepObject expand: explode: true style: deepObject + from_invoice: + explode: true + style: deepObject + issuer: + explode: true + style: deepObject metadata: explode: true style: deepObject - period: + payment_settings: explode: true style: deepObject - price_data: + rendering: explode: true style: deepObject - tax_code: + shipping_cost: explode: true style: deepObject - tax_rates: + shipping_details: + explode: true + style: deepObject + transfer_data: explode: true style: deepObject schema: additionalProperties: false properties: - amount: + account_tax_ids: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string description: >- - The integer amount in cents (or local equivalent) of the - charge to be applied to the upcoming invoice. If you want to - apply a credit to the customer's account, pass a negative - amount. + The account tax IDs associated with the invoice. Only + editable when the invoice is a draft. + application_fee_amount: + description: >- + A fee in cents (or local equivalent) that will be applied to + the invoice and transferred to the application owner's + Stripe account. The request must be made with an OAuth key + or the Stripe-Account header in order to take an application + fee. For more information, see the application fees + [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). + type: integer + auto_advance: + description: >- + Controls whether Stripe performs [automatic + collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) + of the invoice. If `false`, the invoice's state doesn't + automatically advance without an explicit action. + type: boolean + automatic_tax: + description: Settings for automatic tax lookup for this invoice. + properties: + enabled: + type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + required: + - enabled + title: automatic_tax_param + type: object + collection_method: + description: >- + Either `charge_automatically`, or `send_invoice`. When + charging automatically, Stripe will attempt to pay this + invoice using the default source attached to the customer. + When sending an invoice, Stripe will email this invoice to + the customer with payment instructions. Defaults to + `charge_automatically`. + enum: + - charge_automatically + - send_invoice + type: string + currency: + description: >- + The currency to create this invoice in. Defaults to that of + `customer` if not specified. + type: string + custom_fields: + anyOf: + - items: + properties: + name: + maxLength: 40 + type: string + value: + maxLength: 140 + type: string + required: + - name + - value + title: custom_field_params + type: object + type: array + - enum: + - '' + type: string + description: >- + A list of up to 4 custom fields to be displayed on the + invoice. + customer: + description: The ID of the customer who will be billed. + maxLength: 5000 + type: string + days_until_due: + description: >- + The number of days from when the invoice is created until it + is due. Valid only for invoices where + `collection_method=send_invoice`. type: integer + default_payment_method: + description: >- + ID of the default payment method for the invoice. It must + belong to the customer associated with the invoice. If not + set, defaults to the subscription's default payment method, + if any, or to the default payment method in the customer's + invoice settings. + maxLength: 5000 + type: string + default_source: + description: >- + ID of the default payment source for the invoice. It must + belong to the customer associated with the invoice and be in + a chargeable state. If not set, defaults to the + subscription's default source, if any, or to the customer's + default source. + maxLength: 5000 + type: string + default_tax_rates: + description: >- + The tax rates that will apply to any line item that does not + have `tax_rates` set. + items: + maxLength: 5000 + type: string + type: array description: description: >- - An arbitrary string which you can attach to the invoice - item. The description is displayed in the invoice for easy - tracking. - maxLength: 5000 + An arbitrary string attached to the object. Often useful for + displaying to users. Referenced as 'memo' in the Dashboard. + maxLength: 1500 + type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + description: >- + The coupons and promotion codes to redeem into discounts for + the invoice. If not specified, inherits the discount from + the invoice's customer. Pass an empty string to avoid + inheriting any discounts. + due_date: + description: >- + The date on which payment for this invoice is due. Valid + only for invoices where `collection_method=send_invoice`. + format: unix-time + type: integer + effective_at: + description: >- + The date when this invoice is in effect. Same as + `finalized_at` unless overwritten. When defined, this value + replaces the system-generated 'Date of issue' printed on the + invoice PDF and receipt. + format: unix-time + type: integer + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + footer: + description: Footer to be displayed on the invoice. + maxLength: 5000 + type: string + from_invoice: + description: >- + Revise an existing invoice. The new invoice will be created + in `status=draft`. See the [revision + documentation](https://stripe.com/docs/invoicing/invoice-revisions) + for more details. + properties: + action: + enum: + - revision + maxLength: 5000 + type: string + invoice: + maxLength: 5000 + type: string + required: + - action + - invoice + title: from_invoice + type: object + issuer: + description: >- + The connected account that issues the invoice. The invoice + is presented with the branding and support information of + the specified account. + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: 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. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + number: + description: >- + Set the number for this invoice. If no number is present + then a number will be assigned automatically when the + invoice is finalized. In many markets, regulations require + invoices to be unique, sequential and / or gapless. You are + responsible for ensuring this is true across all your + different invoicing systems in the event that you edit the + invoice number using our API. If you use only Stripe for + your invoices and do not change invoice numbers, Stripe + handles this aspect of compliance for you automatically. + maxLength: 26 + type: string + on_behalf_of: + description: >- + The account (if any) for which the funds of the invoice + payment are intended. If set, the invoice will be presented + with the branding and support information of the specified + account. See the [Invoices with + Connect](https://stripe.com/docs/billing/invoices/connect) + documentation for details. + type: string + payment_settings: + description: >- + Configuration settings for the PaymentIntent that is + generated when the invoice is finalized. + properties: + default_mandate: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + payment_method_options: + properties: + acss_debit: + anyOf: + - properties: + mandate_options: + properties: + transaction_type: + enum: + - business + - personal + type: string + title: mandate_options_param + type: object + verification_method: + enum: + - automatic + - instant + - microdeposits + type: string + x-stripeBypassValidation: true + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string + bancontact: + anyOf: + - properties: + preferred_language: + enum: + - de + - en + - fr + - nl + type: string + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string + card: + anyOf: + - properties: + installments: + properties: + enabled: + type: boolean + plan: + anyOf: + - properties: + count: + type: integer + interval: + enum: + - month + type: string + type: + enum: + - fixed_count + type: string + required: + - count + - interval + - type + title: installment_plan + type: object + - enum: + - '' + type: string + title: installments_param + type: object + request_three_d_secure: + enum: + - any + - automatic + - challenge + type: string + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string + customer_balance: + anyOf: + - properties: + bank_transfer: + properties: + eu_bank_transfer: + properties: + country: + maxLength: 5000 + type: string + required: + - country + title: eu_bank_transfer_param + type: object + type: + type: string + title: bank_transfer_param + type: object + funding_type: + type: string + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string + konbini: + anyOf: + - properties: {} + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string + sepa_debit: + anyOf: + - properties: {} + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string + us_bank_account: + anyOf: + - properties: + financial_connections: + properties: + permissions: + items: + enum: + - balances + - ownership + - payment_method + - transactions + maxLength: 5000 + type: string + x-stripeBypassValidation: true + type: array + prefetch: + items: + enum: + - balances + - ownership + - transactions + type: string + x-stripeBypassValidation: true + type: array + title: invoice_linked_account_options_param + type: object + verification_method: + enum: + - automatic + - instant + - microdeposits + type: string + x-stripeBypassValidation: true + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string + title: payment_method_options + type: object + payment_method_types: + anyOf: + - items: + enum: + - ach_credit_transfer + - ach_debit + - acss_debit + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - boleto + - card + - cashapp + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - konbini + - link + - p24 + - paynow + - paypal + - promptpay + - revolut_pay + - sepa_debit + - sofort + - us_bank_account + - wechat_pay + type: string + x-stripeBypassValidation: true + type: array + - enum: + - '' + type: string + title: payment_settings + type: object + pending_invoice_items_behavior: + description: >- + How to handle pending invoice items on invoice creation. + Defaults to `exclude` if the parameter is omitted. + enum: + - exclude + - include type: string - discountable: + x-stripeBypassValidation: true + rendering: description: >- - Controls whether discounts apply to this invoice item. - Defaults to false for prorations or negative invoice items, - and true for all other invoice items. Cannot be set to true - for prorations. - type: boolean - discounts: - anyOf: - - items: - properties: - coupon: - maxLength: 5000 - type: string - discount: - maxLength: 5000 - type: string - title: discounts_data_param - type: object - type: array - - enum: + The rendering-related settings that control how the invoice + is displayed on customer-facing surfaces such as PDF and + Hosted Invoice Page. + properties: + amount_tax_display: + enum: - '' + - exclude_tax + - include_inclusive_tax type: string - description: >- - The coupons & existing discounts which apply to the invoice - item or invoice line item. Item discounts are applied before - invoice discounts. Pass an empty string to remove - previously-defined discounts. - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - metadata: - anyOf: - - additionalProperties: - type: string + pdf: + properties: + page_size: + enum: + - a4 + - auto + - letter + type: string + title: rendering_pdf_param type: object - - enum: - - '' - type: 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. Individual keys can be unset by posting an empty - value to them. All keys can be unset by posting an empty - value to `metadata`. - period: - description: >- - The period associated with this invoice item. When set to - different values, the period will be rendered on the - invoice. If you have [Stripe Revenue - Recognition](https://stripe.com/docs/revenue-recognition) - enabled, the period will be used to recognize and defer - revenue. See the [Revenue Recognition - documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) - for details. - properties: - end: - format: unix-time - type: integer - start: - format: unix-time - type: integer - required: - - end - - start - title: period + title: rendering_param type: object - price: - description: The ID of the price object. - maxLength: 5000 - type: string - price_data: - description: >- - Data used to generate a new - [Price](https://stripe.com/docs/api/prices) object inline. + shipping_cost: + description: Settings for the cost of shipping for this invoice. properties: - currency: - type: string - product: + shipping_rate: maxLength: 5000 type: string - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal - type: string - required: - - currency - - product - title: one_time_price_data + shipping_rate_data: + properties: + delivery_estimate: + properties: + maximum: + properties: + unit: + enum: + - business_day + - day + - hour + - month + - week + type: string + value: + type: integer + required: + - unit + - value + title: delivery_estimate_bound + type: object + minimum: + properties: + unit: + enum: + - business_day + - day + - hour + - month + - week + type: string + value: + type: integer + required: + - unit + - value + title: delivery_estimate_bound + type: object + title: delivery_estimate + type: object + display_name: + maxLength: 100 + type: string + fixed_amount: + properties: + amount: + type: integer + currency: + type: string + currency_options: + additionalProperties: + properties: + amount: + type: integer + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + required: + - amount + title: currency_option + type: object + type: object + required: + - amount + - currency + title: fixed_amount + type: object + metadata: + additionalProperties: + type: string + type: object + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + tax_code: + type: string + type: + enum: + - fixed_amount + type: string + required: + - display_name + title: method_params + type: object + title: shipping_cost type: object - quantity: - description: >- - Non-negative integer. The quantity of units for the invoice - item. - type: integer - tax_behavior: - description: >- - Only required if a [default tax - behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) - was not provided in the Stripe Tax settings. Specifies - whether the price is considered inclusive of taxes or - exclusive of taxes. One of `inclusive`, `exclusive`, or - `unspecified`. Once specified as either `inclusive` or - `exclusive`, it cannot be changed. - enum: - - exclusive - - inclusive - - unspecified - type: string - tax_code: - anyOf: - - type: string - - enum: - - '' - type: string - description: 'A [tax code](https://stripe.com/docs/tax/tax-categories) ID.' - tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - description: >- - The tax rates which apply to the invoice item. When set, the - `default_tax_rates` on the invoice do not apply to this - invoice item. Pass an empty string to remove - previously-defined tax rates. - unit_amount: - description: >- - The integer unit amount in cents (or local equivalent) of - the charge to be applied to the upcoming invoice. This - unit_amount will be multiplied by the quantity to get the - full amount. If you want to apply a credit to the customer's - account, pass a negative unit_amount. - type: integer - unit_amount_decimal: + shipping_details: description: >- - Same as `unit_amount`, but accepts a decimal value in cents - (or local equivalent) with at most 12 decimal places. Only - one of `unit_amount` and `unit_amount_decimal` can be set. - format: decimal - type: string - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/invoiceitem' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - /v1/invoices: - get: - description: >- -

You can list all invoices, or list the invoices for a specific - customer. The invoices are returned sorted by creation date, with the - most recently created invoices appearing first.

- operationId: GetInvoices - parameters: - - description: >- - The collection method of the invoice to retrieve. Either - `charge_automatically` or `send_invoice`. - in: query - name: collection_method - required: false - schema: - enum: - - charge_automatically - - send_invoice - type: string - style: form - - explode: true - in: query - name: created - required: false - schema: - anyOf: - - properties: - gt: - type: integer - gte: - type: integer - lt: - type: integer - lte: - type: integer - title: range_query_specs - type: object - - type: integer - style: deepObject - - description: Only return invoices for the customer specified by this customer ID. - in: query - name: customer - required: false - schema: - maxLength: 5000 - type: string - style: form - - explode: true - in: query - name: due_date - required: false - schema: - anyOf: - - properties: - gt: - type: integer - gte: - type: integer - lt: - type: integer - lte: - type: integer - title: range_query_specs - type: object - - type: integer - style: deepObject - - description: >- - A cursor for use in pagination. `ending_before` is an object ID that - defines your place in the list. For instance, if you make a list - request and receive 100 objects, starting with `obj_bar`, your - subsequent call can include `ending_before=obj_bar` in order to - fetch the previous page of the list. - in: query - name: ending_before - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: Specifies which fields in the response should be expanded. - explode: true - in: query - name: expand - required: false - schema: - items: - maxLength: 5000 - type: string - type: array - style: deepObject - - description: >- - A limit on the number of objects to be returned. Limit can range - between 1 and 100, and the default is 10. - in: query - name: limit - required: false - schema: - type: integer - style: form - - 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. - in: query - name: starting_after - required: false - schema: - maxLength: 5000 - type: string - style: form - - description: >- - The status of the invoice, one of `draft`, `open`, `paid`, - `uncollectible`, or `void`. [Learn - more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview) - in: query - name: status - required: false - schema: - enum: - - draft - - open - - paid - - uncollectible - - void - type: string - x-stripeBypassValidation: true - style: form - - description: >- - Only return invoices for the subscription specified by this - subscription ID. - in: query - name: subscription - required: false - schema: - maxLength: 5000 - type: string - style: form - requestBody: - content: - application/x-www-form-urlencoded: - encoding: {} - schema: - additionalProperties: false - properties: {} + Shipping details for the invoice. The Invoice PDF will use + the `shipping_details` value if it is set, otherwise the PDF + will render the shipping address from the customer. + properties: + address: + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: optional_fields_address + type: object + name: + maxLength: 5000 + type: string + phone: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + required: + - address + - name + title: recipient_shipping_with_optional_fields_address + type: object + statement_descriptor: + description: >- + Extra information about a charge for the customer's credit + card statement. It must contain at least one letter. If not + specified and this invoice is part of a subscription, the + default `statement_descriptor` will be set to the first + subscription item's product's `statement_descriptor`. + maxLength: 22 + type: string + subscription: + description: >- + The ID of the subscription to invoice, if any. If set, the + created invoice will only include pending invoice items for + that subscription. The subscription's billing cycle and + regular subscription events won't be affected. + maxLength: 5000 + type: string + transfer_data: + description: >- + If specified, the funds from the invoice will be transferred + to the destination and the ID of the resulting transfer will + be found on the invoice's charge. + properties: + amount: + type: integer + destination: + type: string + required: + - destination + title: transfer_data_specs + type: object type: object required: false responses: @@ -65926,38 +74561,7 @@ paths: content: application/json: schema: - description: '' - properties: - data: - items: - $ref: '#/components/schemas/invoice' - type: array - has_more: - description: >- - True if this list has another page of items after this one - that can be fetched. - type: boolean - object: - description: >- - String representing the object's type. Objects of the same - type share the same value. Always has the value `list`. - enum: - - list - type: string - url: - description: The URL where this list can be accessed. - maxLength: 5000 - pattern: ^/v1/invoices - type: string - required: - - data - - has_more - - object - - url - title: InvoicesList - type: object - x-expandableFields: - - data + $ref: '#/components/schemas/invoice' description: Successful response. default: content: @@ -65965,28 +74569,41 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + /v1/invoices/create_preview: post: description: >- -

This endpoint creates a draft invoice for a given customer. The - invoice remains a draft until you finalize the invoice, which allows you to - pay or send the - invoice to your customers.

- operationId: PostInvoices +

At any time, you can preview the upcoming invoice for a customer. + This will show you all the charges that are pending, including + subscription renewal charges, invoice item charges, etc. It will also + show you any discounts that are applicable to the invoice.

+ + +

Note that when you are viewing an upcoming invoice, you are simply + viewing a preview – the invoice has not yet been created. As such, the + upcoming invoice will not show up in invoice listing calls, and you + cannot use the API to pay or edit the invoice. If you want to change the + amount that your customer will be billed, you can add, remove, or update + pending invoice items, or update the customer’s discount.

+ + +

You can preview the effects of updating a subscription, including a + preview of what proration will take place. To ensure that the actual + proration is calculated exactly the same as the previewed proration, you + should pass the subscription_details.proration_date + parameter when doing the actual subscription update. The recommended way + to get only the prorations being previewed is to consider only proration + line items where period[start] is equal to the + subscription_details.proration_date value passed in the + request.

+ operationId: PostInvoicesCreatePreview requestBody: content: application/x-www-form-urlencoded: encoding: - account_tax_ids: - explode: true - style: deepObject automatic_tax: explode: true style: deepObject - custom_fields: - explode: true - style: deepObject - default_tax_rates: + customer_details: explode: true style: deepObject discounts: @@ -65995,148 +74612,245 @@ paths: expand: explode: true style: deepObject - from_invoice: - explode: true - style: deepObject - metadata: - explode: true - style: deepObject - payment_settings: + invoice_items: explode: true style: deepObject - rendering: + issuer: explode: true style: deepObject - shipping_cost: + on_behalf_of: explode: true style: deepObject - shipping_details: + schedule_details: explode: true style: deepObject - transfer_data: + subscription_details: explode: true style: deepObject schema: additionalProperties: false properties: - account_tax_ids: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - description: >- - The account tax IDs associated with the invoice. Only - editable when the invoice is a draft. - application_fee_amount: - description: >- - A fee in cents (or local equivalent) that will be applied to - the invoice and transferred to the application owner's - Stripe account. The request must be made with an OAuth key - or the Stripe-Account header in order to take an application - fee. For more information, see the application fees - [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees). - type: integer - auto_advance: - description: >- - Controls whether Stripe performs [automatic - collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) - of the invoice. If `false`, the invoice's state doesn't - automatically advance without an explicit action. - type: boolean automatic_tax: - description: Settings for automatic tax lookup for this invoice. + description: Settings for automatic tax lookup for this invoice preview. properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_param type: object - collection_method: + coupon: description: >- - Either `charge_automatically`, or `send_invoice`. When - charging automatically, Stripe will attempt to pay this - invoice using the default source attached to the customer. - When sending an invoice, Stripe will email this invoice to - the customer with payment instructions. Defaults to - `charge_automatically`. - enum: - - charge_automatically - - send_invoice + 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. + maxLength: 5000 type: string currency: description: >- - The currency to create this invoice in. Defaults to that of + The currency to preview this invoice in. Defaults to that of `customer` if not specified. type: string - custom_fields: - anyOf: - - items: + customer: + 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. + maxLength: 5000 + type: string + customer_details: + description: >- + Details about the customer you want to invoice or overrides + for an existing customer. If `automatic_tax` is enabled then + one of `customer`, `customer_details`, `subscription`, or + `schedule` must be set. + properties: + address: + anyOf: + - properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: optional_fields_address + type: object + - enum: + - '' + type: string + shipping: + anyOf: + - properties: + address: + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: optional_fields_address + type: object + name: + maxLength: 5000 + type: string + phone: + maxLength: 5000 + type: string + required: + - address + - name + title: customer_shipping + type: object + - enum: + - '' + type: string + tax: + properties: + ip_address: + anyOf: + - type: string + - enum: + - '' + type: string + title: tax_param + type: object + tax_exempt: + enum: + - '' + - exempt + - none + - reverse + type: string + tax_ids: + items: properties: - name: - maxLength: 30 + type: + enum: + - ad_nrt + - ae_trn + - ar_cuit + - au_abn + - au_arn + - bg_uic + - bh_vat + - bo_tin + - br_cnpj + - br_cpf + - ca_bn + - ca_gst_hst + - ca_pst_bc + - ca_pst_mb + - ca_pst_sk + - ca_qst + - ch_vat + - cl_tin + - cn_tin + - co_nit + - cr_tin + - do_rcn + - ec_ruc + - eg_tin + - es_cif + - eu_oss_vat + - eu_vat + - gb_vat + - ge_vat + - hk_br + - hu_tin + - id_npwp + - il_vat + - in_gst + - is_vat + - jp_cn + - jp_rn + - jp_trn + - ke_pin + - kr_brn + - kz_bin + - li_uid + - 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 + - ua_vat + - us_ein + - uy_ruc + - ve_rif + - vn_tin + - za_vat + maxLength: 5000 type: string + x-stripeBypassValidation: true value: - maxLength: 30 type: string required: - - name + - type - value - title: custom_field_params + title: data_params type: object type: array - - enum: - - '' - type: string - description: >- - A list of up to 4 custom fields to be displayed on the - invoice. - customer: - description: The ID of the customer who will be billed. - maxLength: 5000 - type: string - days_until_due: - description: >- - The number of days from when the invoice is created until it - is due. Valid only for invoices where - `collection_method=send_invoice`. - type: integer - default_payment_method: - description: >- - ID of the default payment method for the invoice. It must - belong to the customer associated with the invoice. If not - set, defaults to the subscription's default payment method, - if any, or to the default payment method in the customer's - invoice settings. - maxLength: 5000 - type: string - default_source: - description: >- - ID of the default payment source for the invoice. It must - belong to the customer associated with the invoice and be in - a chargeable state. If not set, defaults to the - subscription's default source, if any, or to the customer's - default source. - maxLength: 5000 - type: string - default_tax_rates: - description: >- - The tax rates that will apply to any line item that does not - have `tax_rates` set. - items: - maxLength: 5000 - type: string - type: array - description: - description: >- - An arbitrary string attached to the object. Often useful for - displaying to users. Referenced as 'memo' in the Dashboard. - maxLength: 1500 - type: string + title: customer_details_param + type: object discounts: anyOf: - items: @@ -66147,6 +74861,9 @@ paths: discount: maxLength: 5000 type: string + promotion_code: + maxLength: 5000 + type: string title: discounts_data_param type: object type: array @@ -66154,71 +74871,156 @@ paths: - '' type: string description: >- - The coupons to redeem into discounts for the invoice. If not - specified, inherits the discount from the invoice's - customer. Pass an empty string to avoid inheriting any + The coupons to redeem into discounts for the invoice + preview. If not specified, inherits the discount from the + subscription or customer. This works for both coupons + directly applied to an invoice and coupons applied to a + subscription. Pass an empty string to avoid inheriting any discounts. - due_date: - description: >- - The date on which payment for this invoice is due. Valid - only for invoices where `collection_method=send_invoice`. - format: unix-time - type: integer - effective_at: - description: >- - The date when this invoice is in effect. Same as - `finalized_at` unless overwritten. When defined, this value - replaces the system-generated 'Date of issue' printed on the - invoice PDF and receipt. - format: unix-time - type: integer expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array - footer: - description: Footer to be displayed on the invoice. - maxLength: 5000 - type: string - from_invoice: + invoice_items: description: >- - Revise an existing invoice. The new invoice will be created - in `status=draft`. See the [revision - documentation](https://stripe.com/docs/invoicing/invoice-revisions) - for more details. + List of invoice items to add or update in the upcoming + invoice preview. + items: + properties: + amount: + type: integer + currency: + type: string + description: + maxLength: 5000 + type: string + discountable: + type: boolean + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + invoiceitem: + maxLength: 5000 + type: string + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + period: + properties: + end: + format: unix-time + type: integer + start: + format: unix-time + type: integer + required: + - end + - start + title: period + type: object + price: + maxLength: 5000 + type: string + price_data: + properties: + currency: + type: string + product: + maxLength: 5000 + type: string + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + - product + title: one_time_price_data + type: object + quantity: + type: integer + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + tax_code: + anyOf: + - type: string + - enum: + - '' + type: string + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + title: invoice_item_preview_params + type: object + type: array + issuer: + description: >- + The connected account that issues the invoice. The invoice + is presented with the branding and support information of + the specified account. properties: - action: - enum: - - revision - maxLength: 5000 + account: type: string - invoice: - maxLength: 5000 + type: + enum: + - account + - self type: string required: - - action - - invoice - title: from_invoice + - type + title: param type: object - metadata: + on_behalf_of: anyOf: - - additionalProperties: - type: string - type: object + - type: string - enum: - '' type: 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. Individual keys can be unset by posting an empty - value to them. All keys can be unset by posting an empty - value to `metadata`. - on_behalf_of: description: >- The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented @@ -66226,417 +75028,533 @@ paths: account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details. + schedule: + description: >- + The identifier of the schedule whose upcoming invoice you'd + like to retrieve. Cannot be used with subscription or + subscription fields. + maxLength: 5000 type: string - payment_settings: + schedule_details: description: >- - Configuration settings for the PaymentIntent that is - generated when the invoice is finalized. + The schedule creation or modification params to apply as a + preview. Cannot be used with `subscription` or + `subscription_` prefixed fields. properties: - default_mandate: - anyOf: - - maxLength: 5000 - type: string - - enum: - - '' - type: string - payment_method_options: - properties: - acss_debit: - anyOf: - - properties: - mandate_options: + end_behavior: + enum: + - cancel + - release + type: string + phases: + items: + properties: + add_invoice_items: + items: + properties: + discounts: + items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + price: + maxLength: 5000 + type: string + price_data: properties: - transaction_type: + currency: + type: string + product: + maxLength: 5000 + type: string + tax_behavior: enum: - - business - - personal + - exclusive + - inclusive + - unspecified type: string - title: mandate_options_param + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + - product + title: one_time_price_data_with_negative_amounts type: object - verification_method: - enum: - - automatic - - instant - - microdeposits - type: string - x-stripeBypassValidation: true - title: invoice_payment_method_options_param + quantity: + type: integer + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: add_invoice_item_entry type: object - - enum: - - '' - type: string - bancontact: - anyOf: - - properties: - preferred_language: - enum: - - de - - en - - fr - - nl + type: array + application_fee_percent: + type: number + automatic_tax: + properties: + enabled: + type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + required: + - enabled + title: automatic_tax_config + type: object + billing_cycle_anchor: + enum: + - automatic + - phase_start + type: string + billing_thresholds: + anyOf: + - properties: + amount_gte: + type: integer + reset_billing_cycle_anchor: + type: boolean + title: billing_thresholds_param + type: object + - enum: + - '' + type: string + collection_method: + enum: + - charge_automatically + - send_invoice + type: string + coupon: + maxLength: 5000 + type: string + default_payment_method: + maxLength: 5000 + type: string + default_tax_rates: + anyOf: + - items: + maxLength: 5000 type: string - title: invoice_payment_method_options_param - type: object - - enum: - - '' - type: string - card: - anyOf: - - properties: - installments: + type: array + - enum: + - '' + type: string + description: + anyOf: + - maxLength: 500 + type: string + - enum: + - '' + type: string + discounts: + anyOf: + - items: properties: - enabled: - type: boolean - plan: - anyOf: - - properties: - count: - type: integer - interval: - enum: - - month - type: string - type: - enum: - - fixed_count - type: string - required: - - count - - interval - - type - title: installment_plan - type: object - - enum: - - '' - type: string - title: installments_param + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param type: object - request_three_d_secure: - enum: - - any - - automatic + type: array + - enum: + - '' + type: string + end_date: + anyOf: + - format: unix-time + type: integer + - enum: + - now + maxLength: 5000 + type: string + invoice_settings: + properties: + account_tax_ids: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + days_until_due: + type: integer + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + title: invoice_settings + type: object + items: + items: + properties: + billing_thresholds: + anyOf: + - properties: + usage_gte: + type: integer + required: + - usage_gte + title: item_billing_thresholds_param + type: object + - enum: + - '' + type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + metadata: + additionalProperties: + type: string + type: object + price: + maxLength: 5000 type: string - title: invoice_payment_method_options_param - type: object - - enum: - - '' - type: string - customer_balance: - anyOf: - - properties: - bank_transfer: + price_data: properties: - eu_bank_transfer: + currency: + type: string + product: + maxLength: 5000 + type: string + recurring: properties: - country: - maxLength: 5000 + interval: + enum: + - day + - month + - week + - year type: string + interval_count: + type: integer required: - - country - title: eu_bank_transfer_param + - interval + title: recurring_adhoc type: object - type: + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified type: string - title: bank_transfer_param + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + - product + - recurring + title: recurring_price_data type: object - funding_type: - type: string - title: invoice_payment_method_options_param - type: object - - enum: - - '' - type: string - konbini: - anyOf: - - properties: {} - title: invoice_payment_method_options_param - type: object - - enum: - - '' - type: string - us_bank_account: - anyOf: - - properties: - financial_connections: - properties: - permissions: - items: - enum: - - balances - - ownership - - payment_method - - transactions + quantity: + type: integer + tax_rates: + anyOf: + - items: maxLength: 5000 type: string - x-stripeBypassValidation: true - type: array - prefetch: - items: - enum: - - balances - type: string - x-stripeBypassValidation: true type: array - title: invoice_linked_account_options_param - type: object - verification_method: - enum: - - automatic - - instant - - microdeposits - type: string - x-stripeBypassValidation: true - title: invoice_payment_method_options_param + - enum: + - '' + type: string + title: configuration_item_params type: object - - enum: - - '' + type: array + iterations: + type: integer + metadata: + additionalProperties: type: string - title: payment_method_options - type: object - payment_method_types: - anyOf: - - items: + type: object + on_behalf_of: + type: string + proration_behavior: enum: - - ach_credit_transfer - - ach_debit - - acss_debit - - au_becs_debit - - bacs_debit - - bancontact - - boleto - - card - - cashapp - - customer_balance - - fpx - - giropay - - grabpay - - ideal - - konbini - - link - - paynow - - paypal - - promptpay - - sepa_debit - - sofort - - us_bank_account - - wechat_pay + - always_invoice + - create_prorations + - none type: string - x-stripeBypassValidation: true - type: array - - enum: - - '' - type: string - title: payment_settings - type: object - pending_invoice_items_behavior: - description: >- - How to handle pending invoice items on invoice creation. One - of `include` or `exclude`. `include` will include any - pending invoice items, and will create an empty draft - invoice if no pending invoice items exist. `exclude` will - always create an empty invoice draft regardless if there are - pending invoice items or not. Defaults to `exclude` if the - parameter is omitted. - enum: - - exclude - - include - - include_and_require - type: string - rendering: - description: >- - The rendering-related settings that control how the invoice - is displayed on customer-facing surfaces such as PDF and - Hosted Invoice Page. - properties: - amount_tax_display: + start_date: + anyOf: + - format: unix-time + type: integer + - enum: + - now + maxLength: 5000 + type: string + transfer_data: + properties: + amount_percent: + type: number + destination: + type: string + required: + - destination + title: transfer_data_specs + type: object + trial: + type: boolean + trial_end: + anyOf: + - format: unix-time + type: integer + - enum: + - now + maxLength: 5000 + type: string + required: + - items + title: phase_configuration_params + type: object + type: array + proration_behavior: enum: - - '' - - exclude_tax - - include_inclusive_tax - type: string - pdf: - properties: - page_size: - enum: - - a4 - - auto - - letter - type: string - title: rendering_pdf_param - type: object - title: rendering_param - type: object - shipping_cost: - description: Settings for the cost of shipping for this invoice. - properties: - shipping_rate: - maxLength: 5000 - type: string - shipping_rate_data: - properties: - delivery_estimate: - properties: - maximum: - properties: - unit: - enum: - - business_day - - day - - hour - - month - - week - type: string - value: - type: integer - required: - - unit - - value - title: delivery_estimate_bound - type: object - minimum: - properties: - unit: - enum: - - business_day - - day - - hour - - month - - week - type: string - value: - type: integer - required: - - unit - - value - title: delivery_estimate_bound - type: object - title: delivery_estimate - type: object - display_name: - maxLength: 100 - type: string - fixed_amount: - properties: - amount: - type: integer - currency: - type: string - currency_options: - additionalProperties: - properties: - amount: - type: integer - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - required: - - amount - title: currency_option - type: object - type: object - required: - - amount - - currency - title: fixed_amount - type: object - metadata: - additionalProperties: - type: string - type: object - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - tax_code: - type: string - type: - enum: - - fixed_amount - type: string - required: - - display_name - title: method_params - type: object - title: shipping_cost + - always_invoice + - create_prorations + - none + type: string + title: schedule_details_params type: object - shipping_details: + subscription: description: >- - Shipping details for the invoice. The Invoice PDF will use - the `shipping_details` value if it is set, otherwise the PDF - will render the shipping address from the customer. + The identifier of the subscription for which you'd like to + retrieve the upcoming invoice. If not provided, but a + `subscription_items` is provided, you will preview creating + a subscription with those items. If neither `subscription` + nor `subscription_items` is provided, you will retrieve the + next upcoming invoice from among the customer's + subscriptions. + maxLength: 5000 + type: string + subscription_details: + description: >- + The subscription creation or modification params to apply as + a preview. Cannot be used with `schedule` or + `schedule_details` fields. properties: - address: - properties: - city: - maxLength: 5000 - type: string - country: - maxLength: 5000 - type: string - line1: - maxLength: 5000 - type: string - line2: - maxLength: 5000 - type: string - postal_code: - maxLength: 5000 - type: string - state: + billing_cycle_anchor: + anyOf: + - enum: + - now + - unchanged maxLength: 5000 type: string - title: optional_fields_address - type: object - name: - maxLength: 5000 - type: string - phone: + - format: unix-time + type: integer + cancel_at: anyOf: - - maxLength: 5000 + - format: unix-time + type: integer + - enum: + - '' type: string + cancel_at_period_end: + type: boolean + cancel_now: + type: boolean + default_tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array - enum: - '' type: string - required: - - address - - name - title: recipient_shipping_with_optional_fields_address - type: object - statement_descriptor: - description: >- - Extra information about a charge for the customer's credit - card statement. It must contain at least one letter. If not - specified and this invoice is part of a subscription, the - default `statement_descriptor` will be set to the first - subscription item's product's `statement_descriptor`. - maxLength: 22 - type: string - subscription: - description: >- - The ID of the subscription to invoice, if any. If set, the - created invoice will only include pending invoice items for - that subscription. The subscription's billing cycle and - regular subscription events won't be affected. - maxLength: 5000 - type: string - transfer_data: - description: >- - If specified, the funds from the invoice will be transferred - to the destination and the ID of the resulting transfer will - be found on the invoice's charge. - properties: - amount: + items: + items: + properties: + billing_thresholds: + anyOf: + - properties: + usage_gte: + type: integer + required: + - usage_gte + title: item_billing_thresholds_param + type: object + - enum: + - '' + type: string + clear_usage: + type: boolean + deleted: + type: boolean + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + id: + maxLength: 5000 + type: string + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + price: + maxLength: 5000 + type: string + price_data: + properties: + currency: + type: string + product: + maxLength: 5000 + type: string + recurring: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + required: + - interval + title: recurring_adhoc + type: object + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + - product + - recurring + title: recurring_price_data + type: object + quantity: + type: integer + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: subscription_item_update_params + type: object + type: array + proration_behavior: + enum: + - always_invoice + - create_prorations + - none + type: string + proration_date: + format: unix-time type: integer - destination: + resume_at: + enum: + - now + maxLength: 5000 type: string - required: - - destination - title: transfer_data_specs + start_date: + format: unix-time + type: integer + trial_end: + anyOf: + - enum: + - now + maxLength: 5000 + type: string + - format: unix-time + type: integer + title: subscription_details_params type: object type: object required: false @@ -66789,14 +75707,12 @@ paths:

You can preview the effects of updating a subscription, including a preview of what proration will take place. To ensure that the actual proration is calculated exactly the same as the previewed proration, you - should pass a proration_date parameter when doing the - actual subscription update. The value passed in should be the same as - the subscription_proration_date returned on the upcoming - invoice resource. The recommended way to get only the prorations being - previewed is to consider only proration line items where - period[start] is equal to the - subscription_proration_date on the upcoming invoice - resource.

+ should pass the subscription_details.proration_date + parameter when doing the actual subscription update. The recommended way + to get only the prorations being previewed is to consider only proration + line items where period[start] is equal to the + subscription_details.proration_date value passed in the + request.

operationId: GetInvoicesUpcoming parameters: - description: Settings for automatic tax lookup for this invoice preview. @@ -66808,19 +75724,28 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_param type: object style: deepObject - description: >- - The code of the coupon to apply. If `subscription` or - `subscription_items` is provided, the invoice returned will preview - updating or creating a subscription with that coupon. Otherwise, it - will preview applying that coupon to the customer for the next - upcoming invoice from among the customer's subscriptions. The - invoice can be previewed without a coupon by passing this value as - an empty string. + 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. in: query name: coupon required: false @@ -66952,6 +75877,7 @@ paths: - au_abn - au_arn - bg_uic + - bh_vat - bo_tin - br_cnpj - br_cpf @@ -66985,13 +75911,17 @@ paths: - jp_trn - ke_pin - kr_brn + - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst + - ng_tin - no_vat + - no_voec - nz_gst + - om_vat - pe_ruc - ph_tin - ro_tin @@ -67028,12 +75958,10 @@ paths: style: deepObject - description: >- The coupons to redeem into discounts for the invoice preview. If not - specified, inherits the discount from the customer or subscription. - This only works for coupons directly applied to the invoice. To - apply a coupon to a subscription, you must use the `coupon` - parameter instead. Pass an empty string to avoid inheriting any - discounts. To preview the upcoming invoice for a subscription that - hasn't been created, use `coupon` instead. + specified, inherits the discount from the subscription or customer. + This works for both coupons directly applied to an invoice and + coupons applied to a subscription. Pass an empty string to avoid + inheriting any discounts. explode: true in: query name: discounts @@ -67048,6 +75976,9 @@ paths: discount: maxLength: 5000 type: string + promotion_code: + maxLength: 5000 + type: string title: discounts_data_param type: object type: array @@ -67095,6 +76026,9 @@ paths: discount: maxLength: 5000 type: string + promotion_code: + maxLength: 5000 + type: string title: discounts_data_param type: object type: array @@ -67147,52 +76081,439 @@ paths: format: decimal type: string required: - - currency - - product - title: one_time_price_data + - currency + - product + title: one_time_price_data + type: object + quantity: + type: integer + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + tax_code: + anyOf: + - type: string + - enum: + - '' + type: string + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + title: invoice_item_preview_params + type: object + type: array + style: deepObject + - description: >- + The connected account that issues the invoice. The invoice is + presented with the branding and support information of the specified + account. + explode: true + in: query + name: issuer + required: false + schema: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + style: deepObject + - description: >- + The account (if any) for which the funds of the invoice payment are + intended. If set, the invoice will be presented with the branding + and support information of the specified account. See the [Invoices + with Connect](https://stripe.com/docs/billing/invoices/connect) + documentation for details. + explode: true + in: query + name: on_behalf_of + required: false + schema: + anyOf: + - type: string + - enum: + - '' + type: string + style: deepObject + - description: >- + The identifier of the schedule whose upcoming invoice you'd like to + retrieve. Cannot be used with subscription or subscription fields. + in: query + name: schedule + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: >- + The schedule creation or modification params to apply as a preview. + Cannot be used with `subscription` or `subscription_` prefixed + fields. + explode: true + in: query + name: schedule_details + required: false + schema: + properties: + end_behavior: + enum: + - cancel + - release + type: string + phases: + items: + properties: + add_invoice_items: + items: + properties: + discounts: + items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + price: + maxLength: 5000 + type: string + price_data: + properties: + currency: + type: string + product: + maxLength: 5000 + type: string + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + - product + title: one_time_price_data_with_negative_amounts + type: object + quantity: + type: integer + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: add_invoice_item_entry + type: object + type: array + application_fee_percent: + type: number + automatic_tax: + properties: + enabled: + type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + required: + - enabled + title: automatic_tax_config + type: object + billing_cycle_anchor: + enum: + - automatic + - phase_start + type: string + billing_thresholds: + anyOf: + - properties: + amount_gte: + type: integer + reset_billing_cycle_anchor: + type: boolean + title: billing_thresholds_param + type: object + - enum: + - '' + type: string + collection_method: + enum: + - charge_automatically + - send_invoice + type: string + coupon: + maxLength: 5000 + type: string + default_payment_method: + maxLength: 5000 + type: string + default_tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + description: + anyOf: + - maxLength: 500 + type: string + - enum: + - '' + type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + end_date: + anyOf: + - format: unix-time + type: integer + - enum: + - now + maxLength: 5000 + type: string + invoice_settings: + properties: + account_tax_ids: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + days_until_due: + type: integer + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + title: invoice_settings + type: object + items: + items: + properties: + billing_thresholds: + anyOf: + - properties: + usage_gte: + type: integer + required: + - usage_gte + title: item_billing_thresholds_param + type: object + - enum: + - '' + type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + metadata: + additionalProperties: + type: string + type: object + price: + maxLength: 5000 + type: string + price_data: + properties: + currency: + type: string + product: + maxLength: 5000 + type: string + recurring: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + required: + - interval + title: recurring_adhoc + type: object + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + - product + - recurring + title: recurring_price_data + type: object + quantity: + type: integer + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: configuration_item_params + type: object + type: array + iterations: + type: integer + metadata: + additionalProperties: + type: string + type: object + on_behalf_of: + type: string + proration_behavior: + enum: + - always_invoice + - create_prorations + - none + type: string + start_date: + anyOf: + - format: unix-time + type: integer + - enum: + - now + maxLength: 5000 + type: string + transfer_data: + properties: + amount_percent: + type: number + destination: + type: string + required: + - destination + title: transfer_data_specs + type: object + trial: + type: boolean + trial_end: + anyOf: + - format: unix-time + type: integer + - enum: + - now + maxLength: 5000 + type: string + required: + - items + title: phase_configuration_params type: object - quantity: - type: integer - tax_behavior: - enum: - - exclusive - - inclusive - - unspecified - type: string - tax_code: - anyOf: - - type: string - - enum: - - '' - type: string - tax_rates: - anyOf: - - items: - maxLength: 5000 - type: string - type: array - - enum: - - '' - type: string - unit_amount: - type: integer - unit_amount_decimal: - format: decimal - type: string - title: invoice_item_preview_params - type: object - type: array + type: array + proration_behavior: + enum: + - always_invoice + - create_prorations + - none + type: string + title: schedule_details_params + type: object style: deepObject - - description: >- - The identifier of the schedule whose upcoming invoice you'd like to - retrieve. Cannot be used with subscription or subscription fields. - in: query - name: schedule - required: false - schema: - maxLength: 5000 - type: string - style: form - description: >- The identifier of the subscription for which you'd like to retrieve the upcoming invoice. If not provided, but a `subscription_items` is @@ -67214,7 +76535,9 @@ paths: used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only - be set to `now` or `unchanged`. + be set to `now` or `unchanged`. This field has been deprecated and + will be removed in a future API version. Use + `subscription_details.billing_cycle_anchor` instead. explode: true in: query name: subscription_billing_cycle_anchor @@ -67230,9 +76553,12 @@ paths: type: integer style: deepObject - description: >- - Timestamp indicating when the subscription should be scheduled to - cancel. Will prorate if within the current period and prorations - have been enabled using `proration_behavior`. + A timestamp at which the subscription should cancel. If set to a + date before the current period ends, this will cause a proration if + prorations have been enabled using `proration_behavior`. If set + during a future period, this will always cause a proration for that + period. This field has been deprecated and will be removed in a + future API version. Use `subscription_details.cancel_at` instead. explode: true in: query name: subscription_cancel_at @@ -67247,7 +76573,9 @@ paths: style: deepObject - description: >- Boolean indicating whether this subscription should cancel at the - end of the current period. + end of the current period. This field has been deprecated and will + be removed in a future API version. Use + `subscription_details.cancel_at_period_end` instead. in: query name: subscription_cancel_at_period_end required: false @@ -67256,7 +76584,8 @@ paths: style: form - description: >- This simulates the subscription being canceled or expired - immediately. + immediately. This field has been deprecated and will be removed in a + future API version. Use `subscription_details.cancel_now` instead. in: query name: subscription_cancel_now required: false @@ -67266,7 +76595,9 @@ paths: - description: >- If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates - will apply to any line item that does not have `tax_rates` set. + will apply to any line item that does not have `tax_rates` set. This + field has been deprecated and will be removed in a future API + version. Use `subscription_details.default_tax_rates` instead. explode: true in: query name: subscription_default_tax_rates @@ -67281,7 +76612,182 @@ paths: - '' type: string style: deepObject - - description: 'A list of up to 20 subscription items, each with an attached price.' + - description: >- + The subscription creation or modification params to apply as a + preview. Cannot be used with `schedule` or `schedule_details` + fields. + explode: true + in: query + name: subscription_details + required: false + schema: + properties: + billing_cycle_anchor: + anyOf: + - enum: + - now + - unchanged + maxLength: 5000 + type: string + - format: unix-time + type: integer + cancel_at: + anyOf: + - format: unix-time + type: integer + - enum: + - '' + type: string + cancel_at_period_end: + type: boolean + cancel_now: + type: boolean + default_tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + items: + items: + properties: + billing_thresholds: + anyOf: + - properties: + usage_gte: + type: integer + required: + - usage_gte + title: item_billing_thresholds_param + type: object + - enum: + - '' + type: string + clear_usage: + type: boolean + deleted: + type: boolean + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + id: + maxLength: 5000 + type: string + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + price: + maxLength: 5000 + type: string + price_data: + properties: + currency: + type: string + product: + maxLength: 5000 + type: string + recurring: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + required: + - interval + title: recurring_adhoc + type: object + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + - product + - recurring + title: recurring_price_data + type: object + quantity: + type: integer + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: subscription_item_update_params + type: object + type: array + proration_behavior: + enum: + - always_invoice + - create_prorations + - none + type: string + proration_date: + format: unix-time + type: integer + resume_at: + enum: + - now + maxLength: 5000 + type: string + start_date: + format: unix-time + type: integer + trial_end: + anyOf: + - enum: + - now + maxLength: 5000 + type: string + - format: unix-time + type: integer + title: subscription_details_params + type: object + style: deepObject + - description: >- + A list of up to 20 subscription items, each with an attached price. + This field has been deprecated and will be removed in a future API + version. Use `subscription_details.items` instead. explode: true in: query name: subscription_items @@ -67305,6 +76811,25 @@ paths: type: boolean deleted: type: boolean + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string id: maxLength: 5000 type: string @@ -67375,10 +76900,12 @@ paths: style: deepObject - description: >- Determines how to handle - [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) + [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + This field has been deprecated and will be removed in a future API + version. Use `subscription_details.proration_behavior` instead. in: query name: subscription_proration_behavior required: false @@ -67398,6 +76925,8 @@ paths: schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. + This field has been deprecated and will be removed in a future API + version. Use `subscription_details.proration_date` instead. in: query name: subscription_proration_date required: false @@ -67408,7 +76937,8 @@ paths: - description: >- For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription - is resumed. + is resumed. This field has been deprecated and will be removed in a + future API version. Use `subscription_details.resume_at` instead. in: query name: subscription_resume_at required: false @@ -67418,7 +76948,10 @@ paths: maxLength: 5000 type: string style: form - - description: Date a subscription is intended to start (can be future or past) + - description: >- + Date a subscription is intended to start (can be future or past). + This field has been deprecated and will be removed in a future API + version. Use `subscription_details.start_date` instead. in: query name: subscription_start_date required: false @@ -67429,7 +76962,9 @@ paths: - description: >- If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of - `subscription_items` or `subscription` is required. + `subscription_items` or `subscription` is required. This field has + been deprecated and will be removed in a future API version. Use + `subscription_details.trial_end` instead. explode: true in: query name: subscription_trial_end @@ -67443,20 +76978,6 @@ paths: - format: unix-time type: integer style: deepObject - - description: >- - Indicates if a plan's `trial_period_days` should be applied to the - subscription. Setting `subscription_trial_end` per subscription is - preferred, and this defaults to `false`. Setting this flag to `true` - together with `subscription_trial_end` is not allowed. See [Using - trial periods on - subscriptions](https://stripe.com/docs/billing/subscriptions/trials) - to learn more. - in: query - name: subscription_trial_from_plan - required: false - schema: - type: boolean - style: form requestBody: content: application/x-www-form-urlencoded: @@ -67497,19 +77018,28 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_param type: object style: deepObject - description: >- - The code of the coupon to apply. If `subscription` or - `subscription_items` is provided, the invoice returned will preview - updating or creating a subscription with that coupon. Otherwise, it - will preview applying that coupon to the customer for the next - upcoming invoice from among the customer's subscriptions. The - invoice can be previewed without a coupon by passing this value as - an empty string. + 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. in: query name: coupon required: false @@ -67641,6 +77171,7 @@ paths: - au_abn - au_arn - bg_uic + - bh_vat - bo_tin - br_cnpj - br_cpf @@ -67674,13 +77205,17 @@ paths: - jp_trn - ke_pin - kr_brn + - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst + - ng_tin - no_vat + - no_voec - nz_gst + - om_vat - pe_ruc - ph_tin - ro_tin @@ -67717,12 +77252,10 @@ paths: style: deepObject - description: >- The coupons to redeem into discounts for the invoice preview. If not - specified, inherits the discount from the customer or subscription. - This only works for coupons directly applied to the invoice. To - apply a coupon to a subscription, you must use the `coupon` - parameter instead. Pass an empty string to avoid inheriting any - discounts. To preview the upcoming invoice for a subscription that - hasn't been created, use `coupon` instead. + specified, inherits the discount from the subscription or customer. + This works for both coupons directly applied to an invoice and + coupons applied to a subscription. Pass an empty string to avoid + inheriting any discounts. explode: true in: query name: discounts @@ -67737,6 +77270,9 @@ paths: discount: maxLength: 5000 type: string + promotion_code: + maxLength: 5000 + type: string title: discounts_data_param type: object type: array @@ -67797,6 +77333,9 @@ paths: discount: maxLength: 5000 type: string + promotion_code: + maxLength: 5000 + type: string title: discounts_data_param type: object type: array @@ -67885,6 +77424,28 @@ paths: type: object type: array style: deepObject + - description: >- + The connected account that issues the invoice. The invoice is + presented with the branding and support information of the specified + account. + explode: true + in: query + name: issuer + required: false + schema: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + style: deepObject - description: >- A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. @@ -67894,6 +77455,23 @@ paths: schema: type: integer style: form + - description: >- + The account (if any) for which the funds of the invoice payment are + intended. If set, the invoice will be presented with the branding + and support information of the specified account. See the [Invoices + with Connect](https://stripe.com/docs/billing/invoices/connect) + documentation for details. + explode: true + in: query + name: on_behalf_of + required: false + schema: + anyOf: + - type: string + - enum: + - '' + type: string + style: deepObject - description: >- The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields. @@ -67904,6 +77482,354 @@ paths: maxLength: 5000 type: string style: form + - description: >- + The schedule creation or modification params to apply as a preview. + Cannot be used with `subscription` or `subscription_` prefixed + fields. + explode: true + in: query + name: schedule_details + required: false + schema: + properties: + end_behavior: + enum: + - cancel + - release + type: string + phases: + items: + properties: + add_invoice_items: + items: + properties: + discounts: + items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + price: + maxLength: 5000 + type: string + price_data: + properties: + currency: + type: string + product: + maxLength: 5000 + type: string + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + - product + title: one_time_price_data_with_negative_amounts + type: object + quantity: + type: integer + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: add_invoice_item_entry + type: object + type: array + application_fee_percent: + type: number + automatic_tax: + properties: + enabled: + type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + required: + - enabled + title: automatic_tax_config + type: object + billing_cycle_anchor: + enum: + - automatic + - phase_start + type: string + billing_thresholds: + anyOf: + - properties: + amount_gte: + type: integer + reset_billing_cycle_anchor: + type: boolean + title: billing_thresholds_param + type: object + - enum: + - '' + type: string + collection_method: + enum: + - charge_automatically + - send_invoice + type: string + coupon: + maxLength: 5000 + type: string + default_payment_method: + maxLength: 5000 + type: string + default_tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + description: + anyOf: + - maxLength: 500 + type: string + - enum: + - '' + type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + end_date: + anyOf: + - format: unix-time + type: integer + - enum: + - now + maxLength: 5000 + type: string + invoice_settings: + properties: + account_tax_ids: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + days_until_due: + type: integer + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + title: invoice_settings + type: object + items: + items: + properties: + billing_thresholds: + anyOf: + - properties: + usage_gte: + type: integer + required: + - usage_gte + title: item_billing_thresholds_param + type: object + - enum: + - '' + type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + metadata: + additionalProperties: + type: string + type: object + price: + maxLength: 5000 + type: string + price_data: + properties: + currency: + type: string + product: + maxLength: 5000 + type: string + recurring: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + required: + - interval + title: recurring_adhoc + type: object + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + - product + - recurring + title: recurring_price_data + type: object + quantity: + type: integer + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: configuration_item_params + type: object + type: array + iterations: + type: integer + metadata: + additionalProperties: + type: string + type: object + on_behalf_of: + type: string + proration_behavior: + enum: + - always_invoice + - create_prorations + - none + type: string + start_date: + anyOf: + - format: unix-time + type: integer + - enum: + - now + maxLength: 5000 + type: string + transfer_data: + properties: + amount_percent: + type: number + destination: + type: string + required: + - destination + title: transfer_data_specs + type: object + trial: + type: boolean + trial_end: + anyOf: + - format: unix-time + type: integer + - enum: + - now + maxLength: 5000 + type: string + required: + - items + title: phase_configuration_params + type: object + type: array + proration_behavior: + enum: + - always_invoice + - create_prorations + - none + type: string + title: schedule_details_params + type: object + style: deepObject - 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 @@ -67938,7 +77864,9 @@ paths: used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only - be set to `now` or `unchanged`. + be set to `now` or `unchanged`. This field has been deprecated and + will be removed in a future API version. Use + `subscription_details.billing_cycle_anchor` instead. explode: true in: query name: subscription_billing_cycle_anchor @@ -67954,9 +77882,12 @@ paths: type: integer style: deepObject - description: >- - Timestamp indicating when the subscription should be scheduled to - cancel. Will prorate if within the current period and prorations - have been enabled using `proration_behavior`. + A timestamp at which the subscription should cancel. If set to a + date before the current period ends, this will cause a proration if + prorations have been enabled using `proration_behavior`. If set + during a future period, this will always cause a proration for that + period. This field has been deprecated and will be removed in a + future API version. Use `subscription_details.cancel_at` instead. explode: true in: query name: subscription_cancel_at @@ -67971,7 +77902,9 @@ paths: style: deepObject - description: >- Boolean indicating whether this subscription should cancel at the - end of the current period. + end of the current period. This field has been deprecated and will + be removed in a future API version. Use + `subscription_details.cancel_at_period_end` instead. in: query name: subscription_cancel_at_period_end required: false @@ -67980,7 +77913,8 @@ paths: style: form - description: >- This simulates the subscription being canceled or expired - immediately. + immediately. This field has been deprecated and will be removed in a + future API version. Use `subscription_details.cancel_now` instead. in: query name: subscription_cancel_now required: false @@ -67990,7 +77924,9 @@ paths: - description: >- If provided, the invoice returned will preview updating or creating a subscription with these default tax rates. The default tax rates - will apply to any line item that does not have `tax_rates` set. + will apply to any line item that does not have `tax_rates` set. This + field has been deprecated and will be removed in a future API + version. Use `subscription_details.default_tax_rates` instead. explode: true in: query name: subscription_default_tax_rates @@ -68005,7 +77941,182 @@ paths: - '' type: string style: deepObject - - description: 'A list of up to 20 subscription items, each with an attached price.' + - description: >- + The subscription creation or modification params to apply as a + preview. Cannot be used with `schedule` or `schedule_details` + fields. + explode: true + in: query + name: subscription_details + required: false + schema: + properties: + billing_cycle_anchor: + anyOf: + - enum: + - now + - unchanged + maxLength: 5000 + type: string + - format: unix-time + type: integer + cancel_at: + anyOf: + - format: unix-time + type: integer + - enum: + - '' + type: string + cancel_at_period_end: + type: boolean + cancel_now: + type: boolean + default_tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + items: + items: + properties: + billing_thresholds: + anyOf: + - properties: + usage_gte: + type: integer + required: + - usage_gte + title: item_billing_thresholds_param + type: object + - enum: + - '' + type: string + clear_usage: + type: boolean + deleted: + type: boolean + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + id: + maxLength: 5000 + type: string + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: string + price: + maxLength: 5000 + type: string + price_data: + properties: + currency: + type: string + product: + maxLength: 5000 + type: string + recurring: + properties: + interval: + enum: + - day + - month + - week + - year + type: string + interval_count: + type: integer + required: + - interval + title: recurring_adhoc + type: object + tax_behavior: + enum: + - exclusive + - inclusive + - unspecified + type: string + unit_amount: + type: integer + unit_amount_decimal: + format: decimal + type: string + required: + - currency + - product + - recurring + title: recurring_price_data + type: object + quantity: + type: integer + tax_rates: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + title: subscription_item_update_params + type: object + type: array + proration_behavior: + enum: + - always_invoice + - create_prorations + - none + type: string + proration_date: + format: unix-time + type: integer + resume_at: + enum: + - now + maxLength: 5000 + type: string + start_date: + format: unix-time + type: integer + trial_end: + anyOf: + - enum: + - now + maxLength: 5000 + type: string + - format: unix-time + type: integer + title: subscription_details_params + type: object + style: deepObject + - description: >- + A list of up to 20 subscription items, each with an attached price. + This field has been deprecated and will be removed in a future API + version. Use `subscription_details.items` instead. explode: true in: query name: subscription_items @@ -68029,6 +78140,25 @@ paths: type: boolean deleted: type: boolean + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string id: maxLength: 5000 type: string @@ -68099,10 +78229,12 @@ paths: style: deepObject - description: >- Determines how to handle - [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) + [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`. + This field has been deprecated and will be removed in a future API + version. Use `subscription_details.proration_behavior` instead. in: query name: subscription_proration_behavior required: false @@ -68122,6 +78254,8 @@ paths: schedule exists. If set, `subscription`, and one of `subscription_items`, or `subscription_trial_end` are required. Also, `subscription_proration_behavior` cannot be set to 'none'. + This field has been deprecated and will be removed in a future API + version. Use `subscription_details.proration_date` instead. in: query name: subscription_proration_date required: false @@ -68132,7 +78266,8 @@ paths: - description: >- For paused subscriptions, setting `subscription_resume_at` to `now` will preview the invoice that will be generated if the subscription - is resumed. + is resumed. This field has been deprecated and will be removed in a + future API version. Use `subscription_details.resume_at` instead. in: query name: subscription_resume_at required: false @@ -68142,7 +78277,10 @@ paths: maxLength: 5000 type: string style: form - - description: Date a subscription is intended to start (can be future or past) + - description: >- + Date a subscription is intended to start (can be future or past). + This field has been deprecated and will be removed in a future API + version. Use `subscription_details.start_date` instead. in: query name: subscription_start_date required: false @@ -68153,7 +78291,9 @@ paths: - description: >- If provided, the invoice returned will preview updating or creating a subscription with that trial end. If set, one of - `subscription_items` or `subscription` is required. + `subscription_items` or `subscription` is required. This field has + been deprecated and will be removed in a future API version. Use + `subscription_details.trial_end` instead. explode: true in: query name: subscription_trial_end @@ -68167,20 +78307,6 @@ paths: - format: unix-time type: integer style: deepObject - - description: >- - Indicates if a plan's `trial_period_days` should be applied to the - subscription. Setting `subscription_trial_end` per subscription is - preferred, and this defaults to `false`. Setting this flag to `true` - together with `subscription_trial_end` is not allowed. See [Using - trial periods on - subscriptions](https://stripe.com/docs/billing/subscriptions/trials) - to learn more. - in: query - name: subscription_trial_from_plan - required: false - schema: - type: boolean - style: form requestBody: content: application/x-www-form-urlencoded: @@ -68370,9 +78496,15 @@ paths: expand: explode: true style: deepObject + issuer: + explode: true + style: deepObject metadata: explode: true style: deepObject + number: + explode: true + style: deepObject on_behalf_of: explode: true style: deepObject @@ -68426,6 +78558,19 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_param @@ -68443,10 +78588,10 @@ paths: - items: properties: name: - maxLength: 30 + maxLength: 40 type: string value: - maxLength: 30 + maxLength: 140 type: string required: - name @@ -68521,6 +78666,9 @@ paths: discount: maxLength: 5000 type: string + promotion_code: + maxLength: 5000 + type: string title: discounts_data_param type: object type: array @@ -68559,6 +78707,23 @@ paths: description: Footer to be displayed on the invoice. maxLength: 5000 type: string + issuer: + description: >- + The connected account that issues the invoice. The invoice + is presented with the branding and support information of + the specified account. + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object metadata: anyOf: - additionalProperties: @@ -68575,6 +78740,23 @@ paths: format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + number: + anyOf: + - maxLength: 26 + type: string + - enum: + - '' + type: string + description: >- + Set the number for this invoice. If no number is present + then a number will be assigned automatically when the + invoice is finalized. In many markets, regulations require + invoices to be unique, sequential and / or gapless. You are + responsible for ensuring this is true across all your + different invoicing systems in the event that you edit the + invoice number using our API. If you use only Stripe for + your invoices and do not change invoice numbers, Stripe + handles this aspect of compliance for you automatically. on_behalf_of: anyOf: - type: string @@ -68676,6 +78858,7 @@ paths: enum: - any - automatic + - challenge type: string title: invoice_payment_method_options_param type: object @@ -68715,6 +78898,14 @@ paths: - enum: - '' type: string + sepa_debit: + anyOf: + - properties: {} + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string us_bank_account: anyOf: - properties: @@ -68735,6 +78926,8 @@ paths: items: enum: - balances + - ownership + - transactions type: string x-stripeBypassValidation: true type: array @@ -68761,6 +78954,7 @@ paths: - ach_credit_transfer - ach_debit - acss_debit + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -68768,15 +78962,18 @@ paths: - card - cashapp - customer_balance + - eps - fpx - giropay - grabpay - ideal - konbini - link + - p24 - paynow - paypal - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -69263,6 +79460,9 @@ paths: discount: maxLength: 5000 type: string + promotion_code: + maxLength: 5000 + type: string title: discounts_data_param type: object type: array @@ -69270,9 +79470,10 @@ paths: - '' type: string description: >- - The coupons & existing discounts which apply to the line - item. Item discounts are applied before invoice discounts. - Pass an empty string to remove previously-defined discounts. + The coupons, promotion codes & existing discounts which + apply to the line item. Item discounts are applied before + invoice discounts. Pass an empty string to remove + previously-defined discounts. expand: description: Specifies which fields in the response should be expanded. items: @@ -69294,7 +79495,11 @@ paths: additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty - value to `metadata`. + value to `metadata`. For `type=recurring` line items, the + incoming metadata specified on the request is directly used + to set this value, in contrast to `type=invoiceitem` line + items, where any existing metadata on the invoice line is + merged with the incoming data. period: description: >- The period associated with this invoice item. When set to @@ -69414,9 +79619,9 @@ paths: - qst - rst - sales_tax - - service_tax - vat type: string + x-stripeBypassValidation: true required: - display_name - inclusive @@ -69688,6 +79893,14 @@ paths: invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

+ + +

Consult with local regulations to determine whether and how an + invoice might be amended, canceled, or voided in the jurisdiction you’re + doing business in. You might need to issue + another invoice or credit note + instead. Stripe recommends that you consult with your legal counsel for + advice specific to your business.

operationId: PostInvoicesInvoiceVoid parameters: - in: path @@ -69997,6 +80210,7 @@ paths: description: Error response. '/v1/issuing/authorizations/{authorization}/approve': post: + deprecated: true description: >-

[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the -

[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the - 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 @@ -72910,6 +83152,12 @@ paths: metadata: explode: true style: deepObject + pin: + explode: true + style: deepObject + second_line: + explode: true + style: deepObject shipping: explode: true style: deepObject @@ -72949,6 +83197,18 @@ paths: value to them. All keys can be unset by posting an empty value to `metadata`. type: object + personalization_design: + description: The personalization design object belonging to this card. + maxLength: 5000 + type: string + pin: + description: The desired PIN for this card. + properties: + encrypted_number: + maxLength: 5000 + type: string + title: encrypted_pin_param + type: object replacement_for: description: The card this is meant to be a replacement for (if any). maxLength: 5000 @@ -72964,6 +83224,14 @@ paths: - stolen type: string x-stripeBypassValidation: true + second_line: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + description: The second line to print on the card. shipping: description: The address where the card will be shipped. properties: @@ -73340,6 +83608,11 @@ paths: maxLength: 5000 type: string type: array + allowed_merchant_countries: + items: + maxLength: 5000 + type: string + type: array blocked_categories: items: enum: @@ -73649,6 +83922,11 @@ paths: maxLength: 5000 type: string type: array + blocked_merchant_countries: + items: + maxLength: 5000 + type: string + type: array spending_limits: items: properties: @@ -74129,6 +84407,9 @@ paths: format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + personalization_design: + maxLength: 5000 + type: string pin: description: The desired new PIN for this card. properties: @@ -74452,6 +84733,11 @@ paths: maxLength: 5000 type: string type: array + allowed_merchant_countries: + items: + maxLength: 5000 + type: string + type: array blocked_categories: items: enum: @@ -74761,6 +85047,11 @@ paths: maxLength: 5000 type: string type: array + blocked_merchant_countries: + items: + maxLength: 5000 + type: string + type: array spending_limits: items: properties: @@ -75137,7 +85428,7 @@ paths: operationId: GetIssuingDisputes parameters: - description: >- - Select Issuing disputes that were created during the given date + Only return Issuing disputes that were created during the given date interval. explode: true in: query @@ -75993,94 +86284,405 @@ paths: - enum: - '' type: string - other: + other: + anyOf: + - properties: + additional_documentation: + anyOf: + - type: string + - enum: + - '' + type: string + explanation: + anyOf: + - maxLength: 1500 + type: string + - enum: + - '' + type: string + product_description: + anyOf: + - maxLength: 1500 + type: string + - enum: + - '' + type: string + product_type: + enum: + - '' + - merchandise + - service + type: string + title: other + type: object + - enum: + - '' + type: string + reason: + enum: + - canceled + - duplicate + - fraudulent + - merchandise_not_as_described + - not_received + - other + - service_not_as_described + type: string + x-stripeBypassValidation: true + service_not_as_described: + anyOf: + - properties: + additional_documentation: + anyOf: + - type: string + - enum: + - '' + type: string + canceled_at: + anyOf: + - format: unix-time + type: integer + - enum: + - '' + type: string + cancellation_reason: + anyOf: + - maxLength: 1500 + type: string + - enum: + - '' + type: string + explanation: + anyOf: + - maxLength: 1500 + type: string + - enum: + - '' + type: string + received_at: + anyOf: + - format: unix-time + type: integer + - enum: + - '' + type: string + title: service_not_as_described + type: object + - enum: + - '' + type: string + title: evidence_param + type: object + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: 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. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.dispute' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/issuing/disputes/{dispute}/submit': + post: + description: >- +

Submits an Issuing Dispute to the card network. Stripe + validates that all evidence fields required for the dispute’s reason are + present. For more details, see Dispute + reasons and evidence.

+ operationId: PostIssuingDisputesDisputeSubmit + parameters: + - in: path + name: dispute + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + metadata: + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: 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. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.dispute' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/issuing/personalization_designs: + get: + description: >- +

Returns a list of personalization design objects. The objects are + sorted in descending order by creation date, with the most recently + created object appearing first.

+ operationId: GetIssuingPersonalizationDesigns + parameters: + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: Only return personalization designs with the given lookup keys. + explode: true + in: query + name: lookup_keys + required: false + schema: + items: + maxLength: 200 + type: string + type: array + style: deepObject + - description: Only return personalization designs with the given preferences. + explode: true + in: query + name: preferences + required: false + schema: + properties: + is_default: + type: boolean + is_platform_default: + type: boolean + title: preferences_list_param + type: object + style: deepObject + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Only return personalization designs with the given status. + in: query + name: status + required: false + schema: + enum: + - active + - inactive + - rejected + - review + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/issuing.personalization_design' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/issuing/personalization_designs + type: string + required: + - data + - has_more + - object + - url + title: IssuingPersonalizationDesignList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description:

Creates a personalization design object.

+ operationId: PostIssuingPersonalizationDesigns + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + carrier_text: + explode: true + style: deepObject + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + preferences: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + card_logo: + description: >- + The file for the card logo, for use with physical bundles + that support card logos. Must have a `purpose` value of + `issuing_logo`. + type: string + carrier_text: + description: >- + Hash containing carrier text, for use with physical bundles + that support carrier text. + properties: + footer_body: + anyOf: + - maxLength: 200 + type: string + - enum: + - '' + type: string + footer_title: + anyOf: + - maxLength: 30 + type: string + - enum: + - '' + type: string + header_body: anyOf: - - properties: - additional_documentation: - anyOf: - - type: string - - enum: - - '' - type: string - explanation: - anyOf: - - maxLength: 1500 - type: string - - enum: - - '' - type: string - product_description: - anyOf: - - maxLength: 1500 - type: string - - enum: - - '' - type: string - product_type: - enum: - - '' - - merchandise - - service - type: string - title: other - type: object + - maxLength: 200 + type: string - enum: - '' type: string - reason: - enum: - - canceled - - duplicate - - fraudulent - - merchandise_not_as_described - - not_received - - other - - service_not_as_described - type: string - x-stripeBypassValidation: true - service_not_as_described: + header_title: anyOf: - - properties: - additional_documentation: - anyOf: - - type: string - - enum: - - '' - type: string - canceled_at: - anyOf: - - format: unix-time - type: integer - - enum: - - '' - type: string - cancellation_reason: - anyOf: - - maxLength: 1500 - type: string - - enum: - - '' - type: string - explanation: - anyOf: - - maxLength: 1500 - type: string - - enum: - - '' - type: string - received_at: - anyOf: - - format: unix-time - type: integer - - enum: - - '' - type: string - title: service_not_as_described - type: object + - maxLength: 30 + type: string - enum: - '' type: string - title: evidence_param + title: carrier_text_param type: object expand: description: Specifies which fields in the response should be expanded. @@ -76088,14 +86690,16 @@ paths: maxLength: 5000 type: string type: array + lookup_key: + description: >- + A lookup key used to retrieve personalization designs + dynamically from a static string. This may be up to 200 + characters. + maxLength: 200 + type: string metadata: - anyOf: - - additionalProperties: - type: string - type: object - - enum: - - '' - type: string + additionalProperties: + type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can @@ -76104,6 +86708,81 @@ paths: format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + type: object + name: + description: Friendly display name. + maxLength: 200 + type: string + physical_bundle: + description: >- + The physical bundle object belonging to this personalization + design. + maxLength: 5000 + type: string + preferences: + description: >- + Information on whether this personalization design is used + to create cards when one is not specified. + properties: + is_default: + type: boolean + required: + - is_default + title: preferences_param + type: object + transfer_lookup_key: + description: >- + If set to true, will atomically remove the lookup key from + the existing personalization design, and assign it to this + personalization design. + type: boolean + required: + - physical_bundle + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.personalization_design' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/issuing/personalization_designs/{personalization_design}': + get: + description:

Retrieves a personalization design object.

+ operationId: GetIssuingPersonalizationDesignsPersonalizationDesign + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: personalization_design + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} type: object required: false responses: @@ -76111,7 +86790,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/issuing.dispute' + $ref: '#/components/schemas/issuing.personalization_design' description: Successful response. default: content: @@ -76119,18 +86798,12 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/issuing/disputes/{dispute}/submit': post: - description: >- -

Submits an Issuing Dispute to the card network. Stripe - validates that all evidence fields required for the dispute’s reason are - present. For more details, see Dispute - reasons and evidence.

- operationId: PostIssuingDisputesDisputeSubmit + description:

Updates a card personalization object.

+ operationId: PostIssuingPersonalizationDesignsPersonalizationDesign parameters: - in: path - name: dispute + name: personalization_design required: true schema: maxLength: 5000 @@ -76140,29 +86813,99 @@ paths: content: application/x-www-form-urlencoded: encoding: + card_logo: + explode: true + style: deepObject + carrier_text: + explode: true + style: deepObject expand: explode: true style: deepObject + lookup_key: + explode: true + style: deepObject metadata: explode: true style: deepObject + name: + explode: true + style: deepObject + preferences: + explode: true + style: deepObject schema: additionalProperties: false properties: + card_logo: + anyOf: + - type: string + - enum: + - '' + type: string + description: >- + The file for the card logo, for use with physical bundles + that support card logos. Must have a `purpose` value of + `issuing_logo`. + carrier_text: + anyOf: + - properties: + footer_body: + anyOf: + - maxLength: 200 + type: string + - enum: + - '' + type: string + footer_title: + anyOf: + - maxLength: 30 + type: string + - enum: + - '' + type: string + header_body: + anyOf: + - maxLength: 200 + type: string + - enum: + - '' + type: string + header_title: + anyOf: + - maxLength: 30 + type: string + - enum: + - '' + type: string + title: carrier_text_param + type: object + - enum: + - '' + type: string + description: >- + Hash containing carrier text, for use with physical bundles + that support carrier text. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array - metadata: + lookup_key: anyOf: - - additionalProperties: - type: string - type: object + - maxLength: 200 + type: string - enum: - '' type: string + description: >- + A lookup key used to retrieve personalization designs + dynamically from a static string. This may be up to 200 + characters. + metadata: + additionalProperties: + type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can @@ -76171,6 +86914,40 @@ paths: format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + type: object + name: + anyOf: + - maxLength: 200 + type: string + - enum: + - '' + type: string + description: >- + Friendly display name. Providing an empty string will set + the field to null. + physical_bundle: + description: >- + The physical bundle object belonging to this personalization + design. + maxLength: 5000 + type: string + preferences: + description: >- + Information on whether this personalization design is used + to create cards when one is not specified. + properties: + is_default: + type: boolean + required: + - is_default + title: preferences_param + type: object + transfer_lookup_key: + description: >- + If set to true, will atomically remove the lookup key from + the existing personalization design, and assign it to this + personalization design. + type: boolean type: object required: false responses: @@ -76178,7 +86955,180 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/issuing.dispute' + $ref: '#/components/schemas/issuing.personalization_design' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/issuing/physical_bundles: + get: + description: >- +

Returns a list of physical bundle objects. The objects are sorted in + descending order by creation date, with the most recently created object + appearing first.

+ operationId: GetIssuingPhysicalBundles + parameters: + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Only return physical bundles with the given status. + in: query + name: status + required: false + schema: + enum: + - active + - inactive + - review + type: string + style: form + - description: Only return physical bundles with the given type. + in: query + name: type + required: false + schema: + enum: + - custom + - standard + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/issuing.physical_bundle' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + pattern: ^/v1/issuing/physical_bundles + type: string + required: + - data + - has_more + - object + - url + title: IssuingPhysicalBundleList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/issuing/physical_bundles/{physical_bundle}': + get: + description:

Retrieves a physical bundle object.

+ operationId: GetIssuingPhysicalBundlesPhysicalBundle + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: physical_bundle + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.physical_bundle' description: Successful response. default: content: @@ -76434,7 +87384,7 @@ paths: type: string style: form - description: >- - Select Issuing tokens that were created during the given date + Only return Issuing tokens that were created during the given date interval. explode: true in: query @@ -77020,6 +87970,7 @@ paths: enum: - balances - ownership + - transactions type: string x-stripeBypassValidation: true type: array @@ -77482,6 +88433,7 @@ paths: enum: - balance - ownership + - transactions type: string x-stripeBypassValidation: true type: array @@ -77801,17 +88753,33 @@ paths: description: >- Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) - this PaymentIntent immediately. This parameter defaults to - `false`. When creating and confirming a PaymentIntent at the - same time, you can also provide the parameters available in - the [Confirm + immediately. This parameter defaults to `false`. When + creating and confirming a PaymentIntent at the same time, + you can also provide the parameters available in the + [Confirm API](https://stripe.com/docs/api/payment_intents/confirm). type: boolean confirmation_method: + description: >- + Describes whether we can confirm this PaymentIntent + automatically, or if it requires customer action to confirm + the payment. enum: - automatic - manual type: string + confirmation_token: + description: >- + ID of the ConfirmationToken used to confirm this + PaymentIntent. + + + 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. + maxLength: 5000 + type: string currency: description: >- Three-letter [ISO currency @@ -78004,6 +88972,16 @@ paths: properties: {} title: param type: object + allow_redisplay: + enum: + - always + - limited + - unspecified + type: string + amazon_pay: + properties: {} + title: param + type: object au_becs_debit: properties: account_number: @@ -78191,6 +89169,7 @@ paths: - knab - moneyou - n26 + - nn - rabobank - regiobank - revolut @@ -78236,6 +89215,10 @@ paths: additionalProperties: type: string type: object + mobilepay: + properties: {} + title: param + type: object oxxo: properties: {} title: param @@ -78268,6 +89251,7 @@ paths: - santander_przelew24 - tmobile_usbugi_bankowe - toyota_bank + - velobank - volkswagen_bank type: string x-stripeBypassValidation: true @@ -78294,7 +89278,7 @@ paths: session: maxLength: 5000 type: string - title: radar_options + title: radar_options_with_hidden_options type: object revolut_pay: properties: {} @@ -78324,12 +89308,17 @@ paths: - country title: param type: object + swish: + properties: {} + title: param + type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -78345,6 +89334,7 @@ paths: - klarna - konbini - link + - mobilepay - oxxo - p24 - paynow @@ -78354,6 +89344,7 @@ paths: - revolut_pay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay - zip @@ -78501,6 +89492,25 @@ paths: - enum: - '' type: string + amazon_pay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string au_becs_debit: anyOf: - properties: @@ -78558,6 +89568,12 @@ paths: code: maxLength: 5000 type: string + setup_future_usage: + enum: + - '' + - none + type: string + x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: @@ -78704,9 +89720,11 @@ paths: enum: - any - automatic - maxLength: 5000 + - challenge type: string x-stripeBypassValidation: true + require_cvc_recollection: + type: boolean setup_future_usage: enum: - '' @@ -78728,6 +89746,78 @@ paths: - enum: - '' type: string + three_d_secure: + properties: + ares_trans_status: + enum: + - A + - C + - I + - 'N' + - R + - U + - 'Y' + type: string + cryptogram: + maxLength: 5000 + type: string + electronic_commerce_indicator: + enum: + - '01' + - '02' + - '05' + - '06' + - '07' + type: string + x-stripeBypassValidation: true + exemption_indicator: + enum: + - low_risk + - none + type: string + network_options: + properties: + cartes_bancaires: + properties: + cb_avalgo: + enum: + - '0' + - '1' + - '2' + - '3' + - '4' + - A + type: string + cb_exemption: + maxLength: 4 + type: string + cb_score: + type: integer + required: + - cb_avalgo + title: cartes_bancaires_network_options_param + type: object + title: network_options_param + type: object + requestor_challenge_indicator: + maxLength: 2 + type: string + transaction_id: + maxLength: 5000 + type: string + version: + enum: + - 1.0.2 + - 2.1.0 + - 2.2.0 + type: string + x-stripeBypassValidation: true + required: + - cryptogram + - transaction_id + - version + title: payment_method_options_param + type: object title: payment_intent_param type: object - enum: @@ -78948,6 +90038,7 @@ paths: enum: - none type: string + x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: @@ -79011,6 +90102,23 @@ paths: - enum: - '' type: string + mobilepay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + setup_future_usage: + enum: + - none + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string oxxo: anyOf: - properties: @@ -79133,6 +90241,11 @@ paths: revolut_pay: anyOf: - properties: + capture_method: + enum: + - '' + - manual + type: string setup_future_usage: enum: - '' @@ -79188,6 +90301,25 @@ paths: - enum: - '' type: string + swish: + anyOf: + - properties: + reference: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + setup_future_usage: + enum: + - none + type: string + title: payment_intent_payment_method_options_param + type: object + - enum: + - '' + type: string us_bank_account: anyOf: - properties: @@ -79208,6 +90340,8 @@ paths: items: enum: - balances + - ownership + - transactions type: string x-stripeBypassValidation: true type: array @@ -79216,6 +90350,16 @@ paths: type: string title: linked_account_options_param type: object + mandate_options: + properties: + collection_method: + enum: + - '' + - paper + type: string + x-stripeBypassValidation: true + title: mandate_options_param + type: object networks: properties: requested: @@ -79396,8 +90540,10 @@ paths: type: object statement_descriptor: description: >- - For non-card charges, you can use this value as the complete - description that appears on your customers’ statements. It + For card charges, use + [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). + Otherwise, you can use this value as the complete + description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long. maxLength: 22 @@ -79842,6 +90988,16 @@ paths: properties: {} title: param type: object + allow_redisplay: + enum: + - always + - limited + - unspecified + type: string + amazon_pay: + properties: {} + title: param + type: object au_becs_debit: properties: account_number: @@ -80029,6 +91185,7 @@ paths: - knab - moneyou - n26 + - nn - rabobank - regiobank - revolut @@ -80074,6 +91231,10 @@ paths: additionalProperties: type: string type: object + mobilepay: + properties: {} + title: param + type: object oxxo: properties: {} title: param @@ -80106,6 +91267,7 @@ paths: - santander_przelew24 - tmobile_usbugi_bankowe - toyota_bank + - velobank - volkswagen_bank type: string x-stripeBypassValidation: true @@ -80132,7 +91294,7 @@ paths: session: maxLength: 5000 type: string - title: radar_options + title: radar_options_with_hidden_options type: object revolut_pay: properties: {} @@ -80162,12 +91324,17 @@ paths: - country title: param type: object + swish: + properties: {} + title: param + type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -80183,6 +91350,7 @@ paths: - klarna - konbini - link + - mobilepay - oxxo - p24 - paynow @@ -80192,6 +91360,7 @@ paths: - revolut_pay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay - zip @@ -80339,6 +91508,25 @@ paths: - enum: - '' type: string + amazon_pay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string au_becs_debit: anyOf: - properties: @@ -80396,6 +91584,12 @@ paths: code: maxLength: 5000 type: string + setup_future_usage: + enum: + - '' + - none + type: string + x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: @@ -80542,9 +91736,11 @@ paths: enum: - any - automatic - maxLength: 5000 + - challenge type: string x-stripeBypassValidation: true + require_cvc_recollection: + type: boolean setup_future_usage: enum: - '' @@ -80566,6 +91762,78 @@ paths: - enum: - '' type: string + three_d_secure: + properties: + ares_trans_status: + enum: + - A + - C + - I + - 'N' + - R + - U + - 'Y' + type: string + cryptogram: + maxLength: 5000 + type: string + electronic_commerce_indicator: + enum: + - '01' + - '02' + - '05' + - '06' + - '07' + type: string + x-stripeBypassValidation: true + exemption_indicator: + enum: + - low_risk + - none + type: string + network_options: + properties: + cartes_bancaires: + properties: + cb_avalgo: + enum: + - '0' + - '1' + - '2' + - '3' + - '4' + - A + type: string + cb_exemption: + maxLength: 4 + type: string + cb_score: + type: integer + required: + - cb_avalgo + title: cartes_bancaires_network_options_param + type: object + title: network_options_param + type: object + requestor_challenge_indicator: + maxLength: 2 + type: string + transaction_id: + maxLength: 5000 + type: string + version: + enum: + - 1.0.2 + - 2.1.0 + - 2.2.0 + type: string + x-stripeBypassValidation: true + required: + - cryptogram + - transaction_id + - version + title: payment_method_options_param + type: object title: payment_intent_param type: object - enum: @@ -80786,6 +92054,7 @@ paths: enum: - none type: string + x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: @@ -80849,6 +92118,23 @@ paths: - enum: - '' type: string + mobilepay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + setup_future_usage: + enum: + - none + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string oxxo: anyOf: - properties: @@ -80971,6 +92257,11 @@ paths: revolut_pay: anyOf: - properties: + capture_method: + enum: + - '' + - manual + type: string setup_future_usage: enum: - '' @@ -81026,6 +92317,25 @@ paths: - enum: - '' type: string + swish: + anyOf: + - properties: + reference: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + setup_future_usage: + enum: + - none + type: string + title: payment_intent_payment_method_options_param + type: object + - enum: + - '' + type: string us_bank_account: anyOf: - properties: @@ -81046,6 +92356,8 @@ paths: items: enum: - balances + - ownership + - transactions type: string x-stripeBypassValidation: true type: array @@ -81054,6 +92366,16 @@ paths: type: string title: linked_account_options_param type: object + mandate_options: + properties: + collection_method: + enum: + - '' + - paper + type: string + x-stripeBypassValidation: true + title: mandate_options_param + type: object networks: properties: requested: @@ -81229,9 +92551,12 @@ paths: description: Shipping information for this PaymentIntent. statement_descriptor: description: >- - For non-card charges, you can use this value as the complete - description that appears on your customers’ statements. Must - contain at least one letter, maximum 22 characters. + For card charges, use + [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). + Otherwise, you can use this value as the complete + description of a charge on your customers' statements. It + must contain at least one letter and be 1–22 characters + long. maxLength: 22 type: string statement_descriptor_suffix: @@ -81509,9 +92834,12 @@ paths: value to `metadata`. statement_descriptor: description: >- - For non-card charges, you can use this value as the complete - description that appears on your customers’ statements. Must - contain at least one letter, maximum 22 characters. + For card charges, use + [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). + Otherwise, you can use this value as the complete + description of a charge on your customers' statements. It + must contain at least one letter and be 1–22 characters + long. maxLength: 22 type: string statement_descriptor_suffix: @@ -81607,11 +92935,7 @@ paths: explicitly re-confirm the PaymentIntent to initiate the next payment - attempt. Read the expanded - documentation - - to learn more about manual confirmation.

+ attempt.

operationId: PostPaymentIntentsIntentConfirm parameters: - in: path @@ -81668,6 +92992,18 @@ paths: description: The client secret of the PaymentIntent. maxLength: 5000 type: string + confirmation_token: + description: >- + ID of the ConfirmationToken used to confirm this + PaymentIntent. + + + 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. + maxLength: 5000 + type: string error_on_requires_action: description: >- Set to `true` to fail the payment attempt if the @@ -81815,6 +93151,16 @@ paths: properties: {} title: param type: object + allow_redisplay: + enum: + - always + - limited + - unspecified + type: string + amazon_pay: + properties: {} + title: param + type: object au_becs_debit: properties: account_number: @@ -82002,6 +93348,7 @@ paths: - knab - moneyou - n26 + - nn - rabobank - regiobank - revolut @@ -82047,6 +93394,10 @@ paths: additionalProperties: type: string type: object + mobilepay: + properties: {} + title: param + type: object oxxo: properties: {} title: param @@ -82079,6 +93430,7 @@ paths: - santander_przelew24 - tmobile_usbugi_bankowe - toyota_bank + - velobank - volkswagen_bank type: string x-stripeBypassValidation: true @@ -82105,7 +93457,7 @@ paths: session: maxLength: 5000 type: string - title: radar_options + title: radar_options_with_hidden_options type: object revolut_pay: properties: {} @@ -82135,12 +93487,17 @@ paths: - country title: param type: object + swish: + properties: {} + title: param + type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -82156,6 +93513,7 @@ paths: - klarna - konbini - link + - mobilepay - oxxo - p24 - paynow @@ -82165,6 +93523,7 @@ paths: - revolut_pay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay - zip @@ -82312,6 +93671,25 @@ paths: - enum: - '' type: string + amazon_pay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + setup_future_usage: + enum: + - '' + - none + - off_session + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string au_becs_debit: anyOf: - properties: @@ -82369,6 +93747,12 @@ paths: code: maxLength: 5000 type: string + setup_future_usage: + enum: + - '' + - none + type: string + x-stripeBypassValidation: true title: payment_intent_payment_method_options_param type: object - enum: @@ -82515,9 +93899,11 @@ paths: enum: - any - automatic - maxLength: 5000 + - challenge type: string x-stripeBypassValidation: true + require_cvc_recollection: + type: boolean setup_future_usage: enum: - '' @@ -82539,6 +93925,78 @@ paths: - enum: - '' type: string + three_d_secure: + properties: + ares_trans_status: + enum: + - A + - C + - I + - 'N' + - R + - U + - 'Y' + type: string + cryptogram: + maxLength: 5000 + type: string + electronic_commerce_indicator: + enum: + - '01' + - '02' + - '05' + - '06' + - '07' + type: string + x-stripeBypassValidation: true + exemption_indicator: + enum: + - low_risk + - none + type: string + network_options: + properties: + cartes_bancaires: + properties: + cb_avalgo: + enum: + - '0' + - '1' + - '2' + - '3' + - '4' + - A + type: string + cb_exemption: + maxLength: 4 + type: string + cb_score: + type: integer + required: + - cb_avalgo + title: cartes_bancaires_network_options_param + type: object + title: network_options_param + type: object + requestor_challenge_indicator: + maxLength: 2 + type: string + transaction_id: + maxLength: 5000 + type: string + version: + enum: + - 1.0.2 + - 2.1.0 + - 2.2.0 + type: string + x-stripeBypassValidation: true + required: + - cryptogram + - transaction_id + - version + title: payment_method_options_param + type: object title: payment_intent_param type: object - enum: @@ -82759,6 +94217,7 @@ paths: enum: - none type: string + x-stripeBypassValidation: true title: payment_method_options_param type: object - enum: @@ -82822,6 +94281,23 @@ paths: - enum: - '' type: string + mobilepay: + anyOf: + - properties: + capture_method: + enum: + - '' + - manual + type: string + setup_future_usage: + enum: + - none + type: string + title: payment_method_options_param + type: object + - enum: + - '' + type: string oxxo: anyOf: - properties: @@ -82944,6 +94420,11 @@ paths: revolut_pay: anyOf: - properties: + capture_method: + enum: + - '' + - manual + type: string setup_future_usage: enum: - '' @@ -82999,6 +94480,25 @@ paths: - enum: - '' type: string + swish: + anyOf: + - properties: + reference: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + setup_future_usage: + enum: + - none + type: string + title: payment_intent_payment_method_options_param + type: object + - enum: + - '' + type: string us_bank_account: anyOf: - properties: @@ -83019,6 +94519,8 @@ paths: items: enum: - balances + - ownership + - transactions type: string x-stripeBypassValidation: true type: array @@ -83027,6 +94529,16 @@ paths: type: string title: linked_account_options_param type: object + mandate_options: + properties: + collection_method: + enum: + - '' + - paper + type: string + x-stripeBypassValidation: true + title: mandate_options_param + type: object networks: properties: requested: @@ -83365,9 +94877,12 @@ paths: type: object statement_descriptor: description: >- - For non-card charges, you can use this value as the complete - description that appears on your customers’ statements. Must - contain at least one letter, maximum 22 characters. + For card charges, use + [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). + Otherwise, you can use this value as the complete + description of a charge on your customers' statements. It + must contain at least one letter and be 1–22 characters + long. maxLength: 22 type: string transfer_data: @@ -83618,6 +95133,9 @@ paths: phone_number_collection: explode: true style: deepObject + restrictions: + explode: true + style: deepObject shipping_address_collection: explode: true style: deepObject @@ -83687,12 +95205,27 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_params type: object billing_address_collection: - description: Configuration for collecting the customer's billing address. + description: >- + Configuration for collecting the customer's billing address. + Defaults to `auto`. enum: - auto - required @@ -83700,6 +95233,17 @@ paths: consent_collection: description: Configure fields to gather active consent from customers. properties: + payment_method_reuse_agreement: + properties: + position: + enum: + - auto + - hidden + type: string + required: + - position + title: payment_method_reuse_agreement_params + type: object promotions: enum: - auto @@ -83723,7 +95267,7 @@ paths: custom_fields: description: >- Collect additional information from your customer using - custom fields. Up to 2 fields are supported. + custom fields. Up to 3 fields are supported. items: properties: dropdown: @@ -83800,6 +95344,19 @@ paths: Display additional text for your customers using custom text. properties: + after_submit: + anyOf: + - properties: + message: + maxLength: 1200 + type: string + required: + - message + title: custom_text_position_param + type: object + - enum: + - '' + type: string shipping_address: anyOf: - properties: @@ -83857,6 +95414,12 @@ paths: maxLength: 5000 type: string type: array + inactive_message: + description: >- + The custom message to be displayed to a customer when a + payment link is no longer active. + maxLength: 500 + type: string invoice_creation: description: Generate a post-purchase Invoice for one-time payments. properties: @@ -83878,10 +95441,10 @@ paths: - items: properties: name: - maxLength: 30 + maxLength: 40 type: string value: - maxLength: 30 + maxLength: 140 type: string required: - name @@ -83898,6 +95461,19 @@ paths: footer: maxLength: 5000 type: string + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object metadata: anyOf: - additionalProperties: @@ -84003,6 +95579,9 @@ paths: statement_descriptor_suffix: maxLength: 22 type: string + transfer_group: + maxLength: 5000 + type: string title: payment_intent_data_params type: object payment_method_collection: @@ -84014,7 +95593,8 @@ paths: discount. - Can only be set in `subscription` mode. + Can only be set in `subscription` mode. Defaults to + `always`. If you'd like information on how to collect a payment method @@ -84061,6 +95641,7 @@ paths: - promptpay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay type: string @@ -84080,6 +95661,21 @@ paths: - enabled title: phone_number_collection_params type: object + restrictions: + description: Settings that restrict the usage of a payment link. + properties: + completed_sessions: + properties: + limit: + type: integer + required: + - limit + title: completed_sessions_params + type: object + required: + - completed_sessions + title: restrictions_params + type: object shipping_address_collection: description: >- Configuration for collecting the customer's shipping @@ -84367,12 +95963,47 @@ paths: description: maxLength: 500 type: string + invoice_settings: + properties: + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + title: subscription_data_invoice_settings_params + type: object metadata: additionalProperties: type: string type: object trial_period_days: type: integer + trial_settings: + properties: + end_behavior: + properties: + missing_payment_method: + enum: + - cancel + - create_invoice + - pause + type: string + required: + - missing_payment_method + title: end_behavior + type: object + required: + - end_behavior + title: trial_settings_config + type: object title: subscription_data_params type: object tax_id_collection: @@ -84490,6 +96121,9 @@ paths: expand: explode: true style: deepObject + inactive_message: + explode: true + style: deepObject invoice_creation: explode: true style: deepObject @@ -84505,6 +96139,9 @@ paths: payment_method_types: explode: true style: deepObject + restrictions: + explode: true + style: deepObject shipping_address_collection: explode: true style: deepObject @@ -84556,12 +96193,27 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_params type: object billing_address_collection: - description: Configuration for collecting the customer's billing address. + description: >- + Configuration for collecting the customer's billing address. + Defaults to `auto`. enum: - auto - required @@ -84644,12 +96296,25 @@ paths: type: string description: >- Collect additional information from your customer using - custom fields. Up to 2 fields are supported. + custom fields. Up to 3 fields are supported. custom_text: description: >- Display additional text for your customers using custom text. properties: + after_submit: + anyOf: + - properties: + message: + maxLength: 1200 + type: string + required: + - message + title: custom_text_position_param + type: object + - enum: + - '' + type: string shipping_address: anyOf: - properties: @@ -84707,6 +96372,16 @@ paths: maxLength: 5000 type: string type: array + inactive_message: + anyOf: + - maxLength: 500 + type: string + - enum: + - '' + type: string + description: >- + The custom message to be displayed to a customer when a + payment link is no longer active. invoice_creation: description: Generate a post-purchase Invoice for one-time payments. properties: @@ -84728,10 +96403,10 @@ paths: - items: properties: name: - maxLength: 30 + maxLength: 40 type: string value: - maxLength: 30 + maxLength: 140 type: string required: - name @@ -84748,6 +96423,19 @@ paths: footer: maxLength: 5000 type: string + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object metadata: anyOf: - additionalProperties: @@ -84854,6 +96542,13 @@ paths: - enum: - '' type: string + transfer_group: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string title: payment_intent_data_update_params type: object payment_method_collection: @@ -84865,7 +96560,8 @@ paths: discount. - Can only be set in `subscription` mode. + Can only be set in `subscription` mode. Defaults to + `always`. If you'd like information on how to collect a payment method @@ -84906,6 +96602,7 @@ paths: - promptpay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay type: string @@ -84919,6 +96616,25 @@ paths: Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods). + restrictions: + anyOf: + - properties: + completed_sessions: + properties: + limit: + type: integer + required: + - limit + title: completed_sessions_params + type: object + required: + - completed_sessions + title: restrictions_params + type: object + - enum: + - '' + type: string + description: Settings that restrict the usage of a payment link. shipping_address_collection: anyOf: - properties: @@ -85180,6 +96896,23 @@ paths: data will be used. There must be at least one line item with a recurring price to use `subscription_data`. properties: + invoice_settings: + properties: + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + title: subscription_data_invoice_settings_params + type: object metadata: anyOf: - additionalProperties: @@ -85188,6 +96921,28 @@ paths: - enum: - '' type: string + trial_settings: + anyOf: + - properties: + end_behavior: + properties: + missing_payment_method: + enum: + - cancel + - create_invoice + - pause + type: string + required: + - missing_payment_method + title: end_behavior + type: object + required: + - end_behavior + title: trial_settings_config + type: object + - enum: + - '' + type: string title: subscription_data_update_params type: object type: object @@ -85338,6 +97093,19 @@ paths: - '' type: string style: deepObject + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form - description: Specifies which fields in the response should be expanded. explode: true in: query @@ -85349,6 +97117,28 @@ paths: type: string type: array style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form requestBody: content: application/x-www-form-urlencoded: @@ -85384,6 +97174,7 @@ paths: url: description: The URL where this list can be accessed. maxLength: 5000 + pattern: ^/v1/payment_method_configurations type: string required: - data @@ -85420,6 +97211,9 @@ paths: alipay: explode: true style: deepObject + amazon_pay: + explode: true + style: deepObject apple_pay: explode: true style: deepObject @@ -85450,6 +97244,9 @@ paths: cashapp: explode: true style: deepObject + customer_balance: + explode: true + style: deepObject eps: explode: true style: deepObject @@ -85483,6 +97280,9 @@ paths: link: explode: true style: deepObject + mobilepay: + explode: true + style: deepObject oxxo: explode: true style: deepObject @@ -85498,18 +97298,27 @@ paths: promptpay: explode: true style: deepObject + revolut_pay: + explode: true + style: deepObject sepa_debit: explode: true style: deepObject sofort: explode: true style: deepObject + swish: + explode: true + style: deepObject us_bank_account: explode: true style: deepObject wechat_pay: explode: true style: deepObject + zip: + explode: true + style: deepObject schema: additionalProperties: false properties: @@ -85597,6 +97406,23 @@ paths: type: object title: payment_method_param type: object + amazon_pay: + description: >- + Amazon Pay is a wallet payment method that lets your + customers check out the same way as on Amazon. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object apple_pay: description: >- Stripe users can accept [Apple Pay](/payments/apple-pay) in @@ -85801,6 +97627,27 @@ paths: type: object title: payment_method_param type: object + customer_balance: + description: >- + Uses a customer’s [cash + balance](https://stripe.com/docs/payments/customer-balance) + for the payment. The cash balance can be funded via a bank + transfer. Check this + [page](https://stripe.com/docs/payments/bank-transfers) for + more details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object eps: description: >- EPS is an Austria-based payment method that allows customers @@ -86027,6 +97874,29 @@ paths: type: object title: payment_method_param type: object + mobilepay: + description: >- + MobilePay is a + [single-use](https://stripe.com/docs/payments/payment-methods#usage) + card wallet payment method used in Denmark and Finland. It + allows customers to [authenticate and + approve](https://stripe.com/docs/payments/payment-methods#customer-actions) + payments using the MobilePay app. Check this + [page](https://stripe.com/docs/payments/mobilepay) for more + details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object name: description: Configuration name. maxLength: 100 @@ -86141,6 +98011,26 @@ paths: type: object title: payment_method_param type: object + revolut_pay: + description: >- + Revolut Pay, developed by Revolut, a global finance app, is + a digital wallet payment method. Revolut Pay uses the + customer’s stored balance or cards to fund the payment, and + offers the option for non-Revolut customers to save their + details after their first purchase. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object sepa_debit: description: >- The [Single Euro Payments Area @@ -86188,6 +98078,30 @@ paths: type: object title: payment_method_param type: object + swish: + description: >- + Swish is a + [real-time](https://stripe.com/docs/payments/real-time) + payment method popular in Sweden. It allows customers to + [authenticate and + approve](https://stripe.com/docs/payments/payment-methods#customer-actions) + payments using the Swish mobile app and the Swedish BankID + mobile app. Check this + [page](https://stripe.com/docs/payments/swish) for more + details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object us_bank_account: description: >- Stripe users in the United States can accept ACH direct @@ -86232,6 +98146,25 @@ paths: type: object title: payment_method_param type: object + zip: + description: >- + Zip gives your customers a way to split purchases over a + series of payments. Check this + [page](https://stripe.com/docs/payments/zip) for more + details like country availability. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object type: object required: false responses: @@ -86319,6 +98252,9 @@ paths: alipay: explode: true style: deepObject + amazon_pay: + explode: true + style: deepObject apple_pay: explode: true style: deepObject @@ -86349,6 +98285,9 @@ paths: cashapp: explode: true style: deepObject + customer_balance: + explode: true + style: deepObject eps: explode: true style: deepObject @@ -86382,6 +98321,9 @@ paths: link: explode: true style: deepObject + mobilepay: + explode: true + style: deepObject oxxo: explode: true style: deepObject @@ -86397,18 +98339,27 @@ paths: promptpay: explode: true style: deepObject + revolut_pay: + explode: true + style: deepObject sepa_debit: explode: true style: deepObject sofort: explode: true style: deepObject + swish: + explode: true + style: deepObject us_bank_account: explode: true style: deepObject wechat_pay: explode: true style: deepObject + zip: + explode: true + style: deepObject schema: additionalProperties: false properties: @@ -86499,6 +98450,23 @@ paths: type: object title: payment_method_param type: object + amazon_pay: + description: >- + Amazon Pay is a wallet payment method that lets your + customers check out the same way as on Amazon. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object apple_pay: description: >- Stripe users can accept [Apple Pay](/payments/apple-pay) in @@ -86703,6 +98671,27 @@ paths: type: object title: payment_method_param type: object + customer_balance: + description: >- + Uses a customer’s [cash + balance](https://stripe.com/docs/payments/customer-balance) + for the payment. The cash balance can be funded via a bank + transfer. Check this + [page](https://stripe.com/docs/payments/bank-transfers) for + more details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object eps: description: >- EPS is an Austria-based payment method that allows customers @@ -86929,6 +98918,29 @@ paths: type: object title: payment_method_param type: object + mobilepay: + description: >- + MobilePay is a + [single-use](https://stripe.com/docs/payments/payment-methods#usage) + card wallet payment method used in Denmark and Finland. It + allows customers to [authenticate and + approve](https://stripe.com/docs/payments/payment-methods#customer-actions) + payments using the MobilePay app. Check this + [page](https://stripe.com/docs/payments/mobilepay) for more + details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object name: description: Configuration name. maxLength: 100 @@ -87037,6 +99049,26 @@ paths: type: object title: payment_method_param type: object + revolut_pay: + description: >- + Revolut Pay, developed by Revolut, a global finance app, is + a digital wallet payment method. Revolut Pay uses the + customer’s stored balance or cards to fund the payment, and + offers the option for non-Revolut customers to save their + details after their first purchase. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object sepa_debit: description: >- The [Single Euro Payments Area @@ -87084,6 +99116,30 @@ paths: type: object title: payment_method_param type: object + swish: + description: >- + Swish is a + [real-time](https://stripe.com/docs/payments/real-time) + payment method popular in Sweden. It allows customers to + [authenticate and + approve](https://stripe.com/docs/payments/payment-methods#customer-actions) + payments using the Swish mobile app and the Swedish BankID + mobile app. Check this + [page](https://stripe.com/docs/payments/swish) for more + details. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object us_bank_account: description: >- Stripe users in the United States can accept ACH direct @@ -87128,6 +99184,25 @@ paths: type: object title: payment_method_param type: object + zip: + description: >- + Zip gives your customers a way to split purchases over a + series of payments. Check this + [page](https://stripe.com/docs/payments/zip) for more + details like country availability. + properties: + display_preference: + properties: + preference: + enum: + - none + - 'off' + - 'on' + type: string + title: display_preference_param + type: object + title: payment_method_param + type: object type: object required: false responses: @@ -87540,6 +99615,7 @@ paths: - affirm - afterpay_clearpay - alipay + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -87556,6 +99632,7 @@ paths: - klarna - konbini - link + - mobilepay - oxxo - p24 - paynow @@ -87565,6 +99642,7 @@ paths: - revolut_pay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay - zip @@ -87653,6 +99731,9 @@ paths: alipay: explode: true style: deepObject + amazon_pay: + explode: true + style: deepObject au_becs_debit: explode: true style: deepObject @@ -87713,6 +99794,9 @@ paths: metadata: explode: true style: deepObject + mobilepay: + explode: true + style: deepObject oxxo: explode: true style: deepObject @@ -87743,6 +99827,9 @@ paths: sofort: explode: true style: deepObject + swish: + explode: true + style: deepObject us_bank_account: explode: true style: deepObject @@ -87796,6 +99883,26 @@ paths: properties: {} title: param type: object + 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 + type: string + amazon_pay: + description: >- + If this is a AmazonPay PaymentMethod, this hash contains + details about the AmazonPay payment method. + properties: {} + title: param + type: object au_becs_debit: description: >- If this is an `au_becs_debit` PaymentMethod, this hash @@ -87915,6 +100022,16 @@ paths: type: integer exp_year: type: integer + networks: + properties: + preferred: + enum: + - cartes_bancaires + - mastercard + - visa + type: string + title: networks_params + type: object number: maxLength: 5000 type: string @@ -88073,6 +100190,7 @@ paths: - knab - moneyou - n26 + - nn - rabobank - regiobank - revolut @@ -88138,6 +100256,13 @@ paths: value to them. All keys can be unset by posting an empty value to `metadata`. type: object + mobilepay: + description: >- + If this is a `mobilepay` PaymentMethod, this hash contains + details about the MobilePay payment method. + properties: {} + title: param + type: object oxxo: description: >- If this is an `oxxo` PaymentMethod, this hash contains @@ -88176,6 +100301,7 @@ paths: - santander_przelew24 - tmobile_usbugi_bankowe - toyota_bank + - velobank - volkswagen_bank type: string x-stripeBypassValidation: true @@ -88222,7 +100348,7 @@ paths: session: maxLength: 5000 type: string - title: radar_options + title: radar_options_with_hidden_options type: object revolut_pay: description: >- @@ -88261,6 +100387,13 @@ paths: - country title: param type: object + swish: + description: >- + If this is a `swish` PaymentMethod, this hash contains + details about the Swish payment method. + properties: {} + title: param + type: object type: description: >- The type of the PaymentMethod. An additional hash is @@ -88272,6 +100405,7 @@ paths: - affirm - afterpay_clearpay - alipay + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -88288,6 +100422,7 @@ paths: - klarna - konbini - link + - mobilepay - oxxo - p24 - paynow @@ -88297,6 +100432,7 @@ paths: - revolut_pay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay - zip @@ -88444,6 +100580,19 @@ paths: schema: additionalProperties: false properties: + 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 + type: string billing_details: description: >- Billing information associated with the PaymentMethod that @@ -88507,6 +100656,17 @@ paths: type: integer exp_year: type: integer + networks: + properties: + preferred: + enum: + - '' + - cartes_bancaires + - mastercard + - visa + type: string + title: networks_update_api_param + type: object title: update_api_param type: object expand: @@ -88548,6 +100708,11 @@ paths: - company - individual type: string + account_type: + enum: + - checking + - savings + type: string title: update_param type: object type: object @@ -88699,7 +100864,10 @@ paths: with the most recently created payouts appearing first.

operationId: GetPayouts parameters: - - explode: true + - description: >- + Only return payouts that are expected to arrive during the given + date interval. + explode: true in: query name: arrival_date required: false @@ -88718,7 +100886,10 @@ paths: type: object - type: integer style: deepObject - - explode: true + - description: >- + Only return payouts that were created during the given date + interval. + explode: true in: query name: created required: false @@ -89093,9 +101264,9 @@ paths: '/v1/payouts/{payout}/cancel': post: description: >- -

You can cancel a previously created payout if it hasn’t been paid out - yet. Stripe refunds the funds to your available balance. You can’t - cancel automatic Stripe payouts.

+

You can cancel a previously created payout if its status is + pending. Stripe refunds the funds to your available + balance. You can’t cancel automatic Stripe payouts.

operationId: PostPayoutsPayoutCancel parameters: - in: path @@ -89141,8 +101312,8 @@ paths: description: >-

Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank - accounts. If the payout is in the pending status, use - /v1/payouts/:id/cancel instead.

+ accounts. If the payout is manual and in the pending + status, use /v1/payouts/:id/cancel instead.

By requesting a reversal through @@ -89460,8 +101631,8 @@ paths: description: >- The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every - 3 months. Maximum of one year interval allowed (1 year, 12 - months, or 52 weeks). + 3 months. Maximum of three years interval allowed (3 years, + 36 months, or 156 weeks). type: integer metadata: anyOf: @@ -89479,6 +101650,10 @@ paths: format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + meter: + description: The meter tracking the usage of a metered price + maxLength: 5000 + type: string nickname: description: 'A brief description of the plan, hidden from customers.' maxLength: 5000 @@ -89894,6 +102069,9 @@ paths: - week - year type: string + meter: + maxLength: 5000 + type: string usage_type: enum: - licensed @@ -90203,6 +102381,9 @@ paths: type: string interval_count: type: integer + meter: + maxLength: 5000 + type: string usage_type: enum: - licensed @@ -90293,7 +102474,8 @@ paths: description: >- A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of - `unit_amount` or `custom_unit_amount` is required, unless + `unit_amount`, `unit_amount_decimal`, or + `custom_unit_amount` is required, unless `billing_scheme=tiered`. type: integer unit_amount_decimal: @@ -90830,10 +103012,10 @@ paths: expand: explode: true style: deepObject - features: + images: explode: true style: deepObject - images: + marketing_features: explode: true style: deepObject metadata: @@ -90958,21 +103140,6 @@ paths: maxLength: 5000 type: string type: array - features: - description: >- - A list of up to 15 features for this product. These are - displayed in [pricing - tables](https://stripe.com/docs/payments/checkout/pricing-table). - items: - properties: - name: - maxLength: 5000 - type: string - required: - - name - title: features - type: object - type: array id: description: >- An identifier will be randomly generated by Stripe. You can @@ -90987,6 +103154,21 @@ paths: items: type: string type: array + marketing_features: + description: >- + A list of up to 15 marketing features for this product. + These are displayed in [pricing + tables](https://stripe.com/docs/payments/checkout/pricing-table). + items: + properties: + name: + maxLength: 5000 + type: string + required: + - name + title: features + type: object + type: array metadata: additionalProperties: type: string @@ -91294,10 +103476,10 @@ paths: expand: explode: true style: deepObject - features: + images: explode: true style: deepObject - images: + marketing_features: explode: true style: deepObject metadata: @@ -91345,7 +103527,18 @@ paths: maxLength: 5000 type: string type: array - features: + images: + anyOf: + - items: + type: string + type: array + - enum: + - '' + type: string + description: >- + A list of up to 8 URLs of images for this product, meant to + be displayable to the customer. + marketing_features: anyOf: - items: properties: @@ -91361,20 +103554,9 @@ paths: - '' type: string description: >- - A list of up to 15 features for this product. These are - displayed in [pricing + A list of up to 15 marketing features for this product. + These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table). - images: - anyOf: - - items: - type: string - type: array - - enum: - - '' - type: string - description: >- - A list of up to 8 URLs of images for this product, meant to - be displayable to the customer. metadata: anyOf: - additionalProperties: @@ -91476,6 +103658,265 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + '/v1/products/{product}/features': + get: + description:

Retrieve a list of features for a product

+ operationId: GetProductsProductFeatures + parameters: + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - in: path + name: product + required: true + schema: + maxLength: 5000 + type: string + style: simple + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + items: + $ref: '#/components/schemas/product_feature' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: EntitlementsResourceProductFeatureList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + post: + description: >- +

Creates a product_feature, which represents a feature attachment to a + product

+ operationId: PostProductsProductFeatures + parameters: + - in: path + name: product + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + entitlement_feature: + description: >- + The ID of the + [Feature](https://stripe.com/docs/api/entitlements/feature) + object attached to this product. + maxLength: 5000 + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + required: + - entitlement_feature + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/product_feature' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/products/{product}/features/{id}': + delete: + description:

Deletes the feature attachment to a product

+ operationId: DeleteProductsProductFeaturesId + parameters: + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + - in: path + name: product + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/deleted_product_feature' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + get: + description: >- +

Retrieves a product_feature, which represents a feature attachment to + a product

+ operationId: GetProductsProductFeaturesId + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: The ID of the product_feature. + in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + - description: The ID of the product. + in: path + name: product + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/product_feature' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. /v1/promotion_codes: get: description:

Returns a list of your promotion codes.

@@ -92106,6 +104547,19 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_param @@ -92166,6 +104620,9 @@ paths: discount: maxLength: 5000 type: string + promotion_code: + maxLength: 5000 + type: string title: discounts_data_param type: object type: array @@ -92237,6 +104694,19 @@ paths: properties: days_until_due: type: integer + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object title: quote_param type: object line_items: @@ -92246,6 +104716,25 @@ paths: quantity, and the resulting cost. items: properties: + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string price: maxLength: 5000 type: string @@ -92532,6 +105021,19 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_param @@ -92587,6 +105089,9 @@ paths: discount: maxLength: 5000 type: string + promotion_code: + maxLength: 5000 + type: string title: discounts_data_param type: object type: array @@ -92630,6 +105135,19 @@ paths: properties: days_until_due: type: integer + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object title: quote_param type: object line_items: @@ -92639,6 +105157,25 @@ paths: quantity, and the resulting cost. items: properties: + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string id: maxLength: 5000 type: string @@ -93159,7 +105696,10 @@ paths: description: Error response. '/v1/quotes/{quote}/pdf': get: - description:

Download the PDF for a finalized quote

+ description: >- +

Download the PDF for a finalized quote. Explanation for special + handling can be found here

operationId: GetQuotesQuotePdf parameters: - description: Specifies which fields in the response should be expanded. @@ -93203,6 +105743,8 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + servers: + - url: 'https://files.stripe.com/' /v1/radar/early_fraud_warnings: get: description:

Returns a list of early fraud warnings.

@@ -93217,6 +105759,28 @@ paths: schema: type: string style: form + - description: >- + Only return early fraud warnings that were created during the given + date interval. + explode: true + in: query + name: created + required: false + schema: + anyOf: + - properties: + gt: + type: integer + gte: + type: integer + lt: + type: integer + lte: + type: integer + title: range_query_specs + type: object + - type: integer + style: deepObject - description: >- A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list @@ -93385,7 +105949,8 @@ paths: created object appearing first.

operationId: GetRadarValueListItems parameters: - - explode: true + - description: Only return items that were created during the given date interval. + explode: true in: query name: created required: false @@ -93678,7 +106243,10 @@ paths: maxLength: 800 type: string style: form - - explode: true + - description: >- + Only return value lists that were created during the given date + interval. + explode: true in: query name: created required: false @@ -94043,7 +106611,10 @@ paths: schema: type: string style: form - - explode: true + - description: >- + Only return refunds that were created during the given date + interval. + explode: true in: query name: created required: false @@ -94473,7 +107044,10 @@ paths: first.

operationId: GetReportingReportRuns parameters: - - explode: true + - description: >- + Only return Report Runs that were created during the given date + interval. + explode: true in: query name: created required: false @@ -94649,6 +107223,8 @@ paths: - anticipation_repayment - charge - charge_failure + - climate_order_purchase + - climate_order_refund - connect_collection_transfer - connect_reserved_funds - contribution @@ -94664,7 +107240,6 @@ paths: - issuing_dispute - issuing_transaction - network_cost - - obligation - other_adjustment - partial_capture_reversal - payout @@ -95479,7 +108054,10 @@ paths: appearing first.

operationId: GetReviews parameters: - - explode: true + - description: >- + Only return reviews that were created during the given date + interval. + explode: true in: query name: created required: false @@ -96068,6 +108646,18 @@ paths: is the attached payment method, you can provide a `return_url` in case further authentication is necessary. type: boolean + confirmation_token: + description: >- + ID of the ConfirmationToken used to confirm this + SetupIntent. + + + 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. + maxLength: 5000 + type: string customer: description: >- ID of the Customer this SetupIntent belongs to, if one @@ -96218,6 +108808,16 @@ paths: properties: {} title: param type: object + allow_redisplay: + enum: + - always + - limited + - unspecified + type: string + amazon_pay: + properties: {} + title: param + type: object au_becs_debit: properties: account_number: @@ -96405,6 +109005,7 @@ paths: - knab - moneyou - n26 + - nn - rabobank - regiobank - revolut @@ -96450,6 +109051,10 @@ paths: additionalProperties: type: string type: object + mobilepay: + properties: {} + title: param + type: object oxxo: properties: {} title: param @@ -96482,6 +109087,7 @@ paths: - santander_przelew24 - tmobile_usbugi_bankowe - toyota_bank + - velobank - volkswagen_bank type: string x-stripeBypassValidation: true @@ -96508,7 +109114,7 @@ paths: session: maxLength: 5000 type: string - title: radar_options + title: radar_options_with_hidden_options type: object revolut_pay: properties: {} @@ -96538,12 +109144,17 @@ paths: - country title: param type: object + swish: + properties: {} + title: param + type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -96559,6 +109170,7 @@ paths: - klarna - konbini - link + - mobilepay - oxxo - p24 - paynow @@ -96568,6 +109180,7 @@ paths: - revolut_pay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay - zip @@ -96659,6 +109272,10 @@ paths: x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object + amazon_pay: + properties: {} + title: setup_intent_payment_method_options_param + type: object card: properties: mandate_options: @@ -96729,11 +109346,78 @@ paths: enum: - any - automatic - maxLength: 5000 + - challenge type: string x-stripeBypassValidation: true + three_d_secure: + properties: + ares_trans_status: + enum: + - A + - C + - I + - 'N' + - R + - U + - 'Y' + type: string + cryptogram: + maxLength: 5000 + type: string + electronic_commerce_indicator: + enum: + - '01' + - '02' + - '05' + - '06' + - '07' + type: string + x-stripeBypassValidation: true + network_options: + properties: + cartes_bancaires: + properties: + cb_avalgo: + enum: + - '0' + - '1' + - '2' + - '3' + - '4' + - A + type: string + cb_exemption: + maxLength: 4 + type: string + cb_score: + type: integer + required: + - cb_avalgo + title: cartes_bancaires_network_options_param + type: object + title: network_options_param + type: object + requestor_challenge_indicator: + maxLength: 2 + type: string + transaction_id: + maxLength: 5000 + type: string + version: + enum: + - 1.0.2 + - 2.1.0 + - 2.2.0 + type: string + x-stripeBypassValidation: true + title: setup_intent_payment_method_options_param + type: object title: setup_intent_param type: object + card_present: + properties: {} + title: setup_intent_payment_method_options_param + type: object link: properties: {} title: setup_intent_payment_method_options_param @@ -96772,6 +109456,8 @@ paths: items: enum: - balances + - ownership + - transactions type: string x-stripeBypassValidation: true type: array @@ -96780,6 +109466,16 @@ paths: type: string title: linked_account_options_param type: object + mandate_options: + properties: + collection_method: + enum: + - '' + - paper + type: string + x-stripeBypassValidation: true + title: mandate_options_param + type: object networks: properties: requested: @@ -97085,6 +109781,16 @@ paths: properties: {} title: param type: object + allow_redisplay: + enum: + - always + - limited + - unspecified + type: string + amazon_pay: + properties: {} + title: param + type: object au_becs_debit: properties: account_number: @@ -97272,6 +109978,7 @@ paths: - knab - moneyou - n26 + - nn - rabobank - regiobank - revolut @@ -97317,6 +110024,10 @@ paths: additionalProperties: type: string type: object + mobilepay: + properties: {} + title: param + type: object oxxo: properties: {} title: param @@ -97349,6 +110060,7 @@ paths: - santander_przelew24 - tmobile_usbugi_bankowe - toyota_bank + - velobank - volkswagen_bank type: string x-stripeBypassValidation: true @@ -97375,7 +110087,7 @@ paths: session: maxLength: 5000 type: string - title: radar_options + title: radar_options_with_hidden_options type: object revolut_pay: properties: {} @@ -97405,12 +110117,17 @@ paths: - country title: param type: object + swish: + properties: {} + title: param + type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -97426,6 +110143,7 @@ paths: - klarna - konbini - link + - mobilepay - oxxo - p24 - paynow @@ -97435,6 +110153,7 @@ paths: - revolut_pay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay - zip @@ -97526,6 +110245,10 @@ paths: x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object + amazon_pay: + properties: {} + title: setup_intent_payment_method_options_param + type: object card: properties: mandate_options: @@ -97596,11 +110319,78 @@ paths: enum: - any - automatic - maxLength: 5000 + - challenge type: string x-stripeBypassValidation: true + three_d_secure: + properties: + ares_trans_status: + enum: + - A + - C + - I + - 'N' + - R + - U + - 'Y' + type: string + cryptogram: + maxLength: 5000 + type: string + electronic_commerce_indicator: + enum: + - '01' + - '02' + - '05' + - '06' + - '07' + type: string + x-stripeBypassValidation: true + network_options: + properties: + cartes_bancaires: + properties: + cb_avalgo: + enum: + - '0' + - '1' + - '2' + - '3' + - '4' + - A + type: string + cb_exemption: + maxLength: 4 + type: string + cb_score: + type: integer + required: + - cb_avalgo + title: cartes_bancaires_network_options_param + type: object + title: network_options_param + type: object + requestor_challenge_indicator: + maxLength: 2 + type: string + transaction_id: + maxLength: 5000 + type: string + version: + enum: + - 1.0.2 + - 2.1.0 + - 2.2.0 + type: string + x-stripeBypassValidation: true + title: setup_intent_payment_method_options_param + type: object title: setup_intent_param type: object + card_present: + properties: {} + title: setup_intent_payment_method_options_param + type: object link: properties: {} title: setup_intent_payment_method_options_param @@ -97639,6 +110429,8 @@ paths: items: enum: - balances + - ownership + - transactions type: string x-stripeBypassValidation: true type: array @@ -97647,6 +110439,16 @@ paths: type: string title: linked_account_options_param type: object + mandate_options: + properties: + collection_method: + enum: + - '' + - paper + type: string + x-stripeBypassValidation: true + title: mandate_options_param + type: object networks: properties: requested: @@ -97816,6 +110618,18 @@ paths: description: The client secret of the SetupIntent. maxLength: 5000 type: string + confirmation_token: + description: >- + ID of the ConfirmationToken used to confirm this + SetupIntent. + + + 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. + maxLength: 5000 + type: string expand: description: Specifies which fields in the response should be expanded. items: @@ -97933,6 +110747,16 @@ paths: properties: {} title: param type: object + allow_redisplay: + enum: + - always + - limited + - unspecified + type: string + amazon_pay: + properties: {} + title: param + type: object au_becs_debit: properties: account_number: @@ -98120,6 +110944,7 @@ paths: - knab - moneyou - n26 + - nn - rabobank - regiobank - revolut @@ -98165,6 +110990,10 @@ paths: additionalProperties: type: string type: object + mobilepay: + properties: {} + title: param + type: object oxxo: properties: {} title: param @@ -98197,6 +111026,7 @@ paths: - santander_przelew24 - tmobile_usbugi_bankowe - toyota_bank + - velobank - volkswagen_bank type: string x-stripeBypassValidation: true @@ -98223,7 +111053,7 @@ paths: session: maxLength: 5000 type: string - title: radar_options + title: radar_options_with_hidden_options type: object revolut_pay: properties: {} @@ -98253,12 +111083,17 @@ paths: - country title: param type: object + swish: + properties: {} + title: param + type: object type: enum: - acss_debit - affirm - afterpay_clearpay - alipay + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -98274,6 +111109,7 @@ paths: - klarna - konbini - link + - mobilepay - oxxo - p24 - paynow @@ -98283,6 +111119,7 @@ paths: - revolut_pay - sepa_debit - sofort + - swish - us_bank_account - wechat_pay - zip @@ -98374,6 +111211,10 @@ paths: x-stripeBypassValidation: true title: setup_intent_payment_method_options_param type: object + amazon_pay: + properties: {} + title: setup_intent_payment_method_options_param + type: object card: properties: mandate_options: @@ -98444,11 +111285,78 @@ paths: enum: - any - automatic - maxLength: 5000 + - challenge type: string x-stripeBypassValidation: true + three_d_secure: + properties: + ares_trans_status: + enum: + - A + - C + - I + - 'N' + - R + - U + - 'Y' + type: string + cryptogram: + maxLength: 5000 + type: string + electronic_commerce_indicator: + enum: + - '01' + - '02' + - '05' + - '06' + - '07' + type: string + x-stripeBypassValidation: true + network_options: + properties: + cartes_bancaires: + properties: + cb_avalgo: + enum: + - '0' + - '1' + - '2' + - '3' + - '4' + - A + type: string + cb_exemption: + maxLength: 4 + type: string + cb_score: + type: integer + required: + - cb_avalgo + title: cartes_bancaires_network_options_param + type: object + title: network_options_param + type: object + requestor_challenge_indicator: + maxLength: 2 + type: string + transaction_id: + maxLength: 5000 + type: string + version: + enum: + - 1.0.2 + - 2.1.0 + - 2.2.0 + type: string + x-stripeBypassValidation: true + title: setup_intent_payment_method_options_param + type: object title: setup_intent_param type: object + card_present: + properties: {} + title: setup_intent_payment_method_options_param + type: object link: properties: {} title: setup_intent_payment_method_options_param @@ -98487,6 +111395,8 @@ paths: items: enum: - balances + - ownership + - transactions type: string x-stripeBypassValidation: true type: array @@ -98495,6 +111405,16 @@ paths: type: string title: linked_account_options_param type: object + mandate_options: + properties: + collection_method: + enum: + - '' + - paper + type: string + x-stripeBypassValidation: true + title: mandate_options_param + type: object networks: properties: requested: @@ -100278,6 +113198,9 @@ paths: billing_thresholds: explode: true style: deepObject + discounts: + explode: true + style: deepObject expand: explode: true style: deepObject @@ -100310,6 +113233,28 @@ paths: subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + description: >- + The coupons to redeem into discounts for the subscription + item. expand: description: Specifies which fields in the response should be expanded. items: @@ -100422,7 +113367,7 @@ paths: proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) + [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is @@ -100512,7 +113457,7 @@ paths: proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) + [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is @@ -100611,6 +113556,9 @@ paths: billing_thresholds: explode: true style: deepObject + discounts: + explode: true + style: deepObject expand: explode: true style: deepObject @@ -100643,6 +113591,28 @@ paths: subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds. + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + description: >- + The coupons to redeem into discounts for the subscription + item. expand: description: Specifies which fields in the response should be expanded. items: @@ -100767,7 +113737,7 @@ paths: proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) + [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is @@ -101299,6 +114269,19 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_config @@ -101337,8 +114320,30 @@ paths: type: string invoice_settings: properties: + account_tax_ids: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string days_until_due: type: integer + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object title: subscription_schedule_default_settings_param type: object on_behalf_of: @@ -101369,7 +114374,7 @@ paths: subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying - subscription running.`cancel` will end the subscription + subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. enum: - cancel @@ -101423,6 +114428,21 @@ paths: add_invoice_items: items: properties: + discounts: + items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array price: maxLength: 5000 type: string @@ -101469,6 +114489,19 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_config @@ -101519,13 +114552,54 @@ paths: - enum: - '' type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string end_date: format: unix-time type: integer invoice_settings: properties: + account_tax_ids: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string days_until_due: type: integer + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object title: invoice_settings type: object items: @@ -101543,6 +114617,25 @@ paths: - enum: - '' type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string metadata: additionalProperties: type: string @@ -101755,6 +114848,19 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_config @@ -101793,8 +114899,30 @@ paths: type: string invoice_settings: properties: + account_tax_ids: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string days_until_due: type: integer + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object title: subscription_schedule_default_settings_param type: object on_behalf_of: @@ -101825,7 +114953,7 @@ paths: subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying - subscription running.`cancel` will end the subscription + subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription. enum: - cancel @@ -101867,6 +114995,21 @@ paths: add_invoice_items: items: properties: + discounts: + items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array price: maxLength: 5000 type: string @@ -101913,6 +115056,19 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_config @@ -101961,6 +115117,25 @@ paths: - enum: - '' type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string end_date: anyOf: - format: unix-time @@ -101971,8 +115146,30 @@ paths: type: string invoice_settings: properties: + account_tax_ids: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string days_until_due: type: integer + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object title: invoice_settings type: object items: @@ -101990,6 +115187,25 @@ paths: - enum: - '' type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string metadata: additionalProperties: type: string @@ -102270,7 +115486,10 @@ paths: - send_invoice type: string style: form - - explode: true + - description: >- + Only return subscriptions that were created during the given date + interval. + explode: true in: query name: created required: false @@ -102509,18 +115728,30 @@ paths: add_invoice_items: explode: true style: deepObject + application_fee_percent: + explode: true + style: deepObject automatic_tax: explode: true style: deepObject + billing_cycle_anchor_config: + explode: true + style: deepObject billing_thresholds: explode: true style: deepObject default_tax_rates: explode: true style: deepObject + discounts: + explode: true + style: deepObject expand: explode: true style: deepObject + invoice_settings: + explode: true + style: deepObject items: explode: true style: deepObject @@ -102555,6 +115786,21 @@ paths: You may pass up to 20 items. items: properties: + discounts: + items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array price: maxLength: 5000 type: string @@ -102596,6 +115842,11 @@ paths: type: object type: array application_fee_percent: + anyOf: + - type: number + - enum: + - '' + type: string description: >- A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the @@ -102605,7 +115856,6 @@ paths: an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). - type: number automatic_tax: description: >- Automatic tax settings for this subscription. We recommend @@ -102614,6 +115864,19 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_config @@ -102629,15 +115892,37 @@ paths: type: integer billing_cycle_anchor: description: >- - A future timestamp to anchor the subscription's [billing + A future timestamp in UTC format to anchor the + subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). - This is used to determine the date of the first full - invoice, and, for plans with `month` or `year` intervals, - the day of the month for subsequent invoices. The timestamp - is in UTC format. + The anchor is the reference point that aligns future billing + cycle dates. It sets the day of week for `week` intervals, + the day of month for `month` and `year` intervals, and the + month of year for `year` intervals. format: unix-time type: integer x-stripeBypassValidation: true + billing_cycle_anchor_config: + description: >- + Mutually exclusive with billing_cycle_anchor and only valid + with monthly and yearly price intervals. When provided, the + billing_cycle_anchor is set to the next occurence of the + day_of_month at the hour, minute, and second UTC. + properties: + day_of_month: + type: integer + hour: + type: integer + minute: + type: integer + month: + type: integer + second: + type: integer + required: + - day_of_month + title: billing_cycle_anchor_config_param + type: object billing_thresholds: anyOf: - properties: @@ -102685,7 +115970,9 @@ paths: 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. + for that particular subscription. This field has been + deprecated and will be removed in a future API version. Use + `discounts` instead. maxLength: 5000 type: string currency: @@ -102749,12 +116036,62 @@ paths: surfaces and certain local payment methods UIs. maxLength: 500 type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + description: >- + The coupons to redeem into discounts for the subscription. + If not specified or empty, inherits the discount from the + subscription's customer. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array + invoice_settings: + description: All invoices will be billed using the specified settings. + properties: + account_tax_ids: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + title: invoice_settings_param + type: object items: description: >- A list of up to 20 subscription items, each with an attached @@ -102773,6 +116110,25 @@ paths: - enum: - '' type: string + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string metadata: additionalProperties: type: string @@ -102869,13 +116225,13 @@ paths: `collection_method=charge_automatically`. - Use `allow_incomplete` to create subscriptions with - `status=incomplete` if the first invoice cannot be paid. - Creating subscriptions with this status allows you to manage - scenarios where additional user actions are needed to pay a - subscription's invoice. For example, SCA regulation may - require 3DS authentication to complete payment. See the [SCA - Migration + Use `allow_incomplete` to create Subscriptions with + `status=incomplete` if the first invoice can't be paid. + Creating Subscriptions with this status allows you to manage + scenarios where additional customer actions are needed to + pay a subscription's invoice. For example, SCA regulation + may require 3DS authentication to complete payment. See the + [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior. @@ -102883,34 +116239,35 @@ paths: Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to - `status=active` when successfully confirming the payment - intent on the first invoice. This allows simpler management - of scenarios where additional user actions are needed to pay - a subscription’s invoice. Such as failed payments, [SCA + `status=active` when successfully confirming the + PaymentIntent on the first invoice. This allows simpler + management of scenarios where additional customer actions + are needed to pay a subscription’s invoice, such as failed + payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If - the payment intent is not confirmed within 23 hours - subscriptions transition to `status=incomplete_expired`, + the PaymentIntent is not confirmed within 23 hours + Subscriptions transition to `status=incomplete_expired`, which is a terminal state. Use `error_if_incomplete` if you want Stripe to return an - HTTP 402 status code if a subscription's first invoice - cannot be paid. For example, if a payment method requires - 3DS authentication due to SCA regulation and further user - action is needed, this parameter does not create a - subscription and returns an error instead. This was the + HTTP 402 status code if a subscription's first invoice can't + be paid. For example, if a payment method requires 3DS + authentication due to SCA regulation and further customer + action is needed, this parameter doesn't create a + Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more. `pending_if_incomplete` is only used with updates and cannot - be passed when creating a subscription. + be passed when creating a Subscription. Subscriptions with `collection_method=send_invoice` are - automatically activated regardless of the first invoice + automatically activated regardless of the first Invoice status. enum: - allow_incomplete @@ -103001,6 +116358,7 @@ paths: enum: - any - automatic + - challenge type: string title: subscription_payment_method_options_param type: object @@ -103040,6 +116398,14 @@ paths: - enum: - '' type: string + sepa_debit: + anyOf: + - properties: {} + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string us_bank_account: anyOf: - properties: @@ -103060,6 +116426,8 @@ paths: items: enum: - balances + - ownership + - transactions type: string x-stripeBypassValidation: true type: array @@ -103086,6 +116454,7 @@ paths: - ach_credit_transfer - ach_debit - acss_debit + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -103093,15 +116462,18 @@ paths: - card - cashapp - customer_balance + - eps - fpx - giropay - grabpay - ideal - konbini - link + - p24 - paynow - paypal - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -103145,16 +116517,17 @@ paths: given subscription at the specified interval. promotion_code: description: >- - The API ID of a promotion code to apply to this - subscription. A promotion code applied to a subscription - will only affect invoices created for that particular - subscription. + The ID of a promotion code to apply to this subscription. A + promotion code 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. maxLength: 5000 type: string proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) + [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`. enum: @@ -103594,6 +116967,9 @@ paths: add_invoice_items: explode: true style: deepObject + application_fee_percent: + explode: true + style: deepObject automatic_tax: explode: true style: deepObject @@ -103615,9 +116991,15 @@ paths: description: explode: true style: deepObject + discounts: + explode: true + style: deepObject expand: explode: true style: deepObject + invoice_settings: + explode: true + style: deepObject items: explode: true style: deepObject @@ -103655,6 +117037,21 @@ paths: You may pass up to 20 items. items: properties: + discounts: + items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array price: maxLength: 5000 type: string @@ -103696,6 +117093,11 @@ paths: type: object type: array application_fee_percent: + anyOf: + - type: number + - enum: + - '' + type: string description: >- A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the @@ -103705,7 +117107,6 @@ paths: an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions). - type: number automatic_tax: description: >- Automatic tax settings for this subscription. We recommend @@ -103714,6 +117115,19 @@ paths: properties: enabled: type: boolean + liability: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object required: - enabled title: automatic_tax_config @@ -103806,7 +117220,9 @@ paths: 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. + for that particular subscription. This field has been + deprecated and will be removed in a future API version. Use + `discounts` instead. maxLength: 5000 type: string days_until_due: @@ -103868,12 +117284,62 @@ paths: the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs. + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string + description: >- + The coupons to redeem into discounts for the subscription. + If not specified or empty, inherits the discount from the + subscription's customer. expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array + invoice_settings: + description: All invoices will be billed using the specified settings. + properties: + account_tax_ids: + anyOf: + - items: + maxLength: 5000 + type: string + type: array + - enum: + - '' + type: string + issuer: + properties: + account: + type: string + type: + enum: + - account + - self + type: string + required: + - type + title: param + type: object + title: invoice_settings_param + type: object items: description: >- A list of up to 20 subscription items, each with an attached @@ -103896,6 +117362,25 @@ paths: type: boolean deleted: type: boolean + discounts: + anyOf: + - items: + properties: + coupon: + maxLength: 5000 + type: string + discount: + maxLength: 5000 + type: string + promotion_code: + maxLength: 5000 + type: string + title: discounts_data_param + type: object + type: array + - enum: + - '' + type: string id: maxLength: 5000 type: string @@ -104014,7 +117499,10 @@ paths: type: string description: >- If specified, payment collection for this subscription will - be paused. + be paused. Note that the subscription status will be + unchanged and will not be updated to `paused`. Learn more + about [pausing + collection](/billing/subscriptions/pause-payment). payment_behavior: description: >- Use `allow_incomplete` to transition the subscription to @@ -104143,6 +117631,7 @@ paths: enum: - any - automatic + - challenge type: string title: subscription_payment_method_options_param type: object @@ -104182,6 +117671,14 @@ paths: - enum: - '' type: string + sepa_debit: + anyOf: + - properties: {} + title: invoice_payment_method_options_param + type: object + - enum: + - '' + type: string us_bank_account: anyOf: - properties: @@ -104202,6 +117699,8 @@ paths: items: enum: - balances + - ownership + - transactions type: string x-stripeBypassValidation: true type: array @@ -104228,6 +117727,7 @@ paths: - ach_credit_transfer - ach_debit - acss_debit + - amazon_pay - au_becs_debit - bacs_debit - bancontact @@ -104235,15 +117735,18 @@ paths: - card - cashapp - customer_balance + - eps - fpx - giropay - grabpay - ideal - konbini - link + - p24 - paynow - paypal - promptpay + - revolut_pay - sepa_debit - sofort - us_bank_account @@ -104295,7 +117798,7 @@ paths: proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) + [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is @@ -104484,7 +117987,7 @@ paths: proration_behavior: description: >- Determines how to handle - [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations) + [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is @@ -104538,6 +118041,9 @@ paths: line_items: explode: true style: deepObject + ship_from_details: + explode: true + style: deepObject shipping_cost: explode: true style: deepObject @@ -104623,6 +118129,7 @@ paths: - au_abn - au_arn - bg_uic + - bh_vat - bo_tin - br_cnpj - br_cpf @@ -104656,13 +118163,17 @@ paths: - jp_trn - ke_pin - kr_brn + - kz_bin - li_uid - mx_rfc - my_frp - my_itn - my_sst + - ng_tin - no_vat + - no_voec - nz_gst + - om_vat - pe_ruc - ph_tin - ro_tin @@ -104734,6 +118245,59 @@ paths: title: calculation_line_item type: object type: array + ship_from_details: + description: >- + Details about the address from which the goods are being + shipped. + properties: + address: + properties: + city: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + country: + maxLength: 5000 + type: string + line1: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + line2: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + postal_code: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + state: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + required: + - country + title: merchant_postal_address + type: object + required: + - address + title: ship_from_details + type: object shipping_cost: description: Shipping cost details to be used for the calculation. properties: @@ -105927,6 +119491,7 @@ paths: - state_communications_tax - state_sales_tax type: string + x-stripeBypassValidation: true required: - state - type @@ -105988,6 +119553,50 @@ paths: $ref: '#/components/schemas/error' description: Error response. '/v1/tax/registrations/{id}': + get: + description:

Returns a Tax Registration object.

+ operationId: GetTaxRegistrationsId + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tax.registration' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. post: description: >-

Updates an existing Tax Registration object.

@@ -106292,8 +119901,10 @@ paths: flat_amount: description: >- A flat amount to reverse across the entire transaction, in - negative integer cents. This value represents the total - amount to refund from the transaction, including taxes. + the [smallest currency + unit](https://stripe.com/docs/currencies#zero-decimal) in + negative. This value represents the total amount to refund + from the transaction, including taxes. type: integer line_items: description: The line item amounts to reverse. @@ -106640,7 +120251,185 @@ paths: - has_more - object - url - title: TaxProductResourceTaxCodeList + title: TaxProductResourceTaxCodeList + type: object + x-expandableFields: + - data + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/tax_codes/{id}': + get: + description: >- +

Retrieves the details of an existing tax code. Supply the unique tax + code ID and Stripe will return the corresponding tax code + information.

+ operationId: GetTaxCodesId + parameters: + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tax_code' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + /v1/tax_ids: + get: + description:

Returns a list of tax IDs.

+ operationId: GetTaxIds + parameters: + - description: >- + A cursor for use in pagination. `ending_before` is an object ID that + defines your place in the list. For instance, if you make a list + request and receive 100 objects, starting with `obj_bar`, your + subsequent call can include `ending_before=obj_bar` in order to + fetch the previous page of the list. + in: query + name: ending_before + required: false + schema: + maxLength: 5000 + type: string + style: form + - description: Specifies which fields in the response should be expanded. + explode: true + in: query + name: expand + required: false + schema: + items: + maxLength: 5000 + type: string + type: array + style: deepObject + - description: >- + A limit on the number of objects to be returned. Limit can range + between 1 and 100, and the default is 10. + in: query + name: limit + required: false + schema: + type: integer + style: form + - description: >- + The account or customer the tax ID belongs to. Defaults to + `owner[type]=self`. + explode: true + in: query + name: owner + required: false + schema: + properties: + account: + type: string + customer: + maxLength: 5000 + type: string + type: + enum: + - account + - application + - customer + - self + type: string + required: + - type + title: owner_params + type: object + style: deepObject + - 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. + in: query + name: starting_after + required: false + schema: + maxLength: 5000 + type: string + style: form + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + description: '' + properties: + data: + description: Details about each object. + items: + $ref: '#/components/schemas/tax_id' + type: array + has_more: + description: >- + True if this list has another page of items after this one + that can be fetched. + type: boolean + object: + description: >- + String representing the object's type. Objects of the same + type share the same value. Always has the value `list`. + enum: + - list + type: string + url: + description: The URL where this list can be accessed. + maxLength: 5000 + type: string + required: + - data + - has_more + - object + - url + title: TaxIDsList type: object x-expandableFields: - data @@ -106651,13 +120440,199 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/tax_codes/{id}': - get: + post: + description:

Creates a new account or customer tax_id object.

+ operationId: PostTaxIds + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + owner: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + owner: + description: >- + The account or customer the tax ID belongs to. Defaults to + `owner[type]=self`. + properties: + account: + type: string + customer: + maxLength: 5000 + type: string + type: + enum: + - account + - application + - customer + - self + type: string + required: + - type + title: owner_params + 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`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, + `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, + `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, + `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, + `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, + `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, + `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`, `ua_vat`, + `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat` + enum: + - ad_nrt + - ae_trn + - ar_cuit + - au_abn + - au_arn + - bg_uic + - bh_vat + - bo_tin + - br_cnpj + - br_cpf + - ca_bn + - ca_gst_hst + - ca_pst_bc + - ca_pst_mb + - ca_pst_sk + - ca_qst + - ch_vat + - cl_tin + - cn_tin + - co_nit + - cr_tin + - do_rcn + - ec_ruc + - eg_tin + - es_cif + - eu_oss_vat + - eu_vat + - gb_vat + - ge_vat + - hk_br + - hu_tin + - id_npwp + - il_vat + - in_gst + - is_vat + - jp_cn + - jp_rn + - jp_trn + - ke_pin + - kr_brn + - kz_bin + - li_uid + - 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 + - ua_vat + - us_ein + - uy_ruc + - ve_rif + - vn_tin + - za_vat + maxLength: 5000 + type: string + x-stripeBypassValidation: true + value: + description: Value of the tax ID. + type: string + required: + - type + - value + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/tax_id' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/tax_ids/{id}': + delete: description: >- -

Retrieves the details of an existing tax code. Supply the unique tax - code ID and Stripe will return the corresponding tax code - information.

- operationId: GetTaxCodesId +

Deletes an existing account or customer tax_id + object.

+ operationId: DeleteTaxIdsId + parameters: + - in: path + name: id + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: {} + schema: + additionalProperties: false + properties: {} + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/deleted_tax_id' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + get: + description:

Retrieves an account or customer tax_id object.

+ operationId: GetTaxIdsId parameters: - description: Specifies which fields in the response should be expanded. explode: true @@ -106691,7 +120666,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/tax_code' + $ref: '#/components/schemas/tax_id' description: Successful response. default: content: @@ -106938,9 +120913,9 @@ paths: - qst - rst - sales_tax - - service_tax - vat type: string + x-stripeBypassValidation: true required: - display_name - inclusive @@ -107105,9 +121080,9 @@ paths: - qst - rst - sales_tax - - service_tax - vat type: string + x-stripeBypassValidation: true type: object required: false responses: @@ -107280,6 +121255,10 @@ paths: maxLength: 5000 type: string type: array + name: + description: Name of the configuration + maxLength: 100 + type: string offline: anyOf: - properties: @@ -107662,6 +121641,10 @@ paths: maxLength: 5000 type: string type: array + name: + description: Name of the configuration + maxLength: 100 + type: string offline: anyOf: - properties: @@ -108370,6 +122353,7 @@ paths: - bbpos_chipper2x - bbpos_wisepad3 - bbpos_wisepos_e + - mobile_phone_reader - simulated_wisepos_e - stripe_m2 - verifone_P400 @@ -108700,13 +122684,257 @@ paths: type: string description: The new label of the reader. metadata: - anyOf: - - additionalProperties: - type: string - type: object - - enum: - - '' - type: string + anyOf: + - additionalProperties: + type: string + type: object + - enum: + - '' + type: 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. Individual keys can be unset by posting an empty + value to them. All keys can be unset by posting an empty + value to `metadata`. + type: object + required: false + responses: + '200': + content: + application/json: + schema: + anyOf: + - $ref: '#/components/schemas/terminal.reader' + - $ref: '#/components/schemas/deleted_terminal.reader' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/terminal/readers/{reader}/cancel_action': + post: + description:

Cancels the current reader action.

+ operationId: PostTerminalReadersReaderCancelAction + parameters: + - in: path + name: reader + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/terminal.reader' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/terminal/readers/{reader}/process_payment_intent': + post: + description:

Initiates a payment flow on a Reader.

+ operationId: PostTerminalReadersReaderProcessPaymentIntent + parameters: + - in: path + name: reader + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + process_config: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + payment_intent: + description: PaymentIntent ID + maxLength: 5000 + type: string + process_config: + description: Configuration overrides + properties: + enable_customer_cancellation: + type: boolean + skip_tipping: + type: boolean + tipping: + properties: + amount_eligible: + type: integer + title: tipping_config + type: object + title: process_config + type: object + required: + - payment_intent + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/terminal.reader' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/terminal/readers/{reader}/process_setup_intent': + post: + description:

Initiates a setup intent flow on a Reader.

+ operationId: PostTerminalReadersReaderProcessSetupIntent + parameters: + - in: path + name: reader + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + process_config: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + customer_consent_collected: + description: Customer Consent Collected + type: boolean + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + process_config: + description: Configuration overrides + properties: + enable_customer_cancellation: + type: boolean + title: process_setup_config + type: object + setup_intent: + description: SetupIntent ID + maxLength: 5000 + type: string + required: + - customer_consent_collected + - setup_intent + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/terminal.reader' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/terminal/readers/{reader}/refund_payment': + post: + description:

Initiates a refund on a Reader

+ operationId: PostTerminalReadersReaderRefundPayment + parameters: + - in: path + name: reader + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + metadata: + explode: true + style: deepObject + refund_payment_config: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + amount: + description: >- + A positive integer in __cents__ representing how much of + this charge to refund. + type: integer + charge: + description: ID of the Charge to refund. + maxLength: 5000 + type: string + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + metadata: + additionalProperties: + type: string description: >- Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can @@ -108715,6 +122943,36 @@ paths: format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. + type: object + payment_intent: + description: ID of the PaymentIntent to refund. + maxLength: 5000 + type: string + refund_application_fee: + description: >- + Boolean indicating whether the application fee should be + refunded when refunding this charge. If a full charge refund + is given, the full application fee will be refunded. + Otherwise, the application fee will be refunded in an amount + proportional to the amount of the charge refunded. An + application fee can be refunded only by the application that + created the charge. + type: boolean + refund_payment_config: + description: Configuration overrides + properties: + enable_customer_cancellation: + type: boolean + title: refund_payment_config + type: object + reverse_transfer: + description: >- + Boolean indicating whether the transfer should be reversed + when refunding this charge. The transfer will be reversed + proportionally to the amount being refunded (either the + entire or partial amount). A transfer can be reversed only + by the application that created the charge. + type: boolean type: object required: false responses: @@ -108722,9 +122980,7 @@ paths: content: application/json: schema: - anyOf: - - $ref: '#/components/schemas/terminal.reader' - - $ref: '#/components/schemas/deleted_terminal.reader' + $ref: '#/components/schemas/terminal.reader' description: Successful response. default: content: @@ -108732,10 +122988,10 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/terminal/readers/{reader}/cancel_action': + '/v1/terminal/readers/{reader}/set_reader_display': post: - description:

Cancels the current reader action.

- operationId: PostTerminalReadersReaderCancelAction + description:

Sets reader display to show cart details.

+ operationId: PostTerminalReadersReaderSetReaderDisplay parameters: - in: path name: reader @@ -108748,20 +123004,62 @@ paths: content: application/x-www-form-urlencoded: encoding: + cart: + explode: true + style: deepObject expand: explode: true style: deepObject schema: additionalProperties: false properties: + cart: + description: Cart + properties: + currency: + type: string + line_items: + items: + properties: + amount: + type: integer + description: + maxLength: 5000 + type: string + quantity: + type: integer + required: + - amount + - description + - quantity + title: line_item + type: object + type: array + tax: + type: integer + total: + type: integer + required: + - currency + - line_items + - total + title: cart + type: object expand: description: Specifies which fields in the response should be expanded. items: maxLength: 5000 type: string type: array + type: + description: Type + enum: + - cart + type: string + required: + - type type: object - required: false + required: true responses: '200': content: @@ -108775,18 +123073,12 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. - '/v1/terminal/readers/{reader}/process_payment_intent': + /v1/test_helpers/confirmation_tokens: post: - description:

Initiates a payment flow on a Reader.

- operationId: PostTerminalReadersReaderProcessPaymentIntent - parameters: - - in: path - name: reader - required: true - schema: - maxLength: 5000 - type: string - style: simple + description: >- +

Creates a test mode Confirmation Token server side for your + integration tests.

+ operationId: PostTestHelpersConfirmationTokens requestBody: content: application/x-www-form-urlencoded: @@ -108794,7 +123086,10 @@ paths: expand: explode: true style: deepObject - process_config: + payment_method_data: + explode: true + style: deepObject + shipping: explode: true style: deepObject schema: @@ -108806,268 +123101,523 @@ paths: maxLength: 5000 type: string type: array - payment_intent: - description: PaymentIntent ID + payment_method: + description: ID of an existing PaymentMethod. maxLength: 5000 type: string - process_config: - description: Configuration overrides + payment_method_data: + description: >- + If provided, this hash will be used to create a + PaymentMethod. properties: - skip_tipping: - type: boolean - tipping: + acss_debit: + properties: + account_number: + maxLength: 5000 + type: string + institution_number: + maxLength: 5000 + type: string + transit_number: + maxLength: 5000 + type: string + required: + - account_number + - institution_number + - transit_number + title: payment_method_param + type: object + affirm: + properties: {} + title: param + type: object + afterpay_clearpay: + properties: {} + title: param + type: object + alipay: + properties: {} + title: param + type: object + allow_redisplay: + enum: + - always + - limited + - unspecified + type: string + amazon_pay: + properties: {} + title: param + type: object + au_becs_debit: + properties: + account_number: + maxLength: 5000 + type: string + bsb_number: + maxLength: 5000 + type: string + required: + - account_number + - bsb_number + title: param + type: object + bacs_debit: + properties: + account_number: + maxLength: 5000 + type: string + sort_code: + maxLength: 5000 + type: string + title: param + type: object + bancontact: + properties: {} + title: param + type: object + billing_details: + properties: + address: + anyOf: + - properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: billing_details_address + type: object + - enum: + - '' + type: string + email: + anyOf: + - type: string + - enum: + - '' + type: string + name: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + phone: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string + title: billing_details_inner_params + type: object + blik: + properties: {} + title: param + type: object + boleto: + properties: + tax_id: + maxLength: 5000 + type: string + required: + - tax_id + title: param + type: object + cashapp: + properties: {} + title: param + type: object + customer_balance: + properties: {} + title: param + type: object + eps: + properties: + bank: + enum: + - arzte_und_apotheker_bank + - austrian_anadi_bank_ag + - bank_austria + - bankhaus_carl_spangler + - bankhaus_schelhammer_und_schattera_ag + - bawag_psk_ag + - bks_bank_ag + - brull_kallmus_bank_ag + - btv_vier_lander_bank + - capital_bank_grawe_gruppe_ag + - deutsche_bank_ag + - dolomitenbank + - easybank_ag + - erste_bank_und_sparkassen + - hypo_alpeadriabank_international_ag + - hypo_bank_burgenland_aktiengesellschaft + - hypo_noe_lb_fur_niederosterreich_u_wien + - hypo_oberosterreich_salzburg_steiermark + - hypo_tirol_bank_ag + - hypo_vorarlberg_bank_ag + - marchfelder_bank + - oberbank_ag + - raiffeisen_bankengruppe_osterreich + - schoellerbank_ag + - sparda_bank_wien + - volksbank_gruppe + - volkskreditbank_ag + - vr_bank_braunau + maxLength: 5000 + type: string + title: param + type: object + fpx: + properties: + bank: + enum: + - affin_bank + - agrobank + - alliance_bank + - ambank + - bank_islam + - bank_muamalat + - bank_of_china + - bank_rakyat + - bsn + - cimb + - deutsche_bank + - hong_leong_bank + - hsbc + - kfh + - maybank2e + - maybank2u + - ocbc + - pb_enterprise + - public_bank + - rhb + - standard_chartered + - uob + maxLength: 5000 + type: string + x-stripeBypassValidation: true + required: + - bank + title: param + type: object + giropay: + properties: {} + title: param + type: object + grabpay: + properties: {} + title: param + type: object + ideal: + properties: + bank: + enum: + - abn_amro + - asn_bank + - bunq + - handelsbanken + - ing + - knab + - moneyou + - n26 + - nn + - rabobank + - regiobank + - revolut + - sns_bank + - triodos_bank + - van_lanschot + - yoursafe + maxLength: 5000 + type: string + title: param + type: object + interac_present: + properties: {} + title: param + type: object + klarna: + properties: + dob: + properties: + day: + type: integer + month: + type: integer + year: + type: integer + required: + - day + - month + - year + title: date_of_birth + type: object + title: param + type: object + konbini: + properties: {} + title: param + type: object + link: + properties: {} + title: param + type: object + metadata: + additionalProperties: + type: string + type: object + mobilepay: + properties: {} + title: param + type: object + oxxo: + properties: {} + title: param + type: object + p24: + properties: + bank: + enum: + - alior_bank + - bank_millennium + - bank_nowy_bfg_sa + - bank_pekao_sa + - banki_spbdzielcze + - blik + - bnp_paribas + - boz + - citi_handlowy + - credit_agricole + - envelobank + - etransfer_pocztowy24 + - getin_bank + - ideabank + - ing + - inteligo + - mbank_mtransfer + - nest_przelew + - noble_pay + - pbac_z_ipko + - plus_bank + - santander_przelew24 + - tmobile_usbugi_bankowe + - toyota_bank + - velobank + - volkswagen_bank + type: string + x-stripeBypassValidation: true + title: param + type: object + paynow: + properties: {} + title: param + type: object + paypal: + properties: {} + title: param + type: object + pix: + properties: {} + title: param + type: object + promptpay: + properties: {} + title: param + type: object + radar_options: + properties: + session: + maxLength: 5000 + type: string + title: radar_options_with_hidden_options + type: object + revolut_pay: + properties: {} + title: param + type: object + sepa_debit: + properties: + iban: + maxLength: 5000 + type: string + required: + - iban + title: param + type: object + sofort: + properties: + country: + enum: + - AT + - BE + - DE + - ES + - IT + - NL + type: string + required: + - country + title: param + type: object + swish: + properties: {} + title: param + type: object + type: + enum: + - acss_debit + - affirm + - afterpay_clearpay + - alipay + - amazon_pay + - au_becs_debit + - bacs_debit + - bancontact + - blik + - boleto + - cashapp + - customer_balance + - eps + - fpx + - giropay + - grabpay + - ideal + - klarna + - konbini + - link + - mobilepay + - oxxo + - p24 + - paynow + - paypal + - pix + - promptpay + - revolut_pay + - sepa_debit + - sofort + - swish + - us_bank_account + - wechat_pay + - zip + type: string + x-stripeBypassValidation: true + us_bank_account: properties: - amount_eligible: - type: integer - title: tipping_config + account_holder_type: + enum: + - company + - individual + type: string + account_number: + maxLength: 5000 + type: string + account_type: + enum: + - checking + - savings + type: string + financial_connections_account: + maxLength: 5000 + type: string + routing_number: + maxLength: 5000 + type: string + title: payment_method_param type: object - title: process_config - type: object - required: - - payment_intent - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/terminal.reader' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - '/v1/terminal/readers/{reader}/process_setup_intent': - post: - description:

Initiates a setup intent flow on a Reader.

- operationId: PostTerminalReadersReaderProcessSetupIntent - parameters: - - in: path - name: reader - required: true - schema: - maxLength: 5000 - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: - expand: - explode: true - style: deepObject - process_config: - explode: true - style: deepObject - schema: - additionalProperties: false - properties: - customer_consent_collected: - description: Customer Consent Collected - type: boolean - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - process_config: - description: Configuration overrides - properties: {} - title: process_setup_config + wechat_pay: + properties: {} + title: param + type: object + zip: + properties: {} + title: param + type: object + required: + - type + title: payment_method_data_params type: object - setup_intent: - description: SetupIntent ID - maxLength: 5000 - type: string - required: - - customer_consent_collected - - setup_intent - type: object - required: true - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/terminal.reader' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - '/v1/terminal/readers/{reader}/refund_payment': - post: - description:

Initiates a refund on a Reader

- operationId: PostTerminalReadersReaderRefundPayment - parameters: - - in: path - name: reader - required: true - schema: - maxLength: 5000 - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: - expand: - explode: true - style: deepObject - metadata: - explode: true - style: deepObject - schema: - additionalProperties: false - properties: - amount: - description: >- - A positive integer in __cents__ representing how much of - this charge to refund. - type: integer - charge: - description: ID of the Charge to refund. - maxLength: 5000 + return_url: + description: Return URL used to confirm the Intent. type: string - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - metadata: - additionalProperties: - type: string + setup_future_usage: 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. Individual keys can be unset by posting an empty - value to them. All keys can be unset by posting an empty - value to `metadata`. - type: object - payment_intent: - description: ID of the PaymentIntent to refund. - maxLength: 5000 + Indicates that you intend to make future payments with this + ConfirmationToken's payment method. + + + The presence of this property will [attach the payment + method](https://stripe.com/docs/payments/save-during-payment) + to the PaymentIntent's Customer, if present, after the + PaymentIntent is confirmed and any required actions from the + user are complete. + enum: + - off_session + - on_session type: string - refund_application_fee: - description: >- - Boolean indicating whether the application fee should be - refunded when refunding this charge. If a full charge refund - is given, the full application fee will be refunded. - Otherwise, the application fee will be refunded in an amount - proportional to the amount of the charge refunded. An - application fee can be refunded only by the application that - created the charge. - type: boolean - reverse_transfer: - description: >- - Boolean indicating whether the transfer should be reversed - when refunding this charge. The transfer will be reversed - proportionally to the amount being refunded (either the - entire or partial amount). A transfer can be reversed only - by the application that created the charge. - type: boolean - type: object - required: false - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/terminal.reader' - description: Successful response. - default: - content: - application/json: - schema: - $ref: '#/components/schemas/error' - description: Error response. - '/v1/terminal/readers/{reader}/set_reader_display': - post: - description:

Sets reader display to show cart details.

- operationId: PostTerminalReadersReaderSetReaderDisplay - parameters: - - in: path - name: reader - required: true - schema: - maxLength: 5000 - type: string - style: simple - requestBody: - content: - application/x-www-form-urlencoded: - encoding: - cart: - explode: true - style: deepObject - expand: - explode: true - style: deepObject - schema: - additionalProperties: false - properties: - cart: - description: Cart + shipping: + description: Shipping information for this ConfirmationToken. properties: - currency: + address: + properties: + city: + maxLength: 5000 + type: string + country: + maxLength: 5000 + type: string + line1: + maxLength: 5000 + type: string + line2: + maxLength: 5000 + type: string + postal_code: + maxLength: 5000 + type: string + state: + maxLength: 5000 + type: string + title: optional_fields_address + type: object + name: + maxLength: 5000 type: string - line_items: - items: - properties: - amount: - type: integer - description: - maxLength: 5000 - type: string - quantity: - type: integer - required: - - amount - - description - - quantity - title: line_item - type: object - type: array - tax: - type: integer - total: - type: integer + phone: + anyOf: + - maxLength: 5000 + type: string + - enum: + - '' + type: string required: - - currency - - line_items - - total - title: cart + - address + - name + title: recipient_shipping_with_optional_fields_address type: object - expand: - description: Specifies which fields in the response should be expanded. - items: - maxLength: 5000 - type: string - type: array - type: - description: Type - enum: - - cart - type: string - required: - - type type: object - required: true + required: false responses: '200': content: application/json: schema: - $ref: '#/components/schemas/terminal.reader' + $ref: '#/components/schemas/confirmation_token' description: Successful response. default: content: @@ -109176,7 +123726,7 @@ paths: amount: description: >- The total amount to attempt to authorize. This amount is in - the provided currency, or defaults to the cards currency, + the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). type: integer @@ -109599,6 +124149,7 @@ paths: enum: - low_value_transaction - transaction_risk_analysis + - unknown type: string x-stripeBypassValidation: true required: @@ -109763,6 +124314,7 @@ paths: unit: enum: - liter + - other - us_gallon maxLength: 5000 type: string @@ -110150,6 +124702,178 @@ paths: schema: $ref: '#/components/schemas/error' description: Error response. + '/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate': + post: + description: >- +

Updates the status of the specified testmode + personalization design object to active.

+ operationId: >- + PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignActivate + parameters: + - in: path + name: personalization_design + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.personalization_design' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate': + post: + description: >- +

Updates the status of the specified testmode + personalization design object to inactive.

+ operationId: >- + PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignDeactivate + parameters: + - in: path + name: personalization_design + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + type: object + required: false + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.personalization_design' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. + '/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject': + post: + description: >- +

Updates the status of the specified testmode + personalization design object to rejected.

+ operationId: PostTestHelpersIssuingPersonalizationDesignsPersonalizationDesignReject + parameters: + - in: path + name: personalization_design + required: true + schema: + maxLength: 5000 + type: string + style: simple + requestBody: + content: + application/x-www-form-urlencoded: + encoding: + expand: + explode: true + style: deepObject + rejection_reasons: + explode: true + style: deepObject + schema: + additionalProperties: false + properties: + expand: + description: Specifies which fields in the response should be expanded. + items: + maxLength: 5000 + type: string + type: array + rejection_reasons: + description: The reason(s) the personalization design was rejected. + properties: + card_logo: + items: + enum: + - geographic_location + - inappropriate + - network_name + - non_binary_image + - non_fiat_currency + - other + - other_entity + - promotional_material + type: string + type: array + carrier_text: + items: + enum: + - geographic_location + - inappropriate + - network_name + - non_fiat_currency + - other + - other_entity + - promotional_material + type: string + type: array + title: rejection_reasons_param + type: object + required: + - rejection_reasons + type: object + required: true + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/issuing.personalization_design' + description: Successful response. + default: + content: + application/json: + schema: + $ref: '#/components/schemas/error' + description: Error response. /v1/test_helpers/issuing/transactions/create_force_capture: post: description: >- @@ -110590,6 +125314,7 @@ paths: unit: enum: - liter + - other - us_gallon maxLength: 5000 type: string @@ -111090,6 +125815,7 @@ paths: unit: enum: - liter + - other - us_gallon maxLength: 5000 type: string @@ -112153,7 +126879,12 @@ paths: title: source_params type: object network: - description: The rails used for the object. + description: >- + Specifies the network rails to be used. If not set, will + default to the PaymentMethod's preferred network. See the + [docs](https://stripe.com/docs/treasury/money-movement/timelines) + to learn more about money movement timelines for each + network type. enum: - ach - us_domestic_wire @@ -112248,7 +126979,12 @@ paths: title: source_params type: object network: - description: The rails used for the object. + description: >- + Specifies the network rails to be used. If not set, will + default to the PaymentMethod's preferred network. See the + [docs](https://stripe.com/docs/treasury/money-movement/timelines) + to learn more about money movement timelines for each + network type. enum: - ach type: string @@ -112279,7 +127015,9 @@ paths: You can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a - Custom account.

+ connected account where controller.requirement_collection + is application, which includes Custom accounts.

operationId: PostTokens requestBody: content: @@ -112453,6 +127191,7 @@ paths: - public_company - public_corporation - public_partnership + - registered_charity - single_member_llc - sole_establishment - sole_proprietorship @@ -112656,6 +127395,25 @@ paths: type: string title: address_specs type: object + relationship: + properties: + director: + type: boolean + executive: + type: boolean + owner: + type: boolean + percent_ownership: + anyOf: + - type: number + - enum: + - '' + type: string + title: + maxLength: 5000 + type: string + title: individual_relationship_specs + type: object ssn_last_4: maxLength: 5000 type: string @@ -112717,6 +127475,9 @@ paths: type: string currency: type: string + payment_method: + maxLength: 5000 + type: string routing_number: maxLength: 5000 type: string @@ -112762,6 +127523,16 @@ paths: name: maxLength: 5000 type: string + networks: + properties: + preferred: + enum: + - cartes_bancaires + - mastercard + - visa + type: string + title: networks_param_specs + type: object number: maxLength: 5000 type: string @@ -113583,7 +128354,10 @@ paths: transfers appearing first.

operationId: GetTransfers parameters: - - explode: true + - description: >- + Only return transfers that were created during the given date + interval. + explode: true in: query name: created required: false @@ -114769,7 +129543,10 @@ paths: description:

Returns a list of FinancialAccounts.

operationId: GetTreasuryFinancialAccounts parameters: - - explode: true + - description: >- + Only return FinancialAccounts that were created during the given + date interval. + explode: true in: query name: created required: false @@ -115808,6 +130585,28 @@ paths: FinancialAccount.

operationId: GetTreasuryOutboundPayments parameters: + - description: >- + Only return OutboundPayments that were created during the given date + interval. + explode: true + in: query + name: created + required: false + schema: + anyOf: + - properties: + gt: + type: integer + gte: + type: integer + lt: + type: integer + lte: + type: integer + title: range_query_specs + type: object + - type: integer + style: deepObject - description: Only return OutboundPayments sent to this customer. in: query name: customer @@ -116144,8 +130943,9 @@ paths: The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, - 140 characters for `wire` payments, or 500 characters for - `stripe` network transfers. The default value is `payment`. + 140 characters for `us_domestic_wire` payments, or 500 + characters for `stripe` network transfers. The default value + is "payment". maxLength: 5000 type: string required: @@ -116470,8 +131270,8 @@ paths: description: >- Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers - or 140 characters for `wire` transfers. The default value is - `transfer`. + or 140 characters for `us_domestic_wire` transfers. The + default value is "transfer". maxLength: 5000 type: string required: @@ -116953,7 +131753,10 @@ paths: description:

Retrieves a list of TransactionEntry objects.

operationId: GetTreasuryTransactionEntries parameters: - - explode: true + - description: >- + Only return TransactionEntries that were created during the given + date interval. + explode: true in: query name: created required: false @@ -117168,7 +131971,10 @@ paths: description:

Retrieves a list of Transaction objects.

operationId: GetTreasuryTransactions parameters: - - explode: true + - description: >- + Only return Transactions that were created during the given date + interval. + explode: true in: query name: created required: false @@ -117632,6 +132438,7 @@ paths: - '2022-11-15' - '2023-08-16' - '2023-10-16' + - '2024-04-10' maxLength: 5000 type: string x-stripeBypassValidation: true @@ -117689,6 +132496,13 @@ paths: - checkout.session.async_payment_succeeded - checkout.session.completed - checkout.session.expired + - climate.order.canceled + - climate.order.created + - climate.order.delayed + - climate.order.delivered + - climate.order.product_substituted + - climate.product.created + - climate.product.pricing_updated - coupon.created - coupon.deleted - coupon.updated @@ -117717,12 +132531,15 @@ paths: - customer.tax_id.updated - customer.updated - customer_cash_balance_transaction.created + - entitlements.active_entitlement_summary.updated - file.created - financial_connections.account.created - financial_connections.account.deactivated - financial_connections.account.disconnected - financial_connections.account.reactivated - financial_connections.account.refreshed_balance + - financial_connections.account.refreshed_ownership + - financial_connections.account.refreshed_transactions - identity.verification_session.canceled - identity.verification_session.created - identity.verification_session.processing @@ -118085,6 +132902,13 @@ paths: - checkout.session.async_payment_succeeded - checkout.session.completed - checkout.session.expired + - climate.order.canceled + - climate.order.created + - climate.order.delayed + - climate.order.delivered + - climate.order.product_substituted + - climate.product.created + - climate.product.pricing_updated - coupon.created - coupon.deleted - coupon.updated @@ -118113,12 +132937,15 @@ paths: - customer.tax_id.updated - customer.updated - customer_cash_balance_transaction.created + - entitlements.active_entitlement_summary.updated - file.created - financial_connections.account.created - financial_connections.account.deactivated - financial_connections.account.disconnected - financial_connections.account.reactivated - financial_connections.account.refreshed_balance + - financial_connections.account.refreshed_ownership + - financial_connections.account.refreshed_transactions - identity.verification_session.canceled - identity.verification_session.created - identity.verification_session.processing diff --git a/packages/openapi-typescript/scripts/update-examples.ts b/packages/openapi-typescript/scripts/update-examples.ts index fc5c38439..c9f73cb8e 100644 --- a/packages/openapi-typescript/scripts/update-examples.ts +++ b/packages/openapi-typescript/scripts/update-examples.ts @@ -3,7 +3,7 @@ import path from "node:path"; import { multiFile, singleFile } from "./schemas.js"; async function generateSchemas() { - const cwd = new URL("../", import.meta.url); + const rootCWD = new URL("../", import.meta.url); const singleFileSchemas = Object.entries(singleFile); const multiFileSchemas = Object.entries(multiFile); @@ -12,17 +12,38 @@ async function generateSchemas() { const updateSchema = async (name: string, ext: string) => { const start = performance.now(); + const cwd = + process.platform === "win32" + ? // execa/cross-spawn can not handle URL objects on Windows, so convert it to string and cut away the protocol + rootCWD + .toString() + .slice("file:///".length) + : rootCWD; try { - await execa("./bin/cli.js", [`./examples/${name}${ext}`, "-o", `./examples/${name}.ts`], { - cwd: - process.platform === "win32" - ? // execa/cross-spawn can not handle URL objects on Windows, so convert it to string and cut away the protocol - cwd - .toString() - .slice("file:///".length) - : cwd, - }); + await Promise.all([ + execa("./bin/cli.js", [`./examples/${name}${ext}`, "-o", `./examples/${name}.ts`], { cwd }), + ...(name === "github-api" + ? [ + execa( + "./bin/cli.js", + [ + `./examples/${name}${ext}`, + "--immutable", + "--export-type", + "-o", + `./examples/${name}-export-type-immutable.ts`, + ], + { cwd }, + ), + execa( + "./bin/cli.js", + [`./examples/${name}${ext}`, "--immutable", "-o", `./examples/${name}-immutable.ts`], + { cwd }, + ), + ] + : []), + ]); schemasDoneCount++; const timeMs = Math.round(performance.now() - start); diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 7d3d4107c..b25293ed7 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -30,8 +30,8 @@ importers: docs: devDependencies: vitepress: - specifier: 1.1.3 - version: 1.1.3(@algolia/client-search@4.23.3)(@types/node@20.12.7)(@types/react@18.2.79)(axios@1.6.8)(postcss@8.4.38)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(search-insights@2.13.0)(typescript@5.4.5) + specifier: 1.1.4 + version: 1.1.4(@algolia/client-search@4.23.3)(@types/node@20.12.7)(@types/react@18.3.1)(axios@1.6.8)(postcss@8.4.38)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)(typescript@5.4.5) packages/openapi-fetch: dependencies: @@ -73,27 +73,27 @@ importers: packages/openapi-fetch/examples/nextjs: dependencies: next: - specifier: 14.2.2 - version: 14.2.2(react-dom@18.2.0(react@18.2.0))(react@18.2.0) + specifier: 14.2.3 + version: 14.2.3(react-dom@18.3.1(react@18.3.1))(react@18.3.1) openapi-fetch: specifier: workspace:^ version: link:../.. react: - specifier: 18.2.0 - version: 18.2.0 + specifier: 18.3.1 + version: 18.3.1 react-dom: - specifier: 18.2.0 - version: 18.2.0(react@18.2.0) + specifier: 18.3.1 + version: 18.3.1(react@18.3.1) devDependencies: '@types/node': specifier: 20.12.7 version: 20.12.7 '@types/react': - specifier: 18.2.79 - version: 18.2.79 + specifier: 18.3.1 + version: 18.3.1 '@types/react-dom': - specifier: 18.2.25 - version: 18.2.25 + specifier: 18.3.0 + version: 18.3.0 openapi-typescript: specifier: workspace:^ version: link:../../../openapi-typescript @@ -105,7 +105,7 @@ importers: dependencies: '@tanstack/react-query': specifier: ^5.32.0 - version: 5.32.0(react@18.2.0) + version: 5.32.0(react@18.3.1) openapi-fetch: specifier: workspace:^ version: link:../.. @@ -113,18 +113,18 @@ importers: specifier: workspace:^ version: link:../../../openapi-typescript react: - specifier: ^18.2.0 - version: 18.2.0 + specifier: ^18.3.1 + version: 18.3.1 react-dom: - specifier: ^18.2.0 - version: 18.2.0(react@18.2.0) + specifier: ^18.3.1 + version: 18.3.1(react@18.3.1) devDependencies: '@types/react': - specifier: 18.2.79 - version: 18.2.79 + specifier: 18.3.1 + version: 18.3.1 '@types/react-dom': - specifier: 18.2.25 - version: 18.2.25 + specifier: 18.3.0 + version: 18.3.0 '@vitejs/plugin-react-swc': specifier: ^3.6.0 version: 3.6.0(@swc/helpers@0.5.5)(vite@5.2.10(@types/node@20.12.7)) @@ -140,9 +140,6 @@ importers: openapi-fetch: specifier: workspace:^ version: link:../.. - openapi-typescript: - specifier: workspace:^ - version: link:../../../openapi-typescript devDependencies: '@sveltejs/adapter-auto': specifier: ^3.2.0 @@ -153,12 +150,15 @@ importers: '@sveltejs/vite-plugin-svelte': specifier: ^3.1.0 version: 3.1.0(svelte@4.2.15)(vite@5.2.10(@types/node@20.12.7)) + openapi-typescript: + specifier: workspace:^ + version: link:../../../openapi-typescript svelte: specifier: ^4.2.15 version: 4.2.15 svelte-check: - specifier: ^3.6.9 - version: 3.6.9(postcss@8.4.38)(svelte@4.2.15) + specifier: ^3.7.0 + version: 3.7.0(postcss@8.4.38)(svelte@4.2.15) tslib: specifier: ^2.6.2 version: 2.6.2 @@ -665,59 +665,59 @@ packages: resolution: {integrity: sha512-HM47Lu1YFmnYHKMBynFfjCp0U/yRskHj/8QEJW0CBEPOlw8Gkmjfll+S9b8M7V5CNDw2/ciRxjjnWeaCiblSIQ==} engines: {node: '>=18'} - '@next/env@14.2.2': - resolution: {integrity: sha512-sk72qRfM1Q90XZWYRoJKu/UWlTgihrASiYw/scb15u+tyzcze3bOuJ/UV6TBOQEeUaxOkRqGeuGUdiiuxc5oqw==} + '@next/env@14.2.3': + resolution: {integrity: sha512-W7fd7IbkfmeeY2gXrzJYDx8D2lWKbVoTIj1o1ScPHNzvp30s1AuoEFSdr39bC5sjxJaxTtq3OTCZboNp0lNWHA==} - '@next/swc-darwin-arm64@14.2.2': - resolution: {integrity: sha512-3iPgMhzbalizGwHNFUcGnDhFPSgVBHQ8aqSTAMxB5BvJG0oYrDf1WOJZlbXBgunOEj/8KMVbejEur/FpvFsgFQ==} + '@next/swc-darwin-arm64@14.2.3': + resolution: {integrity: sha512-3pEYo/RaGqPP0YzwnlmPN2puaF2WMLM3apt5jLW2fFdXD9+pqcoTzRk+iZsf8ta7+quAe4Q6Ms0nR0SFGFdS1A==} engines: {node: '>= 10'} cpu: [arm64] os: [darwin] - '@next/swc-darwin-x64@14.2.2': - resolution: {integrity: sha512-x7Afi/jt0ZBRUZHTi49yyej4o8znfIMHO4RvThuoc0P+uli8Jd99y5GKjxoYunPKsXL09xBXEM1+OQy2xEL0Ag==} + '@next/swc-darwin-x64@14.2.3': + resolution: {integrity: sha512-6adp7waE6P1TYFSXpY366xwsOnEXM+y1kgRpjSRVI2CBDOcbRjsJ67Z6EgKIqWIue52d2q/Mx8g9MszARj8IEA==} engines: {node: '>= 10'} cpu: [x64] os: [darwin] - '@next/swc-linux-arm64-gnu@14.2.2': - resolution: {integrity: sha512-zbfPtkk7L41ODMJwSp5VbmPozPmMMQrzAc0HAUomVeVIIwlDGs/UCqLJvLNDt4jpWgc21SjjyIn762lNGrMaUA==} + '@next/swc-linux-arm64-gnu@14.2.3': + resolution: {integrity: sha512-cuzCE/1G0ZSnTAHJPUT1rPgQx1w5tzSX7POXSLaS7w2nIUJUD+e25QoXD/hMfxbsT9rslEXugWypJMILBj/QsA==} engines: {node: '>= 10'} cpu: [arm64] os: [linux] - '@next/swc-linux-arm64-musl@14.2.2': - resolution: {integrity: sha512-wPbS3pI/JU16rm3XdLvvTmlsmm1nd+sBa2ohXgBZcShX4TgOjD4R+RqHKlI1cjo/jDZKXt6OxmcU0Iys0OC/yg==} + '@next/swc-linux-arm64-musl@14.2.3': + resolution: {integrity: sha512-0D4/oMM2Y9Ta3nGuCcQN8jjJjmDPYpHX9OJzqk42NZGJocU2MqhBq5tWkJrUQOQY9N+In9xOdymzapM09GeiZw==} engines: {node: '>= 10'} cpu: [arm64] os: [linux] - '@next/swc-linux-x64-gnu@14.2.2': - resolution: {integrity: sha512-NqWOHqqq8iC9tuHvZxjQ2tX+jWy2X9y8NX2mcB4sj2bIccuCxbIZrU/ThFPZZPauygajZuVQ6zediejQHwZHwQ==} + '@next/swc-linux-x64-gnu@14.2.3': + resolution: {integrity: sha512-ENPiNnBNDInBLyUU5ii8PMQh+4XLr4pG51tOp6aJ9xqFQ2iRI6IH0Ds2yJkAzNV1CfyagcyzPfROMViS2wOZ9w==} engines: {node: '>= 10'} cpu: [x64] os: [linux] - '@next/swc-linux-x64-musl@14.2.2': - resolution: {integrity: sha512-lGepHhwb9sGhCcU7999+iK1ZZT+6rrIoVg40MP7DZski9GIZP80wORSbt5kJzh9v2x2ev2lxC6VgwMQT0PcgTA==} + '@next/swc-linux-x64-musl@14.2.3': + resolution: {integrity: sha512-BTAbq0LnCbF5MtoM7I/9UeUu/8ZBY0i8SFjUMCbPDOLv+un67e2JgyN4pmgfXBwy/I+RHu8q+k+MCkDN6P9ViQ==} engines: {node: '>= 10'} cpu: [x64] os: [linux] - '@next/swc-win32-arm64-msvc@14.2.2': - resolution: {integrity: sha512-TZSh/48SfcLEQ4rD25VVn2kdIgUWmMflRX3OiyPwGNXn3NiyPqhqei/BaqCYXViIQ+6QsG9R0C8LftMqy8JPMA==} + '@next/swc-win32-arm64-msvc@14.2.3': + resolution: {integrity: sha512-AEHIw/dhAMLNFJFJIJIyOFDzrzI5bAjI9J26gbO5xhAKHYTZ9Or04BesFPXiAYXDNdrwTP2dQceYA4dL1geu8A==} engines: {node: '>= 10'} cpu: [arm64] os: [win32] - '@next/swc-win32-ia32-msvc@14.2.2': - resolution: {integrity: sha512-M0tBVNMEBJN2ZNQWlcekMn6pvLria7Sa2Fai5znm7CCJz4pP3lrvlSxhKdkCerk0D9E0bqx5yAo3o2Q7RrD4gA==} + '@next/swc-win32-ia32-msvc@14.2.3': + resolution: {integrity: sha512-vga40n1q6aYb0CLrM+eEmisfKCR45ixQYXuBXxOOmmoV8sYST9k7E3US32FsY+CkkF7NtzdcebiFT4CHuMSyZw==} engines: {node: '>= 10'} cpu: [ia32] os: [win32] - '@next/swc-win32-x64-msvc@14.2.2': - resolution: {integrity: sha512-a/20E/wtTJZ3Ykv3f/8F0l7TtgQa2LWHU2oNB9bsu0VjqGuGGHmm/q6waoUNQYTVPYrrlxxaHjJcDV6aiSTt/w==} + '@next/swc-win32-x64-msvc@14.2.3': + resolution: {integrity: sha512-Q1/zm43RWynxrO7lW4ehciQVj+5ePBhOK+/K2P7pLFX3JaJ/IZVC69SHidrmZSOkqz7ECIOhhy7XhAFG4JYyHA==} engines: {node: '>= 10'} cpu: [x64] os: [win32] @@ -756,83 +756,83 @@ packages: resolution: {integrity: sha512-VH10SAkDu+jVW9tDFJWWYroFxHVY9N5VS4gorXw0cK8L+LydUOQ4KiZaKbTsTF2piWmZCxngZI7sNPHMiJ4Ftg==} engines: {node: '>=14.19.0', npm: '>=7.0.0'} - '@rollup/rollup-android-arm-eabi@4.16.4': - resolution: {integrity: sha512-GkhjAaQ8oUTOKE4g4gsZ0u8K/IHU1+2WQSgS1TwTcYvL+sjbaQjNHFXbOJ6kgqGHIO1DfUhI/Sphi9GkRT9K+Q==} + '@rollup/rollup-android-arm-eabi@4.17.0': + resolution: {integrity: sha512-nNvLvC2fjC+3+bHYN9uaGF3gcyy7RHGZhtl8TB/kINj9hiOQza8kWJGZh47GRPMrqeseO8U+Z8ElDMCZlWBdHA==} cpu: [arm] os: [android] - '@rollup/rollup-android-arm64@4.16.4': - resolution: {integrity: sha512-Bvm6D+NPbGMQOcxvS1zUl8H7DWlywSXsphAeOnVeiZLQ+0J6Is8T7SrjGTH29KtYkiY9vld8ZnpV3G2EPbom+w==} + '@rollup/rollup-android-arm64@4.17.0': + resolution: {integrity: sha512-+kjt6dvxnyTIAo7oHeYseYhDyZ7xRKTNl/FoQI96PHkJVxoChldJnne/LzYqpqidoK1/0kX0/q+5rrYqjpth6w==} cpu: [arm64] os: [android] - '@rollup/rollup-darwin-arm64@4.16.4': - resolution: {integrity: sha512-i5d64MlnYBO9EkCOGe5vPR/EeDwjnKOGGdd7zKFhU5y8haKhQZTN2DgVtpODDMxUr4t2K90wTUJg7ilgND6bXw==} + '@rollup/rollup-darwin-arm64@4.17.0': + resolution: {integrity: sha512-Oj6Tp0unMpGTBjvNwbSRv3DopMNLu+mjBzhKTt2zLbDJ/45fB1pltr/rqrO4bE95LzuYwhYn127pop+x/pzf5w==} cpu: [arm64] os: [darwin] - '@rollup/rollup-darwin-x64@4.16.4': - resolution: {integrity: sha512-WZupV1+CdUYehaZqjaFTClJI72fjJEgTXdf4NbW69I9XyvdmztUExBtcI2yIIU6hJtYvtwS6pkTkHJz+k08mAQ==} + '@rollup/rollup-darwin-x64@4.17.0': + resolution: {integrity: sha512-3nJx0T+yptxMd+v93rBRxSPTAVCv8szu/fGZDJiKX7kvRe9sENj2ggXjCH/KK1xZEmJOhaNo0c9sGMgGdfkvEw==} cpu: [x64] os: [darwin] - '@rollup/rollup-linux-arm-gnueabihf@4.16.4': - resolution: {integrity: sha512-ADm/xt86JUnmAfA9mBqFcRp//RVRt1ohGOYF6yL+IFCYqOBNwy5lbEK05xTsEoJq+/tJzg8ICUtS82WinJRuIw==} + '@rollup/rollup-linux-arm-gnueabihf@4.17.0': + resolution: {integrity: sha512-Vb2e8p9b2lxxgqyOlBHmp6hJMu/HSU6g//6Tbr7x5V1DlPCHWLOm37nSIVK314f+IHzORyAQSqL7+9tELxX3zQ==} cpu: [arm] os: [linux] - '@rollup/rollup-linux-arm-musleabihf@4.16.4': - resolution: {integrity: sha512-tJfJaXPiFAG+Jn3cutp7mCs1ePltuAgRqdDZrzb1aeE3TktWWJ+g7xK9SNlaSUFw6IU4QgOxAY4rA+wZUT5Wfg==} + '@rollup/rollup-linux-arm-musleabihf@4.17.0': + resolution: {integrity: sha512-Md60KsmC5ZIaRq/bYYDloklgU+XLEZwS2EXXVcSpiUw+13/ZASvSWQ/P92rQ9YDCL6EIoXxuQ829JkReqdYbGg==} cpu: [arm] os: [linux] - '@rollup/rollup-linux-arm64-gnu@4.16.4': - resolution: {integrity: sha512-7dy1BzQkgYlUTapDTvK997cgi0Orh5Iu7JlZVBy1MBURk7/HSbHkzRnXZa19ozy+wwD8/SlpJnOOckuNZtJR9w==} + '@rollup/rollup-linux-arm64-gnu@4.17.0': + resolution: {integrity: sha512-zL5rBFtJ+2EGnMRm2TqKjdjgFqlotSU+ZJEN37nV+fiD3I6Gy0dUh3jBWN0wSlcXVDEJYW7YBe+/2j0N9unb2w==} cpu: [arm64] os: [linux] - '@rollup/rollup-linux-arm64-musl@4.16.4': - resolution: {integrity: sha512-zsFwdUw5XLD1gQe0aoU2HVceI6NEW7q7m05wA46eUAyrkeNYExObfRFQcvA6zw8lfRc5BHtan3tBpo+kqEOxmg==} + '@rollup/rollup-linux-arm64-musl@4.17.0': + resolution: {integrity: sha512-s2xAyNkJqUdtRVgNK4NK4P9QttS538JuX/kfVQOdZDI5FIKVAUVdLW7qhGfmaySJ1EvN/Bnj9oPm5go9u8navg==} cpu: [arm64] os: [linux] - '@rollup/rollup-linux-powerpc64le-gnu@4.16.4': - resolution: {integrity: sha512-p8C3NnxXooRdNrdv6dBmRTddEapfESEUflpICDNKXpHvTjRRq1J82CbU5G3XfebIZyI3B0s074JHMWD36qOW6w==} + '@rollup/rollup-linux-powerpc64le-gnu@4.17.0': + resolution: {integrity: sha512-7F99yzVT67B7IUNMjLD9QCFDCyHkyCJMS1dywZrGgVFJao4VJ9szrIEgH67cR+bXQgEaY01ur/WSL6B0jtcLyA==} cpu: [ppc64] os: [linux] - '@rollup/rollup-linux-riscv64-gnu@4.16.4': - resolution: {integrity: sha512-Lh/8ckoar4s4Id2foY7jNgitTOUQczwMWNYi+Mjt0eQ9LKhr6sK477REqQkmy8YHY3Ca3A2JJVdXnfb3Rrwkng==} + '@rollup/rollup-linux-riscv64-gnu@4.17.0': + resolution: {integrity: sha512-leFtyiXisfa3Sg9pgZJwRKITWnrQfhtqDjCamnZhkZuIsk1FXmYwKoTkp6lsCgimIcneFFkHKp/yGLxDesga4g==} cpu: [riscv64] os: [linux] - '@rollup/rollup-linux-s390x-gnu@4.16.4': - resolution: {integrity: sha512-1xwwn9ZCQYuqGmulGsTZoKrrn0z2fAur2ujE60QgyDpHmBbXbxLaQiEvzJWDrscRq43c8DnuHx3QorhMTZgisQ==} + '@rollup/rollup-linux-s390x-gnu@4.17.0': + resolution: {integrity: sha512-FtOgui6qMJ4jbSXTxElsy/60LEe/3U0rXkkz2G5CJ9rbHPAvjMvI+3qF0A0fwLQ5hW+/ZC6PbnS2KfRW9JkgDQ==} cpu: [s390x] os: [linux] - '@rollup/rollup-linux-x64-gnu@4.16.4': - resolution: {integrity: sha512-LuOGGKAJ7dfRtxVnO1i3qWc6N9sh0Em/8aZ3CezixSTM+E9Oq3OvTsvC4sm6wWjzpsIlOCnZjdluINKESflJLA==} + '@rollup/rollup-linux-x64-gnu@4.17.0': + resolution: {integrity: sha512-v6eiam/1w3HUfU/ZjzIDodencqgrSqzlNuNtiwH7PFJHYSo1ezL0/UIzmS2lpSJF1ORNaplXeKHYmmdt81vV2g==} cpu: [x64] os: [linux] - '@rollup/rollup-linux-x64-musl@4.16.4': - resolution: {integrity: sha512-ch86i7KkJKkLybDP2AtySFTRi5fM3KXp0PnHocHuJMdZwu7BuyIKi35BE9guMlmTpwwBTB3ljHj9IQXnTCD0vA==} + '@rollup/rollup-linux-x64-musl@4.17.0': + resolution: {integrity: sha512-OUhkSdpM5ofVlVU2k4CwVubYwiwu1a4jYWPpubzN7Vzao73GoPBowHcCfaRSFRz1SszJ3HIsk3dZYk4kzbqjgw==} cpu: [x64] os: [linux] - '@rollup/rollup-win32-arm64-msvc@4.16.4': - resolution: {integrity: sha512-Ma4PwyLfOWZWayfEsNQzTDBVW8PZ6TUUN1uFTBQbF2Chv/+sjenE86lpiEwj2FiviSmSZ4Ap4MaAfl1ciF4aSA==} + '@rollup/rollup-win32-arm64-msvc@4.17.0': + resolution: {integrity: sha512-uL7UYO/MNJPGL/yflybI+HI+n6+4vlfZmQZOCb4I+z/zy1wisHT3exh7oNQsnL6Eso0EUTEfgQ/PaGzzXf6XyQ==} cpu: [arm64] os: [win32] - '@rollup/rollup-win32-ia32-msvc@4.16.4': - resolution: {integrity: sha512-9m/ZDrQsdo/c06uOlP3W9G2ENRVzgzbSXmXHT4hwVaDQhYcRpi9bgBT0FTG9OhESxwK0WjQxYOSfv40cU+T69w==} + '@rollup/rollup-win32-ia32-msvc@4.17.0': + resolution: {integrity: sha512-4WnSgaUiUmXILwFqREdOcqvSj6GD/7FrvSjhaDjmwakX9w4Z2F8JwiSP1AZZbuRkPqzi444UI5FPv33VKOWYFQ==} cpu: [ia32] os: [win32] - '@rollup/rollup-win32-x64-msvc@4.16.4': - resolution: {integrity: sha512-YunpoOAyGLDseanENHmbFvQSfVL5BxW3k7hhy0eN4rb3gS/ct75dVD0EXOWIqFT/nE8XYW6LP6vz6ctKRi0k9A==} + '@rollup/rollup-win32-x64-msvc@4.17.0': + resolution: {integrity: sha512-ve+D8t1prRSRnF2S3pyDtTXDlvW1Pngbz76tjgYFQW1jxVSysmQCZfPoDAo4WP+Ano8zeYp85LsArZBI12HfwQ==} cpu: [x64] os: [win32] @@ -1008,11 +1008,11 @@ packages: '@types/pug@2.0.10': resolution: {integrity: sha512-Sk/uYFOBAB7mb74XcpizmH0KOR2Pv3D2Hmrh1Dmy5BmK3MpdSa5kqZcg6EKBdklU0bFXX9gCfzvpnyUehrPIuA==} - '@types/react-dom@18.2.25': - resolution: {integrity: sha512-o/V48vf4MQh7juIKZU2QGDfli6p1+OOi5oXx36Hffpc9adsHeXjVp8rHuPkjd8VT8sOJ2Zp05HR7CdpGTIUFUA==} + '@types/react-dom@18.3.0': + resolution: {integrity: sha512-EhwApuTmMBmXuFOikhQLIBUn6uFg81SwLMOAUgodJF14SOBOCMdU04gDoYi0WOJJHD144TL32z4yDqCW3dnkQg==} - '@types/react@18.2.79': - resolution: {integrity: sha512-RwGAGXPl9kSXwdNTafkOEuFrTBD5SA2B3iEB96xi8+xu5ddUa/cpvyVCSNn+asgLCTHkb5ZxN8gbuibYJi4s1w==} + '@types/react@18.3.1': + resolution: {integrity: sha512-V0kuGBX3+prX+DQ/7r2qsv1NsdfnCLnTgnRJ1pYnxykBhGMz+qj+box5lq7XsO5mtZsBqpjwwTu/7wszPfMBcw==} '@types/semver@7.5.8': resolution: {integrity: sha512-I8EUhyrgfLrcTkzV3TSsGyl1tSuPrEDzr0yd5m90UgNxQkyDXULk3b6MlQqTCpZpNtWe1K0hzclnZkTcLBe2UQ==} @@ -1053,45 +1053,45 @@ packages: '@vitest/utils@1.5.0': resolution: {integrity: sha512-BDU0GNL8MWkRkSRdNFvCUCAVOeHaUlVJ9Tx0TYBZyXaaOTmGtUFObzchCivIBrIwKzvZA7A9sCejVhXM2aY98A==} - '@vue/compiler-core@3.4.24': - resolution: {integrity: sha512-vbW/tgbwJYj62N/Ww99x0zhFTkZDTcGh3uwJEuadZ/nF9/xuFMC4693P9r+3sxGXISABpDKvffY5ApH9pmdd1A==} + '@vue/compiler-core@3.4.25': + resolution: {integrity: sha512-Y2pLLopaElgWnMNolgG8w3C5nNUVev80L7hdQ5iIKPtMJvhVpG0zhnBG/g3UajJmZdvW0fktyZTotEHD1Srhbg==} - '@vue/compiler-dom@3.4.24': - resolution: {integrity: sha512-4XgABML/4cNndVsQndG6BbGN7+EoisDwi3oXNovqL/4jdNhwvP8/rfRMTb6FxkxIxUUtg6AI1/qZvwfSjxJiWA==} + '@vue/compiler-dom@3.4.25': + resolution: {integrity: sha512-Ugz5DusW57+HjllAugLci19NsDK+VyjGvmbB2TXaTcSlQxwL++2PETHx/+Qv6qFwNLzSt7HKepPe4DcTE3pBWg==} - '@vue/compiler-sfc@3.4.24': - resolution: {integrity: sha512-nRAlJUK02FTWfA2nuvNBAqsDZuERGFgxZ8sGH62XgFSvMxO2URblzulExsmj4gFZ8e+VAyDooU9oAoXfEDNxTA==} + '@vue/compiler-sfc@3.4.25': + resolution: {integrity: sha512-m7rryuqzIoQpOBZ18wKyq05IwL6qEpZxFZfRxlNYuIPDqywrXQxgUwLXIvoU72gs6cRdY6wHD0WVZIFE4OEaAQ==} - '@vue/compiler-ssr@3.4.24': - resolution: {integrity: sha512-ZsAtr4fhaUFnVcDqwW3bYCSDwq+9Gk69q2r/7dAHDrOMw41kylaMgOP4zRnn6GIEJkQznKgrMOGPMFnLB52RbQ==} + '@vue/compiler-ssr@3.4.25': + resolution: {integrity: sha512-H2ohvM/Pf6LelGxDBnfbbXFPyM4NE3hrw0e/EpwuSiYu8c819wx+SVGdJ65p/sFrYDd6OnSDxN1MB2mN07hRSQ==} - '@vue/devtools-api@7.1.2': - resolution: {integrity: sha512-AKd49cN3BdRgttmX5Aw8op7sx6jmaPwaILcDjaa05UKc1yIHDYST7P8yGZs6zd2pKFETAQz40gmyG7+b57slsQ==} + '@vue/devtools-api@7.1.3': + resolution: {integrity: sha512-W8IwFJ/o5iUk78jpqhvScbgCsPiOp2uileDVC0NDtW38gCWhsnu9SeBTjcdu3lbwLdsjc+H1c5Msd/x9ApbcFA==} - '@vue/devtools-kit@7.1.2': - resolution: {integrity: sha512-UTrcUSOhlI9eXqbPMHUWwA6NQiiPT3onzXsVk2JHGR8ZFFSkzsWTTpHyVA1woG8zvgu2HNV/wigW2k87p858zw==} + '@vue/devtools-kit@7.1.3': + resolution: {integrity: sha512-NFskFSJMVCBXTkByuk2llzI3KD3Blcm7WqiRorWjD6nClHPgkH5BobDH08rfulqq5ocRt5xV+3qOT1Q9FXJrwQ==} peerDependencies: vue: ^3.0.0 - '@vue/devtools-shared@7.1.2': - resolution: {integrity: sha512-r9cUf93VMhKSsxF2/cBbf6Lm1nRBx+r1pRuji5CiAf3JIPYPOjeEqJ13OuwP1fauYh1tyBFcCxt3eJPvHT59gg==} + '@vue/devtools-shared@7.1.3': + resolution: {integrity: sha512-KJ3AfgjTn3tJz/XKF+BlVShNPecim3G21oHRue+YQOsooW+0s+qXvm09U09aO7yBza5SivL1QgxSrzAbiKWjhQ==} - '@vue/reactivity@3.4.24': - resolution: {integrity: sha512-nup3fSYg4i4LtNvu9slF/HF/0dkMQYfepUdORBcMSsankzRPzE7ypAFurpwyRBfU1i7Dn1kcwpYsE1wETSh91g==} + '@vue/reactivity@3.4.25': + resolution: {integrity: sha512-mKbEtKr1iTxZkAG3vm3BtKHAOhuI4zzsVcN0epDldU/THsrvfXRKzq+lZnjczZGnTdh3ojd86/WrP+u9M51pWQ==} - '@vue/runtime-core@3.4.24': - resolution: {integrity: sha512-c7iMfj6cJMeAG3s5yOn9Rc5D9e2/wIuaozmGf/ICGCY3KV5H7mbTVdvEkd4ZshTq7RUZqj2k7LMJWVx+EBiY1g==} + '@vue/runtime-core@3.4.25': + resolution: {integrity: sha512-3qhsTqbEh8BMH3pXf009epCI5E7bKu28fJLi9O6W+ZGt/6xgSfMuGPqa5HRbUxLoehTNp5uWvzCr60KuiRIL0Q==} - '@vue/runtime-dom@3.4.24': - resolution: {integrity: sha512-uXKzuh/Emfad2Y7Qm0ABsLZZV6H3mAJ5ZVqmAOlrNQRf+T5mxpPGZBfec1hkP41t6h6FwF6RSGCs/gd8WbuySQ==} + '@vue/runtime-dom@3.4.25': + resolution: {integrity: sha512-ode0sj77kuwXwSc+2Yhk8JMHZh1sZp9F/51wdBiz3KGaWltbKtdihlJFhQG4H6AY+A06zzeMLkq6qu8uDSsaoA==} - '@vue/server-renderer@3.4.24': - resolution: {integrity: sha512-H+DLK4sQF6sRgzKyofmlEVBIV/9KrQU6HIV7nt6yIwSGGKvSwlV8pqJlebUKLpbXaNHugdSfAbP6YmXF69lxow==} + '@vue/server-renderer@3.4.25': + resolution: {integrity: sha512-8VTwq0Zcu3K4dWV0jOwIVINESE/gha3ifYCOKEhxOj6MEl5K5y8J8clQncTcDhKF+9U765nRw4UdUEXvrGhyVQ==} peerDependencies: - vue: 3.4.24 + vue: 3.4.25 - '@vue/shared@3.4.24': - resolution: {integrity: sha512-BW4tajrJBM9AGAknnyEw5tO2xTmnqgup0VTnDAMcxYmqOX0RG0b9aSUGAbEKolD91tdwpA6oCwbltoJoNzpItw==} + '@vue/shared@3.4.25': + resolution: {integrity: sha512-k0yappJ77g2+KNrIaF0FFnzwLvUBLUYr8VOwz+/6vLsmItFp51AcxLL7Ey3iPd7BIRyWPOcqUjMnm7OkahXllA==} '@vueuse/core@10.9.0': resolution: {integrity: sha512-/1vjTol8SXnx6xewDEKfS0Ra//ncg4Hb0DaZiwKf7drgfMsKFExQ+FnnENcN6efPen+1kIzhLQoGSy0eDUVOMg==} @@ -1297,8 +1297,8 @@ packages: resolution: {integrity: sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==} engines: {node: '>=10'} - caniuse-lite@1.0.30001612: - resolution: {integrity: sha512-lFgnZ07UhaCcsSZgWW0K5j4e69dK1u/ltrL9lTUiFOwNHs12S3UMIEYgBV0Z6C6hRDev7iRnMzzYmKabYdXF9g==} + caniuse-lite@1.0.30001614: + resolution: {integrity: sha512-jmZQ1VpmlRwHgdP1/uiKzgiAuGOfLEJsYFP4+GBou/QQ4U6IOJCB4NP1c+1p9RGLpwObcT94jA5/uO+F1vBbog==} chai@4.4.1: resolution: {integrity: sha512-13sOfMv2+DWduEU+/xbun3LScLoqN17nBeTLUsmDfKdoiC1fr0n9PU4guu4AhRcOVFk/sW8LyZWHuhWtQZiF+g==} @@ -2208,8 +2208,8 @@ packages: neo-async@2.6.2: resolution: {integrity: sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==} - next@14.2.2: - resolution: {integrity: sha512-oGwUaa2bCs47FbuxWMpOoXtBMPYpvTPgdZr3UAo+pu7Ns00z9otmYpoeV1HEiYL06AlRQQIA/ypK526KjJfaxg==} + next@14.2.3: + resolution: {integrity: sha512-dowFkFTR8v79NPJO4QsBUtxv0g9BrS/phluVpMAt2ku7H+cbcBJlopXjkWlwxrk/xGqMemr7JkGPGemPrLLX7A==} engines: {node: '>=18.17.0'} hasBin: true peerDependencies: @@ -2452,16 +2452,16 @@ packages: resolution: {integrity: sha512-WuyALRjWPDGtt/wzJiadO5AXY+8hZ80hVpe6MyivgraREW751X3SbhRvG3eLKOYN+8VEvqLcf3wdnt44Z4S4SA==} engines: {node: '>=10'} - react-dom@18.2.0: - resolution: {integrity: sha512-6IMTriUmvsjHUjNtEDudZfuDQUoWXVxKHhlEGSk81n4YFS+r/Kl99wXiwlVXtPBtJenozv2P+hxDsw9eA7Xo6g==} + react-dom@18.3.1: + resolution: {integrity: sha512-5m4nQKp+rZRb09LNH59GM4BxTh9251/ylbKIbpe7TpGxfJ+9kv6BLkLBXIjjspbgbnIBNqlI23tRnTWT0snUIw==} peerDependencies: - react: ^18.2.0 + react: ^18.3.1 react-is@18.2.0: resolution: {integrity: sha512-xWGDIW6x921xtzPkhiULtthJHoJvBbF3q26fzloPCK0hsvxtPVelvftw3zjbHWSkR2km9Z+4uxbDDK/6Zw9B8w==} - react@18.2.0: - resolution: {integrity: sha512-/3IjMdb2L9QbBdWiW5e3P2/npwMBaU9mHCSCUzNln0ZCYbcfTsGbTJrU/kGemdH2IWmB2ioZ+zkxtmq6g09fGQ==} + react@18.3.1: + resolution: {integrity: sha512-wS+hAgJShR0KhEvPJArfuPVN1+Hz1t0Y6n5jLrGQbkb4urgPE/0Rve+1kMB1v/oWgHgm4WIcV+i7F2pTVj+2iQ==} engines: {node: '>=0.10.0'} read-pkg-up@7.0.1: @@ -2541,8 +2541,8 @@ packages: resolution: {integrity: sha512-JZkJMZkAGFFPP2YqXZXPbMlMBgsxzE8ILs4lMIX/2o0L9UBw9O/Y3o6wFw/i9YLapcUJWwqbi3kdxIPdC62TIA==} hasBin: true - rollup@4.16.4: - resolution: {integrity: sha512-kuaTJSUbz+Wsb2ATGvEknkI12XV40vIiHmLuFlejoo7HtDok/O5eDDD0UpCVY5bBX5U5RYo8wWP83H7ZsqVEnA==} + rollup@4.17.0: + resolution: {integrity: sha512-wZJSn0WMtWrxhYKQRt5Z6GIXlziOoMDFmbHmRfL3v+sBTAshx2DBq1AfMArB7eIjF63r4ocn2ZTAyUptg/7kmQ==} engines: {node: '>=18.0.0', npm: '>=8.0.0'} hasBin: true @@ -2567,8 +2567,8 @@ packages: sander@0.5.1: resolution: {integrity: sha512-3lVqBir7WuKDHGrKRDn/1Ye3kwpXaDOMsiRP1wd6wpZW56gJhsbp5RqQpA6JG/P+pkXizygnr1dKR8vzWaVsfA==} - scheduler@0.23.0: - resolution: {integrity: sha512-CtuThmgHNg7zIZWAXi3AsyIzA3n4xx7aNyjwC2VJldO2LMVDhFK+63xGqq6CsJH4rTAt6/M+N4GhZiDYPx9eUw==} + scheduler@0.23.2: + resolution: {integrity: sha512-UOShsPwz7NrMUqhR6t0hWjFduvOzbtv7toDH1/hIrfRNIDBnnBWd0CwJTGvTpngVlmwGCdP9/Zl/tVrDqcuYzQ==} search-insights@2.13.0: resolution: {integrity: sha512-Orrsjf9trHHxFRuo9/rzm0KIWmgzE8RMlZMzuhZOJ01Rnz3D0YBAe+V6473t6/H6c7irs6Lt48brULAiRWb3Vw==} @@ -2776,8 +2776,8 @@ packages: resolution: {integrity: sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w==} engines: {node: '>= 0.4'} - svelte-check@3.6.9: - resolution: {integrity: sha512-hDQrk3L0osX07djQyMiXocKysTLfusqi8AriNcCiQxhQR49/LonYolcUGMtZ0fbUR8HTR198Prrgf52WWU9wEg==} + svelte-check@3.7.0: + resolution: {integrity: sha512-Va6sGL4Vy4znn0K+vaatk98zoBvG2aDee4y3r5X4S80z8DXfbACHvdLlyXa4C4c5tQzK9H0Uq2pbd20wH3ucjQ==} hasBin: true peerDependencies: svelte: ^3.55.0 || ^4.0.0-next.0 || ^4.0.0 || ^5.0.0-next.0 @@ -3007,8 +3007,8 @@ packages: vite: optional: true - vitepress@1.1.3: - resolution: {integrity: sha512-hGrIYN0w9IHWs0NQSnlMjKV/v/HLfD+Ywv5QdvCSkiT32mpNOOwUrZjnqZv/JL/WBPpUc94eghTUvmipxw0xrA==} + vitepress@1.1.4: + resolution: {integrity: sha512-bWIzFZXpPB6NIDBuWnS20aMADH+FcFKDfQNYFvbOWij03PR29eImTceQHIzCKordjXYBhM/TjE5VKFTUJ3EheA==} hasBin: true peerDependencies: markdown-it-mathjax3: ^4 @@ -3055,8 +3055,8 @@ packages: '@vue/composition-api': optional: true - vue@3.4.24: - resolution: {integrity: sha512-NPdx7dLGyHmKHGRRU5bMRYVE+rechR+KDU5R2tSTNG36PuMwbfAJ+amEvOAw7BPfZp5sQulNELSLm5YUkau+Sg==} + vue@3.4.25: + resolution: {integrity: sha512-HWyDqoBHMgav/OKiYA2ZQg+kjfMgLt/T0vg4cbIF7JbXAjDexRf5JRg+PWAfrAkSmTd2I8aPSXtooBFWHB98cg==} peerDependencies: typescript: '*' peerDependenciesMeta: @@ -3515,9 +3515,9 @@ snapshots: '@docsearch/css@3.6.0': {} - '@docsearch/js@3.6.0(@algolia/client-search@4.23.3)(@types/react@18.2.79)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(search-insights@2.13.0)': + '@docsearch/js@3.6.0(@algolia/client-search@4.23.3)(@types/react@18.3.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)': dependencies: - '@docsearch/react': 3.6.0(@algolia/client-search@4.23.3)(@types/react@18.2.79)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(search-insights@2.13.0) + '@docsearch/react': 3.6.0(@algolia/client-search@4.23.3)(@types/react@18.3.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0) preact: 10.20.2 transitivePeerDependencies: - '@algolia/client-search' @@ -3526,16 +3526,16 @@ snapshots: - react-dom - search-insights - '@docsearch/react@3.6.0(@algolia/client-search@4.23.3)(@types/react@18.2.79)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(search-insights@2.13.0)': + '@docsearch/react@3.6.0(@algolia/client-search@4.23.3)(@types/react@18.3.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)': dependencies: '@algolia/autocomplete-core': 1.9.3(@algolia/client-search@4.23.3)(algoliasearch@4.23.3)(search-insights@2.13.0) '@algolia/autocomplete-preset-algolia': 1.9.3(@algolia/client-search@4.23.3)(algoliasearch@4.23.3) '@docsearch/css': 3.6.0 algoliasearch: 4.23.3 optionalDependencies: - '@types/react': 18.2.79 - react: 18.2.0 - react-dom: 18.2.0(react@18.2.0) + '@types/react': 18.3.1 + react: 18.3.1 + react-dom: 18.3.1(react@18.3.1) search-insights: 2.13.0 transitivePeerDependencies: - '@algolia/client-search' @@ -3686,33 +3686,33 @@ snapshots: outvariant: 1.4.2 strict-event-emitter: 0.5.1 - '@next/env@14.2.2': {} + '@next/env@14.2.3': {} - '@next/swc-darwin-arm64@14.2.2': + '@next/swc-darwin-arm64@14.2.3': optional: true - '@next/swc-darwin-x64@14.2.2': + '@next/swc-darwin-x64@14.2.3': optional: true - '@next/swc-linux-arm64-gnu@14.2.2': + '@next/swc-linux-arm64-gnu@14.2.3': optional: true - '@next/swc-linux-arm64-musl@14.2.2': + '@next/swc-linux-arm64-musl@14.2.3': optional: true - '@next/swc-linux-x64-gnu@14.2.2': + '@next/swc-linux-x64-gnu@14.2.3': optional: true - '@next/swc-linux-x64-musl@14.2.2': + '@next/swc-linux-x64-musl@14.2.3': optional: true - '@next/swc-win32-arm64-msvc@14.2.2': + '@next/swc-win32-arm64-msvc@14.2.3': optional: true - '@next/swc-win32-ia32-msvc@14.2.2': + '@next/swc-win32-ia32-msvc@14.2.3': optional: true - '@next/swc-win32-x64-msvc@14.2.2': + '@next/swc-win32-x64-msvc@14.2.3': optional: true '@nodelib/fs.scandir@2.1.5': @@ -3762,52 +3762,52 @@ snapshots: transitivePeerDependencies: - encoding - '@rollup/rollup-android-arm-eabi@4.16.4': + '@rollup/rollup-android-arm-eabi@4.17.0': optional: true - '@rollup/rollup-android-arm64@4.16.4': + '@rollup/rollup-android-arm64@4.17.0': optional: true - '@rollup/rollup-darwin-arm64@4.16.4': + '@rollup/rollup-darwin-arm64@4.17.0': optional: true - '@rollup/rollup-darwin-x64@4.16.4': + '@rollup/rollup-darwin-x64@4.17.0': optional: true - '@rollup/rollup-linux-arm-gnueabihf@4.16.4': + '@rollup/rollup-linux-arm-gnueabihf@4.17.0': optional: true - '@rollup/rollup-linux-arm-musleabihf@4.16.4': + '@rollup/rollup-linux-arm-musleabihf@4.17.0': optional: true - '@rollup/rollup-linux-arm64-gnu@4.16.4': + '@rollup/rollup-linux-arm64-gnu@4.17.0': optional: true - '@rollup/rollup-linux-arm64-musl@4.16.4': + '@rollup/rollup-linux-arm64-musl@4.17.0': optional: true - '@rollup/rollup-linux-powerpc64le-gnu@4.16.4': + '@rollup/rollup-linux-powerpc64le-gnu@4.17.0': optional: true - '@rollup/rollup-linux-riscv64-gnu@4.16.4': + '@rollup/rollup-linux-riscv64-gnu@4.17.0': optional: true - '@rollup/rollup-linux-s390x-gnu@4.16.4': + '@rollup/rollup-linux-s390x-gnu@4.17.0': optional: true - '@rollup/rollup-linux-x64-gnu@4.16.4': + '@rollup/rollup-linux-x64-gnu@4.17.0': optional: true - '@rollup/rollup-linux-x64-musl@4.16.4': + '@rollup/rollup-linux-x64-musl@4.17.0': optional: true - '@rollup/rollup-win32-arm64-msvc@4.16.4': + '@rollup/rollup-win32-arm64-msvc@4.17.0': optional: true - '@rollup/rollup-win32-ia32-msvc@4.16.4': + '@rollup/rollup-win32-ia32-msvc@4.17.0': optional: true - '@rollup/rollup-win32-x64-msvc@4.16.4': + '@rollup/rollup-win32-x64-msvc@4.17.0': optional: true '@shikijs/core@1.3.0': {} @@ -3924,10 +3924,10 @@ snapshots: '@tanstack/query-core@5.32.0': {} - '@tanstack/react-query@5.32.0(react@18.2.0)': + '@tanstack/react-query@5.32.0(react@18.3.1)': dependencies: '@tanstack/query-core': 5.32.0 - react: 18.2.0 + react: 18.3.1 '@types/cookie@0.6.0': {} @@ -3968,11 +3968,11 @@ snapshots: '@types/pug@2.0.10': {} - '@types/react-dom@18.2.25': + '@types/react-dom@18.3.0': dependencies: - '@types/react': 18.2.79 + '@types/react': 18.3.1 - '@types/react@18.2.79': + '@types/react@18.3.1': dependencies: '@types/prop-types': 15.7.12 csstype: 3.1.3 @@ -3992,10 +3992,10 @@ snapshots: transitivePeerDependencies: - '@swc/helpers' - '@vitejs/plugin-vue@5.0.4(vite@5.2.10(@types/node@20.12.7))(vue@3.4.24(typescript@5.4.5))': + '@vitejs/plugin-vue@5.0.4(vite@5.2.10(@types/node@20.12.7))(vue@3.4.25(typescript@5.4.5))': dependencies: vite: 5.2.10(@types/node@20.12.7) - vue: 3.4.24(typescript@5.4.5) + vue: 3.4.25(typescript@5.4.5) '@vitest/expect@1.5.0': dependencies: @@ -4026,93 +4026,93 @@ snapshots: loupe: 2.3.7 pretty-format: 29.7.0 - '@vue/compiler-core@3.4.24': + '@vue/compiler-core@3.4.25': dependencies: '@babel/parser': 7.24.4 - '@vue/shared': 3.4.24 + '@vue/shared': 3.4.25 entities: 4.5.0 estree-walker: 2.0.2 source-map-js: 1.2.0 - '@vue/compiler-dom@3.4.24': + '@vue/compiler-dom@3.4.25': dependencies: - '@vue/compiler-core': 3.4.24 - '@vue/shared': 3.4.24 + '@vue/compiler-core': 3.4.25 + '@vue/shared': 3.4.25 - '@vue/compiler-sfc@3.4.24': + '@vue/compiler-sfc@3.4.25': dependencies: '@babel/parser': 7.24.4 - '@vue/compiler-core': 3.4.24 - '@vue/compiler-dom': 3.4.24 - '@vue/compiler-ssr': 3.4.24 - '@vue/shared': 3.4.24 + '@vue/compiler-core': 3.4.25 + '@vue/compiler-dom': 3.4.25 + '@vue/compiler-ssr': 3.4.25 + '@vue/shared': 3.4.25 estree-walker: 2.0.2 magic-string: 0.30.10 postcss: 8.4.38 source-map-js: 1.2.0 - '@vue/compiler-ssr@3.4.24': + '@vue/compiler-ssr@3.4.25': dependencies: - '@vue/compiler-dom': 3.4.24 - '@vue/shared': 3.4.24 + '@vue/compiler-dom': 3.4.25 + '@vue/shared': 3.4.25 - '@vue/devtools-api@7.1.2(vue@3.4.24(typescript@5.4.5))': + '@vue/devtools-api@7.1.3(vue@3.4.25(typescript@5.4.5))': dependencies: - '@vue/devtools-kit': 7.1.2(vue@3.4.24(typescript@5.4.5)) + '@vue/devtools-kit': 7.1.3(vue@3.4.25(typescript@5.4.5)) transitivePeerDependencies: - vue - '@vue/devtools-kit@7.1.2(vue@3.4.24(typescript@5.4.5))': + '@vue/devtools-kit@7.1.3(vue@3.4.25(typescript@5.4.5))': dependencies: - '@vue/devtools-shared': 7.1.2 + '@vue/devtools-shared': 7.1.3 hookable: 5.5.3 mitt: 3.0.1 perfect-debounce: 1.0.0 speakingurl: 14.0.1 - vue: 3.4.24(typescript@5.4.5) + vue: 3.4.25(typescript@5.4.5) - '@vue/devtools-shared@7.1.2': + '@vue/devtools-shared@7.1.3': dependencies: rfdc: 1.3.1 - '@vue/reactivity@3.4.24': + '@vue/reactivity@3.4.25': dependencies: - '@vue/shared': 3.4.24 + '@vue/shared': 3.4.25 - '@vue/runtime-core@3.4.24': + '@vue/runtime-core@3.4.25': dependencies: - '@vue/reactivity': 3.4.24 - '@vue/shared': 3.4.24 + '@vue/reactivity': 3.4.25 + '@vue/shared': 3.4.25 - '@vue/runtime-dom@3.4.24': + '@vue/runtime-dom@3.4.25': dependencies: - '@vue/runtime-core': 3.4.24 - '@vue/shared': 3.4.24 + '@vue/runtime-core': 3.4.25 + '@vue/shared': 3.4.25 csstype: 3.1.3 - '@vue/server-renderer@3.4.24(vue@3.4.24(typescript@5.4.5))': + '@vue/server-renderer@3.4.25(vue@3.4.25(typescript@5.4.5))': dependencies: - '@vue/compiler-ssr': 3.4.24 - '@vue/shared': 3.4.24 - vue: 3.4.24(typescript@5.4.5) + '@vue/compiler-ssr': 3.4.25 + '@vue/shared': 3.4.25 + vue: 3.4.25(typescript@5.4.5) - '@vue/shared@3.4.24': {} + '@vue/shared@3.4.25': {} - '@vueuse/core@10.9.0(vue@3.4.24(typescript@5.4.5))': + '@vueuse/core@10.9.0(vue@3.4.25(typescript@5.4.5))': dependencies: '@types/web-bluetooth': 0.0.20 '@vueuse/metadata': 10.9.0 - '@vueuse/shared': 10.9.0(vue@3.4.24(typescript@5.4.5)) - vue-demi: 0.14.7(vue@3.4.24(typescript@5.4.5)) + '@vueuse/shared': 10.9.0(vue@3.4.25(typescript@5.4.5)) + vue-demi: 0.14.7(vue@3.4.25(typescript@5.4.5)) transitivePeerDependencies: - '@vue/composition-api' - vue - '@vueuse/integrations@10.9.0(axios@1.6.8)(focus-trap@7.5.4)(vue@3.4.24(typescript@5.4.5))': + '@vueuse/integrations@10.9.0(axios@1.6.8)(focus-trap@7.5.4)(vue@3.4.25(typescript@5.4.5))': dependencies: - '@vueuse/core': 10.9.0(vue@3.4.24(typescript@5.4.5)) - '@vueuse/shared': 10.9.0(vue@3.4.24(typescript@5.4.5)) - vue-demi: 0.14.7(vue@3.4.24(typescript@5.4.5)) + '@vueuse/core': 10.9.0(vue@3.4.25(typescript@5.4.5)) + '@vueuse/shared': 10.9.0(vue@3.4.25(typescript@5.4.5)) + vue-demi: 0.14.7(vue@3.4.25(typescript@5.4.5)) optionalDependencies: axios: 1.6.8 focus-trap: 7.5.4 @@ -4122,9 +4122,9 @@ snapshots: '@vueuse/metadata@10.9.0': {} - '@vueuse/shared@10.9.0(vue@3.4.24(typescript@5.4.5))': + '@vueuse/shared@10.9.0(vue@3.4.25(typescript@5.4.5))': dependencies: - vue-demi: 0.14.7(vue@3.4.24(typescript@5.4.5)) + vue-demi: 0.14.7(vue@3.4.25(typescript@5.4.5)) transitivePeerDependencies: - '@vue/composition-api' - vue @@ -4300,7 +4300,7 @@ snapshots: camelcase@6.3.0: {} - caniuse-lite@1.0.30001612: {} + caniuse-lite@1.0.30001614: {} chai@4.4.1: dependencies: @@ -5279,27 +5279,27 @@ snapshots: neo-async@2.6.2: {} - next@14.2.2(react-dom@18.2.0(react@18.2.0))(react@18.2.0): + next@14.2.3(react-dom@18.3.1(react@18.3.1))(react@18.3.1): dependencies: - '@next/env': 14.2.2 + '@next/env': 14.2.3 '@swc/helpers': 0.5.5 busboy: 1.6.0 - caniuse-lite: 1.0.30001612 + caniuse-lite: 1.0.30001614 graceful-fs: 4.2.11 postcss: 8.4.31 - react: 18.2.0 - react-dom: 18.2.0(react@18.2.0) - styled-jsx: 5.1.1(react@18.2.0) + react: 18.3.1 + react-dom: 18.3.1(react@18.3.1) + styled-jsx: 5.1.1(react@18.3.1) optionalDependencies: - '@next/swc-darwin-arm64': 14.2.2 - '@next/swc-darwin-x64': 14.2.2 - '@next/swc-linux-arm64-gnu': 14.2.2 - '@next/swc-linux-arm64-musl': 14.2.2 - '@next/swc-linux-x64-gnu': 14.2.2 - '@next/swc-linux-x64-musl': 14.2.2 - '@next/swc-win32-arm64-msvc': 14.2.2 - '@next/swc-win32-ia32-msvc': 14.2.2 - '@next/swc-win32-x64-msvc': 14.2.2 + '@next/swc-darwin-arm64': 14.2.3 + '@next/swc-darwin-x64': 14.2.3 + '@next/swc-linux-arm64-gnu': 14.2.3 + '@next/swc-linux-arm64-musl': 14.2.3 + '@next/swc-linux-x64-gnu': 14.2.3 + '@next/swc-linux-x64-musl': 14.2.3 + '@next/swc-win32-arm64-msvc': 14.2.3 + '@next/swc-win32-ia32-msvc': 14.2.3 + '@next/swc-win32-x64-msvc': 14.2.3 transitivePeerDependencies: - '@babel/core' - babel-plugin-macros @@ -5508,15 +5508,15 @@ snapshots: quick-lru@5.1.1: {} - react-dom@18.2.0(react@18.2.0): + react-dom@18.3.1(react@18.3.1): dependencies: loose-envify: 1.4.0 - react: 18.2.0 - scheduler: 0.23.0 + react: 18.3.1 + scheduler: 0.23.2 react-is@18.2.0: {} - react@18.2.0: + react@18.3.1: dependencies: loose-envify: 1.4.0 @@ -5604,26 +5604,26 @@ snapshots: dependencies: glob: 7.2.3 - rollup@4.16.4: + rollup@4.17.0: dependencies: '@types/estree': 1.0.5 optionalDependencies: - '@rollup/rollup-android-arm-eabi': 4.16.4 - '@rollup/rollup-android-arm64': 4.16.4 - '@rollup/rollup-darwin-arm64': 4.16.4 - '@rollup/rollup-darwin-x64': 4.16.4 - '@rollup/rollup-linux-arm-gnueabihf': 4.16.4 - '@rollup/rollup-linux-arm-musleabihf': 4.16.4 - '@rollup/rollup-linux-arm64-gnu': 4.16.4 - '@rollup/rollup-linux-arm64-musl': 4.16.4 - '@rollup/rollup-linux-powerpc64le-gnu': 4.16.4 - '@rollup/rollup-linux-riscv64-gnu': 4.16.4 - '@rollup/rollup-linux-s390x-gnu': 4.16.4 - '@rollup/rollup-linux-x64-gnu': 4.16.4 - '@rollup/rollup-linux-x64-musl': 4.16.4 - '@rollup/rollup-win32-arm64-msvc': 4.16.4 - '@rollup/rollup-win32-ia32-msvc': 4.16.4 - '@rollup/rollup-win32-x64-msvc': 4.16.4 + '@rollup/rollup-android-arm-eabi': 4.17.0 + '@rollup/rollup-android-arm64': 4.17.0 + '@rollup/rollup-darwin-arm64': 4.17.0 + '@rollup/rollup-darwin-x64': 4.17.0 + '@rollup/rollup-linux-arm-gnueabihf': 4.17.0 + '@rollup/rollup-linux-arm-musleabihf': 4.17.0 + '@rollup/rollup-linux-arm64-gnu': 4.17.0 + '@rollup/rollup-linux-arm64-musl': 4.17.0 + '@rollup/rollup-linux-powerpc64le-gnu': 4.17.0 + '@rollup/rollup-linux-riscv64-gnu': 4.17.0 + '@rollup/rollup-linux-s390x-gnu': 4.17.0 + '@rollup/rollup-linux-x64-gnu': 4.17.0 + '@rollup/rollup-linux-x64-musl': 4.17.0 + '@rollup/rollup-win32-arm64-msvc': 4.17.0 + '@rollup/rollup-win32-ia32-msvc': 4.17.0 + '@rollup/rollup-win32-x64-msvc': 4.17.0 fsevents: 2.3.3 run-parallel@1.2.0: @@ -5656,7 +5656,7 @@ snapshots: mkdirp: 0.5.6 rimraf: 2.7.1 - scheduler@0.23.0: + scheduler@0.23.2: dependencies: loose-envify: 1.4.0 @@ -5833,10 +5833,10 @@ snapshots: dependencies: js-tokens: 9.0.0 - styled-jsx@5.1.1(react@18.2.0): + styled-jsx@5.1.1(react@18.3.1): dependencies: client-only: 0.0.1 - react: 18.2.0 + react: 18.3.1 superagent@9.0.0: dependencies: @@ -5865,7 +5865,7 @@ snapshots: supports-preserve-symlinks-flag@1.0.0: {} - svelte-check@3.6.9(postcss@8.4.38)(svelte@4.2.15): + svelte-check@3.7.0(postcss@8.4.38)(svelte@4.2.15): dependencies: '@jridgewell/trace-mapping': 0.3.25 chokidar: 3.6.0 @@ -6065,7 +6065,7 @@ snapshots: dependencies: esbuild: 0.20.2 postcss: 8.4.38 - rollup: 4.16.4 + rollup: 4.17.0 optionalDependencies: '@types/node': 20.12.7 fsevents: 2.3.3 @@ -6074,23 +6074,23 @@ snapshots: optionalDependencies: vite: 5.2.10(@types/node@20.12.7) - vitepress@1.1.3(@algolia/client-search@4.23.3)(@types/node@20.12.7)(@types/react@18.2.79)(axios@1.6.8)(postcss@8.4.38)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(search-insights@2.13.0)(typescript@5.4.5): + vitepress@1.1.4(@algolia/client-search@4.23.3)(@types/node@20.12.7)(@types/react@18.3.1)(axios@1.6.8)(postcss@8.4.38)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0)(typescript@5.4.5): dependencies: '@docsearch/css': 3.6.0 - '@docsearch/js': 3.6.0(@algolia/client-search@4.23.3)(@types/react@18.2.79)(react-dom@18.2.0(react@18.2.0))(react@18.2.0)(search-insights@2.13.0) + '@docsearch/js': 3.6.0(@algolia/client-search@4.23.3)(@types/react@18.3.1)(react-dom@18.3.1(react@18.3.1))(react@18.3.1)(search-insights@2.13.0) '@shikijs/core': 1.3.0 '@shikijs/transformers': 1.3.0 '@types/markdown-it': 14.0.1 - '@vitejs/plugin-vue': 5.0.4(vite@5.2.10(@types/node@20.12.7))(vue@3.4.24(typescript@5.4.5)) - '@vue/devtools-api': 7.1.2(vue@3.4.24(typescript@5.4.5)) - '@vueuse/core': 10.9.0(vue@3.4.24(typescript@5.4.5)) - '@vueuse/integrations': 10.9.0(axios@1.6.8)(focus-trap@7.5.4)(vue@3.4.24(typescript@5.4.5)) + '@vitejs/plugin-vue': 5.0.4(vite@5.2.10(@types/node@20.12.7))(vue@3.4.25(typescript@5.4.5)) + '@vue/devtools-api': 7.1.3(vue@3.4.25(typescript@5.4.5)) + '@vueuse/core': 10.9.0(vue@3.4.25(typescript@5.4.5)) + '@vueuse/integrations': 10.9.0(axios@1.6.8)(focus-trap@7.5.4)(vue@3.4.25(typescript@5.4.5)) focus-trap: 7.5.4 mark.js: 8.11.1 minisearch: 6.3.0 shiki: 1.3.0 vite: 5.2.10(@types/node@20.12.7) - vue: 3.4.24(typescript@5.4.5) + vue: 3.4.25(typescript@5.4.5) optionalDependencies: postcss: 8.4.38 transitivePeerDependencies: @@ -6153,17 +6153,17 @@ snapshots: - supports-color - terser - vue-demi@0.14.7(vue@3.4.24(typescript@5.4.5)): + vue-demi@0.14.7(vue@3.4.25(typescript@5.4.5)): dependencies: - vue: 3.4.24(typescript@5.4.5) + vue: 3.4.25(typescript@5.4.5) - vue@3.4.24(typescript@5.4.5): + vue@3.4.25(typescript@5.4.5): dependencies: - '@vue/compiler-dom': 3.4.24 - '@vue/compiler-sfc': 3.4.24 - '@vue/runtime-dom': 3.4.24 - '@vue/server-renderer': 3.4.24(vue@3.4.24(typescript@5.4.5)) - '@vue/shared': 3.4.24 + '@vue/compiler-dom': 3.4.25 + '@vue/compiler-sfc': 3.4.25 + '@vue/runtime-dom': 3.4.25 + '@vue/server-renderer': 3.4.25(vue@3.4.25(typescript@5.4.5)) + '@vue/shared': 3.4.25 optionalDependencies: typescript: 5.4.5